The QgsLabelFeature class describes a feature that should be used within the labeling engine. More...

#include <qgslabelfeature.h>

Inheritance diagram for QgsLabelFeature:

Public Member Functions
	QgsLabelFeature (QgsFeatureId id, geos::unique_ptr geometry, QSizeF size)
	Create label feature, takes ownership of the geometry instance. More...

virtual	~QgsLabelFeature ()
	Clean up geometry and curved label info (if present) More...

bool	alwaysShow () const
	Whether label should be always shown (sets very high label priority) More...

pal::LineArrangementFlags	arrangementFlags () const
	Returns the feature's arrangement flags. More...

pal::LabelInfo *	curvedLabelInfo () const
	Gets additional infor required for curved label placement. Returns `nullptr` if not set. More...

double	distLabel () const
	Applies to "around point" placement strategy or linestring features. More...

QgsFeature	feature () const
	Returns the original feature associated with this label. More...

double	fixedAngle () const
	Angle in degrees of the fixed angle (relevant only if hasFixedAngle() returns `true`) More...

QgsPointXY	fixedPosition () const
	Coordinates of the fixed position (relevant only if hasFixedPosition() returns `true`) More...

GEOSGeometry *	geometry () const
	Gets access to the associated geometry. More...

bool	hasFixedAngle () const
	Whether the label should use a fixed angle instead of using angle from automatic placement. More...

bool	hasFixedPosition () const
	Whether the label should use a fixed position instead of being automatically placed. More...

bool	hasFixedQuadrant () const
	Returns whether the quadrant for the label is fixed. More...

QgsFeatureId	id () const
	Identifier of the label (unique within the parent label provider) More...

bool	isObstacle () const
	Returns whether the feature will act as an obstacle for labels. More...

bool	labelAllParts () const
	Returns `true` if all parts of the feature should be labeled. More...

QString	labelText () const
	Text of the label. More...

pal::Layer *	layer () const
	Gets PAL layer of the label feature. Should be only used internally in PAL. More...

double	obstacleFactor () const
	Returns the obstacle factor for the feature. More...

GEOSGeometry *	obstacleGeometry () const
	Returns the label's obstacle geometry, if different to the feature geometry. More...

QgsPalLayerSettings::OffsetType	offsetType () const
	Returns the offset type, which determines how offsets and distance to label behaves. More...

double	overrunDistance () const
	Returns the permissible distance (in map units) which labels are allowed to overrun the start or end of linear features. More...

double	overrunSmoothDistance () const
	Returns the distance (in map units) with which the ends of linear features are averaged over when calculating the direction at which to overrun labels. More...

QgsGeometry	permissibleZone () const
	Returns the label's permissible zone geometry. More...

const GEOSPreparedGeometry *	permissibleZonePrepared () const
	Returns a GEOS prepared geometry representing the label's permissibleZone(). More...

QgsPointXY	positionOffset () const
	Applies only to "offset from point" placement strategy. More...

QVector< QgsPalLayerSettings::PredefinedPointPosition >	predefinedPositionOrder () const
	Returns the priority ordered list of predefined positions for label candidates. More...

double	priority () const
	Returns the feature's labeling priority. More...

QgsAbstractLabelProvider *	provider () const
	Returns provider of this instance. More...

QPointF	quadOffset () const
	Applies to "offset from point" placement strategy and "around point" (in case hasFixedQuadrant() returns `true`). More...

double	repeatDistance () const
	Applies only to linestring features - after what distance (in map units) the labels should be repeated (0 = no repetitions) More...

void	setAlwaysShow (bool enabled)
	Sets whether label should be always shown (sets very high label priority) More...

void	setArrangementFlags (pal::LineArrangementFlags flags)
	Sets the feature's arrangement flags. More...

void	setCurvedLabelInfo (pal::LabelInfo *info)
	takes ownership of the instance More...

void	setDistLabel (double dist)
	Applies to "around point" placement strategy or linestring features. More...

void	setFeature (const QgsFeature &feature)
	Sets the original feature associated with this label. More...

void	setFixedAngle (double angle)
	Sets angle in degrees of the fixed angle (relevant only if hasFixedAngle() returns `true`) More...

void	setFixedPosition (const QgsPointXY &point)
	Sets coordinates of the fixed position (relevant only if hasFixedPosition() returns `true`) More...

void	setHasFixedAngle (bool enabled)
	Sets whether the label should use a fixed angle instead of using angle from automatic placement. More...

void	setHasFixedPosition (bool enabled)
	Sets whether the label should use a fixed position instead of being automatically placed. More...

void	setHasFixedQuadrant (bool enabled)
	Sets whether the quadrant for the label must be respected. More...

void	setIsObstacle (bool enabled)
	Sets whether the feature will act as an obstacle for labels. More...

