Class that adds extra information to QgsLabelFeature for labeling of diagrams. More...
#include <qgsvectorlayerdiagramprovider.h>
Inheritance diagram for QgsDiagramLabelFeature:
Public Member Functions | |
| QgsDiagramLabelFeature (QgsFeatureId id, geos::unique_ptr geometry, QSizeF size) | |
| Create label feature, takes ownership of the geometry instance. More... | |
| const QgsAttributes & | attributes () |
| Gets feature's attributes - used for rendering of diagrams. More... | |
| void | setAttributes (const QgsAttributes &attrs) |
| Store feature's attributes - used for rendering of diagrams. More... | |
 Public Member Functions inherited from QgsLabelFeature | |
| 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... | |
| QgsPointXY | anchorPosition () const |
| In case of quadrand or aligned positioning, this is set to the anchor point. More... | |
| QgsLabeling::LinePlacementFlags | arrangementFlags () const |
| Returns the feature's arrangement flags. More... | |
| pal::LabelInfo * | curvedLabelInfo () const |
Gets additional info 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 | 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 | lineAnchorPercent () const |
| Returns the percent along the line at which labels should be placed, for line labels only. More... | |
| QgsLabelLineSettings::AnchorType | lineAnchorType () const |
| Returns the line anchor type, which dictates how the lineAnchorPercent() setting is handled. More... | |
| const QgsLabelObstacleSettings & | obstacleSettings () const |
| Returns the label's obstacle settings. 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... | |
| QgsLabeling::PolygonPlacementFlags | polygonPlacementFlags () const |
| Returns the polygon placement flags, which dictate how polygon labels can be placed. 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 | setAnchorPosition (const QgsPointXY &anchorPosition) |
| In case of quadrand or aligned positioning, this is set to the anchor point. More... | |
| void | setArrangementFlags (QgsLabeling::LinePlacementFlags 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 | 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 | setLineAnchorPercent (double percent) |
| Sets the percent along the line at which labels should be placed, for line labels only. More... | |
| void | setLineAnchorType (QgsLabelLineSettings::AnchorType type) |
| Sets the line anchor type, which dictates how the lineAnchorPercent() setting is handled. More... | |
| void | setObstacleSettings (const QgsLabelObstacleSettings &settings) |
| Sets the label's obstacle settings. 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 | setPolygonPlacementFlags (QgsLabeling::PolygonPlacementFlags flags) |
| Sets the polygon placement flags, which dictate how polygon labels can be placed. 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 | |
| QgsAttributes | mAttributes |
| Stores attribute values for diagram rendering. More... | |
| Protected Attributes inherited from QgsLabelFeature | |
| bool | mAlwaysShow = false |
| whether to always show label - even in case of collisions More... | |
| QgsLabeling::LinePlacementFlags | mArrangementFlags = QgsLabeling::LinePlacementFlags() |
| double | mDistLabel = 0 |
| distance of label from the feature (only for "around point" placement or linestrings) More... | |
| double | mFixedAngle = 0 |
| 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 = false |
| whether mFixedAngle should be respected More... | |
| bool | mHasFixedPosition = false |
| whether mFixedPosition should be respected More... | |
| bool | mHasFixedQuadrant = false |
| 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... | |
| QString | mLabelText |
| text of the label More... | |
| pal::Layer * | mLayer = nullptr |
| Pointer to PAL layer (assigned when registered to PAL) More... | |
| QgsPalLayerSettings::OffsetType | mOffsetType = QgsPalLayerSettings::FromPoint |
| 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... | |
| QgsLabeling::PolygonPlacementFlags | mPolygonPlacementFlags = QgsLabeling::PolygonPlacementFlag::AllowPlacementInsideOfPolygon |
| 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 = -1 |
| Priority of the label. More... | |
| QPointF | mQuadOffset |
| whether the side of the label is fixed (only for "around point" placement) More... | |
| double | mRepeatDistance = 0 |
| 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 = 0 |
| Z-index of label (higher z-index labels are rendered on top of lower z-index labels) More... | |
Detailed Description
Class that adds extra information to QgsLabelFeature for labeling of diagrams.
- Note
- this class is not a part of public API yet. See notes in QgsLabelingEngine
- not available in Python bindings
Definition at line 33 of file qgsvectorlayerdiagramprovider.h.
Constructor & Destructor Documentation
◆ QgsDiagramLabelFeature()
|
inline |
Create label feature, takes ownership of the geometry instance.
Definition at line 37 of file qgsvectorlayerdiagramprovider.h.
Member Function Documentation
◆ attributes()
|
inline |
Gets feature's attributes - used for rendering of diagrams.
Definition at line 43 of file qgsvectorlayerdiagramprovider.h.
◆ setAttributes()
|
inline |
Store feature's attributes - used for rendering of diagrams.
Definition at line 41 of file qgsvectorlayerdiagramprovider.h.
Member Data Documentation
◆ mAttributes
|
protected |
Stores attribute values for diagram rendering.
Definition at line 47 of file qgsvectorlayerdiagramprovider.h.
The documentation for this class was generated from the following file:
- /build/qgis-3.18.1+99unstable/src/core/vector/qgsvectorlayerdiagramprovider.h
