QGIS API Documentation 3.41.0-Master (3c143d501a8)
|
Contains general settings related to how labels are placed. More...
#include <qgslabelplacementsettings.h>
Public Member Functions | |
bool | allowDegradedPlacement () const |
Returns true if labels can be placed in inferior fallback positions if they cannot otherwise be placed. | |
Qgis::LabelOverlapHandling | overlapHandling () const |
Returns the technique used to handle overlapping labels. | |
Qgis::LabelPrioritization | prioritization () const |
Returns the label prioritization technique. | |
void | setAllowDegradedPlacement (bool allow) |
Sets whether labels can be placed in inferior fallback positions if they cannot otherwise be placed. | |
void | setOverlapHandling (Qgis::LabelOverlapHandling handling) |
Sets the technique used to handle overlapping labels. | |
void | setPrioritization (Qgis::LabelPrioritization prioritization) |
Sets the technique used to prioritize labels. | |
void | updateDataDefinedProperties (const QgsPropertyCollection &properties, QgsExpressionContext &context) |
Updates the placement settings to respect any data defined properties set within the specified properties collection. | |
Contains general settings related to how labels are placed.
Definition at line 34 of file qgslabelplacementsettings.h.
|
inline |
Returns true
if labels can be placed in inferior fallback positions if they cannot otherwise be placed.
For instance, this will permit a curved line label to fallback to a horizontal label at the end of the line if the label cannot otherwise be placed on the line in a curved manner.
Definition at line 59 of file qgslabelplacementsettings.h.
|
inline |
Returns the technique used to handle overlapping labels.
Definition at line 42 of file qgslabelplacementsettings.h.
|
inline |
Returns the label prioritization technique.
Definition at line 79 of file qgslabelplacementsettings.h.
|
inline |
Sets whether labels can be placed in inferior fallback positions if they cannot otherwise be placed.
For instance, this will permit a curved line label to fallback to a horizontal label at the end of the line if the label cannot otherwise be placed on the line in a curved manner.
Definition at line 70 of file qgslabelplacementsettings.h.
|
inline |
Sets the technique used to handle overlapping labels.
Definition at line 48 of file qgslabelplacementsettings.h.
|
inline |
Sets the technique used to prioritize labels.
Definition at line 88 of file qgslabelplacementsettings.h.
void QgsLabelPlacementSettings::updateDataDefinedProperties | ( | const QgsPropertyCollection & | properties, |
QgsExpressionContext & | context | ||
) |
Updates the placement settings to respect any data defined properties set within the specified properties collection.
Definition at line 22 of file qgslabelplacementsettings.cpp.