void	setLabelAllParts (bool labelAllParts)
	Sets whether all parts of the feature should be labeled. More...

void	setLabelText (const QString &text)
	Sets text of the label. More...

void	setLayer (pal::Layer *layer)
	Assign PAL layer to the label feature. Should be only used internally in PAL. More...

void	setObstacleFactor (double factor)
	Sets the obstacle factor for the feature. More...

void	setObstacleGeometry (geos::unique_ptr obstacleGeom)
	Sets the label's obstacle geometry, if different to the feature geometry. More...

void	setOffsetType (QgsPalLayerSettings::OffsetType type)
	Sets the offset type, which determines how offsets and distance to label behaves. More...

void	setOverrunDistance (double distance)
	Sets the permissible distance (in map units) which labels are allowed to overrun the start or end of linear features. More...

void	setOverrunSmoothDistance (double distance)
	Sets the distance (in map units) with which the ends of linear features are averaged over when calculating the direction at which to overrun labels. More...

void	setPermissibleZone (const QgsGeometry &geometry)
	Sets the label's permissible zone geometry. More...

void	setPositionOffset (const QgsPointXY &offset)
	Applies only to "offset from point" placement strategy. More...

void	setPredefinedPositionOrder (const QVector< QgsPalLayerSettings::PredefinedPointPosition > &order)
	Sets the priority ordered list of predefined positions for label candidates. More...

void	setPriority (double priority)
	Sets the priority for labeling the feature. More...

void	setQuadOffset (QPointF quadOffset)
	Set which side of the point to use. More...

void	setRepeatDistance (double dist)
	Applies only to linestring features - set after what distance (in map units) the labels should be repeated (0 = no repetitions) More...

void	setRotatedSize (QSizeF size)
	Sets an alternate label size to be used when a label rotation angle is between 45 to 135 and 235 to 313 degrees and the text rotation mode is set to rotation-based. More...

void	setSymbol (const QgsSymbol *symbol)
	Sets the feature symbol associated with this label. More...

void	setSymbolSize (QSizeF size)
	Sets the size of the rendered symbol associated with this feature. More...

void	setVisualMargin (const QgsMargins &margin)
	Sets the visual margin for the label feature. More...

void	setZIndex (double zIndex)
	Sets the label's z-index. More...

QSizeF	size (double angle=0.0) const
	Size of the label (in map units) More...

const QgsSymbol *	symbol ()
	Returns the feature symbol associated with this label. More...

const QSizeF &	symbolSize () const
	Returns the size of the rendered symbol associated with this feature, if applicable. More...

const QgsMargins &	visualMargin () const
	Returns the visual margin for the label feature. More...

double	zIndex () const
	Returns the label's z-index. More...

Protected Attributes
bool	mAlwaysShow
	whether to always show label - even in case of collisions More...

pal::LineArrangementFlags	mArrangementFlags = nullptr

double	mDistLabel
	distance of label from the feature (only for "around point" placement or linestrings) More...

double	mFixedAngle
	fixed rotation for the label (instead of automatic choice) More...

QgsPointXY	mFixedPosition
	fixed position for the label (instead of automatic placement) More...

geos::unique_ptr	mGeometry
	Geometry of the feature to be labelled. More...

bool	mHasFixedAngle
	whether mFixedAngle should be respected More...

bool	mHasFixedPosition
	whether mFixedPosition should be respected More...

bool	mHasFixedQuadrant
	whether mQuadOffset should be respected (only for "around point" placement) More...

QgsFeatureId	mId
	Associated ID unique within the parent label provider. More...

pal::LabelInfo *	mInfo = nullptr
	extra information for curved labels (may be `nullptr`) More...

bool	mIsObstacle
	whether the feature geometry acts as an obstacle for labels More...

QString	mLabelText
	text of the label More...

pal::Layer *	mLayer = nullptr
	Pointer to PAL layer (assigned when registered to PAL) More...

double	mObstacleFactor
	how strong is the geometry acting as obstacle More...

geos::unique_ptr	mObstacleGeometry
	Optional geometry to use for label obstacles, if different to mGeometry. More...

QgsPalLayerSettings::OffsetType	mOffsetType
	Offset type for certain placement modes. More...

double	mOverrunDistance = 0
	Distance to allow label to overrun linear features. More...

double	mOverrunSmoothDistance = 0
	Distance to smooth angle of line start and end when calculating overruns. More...

QgsGeometry	mPermissibleZone
	Optional geometry to use for label's permissible zone. More...

QgsPointXY	mPositionOffset
	offset of label from the feature (only for "offset from point" placement) More...

QVector< QgsPalLayerSettings::PredefinedPointPosition >	mPredefinedPositionOrder
	Ordered list of predefined positions for label (only for OrderedPositionsAroundPoint placement) More...

double	mPriority
	Priority of the label. More...

