QGIS API Documentation  2.99.0-Master (b698612)
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
QgsPalLayerSettings Class Reference

#include <qgspallabeling.h>

Public Types

enum  DirectionSymbols { SymbolLeftRight, SymbolAbove, SymbolBelow }
 
enum  LinePlacementFlags { OnLine = 1, AboveLine = 2, BelowLine = 4, MapOrientation = 8 }
 Line placement flags, which control how candidates are generated for a linear feature. More...
 
enum  MultiLineAlign { MultiLeft = 0, MultiCenter, MultiRight, MultiFollowPlacement }
 
enum  ObstacleType { PolygonInterior, PolygonBoundary, PolygonWhole }
 Valid obstacle types, which affect how features within the layer will act as obstacles for labels. More...
 
enum  OffsetType { FromPoint, FromSymbolBounds }
 Behavior modifier for label offset and distance, only applies in some label placement modes. More...
 
enum  Placement {
  AroundPoint, OverPoint, Line, Curved,
  Horizontal, Free, OrderedPositionsAroundPoint, PerimeterCurved
}
 Placement modes which determine how label candidates are generated for a feature. More...
 
enum  PredefinedPointPosition {
  TopLeft, TopSlightlyLeft, TopMiddle, TopSlightlyRight,
  TopRight, MiddleLeft, MiddleRight, BottomLeft,
  BottomSlightlyLeft, BottomMiddle, BottomSlightlyRight, BottomRight
}
 Positions for labels when using the QgsPalLabeling::OrderedPositionsAroundPoint placement mode. More...
 
enum  Property {
  Size = 0, Bold = 1, Italic = 2, Underline = 3,
  Color = 4, Strikeout = 5, Family = 6, FontStyle = 21,
  FontSizeUnit = 22, FontTransp = 18, FontOpacity = 92, FontCase = 27,
  FontLetterSpacing = 28, FontWordSpacing = 29, FontBlendMode = 30, MultiLineWrapChar = 31,
  MultiLineHeight = 32, MultiLineAlignment = 33, DirSymbDraw = 34, DirSymbLeft = 35,
  DirSymbRight = 36, DirSymbPlacement = 37, DirSymbReverse = 38, NumFormat = 39,
  NumDecimals = 40, NumPlusSign = 41, BufferDraw = 42, BufferSize = 7,
  BufferUnit = 43, BufferColor = 8, BufferTransp = 19, BufferOpacity = 94,
  BufferJoinStyle = 44, BufferBlendMode = 45, ShapeDraw = 46, ShapeKind = 47,
  ShapeSVGFile = 48, ShapeSizeType = 49, ShapeSizeX = 50, ShapeSizeY = 85,
  ShapeSizeUnits = 51, ShapeRotationType = 52, ShapeRotation = 53, ShapeOffset = 54,
  ShapeOffsetUnits = 55, ShapeRadii = 56, ShapeRadiiUnits = 57, ShapeTransparency = 63,
  ShapeOpacity = 93, ShapeBlendMode = 64, ShapeFillColor = 58, ShapeStrokeColor = 59,
  ShapeStrokeWidth = 60, ShapeStrokeWidthUnits = 61, ShapeJoinStyle = 62, ShadowDraw = 65,
  ShadowUnder = 66, ShadowOffsetAngle = 67, ShadowOffsetDist = 68, ShadowOffsetUnits = 69,
  ShadowRadius = 70, ShadowRadiusUnits = 71, ShadowTransparency = 72, ShadowOpacity = 95,
  ShadowScale = 73, ShadowColor = 74, ShadowBlendMode = 75, CentroidWhole = 76,
  OffsetQuad = 77, OffsetXY = 78, OffsetUnits = 80, LabelDistance = 13,
  DistanceUnits = 81, OffsetRotation = 82, CurvedCharAngleInOut = 83, PositionX = 9,
  PositionY = 10, Hali = 11, Vali = 12, Rotation = 14,
  LabelRotation = 96, RepeatDistance = 84, RepeatDistanceUnit = 86, Priority = 87,
  PredefinedPositionOrder = 91, ScaleVisibility = 23, MinScale = 16, MinimumScale = 97,
  MaxScale = 17, MaximumScale = 98, FontLimitPixel = 24, FontMinPixel = 25,
  FontMaxPixel = 26, IsObstacle = 88, ObstacleFactor = 89, ZIndex = 90,
  Show = 15, AlwaysShow = 20
}
 Data definable properties. More...
 
