QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Contains settings related to how the label engine places and formats labels for point features, or polygon features which are labeled in the "around" or "over" centroid placement modes. More...
#include <qgslabelpointsettings.h>
Public Member Functions | |
double | maximumDistance () const |
Returns the maximum distance which labels are allowed to be from their corresponding points. | |
QgsMapUnitScale | maximumDistanceMapUnitScale () const |
Returns the map unit scale for label maximum distance. | |
Qgis::RenderUnit | maximumDistanceUnit () const |
Returns the units for label maximum distance. | |
QVector< Qgis::LabelPredefinedPointPosition > | predefinedPositionOrder () const |
Returns the ordered list of predefined label positions for points. | |
Qgis::LabelQuadrantPosition | quadrant () const |
Returns the quadrant in which to offset labels from the point. | |
void | setMaximumDistance (double distance) |
Sets the maximum distance which labels are allowed to be from their corresponding points. | |
void | setMaximumDistanceMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for label maximum distance. | |
void | setMaximumDistanceUnit (Qgis::RenderUnit unit) |
Sets the unit for label maximum distance. | |
void | setPredefinedPositionOrder (const QVector< Qgis::LabelPredefinedPointPosition > &order) |
Sets the ordered list of predefined label positions for points. | |
void | setQuadrant (Qgis::LabelQuadrantPosition quadrant) |
Sets the quadrant in which to offset labels from the point. | |
void | updateDataDefinedProperties (const QgsPropertyCollection &properties, QgsExpressionContext &context) |
Updates the point settings to respect any data defined properties set within the specified properties collection. | |
Contains settings related to how the label engine places and formats labels for point features, or polygon features which are labeled in the "around" or "over" centroid placement modes.
Definition at line 37 of file qgslabelpointsettings.h.
|
inline |
Returns the maximum distance which labels are allowed to be from their corresponding points.
This setting works alongside the standard label offset distance properties to define a permissible range of distances at which labels can be placed from their points.
The default value is 0, which indicates that no maximum is set and the label's usual distance from point will always be respected.
Definition at line 96 of file qgslabelpointsettings.h.
|
inline |
Returns the map unit scale for label maximum distance.
Definition at line 138 of file qgslabelpointsettings.h.
|
inline |
Returns the units for label maximum distance.
Definition at line 120 of file qgslabelpointsettings.h.
|
inline |
Returns the 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 Qgis::LabelPlacement::OrderedPositionsAroundPoint.
Definition at line 71 of file qgslabelpointsettings.h.
|
inline |
Returns the quadrant in which to offset labels from the point.
Definition at line 54 of file qgslabelpointsettings.h.
|
inline |
Sets the maximum distance which labels are allowed to be from their corresponding points.
This setting works alongside the standard label offset distance properties to define a permissible range of distances at which labels can be placed from their points.
Setting distance to 0 indicates that no maximum is set and the label's usual distance from point will always be respected.
Definition at line 111 of file qgslabelpointsettings.h.
|
inline |
Sets the map unit scale for label maximum distance.
Definition at line 147 of file qgslabelpointsettings.h.
|
inline |
Sets the unit for label maximum distance.
Definition at line 129 of file qgslabelpointsettings.h.
|
inline |
Sets the 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 Qgis::LabelPlacement::OrderedPositionsAroundPoint.
Definition at line 81 of file qgslabelpointsettings.h.
|
inline |
Sets the quadrant in which to offset labels from the point.
Definition at line 61 of file qgslabelpointsettings.h.
void QgsLabelPointSettings::updateDataDefinedProperties | ( | const QgsPropertyCollection & | properties, |
QgsExpressionContext & | context | ||
) |
Updates the point settings to respect any data defined properties set within the specified properties collection.
Definition at line 22 of file qgslabelpointsettings.cpp.