QPointF	mQuadOffset
	whether the side of the label is fixed (only for "around point" placement) More...

double	mRepeatDistance
	distance after which label should be repeated (only for linestrings) More...

QSizeF	mRotatedSize
	Width and height of the label when rotated between 45 to 135 and 235 to 315 degrees;. More...

QSizeF	mSize
	Width and height of the label. More...

QSizeF	mSymbolSize
	Size of associated rendered symbol, if applicable. More...

QgsMargins	mVisualMargin
	Visual margin of label contents. More...

double	mZIndex
	Z-index of label (higher z-index labels are rendered on top of lower z-index labels) More...

Detailed Description

The QgsLabelFeature class describes a feature that should be used within the labeling engine.

Those may be the usual textual labels, diagrams, or any other custom type of map annotations (generated by custom label providers).

Instances only contain data relevant to the labeling engine (geometry, label size etc.) necessary for the layout. Rendering of labels is done by label providers.

Individual label providers may create subclasses of QgsLabelFeature in order to add more data to the instances that will be later used for drawing of labels.

Note: this class is not a part of public API yet. See notes in QgsLabelingEngine; not available in Python bindings

Since: QGIS 2.12

Definition at line 54 of file qgslabelfeature.h.

Constructor & Destructor Documentation

◆ QgsLabelFeature()

QgsLabelFeature::QgsLabelFeature	(	QgsFeatureId	id,
		geos::unique_ptr	geometry,
		QSizeF	size
	)

Create label feature, takes ownership of the geometry instance.

Definition at line 20 of file qgslabelfeature.cpp.

◆ ~QgsLabelFeature()

QgsLabelFeature::~QgsLabelFeature ( )

virtual

Clean up geometry and curved label info (if present)

Definition at line 39 of file qgslabelfeature.cpp.

Member Function Documentation

◆ alwaysShow()

bool QgsLabelFeature::alwaysShow ( ) const

inline

Whether label should be always shown (sets very high label priority)

Definition at line 303 of file qgslabelfeature.h.

◆ arrangementFlags()

pal::LineArrangementFlags QgsLabelFeature::arrangementFlags ( ) const

inline

Returns the feature's arrangement flags.

See also: setArrangementFlags

Definition at line 342 of file qgslabelfeature.h.

◆ curvedLabelInfo()

pal::LabelInfo* QgsLabelFeature::curvedLabelInfo ( ) const

inline

Gets additional infor required for curved label placement. Returns nullptr if not set.

Definition at line 363 of file qgslabelfeature.h.

◆ distLabel()

double QgsLabelFeature::distLabel ( ) const

inline

Applies to "around point" placement strategy or linestring features.

Distance of the label from the feature (in map units)

Definition at line 268 of file qgslabelfeature.h.

◆ feature()

QgsFeature QgsLabelFeature::feature ( ) const

Returns the original feature associated with this label.

See also: setFeature()

Since: QGIS 3.10

Definition at line 76 of file qgslabelfeature.cpp.

◆ fixedAngle()

double QgsLabelFeature::fixedAngle ( ) const

inline

Angle in degrees of the fixed angle (relevant only if hasFixedAngle() returns true)

Definition at line 202 of file qgslabelfeature.h.

◆ fixedPosition()

QgsPointXY QgsLabelFeature::fixedPosition ( ) const

inline

Coordinates of the fixed position (relevant only if hasFixedPosition() returns true)

Definition at line 193 of file qgslabelfeature.h.

◆ geometry()

GEOSGeometry* QgsLabelFeature::geometry ( ) const

inline

Gets access to the associated geometry.

Definition at line 67 of file qgslabelfeature.h.

◆ hasFixedAngle()

bool QgsLabelFeature::hasFixedAngle ( ) const

inline

Whether the label should use a fixed angle instead of using angle from automatic placement.

Definition at line 198 of file qgslabelfeature.h.

◆ hasFixedPosition()

bool QgsLabelFeature::hasFixedPosition ( ) const

inline

Whether the label should use a fixed position instead of being automatically placed.

Definition at line 189 of file qgslabelfeature.h.

◆ hasFixedQuadrant()

bool QgsLabelFeature::hasFixedQuadrant ( ) const

inline

Returns whether the quadrant for the label is fixed.

Applies to "around point" placement strategy.

See also: setHasFixedQuadrant; quadOffset

Definition at line 212 of file qgslabelfeature.h.

◆ id()

QgsFeatureId QgsLabelFeature::id ( ) const

inline

Identifier of the label (unique within the parent label provider)

Definition at line 64 of file qgslabelfeature.h.

◆ isObstacle()

bool QgsLabelFeature::isObstacle ( ) const

inline

Returns whether the feature will act as an obstacle for labels.

Returns: true if feature is an obstacle

See also: setIsObstacle

Definition at line 312 of file qgslabelfeature.h.

◆ labelAllParts()

bool QgsLabelFeature::labelAllParts ( ) const

inline

Returns true if all parts of the feature should be labeled.

See also: setLabelAllParts()

Since: QGIS 3.10

Definition at line 453 of file qgslabelfeature.h.

◆ labelText()

QString QgsLabelFeature::labelText ( ) const

inline

Text of the label.

Used also if "merge connected lines to avoid duplicate labels" is enabled to identify which features may be merged.

Definition at line 358 of file qgslabelfeature.h.

◆ layer()

pal::Layer* QgsLabelFeature::layer ( ) const

inline

Gets PAL layer of the label feature. Should be only used internally in PAL.

Definition at line 368 of file qgslabelfeature.h.

◆ obstacleFactor()

double QgsLabelFeature::obstacleFactor ( ) const

inline

Returns the obstacle factor for the feature.

The factor controls the penalty for labels overlapping this feature.

See also: setObstacleFactor

Definition at line 326 of file qgslabelfeature.h.

◆ obstacleGeometry()

GEOSGeometry* QgsLabelFeature::obstacleGeometry ( ) const

inline

Returns the label's obstacle geometry, if different to the feature geometry.

See also: setObstacleGeometry()

Since: QGIS 2.14

Definition at line 85 of file qgslabelfeature.h.

◆ offsetType()

QgsPalLayerSettings::OffsetType QgsLabelFeature::offsetType ( ) const

inline

Returns the offset type, which determines how offsets and distance to label behaves.

Support depends on which placement mode is used for generating label candidates.

See also: setOffsetType()

Definition at line 254 of file qgslabelfeature.h.

◆ overrunDistance()

double QgsLabelFeature::overrunDistance ( ) const

Returns the permissible distance (in map units) which labels are allowed to overrun the start or end of linear features.

See also: setOverrunDistance(); overrunSmoothDistance()

Since: QGIS 3.10

Definition at line 95 of file qgslabelfeature.cpp.

◆ overrunSmoothDistance()

double QgsLabelFeature::overrunSmoothDistance ( ) const

Returns the distance (in map units) with which the ends of linear features are averaged over when calculating the direction at which to overrun labels.

See also: setOverrunSmoothDistance(); overrunDistance()

Since: QGIS 3.10

Definition at line 105 of file qgslabelfeature.cpp.

◆ permissibleZone()

QgsGeometry QgsLabelFeature::permissibleZone ( ) const

inline

Returns the label's permissible zone geometry.

If a valid geometry is returned, the feature's label MUST be fully contained within this zone, and the feature will not be labeled if no candidates can be generated which are not contained within the zone.

See also: setPermissibleZone(); permissibleZonePrepared()

Since: QGIS 3.0

Definition at line 106 of file qgslabelfeature.h.

◆ permissibleZonePrepared()

const GEOSPreparedGeometry* QgsLabelFeature::permissibleZonePrepared ( ) const

inline

Returns a GEOS prepared geometry representing the label's permissibleZone().

See also: permissibleZone()

Since: QGIS 3.0

Definition at line 114 of file qgslabelfeature.h.

◆ positionOffset()

QgsPointXY QgsLabelFeature::positionOffset ( ) const

inline

Applies only to "offset from point" placement strategy.

What offset (in map units) to use from the point

Definition at line 240 of file qgslabelfeature.h.

◆ predefinedPositionOrder()

QVector< QgsPalLayerSettings::PredefinedPointPosition > QgsLabelFeature::predefinedPositionOrder ( ) const

inline

Returns the priority ordered list of predefined positions for label candidates.

This property is only used for OrderedPositionsAroundPoint placements.

See also: setPredefinedPositionOrder()

Definition at line 281 of file qgslabelfeature.h.

◆ priority()

double QgsLabelFeature::priority ( ) const

inline

Returns the feature's labeling priority.

Returns: feature's priority, as a value between 0 (highest priority) and 1 (lowest priority). Returns -1.0 if feature will use the layer's default priority.

See also: setPriority

Definition at line 160 of file qgslabelfeature.h.

◆ provider()

QgsAbstractLabelProvider * QgsLabelFeature::provider ( ) const

Returns provider of this instance.

Definition at line 610 of file qgslabelingengine.cpp.

◆ quadOffset()

QPointF QgsLabelFeature::quadOffset ( ) const

inline

Applies to "offset from point" placement strategy and "around point" (in case hasFixedQuadrant() returns true).

Determines which side of the point to use. For X coordinate, values -1, 0, 1 mean left, center, right. For Y coordinate, values -1, 0, 1 mean above, center, below.

Definition at line 228 of file qgslabelfeature.h.

◆ repeatDistance()

double QgsLabelFeature::repeatDistance ( ) const

inline

Applies only to linestring features - after what distance (in map units) the labels should be repeated (0 = no repetitions)

Definition at line 294 of file qgslabelfeature.h.

◆ setAlwaysShow()

void QgsLabelFeature::setAlwaysShow ( bool enabled )

inline

Sets whether label should be always shown (sets very high label priority)

Definition at line 305 of file qgslabelfeature.h.

◆ setArrangementFlags()

void QgsLabelFeature::setArrangementFlags ( pal::LineArrangementFlags flags )

inline

Sets the feature's arrangement flags.

Parameters

flags arrangement flags

See also: arrangementFlags

Definition at line 349 of file qgslabelfeature.h.

◆ setCurvedLabelInfo()

void QgsLabelFeature::setCurvedLabelInfo ( pal::LabelInfo * info )

inline

takes ownership of the instance

Definition at line 365 of file qgslabelfeature.h.

◆ setDistLabel()

void QgsLabelFeature::setDistLabel ( double dist )

inline

Applies to "around point" placement strategy or linestring features.

Set distance of the label from the feature (in map units)

Definition at line 274 of file qgslabelfeature.h.

◆ setFeature()

void QgsLabelFeature::setFeature ( const QgsFeature & feature )

Sets the original feature associated with this label.

See also: feature()

Since: QGIS 3.10

Definition at line 90 of file qgslabelfeature.cpp.

◆ setFixedAngle()

void QgsLabelFeature::setFixedAngle ( double angle )

inline

Sets angle in degrees of the fixed angle (relevant only if hasFixedAngle() returns true)

Definition at line 204 of file qgslabelfeature.h.

◆ setFixedPosition()

void QgsLabelFeature::setFixedPosition ( const QgsPointXY & point )

inline

Sets coordinates of the fixed position (relevant only if hasFixedPosition() returns true)

Definition at line 195 of file qgslabelfeature.h.

◆ setHasFixedAngle()

void QgsLabelFeature::setHasFixedAngle ( bool enabled )

inline

Sets whether the label should use a fixed angle instead of using angle from automatic placement.

Definition at line 200 of file qgslabelfeature.h.

◆ setHasFixedPosition()

void QgsLabelFeature::setHasFixedPosition ( bool enabled )

inline

Sets whether the label should use a fixed position instead of being automatically placed.

Definition at line 191 of file qgslabelfeature.h.

◆ setHasFixedQuadrant()

void QgsLabelFeature::setHasFixedQuadrant ( bool enabled )

inline

Sets whether the quadrant for the label must be respected.

This can be used to fix the quadrant for specific features when using an "around point" placement.

See also: hasFixedQuadrant; quadOffset

Definition at line 220 of file qgslabelfeature.h.

◆ setIsObstacle()

void QgsLabelFeature::setIsObstacle ( bool enabled )

inline

Sets whether the feature will act as an obstacle for labels.

Parameters

enabled whether feature will act as an obstacle

See also: isObstacle

Definition at line 319 of file qgslabelfeature.h.

◆ setLabelAllParts()

void QgsLabelFeature::setLabelAllParts ( bool labelAllParts )

inline

Sets whether all parts of the feature should be labeled.

See also: labelAllParts()

Since: QGIS 3.10

Definition at line 460 of file qgslabelfeature.h.

◆ setLabelText()

void QgsLabelFeature::setLabelText ( const QString & text )

inline

Sets text of the label.

Definition at line 360 of file qgslabelfeature.h.

◆ setLayer()

void QgsLabelFeature::setLayer ( pal::Layer * layer )

inline

Assign PAL layer to the label feature. Should be only used internally in PAL.

Definition at line 370 of file qgslabelfeature.h.

◆ setObstacleFactor()

void QgsLabelFeature::setObstacleFactor ( double factor )

inline

Sets the obstacle factor for the feature.

The factor controls the penalty for labels overlapping this feature.

Parameters

factor larger factors ( > 1.0 ) will result in labels which are less likely to cover this feature, smaller factors ( < 1.0 ) mean labels are more likely to cover this feature (where required)

See also: obstacleFactor

Definition at line 336 of file qgslabelfeature.h.

◆ setObstacleGeometry()

void QgsLabelFeature::setObstacleGeometry ( geos::unique_ptr obstacleGeom )

Sets the label's obstacle geometry, if different to the feature geometry.

This can be used to override the shape of the feature for obstacle detection, e.g., to buffer around a point geometry to prevent labels being placed too close to the point itself. It not set, the feature's geometry is used for obstacle detection. Ownership of obstacle geometry is transferred.

See also: obstacleGeometry()

Since: QGIS 2.14

Definition at line 50 of file qgslabelfeature.cpp.

◆ setOffsetType()

void QgsLabelFeature::setOffsetType ( QgsPalLayerSettings::OffsetType type )

inline

Sets the offset type, which determines how offsets and distance to label behaves.

Support depends on which placement mode is used for generating label candidates.

See also: offsetType()

Definition at line 262 of file qgslabelfeature.h.

◆ setOverrunDistance()

void QgsLabelFeature::setOverrunDistance ( double distance )

Sets the permissible distance (in map units) which labels are allowed to overrun the start or end of linear features.

See also: overrunDistance(); setOverrunSmoothDistance()

Since: QGIS 3.10

Definition at line 100 of file qgslabelfeature.cpp.

◆ setOverrunSmoothDistance()

void QgsLabelFeature::setOverrunSmoothDistance ( double distance )

Sets the distance (in map units) with which the ends of linear features are averaged over when calculating the direction at which to overrun labels.

See also: overrunSmoothDistance(); setOverrunDistance()

Since: QGIS 3.10

Definition at line 110 of file qgslabelfeature.cpp.

◆ setPermissibleZone()

void QgsLabelFeature::setPermissibleZone ( const QgsGeometry & geometry )

Sets the label's permissible zone geometry.

If set, the feature's label MUST be fully contained within this zone, and the feature will not be labeled if no candidates can be generated which are not contained within the zone.

Parameters

geometry permissible zone geometry. If an invalid QgsGeometry is passed then no zone limit will be applied to the label candidates (this is the default behavior).

See also: permissibleZone()

Since: QGIS 3.0

Definition at line 55 of file qgslabelfeature.cpp.

◆ setPositionOffset()

void QgsLabelFeature::setPositionOffset ( const QgsPointXY & offset )

inline

Applies only to "offset from point" placement strategy.

Set what offset (in map units) to use from the point

Definition at line 246 of file qgslabelfeature.h.

◆ setPredefinedPositionOrder()

void QgsLabelFeature::setPredefinedPositionOrder ( const QVector< QgsPalLayerSettings::PredefinedPointPosition > & order )

inline

Sets the priority ordered list of predefined positions for label candidates.

This property is only used for OrderedPositionsAroundPoint placements.

See also: predefinedPositionOrder()

Definition at line 288 of file qgslabelfeature.h.

◆ setPriority()

void QgsLabelFeature::setPriority ( double priority )

inline

Sets the priority for labeling the feature.

Parameters

priority feature's priority, as a value between 0 (highest priority) and 1 (lowest priority). Set to -1.0 to use the layer's default priority for this feature.

See also: priority

Definition at line 169 of file qgslabelfeature.h.

◆ setQuadOffset()

void QgsLabelFeature::setQuadOffset ( QPointF quadOffset )

inline

Set which side of the point to use.

See also: quadOffset

Definition at line 234 of file qgslabelfeature.h.

◆ setRepeatDistance()

void QgsLabelFeature::setRepeatDistance ( double dist )

inline

Applies only to linestring features - set after what distance (in map units) the labels should be repeated (0 = no repetitions)

Definition at line 300 of file qgslabelfeature.h.

◆ setRotatedSize()

void QgsLabelFeature::setRotatedSize ( QSizeF size )

inline

Sets an alternate label size to be used when a label rotation angle is between 45 to 135 and 235 to 313 degrees and the text rotation mode is set to rotation-based.

Since: QGIS 3.10

Definition at line 467 of file qgslabelfeature.h.

◆ setSymbol()

void QgsLabelFeature::setSymbol ( const QgsSymbol * symbol )

inline

Sets the feature symbol associated with this label.

Ownership of symbol is not transferred to the label feature, .

See also: symbol()

Since: QGIS 3.10

Definition at line 406 of file qgslabelfeature.h.

◆ setSymbolSize()

void QgsLabelFeature::setSymbolSize ( QSizeF size )

inline

Sets the size of the rendered symbol associated with this feature.

This size is taken into account in certain label placement modes to avoid placing labels over the rendered symbol for this feature.

See also: symbolSize()

Definition at line 143 of file qgslabelfeature.h.

◆ setVisualMargin()

void QgsLabelFeature::setVisualMargin ( const QgsMargins & margin )

inline

Sets the visual margin for the label feature.

The visual margin represents a margin within the label which should not be considered when calculating the positions of candidates for the label feature. It is used in certain label placement modes to adjust the position of candidates so that they all appear to be at visually equal distances from a point feature. For instance, this can be used to place labels which sit above a point so that their baseline rather then the descender of the label is at a preset distance from the point.

Parameters

margin visual margins for label

See also: visualMargin()

Definition at line 129 of file qgslabelfeature.h.

◆ setZIndex()

void QgsLabelFeature::setZIndex ( double zIndex )

inline

Sets the label's z-index.

Higher z-index labels are rendered on top of lower z-index labels.

Parameters

zIndex z-index for label

See also: zIndex()

Since: QGIS 2.14

Definition at line 186 of file qgslabelfeature.h.

◆ size()

QSizeF QgsLabelFeature::size ( double angle = 0.0 ) const

Size of the label (in map units)

Definition at line 81 of file qgslabelfeature.cpp.

◆ symbol()

const QgsSymbol* QgsLabelFeature::symbol ( )

inline

Returns the feature symbol associated with this label.

See also: setSymbol()

Since: QGIS 3.10

Definition at line 397 of file qgslabelfeature.h.

◆ symbolSize()

const QSizeF& QgsLabelFeature::symbolSize ( ) const

inline

Returns the size of the rendered symbol associated with this feature, if applicable.

This size is taken into account in certain label placement modes to avoid placing labels over the rendered symbol for this feature. The size will only be set for labels associated with a point feature.

See also: symbolSize()

Definition at line 152 of file qgslabelfeature.h.

◆ visualMargin()

const QgsMargins& QgsLabelFeature::visualMargin ( ) const

inline

Returns the visual margin for the label feature.

See also: setVisualMargin() for details

Definition at line 135 of file qgslabelfeature.h.

◆ zIndex()

double QgsLabelFeature::zIndex ( ) const

inline

Returns the label's z-index.

Higher z-index labels are rendered on top of lower z-index labels.

See also: setZIndex()

Since: QGIS 2.14

Definition at line 177 of file qgslabelfeature.h.

Member Data Documentation

◆ mAlwaysShow

bool QgsLabelFeature::mAlwaysShow

protected

whether to always show label - even in case of collisions

Definition at line 516 of file qgslabelfeature.h.

◆ mArrangementFlags

pal::LineArrangementFlags QgsLabelFeature::mArrangementFlags = nullptr

protected

Definition at line 531 of file qgslabelfeature.h.

◆ mDistLabel

double QgsLabelFeature::mDistLabel

protected

distance of label from the feature (only for "around point" placement or linestrings)

Definition at line 508 of file qgslabelfeature.h.

◆ mFixedAngle

double QgsLabelFeature::mFixedAngle

protected

fixed rotation for the label (instead of automatic choice)

Definition at line 500 of file qgslabelfeature.h.

◆ mFixedPosition

QgsPointXY QgsLabelFeature::mFixedPosition

protected

fixed position for the label (instead of automatic placement)

Definition at line 496 of file qgslabelfeature.h.

◆ mGeometry

geos::unique_ptr QgsLabelFeature::mGeometry

protected

Geometry of the feature to be labelled.

Definition at line 476 of file qgslabelfeature.h.

◆ mHasFixedAngle

bool QgsLabelFeature::mHasFixedAngle

protected

whether mFixedAngle should be respected

Definition at line 498 of file qgslabelfeature.h.

◆ mHasFixedPosition

bool QgsLabelFeature::mHasFixedPosition

protected

whether mFixedPosition should be respected

Definition at line 494 of file qgslabelfeature.h.

◆ mHasFixedQuadrant

bool QgsLabelFeature::mHasFixedQuadrant

protected

whether mQuadOffset should be respected (only for "around point" placement)

Definition at line 502 of file qgslabelfeature.h.

◆ mId

QgsFeatureId QgsLabelFeature::mId

protected

Associated ID unique within the parent label provider.

Definition at line 474 of file qgslabelfeature.h.

◆ mInfo

pal::LabelInfo* QgsLabelFeature::mInfo = nullptr

protected

extra information for curved labels (may be nullptr)

Definition at line 524 of file qgslabelfeature.h.

◆ mIsObstacle

bool QgsLabelFeature::mIsObstacle

protected

whether the feature geometry acts as an obstacle for labels

Definition at line 518 of file qgslabelfeature.h.

◆ mLabelText

QString QgsLabelFeature::mLabelText

protected

text of the label

Definition at line 522 of file qgslabelfeature.h.

◆ mLayer

pal::Layer* QgsLabelFeature::mLayer = nullptr

protected

Pointer to PAL layer (assigned when registered to PAL)

Definition at line 471 of file qgslabelfeature.h.

◆ mObstacleFactor

double QgsLabelFeature::mObstacleFactor

protected

how strong is the geometry acting as obstacle

Definition at line 520 of file qgslabelfeature.h.

◆ mObstacleGeometry

geos::unique_ptr QgsLabelFeature::mObstacleGeometry

protected

Optional geometry to use for label obstacles, if different to mGeometry.

Definition at line 478 of file qgslabelfeature.h.

◆ mOffsetType

QgsPalLayerSettings::OffsetType QgsLabelFeature::mOffsetType

protected

Offset type for certain placement modes.

Definition at line 510 of file qgslabelfeature.h.

◆ mOverrunDistance

double QgsLabelFeature::mOverrunDistance = 0

protected

Distance to allow label to overrun linear features.

Definition at line 527 of file qgslabelfeature.h.

◆ mOverrunSmoothDistance