enum  QuadrantPosition {
  QuadrantAboveLeft, QuadrantAbove, QuadrantAboveRight, QuadrantLeft,
  QuadrantOver, QuadrantRight, QuadrantBelowLeft, QuadrantBelow,
  QuadrantBelowRight
}
 
enum  SizeUnit { Points = 0, MM, MapUnits, Percent }
 Units used for option sizes, before being converted to rendered sizes. More...
 
enum  UpsideDownLabels { Upright, ShowDefined, ShowAll }
 

Public Member Functions

 QgsPalLayerSettings ()
 
 QgsPalLayerSettings (const QgsPalLayerSettings &s)
 
 ~QgsPalLayerSettings ()
 
void calculateLabelSize (const QFontMetricsF *fm, QString text, double &labelX, double &labelY, QgsFeature *f=nullptr, QgsRenderContext *context=nullptr)
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the label's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the label's property collection, used for data defined overrides. More...
 
const QgsTextFormatformat () const
 Returns the label text formatting settings, e.g., font settings, buffer settings, etc. More...
 
QgsExpression * getLabelExpression ()
 Returns the QgsExpression for this label settings. More...
 
QgsPalLayerSettingsoperator= (const QgsPalLayerSettings &s)
 copy operator - only copies the permanent members More...
 
void readXml (QDomElement &elem, const QgsReadWriteContext &context)
 Read settings from a DOM element. More...
 
void registerFeature (QgsFeature &f, QgsRenderContext &context, QgsLabelFeature **labelFeature=nullptr, QgsGeometry obstacleGeometry=QgsGeometry())
 Register a feature for labeling. More...
 
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the label's property collection, used for data defined overrides. More...
 
void setFormat (const QgsTextFormat &format)
 Sets the label text formatting settings, e.g., font settings, buffer settings, etc. More...
 
QDomElement writeXml (QDomDocument &doc, const QgsReadWriteContext &context)
 Write settings into a DOM element. More...
 

Static Public Member Functions

static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the labeling property definitions. More...
 

Public Attributes

bool addDirectionSymbol
 
double angleOffset
 Label rotation, in degrees clockwise. More...
 
bool centroidInside
 
bool centroidWhole
 
QgsCoordinateTransform ct
 
int decimals
 
bool displayAll
 
double dist
 
bool distInMapUnits
 
QgsMapUnitScale distMapUnitScale
 
bool drawLabels
 Whether to draw labels for this layer. More...
 
QgsGeometry extentGeom
 
int fieldIndex
 
QString fieldName
 
bool fitInPolygonOnly
 True if only labels which completely fit within a polygon are allowed. More...
 
bool fontLimitPixelSize
 
int fontMaxPixelSize
 
int fontMinPixelSize
 
bool formatNumbers
 
bool isExpression
 Is this label made from a expression string, e.g., FieldName || 'mm'. More...
 
bool labelOffsetInMapUnits
 
QgsMapUnitScale labelOffsetMapUnitScale
 
bool labelPerPart
 
QString leftDirectionSymbol
 
bool limitNumLabels
 
double maxCurvedCharAngleIn
 
double maxCurvedCharAngleOut
 