double QgsLabelFeature::mOverrunSmoothDistance = 0

protected

Distance to smooth angle of line start and end when calculating overruns.

Definition at line 529 of file qgslabelfeature.h.

◆ mPermissibleZone

QgsGeometry QgsLabelFeature::mPermissibleZone

protected

Optional geometry to use for label's permissible zone.

Definition at line 480 of file qgslabelfeature.h.

◆ mPositionOffset

QgsPointXY QgsLabelFeature::mPositionOffset

protected

offset of label from the feature (only for "offset from point" placement)

Definition at line 506 of file qgslabelfeature.h.

◆ mPredefinedPositionOrder

QVector< QgsPalLayerSettings::PredefinedPointPosition > QgsLabelFeature::mPredefinedPositionOrder

protected

Ordered list of predefined positions for label (only for OrderedPositionsAroundPoint placement)

Definition at line 512 of file qgslabelfeature.h.

◆ mPriority

double QgsLabelFeature::mPriority

protected

Priority of the label.

Definition at line 490 of file qgslabelfeature.h.

◆ mQuadOffset

QPointF QgsLabelFeature::mQuadOffset

protected

whether the side of the label is fixed (only for "around point" placement)

Definition at line 504 of file qgslabelfeature.h.

◆ mRepeatDistance

double QgsLabelFeature::mRepeatDistance

protected

distance after which label should be repeated (only for linestrings)

Definition at line 514 of file qgslabelfeature.h.

◆ mRotatedSize

QSizeF QgsLabelFeature::mRotatedSize

protected

Width and height of the label when rotated between 45 to 135 and 235 to 315 degrees;.

Definition at line 484 of file qgslabelfeature.h.

◆ mSize

QSizeF QgsLabelFeature::mSize

protected

Width and height of the label.

Definition at line 482 of file qgslabelfeature.h.

◆ mSymbolSize

QSizeF QgsLabelFeature::mSymbolSize

protected

Size of associated rendered symbol, if applicable.

Definition at line 488 of file qgslabelfeature.h.

◆ mVisualMargin

QgsMargins QgsLabelFeature::mVisualMargin

protected

Visual margin of label contents.

Definition at line 486 of file qgslabelfeature.h.

◆ mZIndex

double QgsLabelFeature::mZIndex

protected

Z-index of label (higher z-index labels are rendered on top of lower z-index labels)

Definition at line 492 of file qgslabelfeature.h.

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

/build/qgis-3.10.0+15buster/src/core/qgslabelfeature.h
/build/qgis-3.10.0+15buster/src/core/qgslabelfeature.cpp
/build/qgis-3.10.0+15buster/src/core/qgslabelingengine.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QgsLabelFeature()

◆ ~QgsLabelFeature()

Member Function Documentation

◆ alwaysShow()

◆ arrangementFlags()

◆ curvedLabelInfo()

◆ distLabel()

◆ feature()

◆ fixedAngle()

◆ fixedPosition()

◆ geometry()

◆ hasFixedAngle()

◆ hasFixedPosition()

◆ hasFixedQuadrant()

◆ id()

◆ isObstacle()

◆ labelAllParts()

◆ labelText()

◆ layer()

◆ obstacleFactor()

◆ obstacleGeometry()

◆ offsetType()

◆ overrunDistance()

◆ overrunSmoothDistance()

◆ permissibleZone()

◆ permissibleZonePrepared()

◆ positionOffset()

◆ predefinedPositionOrder()

◆ priority()

◆ provider()

◆ quadOffset()

◆ repeatDistance()

◆ setAlwaysShow()

◆ setArrangementFlags()

◆ setCurvedLabelInfo()

◆ setDistLabel()

◆ setFeature()

◆ setFixedAngle()

◆ setFixedPosition()

◆ setHasFixedAngle()

◆ setHasFixedPosition()

◆ setHasFixedQuadrant()

◆ setIsObstacle()

◆ setLabelAllParts()

◆ setLabelText()

◆ setLayer()

◆ setObstacleFactor()

◆ setObstacleGeometry()

◆ setOffsetType()

◆ setOverrunDistance()

◆ setOverrunSmoothDistance()

◆ setPermissibleZone()

◆ setPositionOffset()

◆ setPredefinedPositionOrder()

◆ setPriority()

◆ setQuadOffset()

◆ setRepeatDistance()

◆ setRotatedSize()

◆ setSymbol()

◆ setSymbolSize()

◆ setVisualMargin()

◆ setZIndex()

◆ size()

◆ symbol()

◆ symbolSize()

◆ visualMargin()

◆ zIndex()

Member Data Documentation

◆ mAlwaysShow

◆ mArrangementFlags

◆ mDistLabel

◆ mFixedAngle

◆ mFixedPosition

◆ mGeometry

◆ mHasFixedAngle

◆ mHasFixedPosition