double maximumScale
 The maximum map scale (i.e. More...
 
int maxNumLabels
 
QgsFeaturemCurFeat = nullptr
 
QgsFields mCurFields
 
bool mergeLines
 
int mFeatsRegPal
 
int mFeatsSendingToPal
 
int mFeaturesToLabel
 
double minFeatureSize
 
double minimumScale
 The minimum map scale (i.e. More...
 
MultiLineAlign multilineAlign
 
bool obstacle
 
double obstacleFactor
 Obstacle factor, where 1.0 = default, < 1.0 more likely to be covered by labels,

1.0 less likely to be covered

More...
 
ObstacleType obstacleType
 Controls how features act as obstacles for labels. More...
 
OffsetType offsetType
 Offset type for layer (only applies in certain placement modes) More...
 
DirectionSymbols placeDirectionSymbol
 
Placement placement
 
unsigned int placementFlags
 
bool plusSign
 
QVector< PredefinedPointPositionpredefinedPositionOrder
 Ordered list of predefined label positions for points. More...
 
bool preserveRotation
 
QColor previewBkgrdColor
 
int priority
 
QgsPointXY ptOne
 
QgsPointXY ptZero
 
QuadrantPosition quadOffset
 
double repeatDistance
 
QgsMapUnitScale repeatDistanceMapUnitScale
 
SizeUnit repeatDistanceUnit
 
bool reverseDirectionSymbol
 
QString rightDirectionSymbol
 
bool scaleVisibility
 
QgsStringReplacementCollection substitutions
 Substitution collection for automatic text substitution with labels. More...
 
UpsideDownLabels upsidedownLabels
 
bool useSubstitutions
 True if substitutions should be applied. More...
 
QString wrapChar
 
const QgsMapToPixelxform = nullptr
 
double xOffset
 
double yOffset
 
double zIndex
 Z-Index of label, where labels with a higher z-index are rendered on top of labels with a lower z-index. More...
 

Friends

class QgsVectorLayer
 

Detailed Description

Definition at line 130 of file qgspallabeling.h.

Member Enumeration Documentation

◆ DirectionSymbols

Enumerator
SymbolLeftRight 

Place direction symbols on left/right of label.

SymbolAbove 

Place direction symbols on above label.

SymbolBelow 

Place direction symbols on below label.

Definition at line 220 of file qgspallabeling.h.

◆ LinePlacementFlags

Line placement flags, which control how candidates are generated for a linear feature.

Enumerator
OnLine 

Labels can be placed directly over a line feature.

AboveLine 

Labels can be placed above a line feature.

Unless MapOrientation is also specified this mode respects the direction of the line feature, so a line from right to left labels will have labels placed placed below the line feature.

BelowLine 

Labels can be placed below a line feature.

Unless MapOrientation is also specified this mode respects the direction of the line feature, so a line from right to left labels will have labels placed placed above the line feature.

MapOrientation 

Signifies that the AboveLine and BelowLine flags should respect the map's orientation rather than the feature's orientation.

For example, AboveLine will always result in label's being placed above a line, regardless of the line's direction.

Definition at line 186 of file qgspallabeling.h.

◆ MultiLineAlign

Enumerator
MultiLeft 
MultiCenter 
MultiRight 
MultiFollowPlacement 

Alignment follows placement of label, e.g., labels to the left of a feature will be drawn with right alignment

Definition at line 227 of file qgspallabeling.h.

◆ ObstacleType

Valid obstacle types, which affect how features within the layer will act as obstacles for labels.

Enumerator
PolygonInterior 

avoid placing labels over interior of polygon (prefer placing labels totally outside or just slightly inside polygon)

PolygonBoundary 

avoid placing labels over boundary of polygon (prefer placing outside or completely inside polygon)

PolygonWhole 

avoid placing labels over ANY part of polygon. Where PolygonInterior will prefer to place labels with the smallest area of intersection between the label and the polygon, PolygonWhole will penalise any label which intersects with the polygon by an equal amount, so that placing labels over any part of the polygon is avoided.

Definition at line 240 of file qgspallabeling.h.

◆ OffsetType

Behavior modifier for label offset and distance, only applies in some label placement modes.

Enumerator
FromPoint 

Offset distance applies from point geometry.

FromSymbolBounds 

Offset distance applies from rendered symbol bounds.

Definition at line 176 of file qgspallabeling.h.

◆ Placement

Placement modes which determine how label candidates are generated for a feature.

Enumerator
AroundPoint 

Arranges candidates in a circle around a point (or centroid of a polygon). Applies to point or polygon layers only.

OverPoint 
Line 

Arranges candidates over a point (or centroid of a polygon), or at a preset offset from the point. Applies to point or polygon layers only.

Arranges candidates parallel to a generalised line representing the feature or parallel to a polygon's perimeter. Applies to line or polygon layers only.

Curved 
Horizontal 

Arranges candidates following the curvature of a line feature. Applies to line layers only.

Arranges horizontal candidates scattered throughout a polygon feature. Applies to polygon layers only.

Free 

Arranges candidates scattered throughout a polygon feature. Candidates are rotated to respect the polygon's orientation. Applies to polygon layers only.

OrderedPositionsAroundPoint 

Candidates are placed in predefined positions around a point. Preference is given to positions with greatest cartographic appeal, e.g., top right, bottom right, etc. Applies to point layers only.

PerimeterCurved 

Definition at line 143 of file qgspallabeling.h.

◆ PredefinedPointPosition

Positions for labels when using the QgsPalLabeling::OrderedPositionsAroundPoint placement mode.

Enumerator
TopLeft 

Label on top-left of point.

TopSlightlyLeft 
TopMiddle 

Label on top of point, slightly left of center.

Label directly above point

TopSlightlyRight 
TopRight 

Label on top of point, slightly right of center.

Label on top-right of point

MiddleLeft 

Label on left of point.

MiddleRight 

Label on right of point.

BottomLeft 

Label on bottom-left of point.

BottomSlightlyLeft 
BottomMiddle 

Label below point, slightly left of center.

Label directly below point

BottomSlightlyRight 
BottomRight 

Label below point, slightly right of center.

Label on bottom right of point

Definition at line 157 of file qgspallabeling.h.

◆ Property

Data definable properties.

Enumerator
Size 

Label size.

Bold 

Use bold style.

Italic 

Use italic style.

Underline 

Use underline.

Color 

Text color.

Strikeout 

Use strikeout.

Family 

Font family.

FontStyle 

Font style name.

FontSizeUnit 

Font size units.

FontTransp 

Text transparency (deprecated)

FontOpacity 

Text opacity.

FontCase 

Label text case.

FontLetterSpacing 

Letter spacing.

FontWordSpacing 

Word spacing.

FontBlendMode 
MultiLineWrapChar 

Text blend mode.

MultiLineHeight 
MultiLineAlignment 
DirSymbDraw 
DirSymbLeft 
DirSymbRight 
DirSymbPlacement 
DirSymbReverse 
NumFormat 
NumDecimals 
NumPlusSign 
BufferDraw 
BufferSize 
BufferUnit 
BufferColor 
BufferTransp 

Buffer transparency (deprecated)

BufferOpacity 

Buffer opacity.

BufferJoinStyle 
BufferBlendMode 
ShapeDraw 
ShapeKind 
ShapeSVGFile 
ShapeSizeType 
ShapeSizeX 
ShapeSizeY 
ShapeSizeUnits 
ShapeRotationType 
ShapeRotation 
ShapeOffset 
ShapeOffsetUnits 
ShapeRadii 
ShapeRadiiUnits 
ShapeTransparency 

Shape transparency (deprecated)

ShapeOpacity 

Shape opacity.

ShapeBlendMode 
ShapeFillColor 
ShapeStrokeColor 
ShapeStrokeWidth 
ShapeStrokeWidthUnits 
ShapeJoinStyle 
ShadowDraw 
ShadowUnder 
ShadowOffsetAngle 
ShadowOffsetDist 
ShadowOffsetUnits 
ShadowRadius 
ShadowRadiusUnits 
ShadowTransparency 

Shadow transparency (deprecated)

ShadowOpacity 

Shadow opacity.

ShadowScale 
ShadowColor 
ShadowBlendMode 
CentroidWhole 
OffsetQuad 
OffsetXY 
OffsetUnits 
LabelDistance 
DistanceUnits 
OffsetRotation 
CurvedCharAngleInOut 
PositionX 

X-coordinate data defined label position.

PositionY 

Y-coordinate data defined label position.

Hali 

Horizontal alignment for data defined label position (Left, Center, Right)

Vali 

Vertical alignment for data defined label position (Bottom, Base, Half, Cap, Top)

Rotation 

Label rotation (deprecated, for old project compatibility only)

LabelRotation 

Label rotation.

RepeatDistance 
RepeatDistanceUnit 
Priority 
PredefinedPositionOrder 
ScaleVisibility 
MinScale 

Min scale (deprecated, for old project compatibility only)

MinimumScale 

Minimum map scale (ie most "zoomed out")

MaxScale 

Max scale (deprecated, for old project compatibility only)

MaximumScale 

Maximum map scale (ie most "zoomed in")

FontLimitPixel 
FontMinPixel 
FontMaxPixel 
IsObstacle 
ObstacleFactor 
ZIndex 
Show 
AlwaysShow 

Definition at line 263 of file qgspallabeling.h.

◆ QuadrantPosition

Enumerator
QuadrantAboveLeft 
QuadrantAbove 
QuadrantAboveRight 
QuadrantLeft 
QuadrantOver 
QuadrantRight 
QuadrantBelowLeft 
QuadrantBelow 
QuadrantBelowRight 

Definition at line 200 of file qgspallabeling.h.

◆ SizeUnit

Units used for option sizes, before being converted to rendered sizes.

Enumerator
Points 
MM 
MapUnits 
Percent 

Definition at line 254 of file qgspallabeling.h.

◆ UpsideDownLabels

Enumerator
Upright 

Upside-down labels (90 <= angle < 270) are shown upright.

ShowDefined 

Show upside down when rotation is layer- or data-defined.

ShowAll 

Show upside down for all labels, including dynamic ones.

Definition at line 213 of file qgspallabeling.h.

Constructor & Destructor Documentation

◆ QgsPalLayerSettings() [1/2]

QgsPalLayerSettings::QgsPalLayerSettings ( )

Definition at line 231 of file qgspallabeling.cpp.

◆ QgsPalLayerSettings() [2/2]

QgsPalLayerSettings::QgsPalLayerSettings ( const QgsPalLayerSettings s)

Definition at line 305 of file qgspallabeling.cpp.

◆ ~QgsPalLayerSettings()

QgsPalLayerSettings::~QgsPalLayerSettings ( )

Definition at line 399 of file qgspallabeling.cpp.

Member Function Documentation

◆ calculateLabelSize()

void QgsPalLayerSettings::calculateLabelSize ( const QFontMetricsF *  fm,
QString  text,
double &  labelX,
double &  labelY,
QgsFeature f = nullptr,
QgsRenderContext context = nullptr 
)

Definition at line 997 of file qgspallabeling.cpp.

◆ dataDefinedProperties() [1/2]

QgsPropertyCollection& QgsPalLayerSettings::dataDefinedProperties ( )
inline

Returns a reference to the label's property collection, used for data defined overrides.

Since
QGIS 3.0
See also
setDataDefinedProperties()

Definition at line 561 of file qgspallabeling.h.

◆ dataDefinedProperties() [2/2]

const QgsPropertyCollection& QgsPalLayerSettings::dataDefinedProperties ( ) const
inline

Returns a reference to the label's property collection, used for data defined overrides.

Since
QGIS 3.0
See also
setDataDefinedProperties()
Note
not available in Python bindings

Definition at line 568 of file qgspallabeling.h.

◆ format()

const QgsTextFormat& QgsPalLayerSettings::format ( ) const
inline

Returns the label text formatting settings, e.g., font settings, buffer settings, etc.

See also
setFormat()
Since
QGIS 3.0

Definition at line 581 of file qgspallabeling.h.

◆ getLabelExpression()

QgsExpression * QgsPalLayerSettings::getLabelExpression ( )

Returns the QgsExpression for this label settings.

Definition at line 413 of file qgspallabeling.cpp.

◆ operator=()

QgsPalLayerSettings & QgsPalLayerSettings::operator= ( const QgsPalLayerSettings s)

copy operator - only copies the permanent members

Definition at line 319 of file qgspallabeling.cpp.

◆ propertyDefinitions()

const QgsPropertiesDefinition & QgsPalLayerSettings::propertyDefinitions ( )
static

Returns the labeling property definitions.

Since
QGIS 3.0

Definition at line 407 of file qgspallabeling.cpp.

◆ readXml()

void QgsPalLayerSettings::readXml ( QDomElement &  elem,
const QgsReadWriteContext context 
)

Read settings from a DOM element.

Since
QGIS 2.12

Definition at line 732 of file qgspallabeling.cpp.

◆ registerFeature()

void QgsPalLayerSettings::registerFeature ( QgsFeature f,
QgsRenderContext context,
QgsLabelFeature **  labelFeature = nullptr,
QgsGeometry  obstacleGeometry = QgsGeometry() 
)

Register a feature for labeling.

Parameters
ffeature to label
contextrender context. The QgsExpressionContext contained within the render context must have already had the feature and fields sets prior to calling this method.
labelFeatureif using QgsLabelingEngine, this will receive the label feature. Not available in Python bindings.
obstacleGeometryoptional obstacle geometry, if a different geometry to the feature's geometry should be used as an obstacle for labels (e.g., if the feature has been rendered with an offset point symbol, the obstacle geometry should represent the bounds of the offset symbol). If not set, the feature's original geometry will be used as an obstacle for labels. Not available in Python bindings.

Definition at line 1136 of file qgspallabeling.cpp.

◆ setDataDefinedProperties()

void QgsPalLayerSettings::setDataDefinedProperties ( const QgsPropertyCollection collection)
inline

Sets the label's property collection, used for data defined overrides.

Parameters
collectionproperty collection. Existing properties will be replaced.
Since
QGIS 3.0
See also
dataDefinedProperties()

Definition at line 575 of file qgspallabeling.h.

◆ setFormat()

void QgsPalLayerSettings::setFormat ( const QgsTextFormat format)
inline

Sets the label text formatting settings, e.g., font settings, buffer settings, etc.

Parameters
formatlabel text format
See also
format()
Since
QGIS 3.0

Definition at line 588 of file qgspallabeling.h.

◆ writeXml()

QDomElement QgsPalLayerSettings::writeXml ( QDomDocument &  doc,
const QgsReadWriteContext context 
)

Write settings into a DOM element.

Since
QGIS 2.12

Definition at line 906 of file qgspallabeling.cpp.

Friends And Related Function Documentation

◆ QgsVectorLayer

friend class QgsVectorLayer
friend

Definition at line 606 of file qgspallabeling.h.

Member Data Documentation

◆ addDirectionSymbol

bool QgsPalLayerSettings::addDirectionSymbol

Definition at line 423 of file qgspallabeling.h.

◆ angleOffset

double QgsPalLayerSettings::angleOffset

Label rotation, in degrees clockwise.

Definition at line 471 of file qgspallabeling.h.

◆ centroidInside

bool QgsPalLayerSettings::centroidInside

Definition at line 439 of file qgspallabeling.h.

◆ centroidWhole

bool QgsPalLayerSettings::centroidWhole

Definition at line 438 of file qgspallabeling.h.

◆ ct

QgsCoordinateTransform QgsPalLayerSettings::ct

Definition at line 595 of file qgspallabeling.h.

◆ decimals

int QgsPalLayerSettings::decimals

Definition at line 430 of file qgspallabeling.h.

◆ displayAll

bool QgsPalLayerSettings::displayAll

Definition at line 504 of file qgspallabeling.h.

◆ dist

double QgsPalLayerSettings::dist

Definition at line 451 of file qgspallabeling.h.

◆ distInMapUnits

bool QgsPalLayerSettings::distInMapUnits

Definition at line 452 of file qgspallabeling.h.

◆ distMapUnitScale

QgsMapUnitScale QgsPalLayerSettings::distMapUnitScale

Definition at line 453 of file qgspallabeling.h.

◆ drawLabels

bool QgsPalLayerSettings::drawLabels

Whether to draw labels for this layer.

For some layers it may be desirable to register their features as obstacles for other labels without requiring labels to be drawn for the layer itself. In this case drawLabels can be set to false and obstacle set to true, which will result in the layer acting as an obstacle but having no labels of its own.

Since
QGIS 2.12

Definition at line 394 of file qgspallabeling.h.

◆ extentGeom

QgsGeometry QgsPalLayerSettings::extentGeom

Definition at line 599 of file qgspallabeling.h.

◆ fieldIndex

int QgsPalLayerSettings::fieldIndex

Definition at line 593 of file qgspallabeling.h.

◆ fieldName

QString QgsPalLayerSettings::fieldName

Definition at line 398 of file qgspallabeling.h.

◆ fitInPolygonOnly

bool QgsPalLayerSettings::fitInPolygonOnly

True if only labels which completely fit within a polygon are allowed.

Definition at line 450 of file qgspallabeling.h.

◆ fontLimitPixelSize

bool QgsPalLayerSettings::fontLimitPixelSize

Definition at line 500 of file qgspallabeling.h.

◆ fontMaxPixelSize

int QgsPalLayerSettings::fontMaxPixelSize

Definition at line 502 of file qgspallabeling.h.

◆ fontMinPixelSize

int QgsPalLayerSettings::fontMinPixelSize

Definition at line 501 of file qgspallabeling.h.

◆ formatNumbers

bool QgsPalLayerSettings::formatNumbers

Definition at line 429 of file qgspallabeling.h.

◆ isExpression

bool QgsPalLayerSettings::isExpression

Is this label made from a expression string, e.g., FieldName || 'mm'.

Definition at line 402 of file qgspallabeling.h.

◆ labelOffsetInMapUnits

bool QgsPalLayerSettings::labelOffsetInMapUnits

Definition at line 467 of file qgspallabeling.h.

◆ labelOffsetMapUnitScale

QgsMapUnitScale QgsPalLayerSettings::labelOffsetMapUnitScale

Definition at line 468 of file qgspallabeling.h.

◆ labelPerPart

bool QgsPalLayerSettings::labelPerPart

Definition at line 507 of file qgspallabeling.h.

◆ leftDirectionSymbol

QString QgsPalLayerSettings::leftDirectionSymbol

Definition at line 424 of file qgspallabeling.h.

◆ limitNumLabels

bool QgsPalLayerSettings::limitNumLabels

Definition at line 510 of file qgspallabeling.h.

◆ maxCurvedCharAngleIn

double QgsPalLayerSettings::maxCurvedCharAngleIn

Definition at line 475 of file qgspallabeling.h.

◆ maxCurvedCharAngleOut

double QgsPalLayerSettings::maxCurvedCharAngleOut

Definition at line 476 of file qgspallabeling.h.

◆ maximumScale

double QgsPalLayerSettings::maximumScale

The maximum map scale (i.e.

most "zoomed in" scale) at which the labels will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no maximum scale visibility.

See also
minimumScale

Definition at line 490 of file qgspallabeling.h.

◆ maxNumLabels

int QgsPalLayerSettings::maxNumLabels

Definition at line 511 of file qgspallabeling.h.

◆ mCurFeat

QgsFeature* QgsPalLayerSettings::mCurFeat = nullptr

Definition at line 591 of file qgspallabeling.h.

◆ mCurFields

QgsFields QgsPalLayerSettings::mCurFields

Definition at line 592 of file qgspallabeling.h.

◆ mergeLines

bool QgsPalLayerSettings::mergeLines

Definition at line 508 of file qgspallabeling.h.

◆ mFeatsRegPal

int QgsPalLayerSettings::mFeatsRegPal

Definition at line 602 of file qgspallabeling.h.

◆ mFeatsSendingToPal

int QgsPalLayerSettings::mFeatsSendingToPal

Definition at line 601 of file qgspallabeling.h.

◆ mFeaturesToLabel

int QgsPalLayerSettings::mFeaturesToLabel

Definition at line 600 of file qgspallabeling.h.

◆ minFeatureSize

double QgsPalLayerSettings::minFeatureSize

Definition at line 513 of file qgspallabeling.h.

◆ minimumScale

double QgsPalLayerSettings::minimumScale

The minimum map scale (i.e.

most "zoomed out" scale) at which the labels will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no minimum scale visibility.

See also
maximumScale

Definition at line 498 of file qgspallabeling.h.

◆ multilineAlign

MultiLineAlign QgsPalLayerSettings::multilineAlign

Definition at line 418 of file qgspallabeling.h.

◆ obstacle

bool QgsPalLayerSettings::obstacle

Definition at line 514 of file qgspallabeling.h.

◆ obstacleFactor

double QgsPalLayerSettings::obstacleFactor

Obstacle factor, where 1.0 = default, < 1.0 more likely to be covered by labels,

1.0 less likely to be covered

Definition at line 519 of file qgspallabeling.h.

◆ obstacleType

ObstacleType QgsPalLayerSettings::obstacleType

Controls how features act as obstacles for labels.

Definition at line 523 of file qgspallabeling.h.

◆ offsetType

OffsetType QgsPalLayerSettings::offsetType

Offset type for layer (only applies in certain placement modes)

Definition at line 455 of file qgspallabeling.h.

◆ placeDirectionSymbol

DirectionSymbols QgsPalLayerSettings::placeDirectionSymbol

Definition at line 426 of file qgspallabeling.h.

◆ placement

Placement QgsPalLayerSettings::placement

Definition at line 435 of file qgspallabeling.h.

◆ placementFlags

unsigned int QgsPalLayerSettings::placementFlags

Definition at line 436 of file qgspallabeling.h.

◆ plusSign

bool QgsPalLayerSettings::plusSign

Definition at line 431 of file qgspallabeling.h.

◆ predefinedPositionOrder

QVector< PredefinedPointPosition > QgsPalLayerSettings::predefinedPositionOrder

Ordered list of predefined label positions for points.

Positions earlier in the list will be prioritized over later positions. Only used when the placement is set to QgsPalLayerSettings::OrderedPositionsAroundPoint.

Note
not available in Python bindings

Definition at line 446 of file qgspallabeling.h.

◆ preserveRotation

bool QgsPalLayerSettings::preserveRotation

Definition at line 473 of file qgspallabeling.h.

◆ previewBkgrdColor

QColor QgsPalLayerSettings::previewBkgrdColor

Definition at line 408 of file qgspallabeling.h.

◆ priority

int QgsPalLayerSettings::priority

Definition at line 478 of file qgspallabeling.h.

◆ ptOne

QgsPointXY QgsPalLayerSettings::ptOne

Definition at line 598 of file qgspallabeling.h.

◆ ptZero

QgsPointXY QgsPalLayerSettings::ptZero

Definition at line 597 of file qgspallabeling.h.

◆ quadOffset

QuadrantPosition QgsPalLayerSettings::quadOffset

Definition at line 463 of file qgspallabeling.h.

◆ repeatDistance

double QgsPalLayerSettings::repeatDistance

Definition at line 457 of file qgspallabeling.h.

◆ repeatDistanceMapUnitScale

QgsMapUnitScale QgsPalLayerSettings::repeatDistanceMapUnitScale

Definition at line 459 of file qgspallabeling.h.

◆ repeatDistanceUnit

SizeUnit QgsPalLayerSettings::repeatDistanceUnit

Definition at line 458 of file qgspallabeling.h.

◆ reverseDirectionSymbol

bool QgsPalLayerSettings::reverseDirectionSymbol

Definition at line 427 of file qgspallabeling.h.

◆ rightDirectionSymbol

QString QgsPalLayerSettings::rightDirectionSymbol

Definition at line 425 of file qgspallabeling.h.

◆ scaleVisibility

bool QgsPalLayerSettings::scaleVisibility

Definition at line 482 of file qgspallabeling.h.

◆ substitutions

QgsStringReplacementCollection QgsPalLayerSettings::substitutions

Substitution collection for automatic text substitution with labels.

Definition at line 411 of file qgspallabeling.h.

◆ upsidedownLabels

UpsideDownLabels QgsPalLayerSettings::upsidedownLabels

Definition at line 505 of file qgspallabeling.h.

◆ useSubstitutions

bool QgsPalLayerSettings::useSubstitutions

True if substitutions should be applied.

Definition at line 413 of file qgspallabeling.h.

◆ wrapChar

QString QgsPalLayerSettings::wrapChar

Definition at line 417 of file qgspallabeling.h.

◆ xform

const QgsMapToPixel* QgsPalLayerSettings::xform = nullptr

Definition at line 594 of file qgspallabeling.h.

◆ xOffset

double QgsPalLayerSettings::xOffset

Definition at line 465 of file qgspallabeling.h.

◆ yOffset

double QgsPalLayerSettings::yOffset

Definition at line 466 of file qgspallabeling.h.

◆ zIndex

double QgsPalLayerSettings::zIndex

Z-Index of label, where labels with a higher z-index are rendered on top of labels with a lower z-index.

Definition at line 526 of file qgspallabeling.h.


The documentation for this class was generated from the following files: