QGIS API Documentation 3.41.0-Master (a6c88b06562)
|
Contains settings related to how the label engine places and formats labels for line features (or polygon features which are labeled in a "perimeter" style mode). More...
#include <qgslabellinesettings.h>
Public Types | |
enum class | AnchorClipping : int { UseVisiblePartsOfLine , UseEntireLine } |
Clipping behavior for line anchor calculation. More... | |
enum class | AnchorTextPoint : int { StartOfText , CenterOfText , EndOfText , FollowPlacement } |
Anchor point of label text. More... | |
enum class | AnchorType : int { HintOnly , Strict } |
Line anchor types. More... | |
enum class | DirectionSymbolPlacement : int { SymbolLeftRight , SymbolAbove , SymbolBelow } |
Placement options for direction symbols. More... | |
Public Member Functions | |
bool | addDirectionSymbol () const |
Returns true if '<' or '>' (or custom strings set via leftDirectionSymbol and rightDirectionSymbol) will be automatically added to the label text, pointing in the direction of the line or polygon ring. | |
AnchorClipping | anchorClipping () const |
Returns the line anchor clipping mode, which dictates how line strings are clipped before calculating the line anchor placement. | |
AnchorTextPoint | anchorTextPoint () const |
Returns the line anchor text point, which dictates which part of the label text should be placed at the lineAnchorPercent(). | |
AnchorType | anchorType () const |
Returns the line anchor type, which dictates how the lineAnchorPercent() setting is handled. | |
DirectionSymbolPlacement | directionSymbolPlacement () const |
Returns the placement for direction symbols. | |
QString | leftDirectionSymbol () const |
Returns the string to use for left direction arrows. | |
double | lineAnchorPercent () const |
Returns the percent along the line at which labels should be placed. | |
bool | mergeLines () const |
Returns true if connected line features with identical label text should be merged prior to generating label positions. | |
double | overrunDistance () const |
Returns the distance which labels are allowed to overrun past the start or end of line features. | |
QgsMapUnitScale | overrunDistanceMapUnitScale () const |
Returns the map unit scale for label overrun distance. | |
Qgis::RenderUnit | overrunDistanceUnit () const |
Returns the units for label overrun distance. | |
Qgis::LabelLinePlacementFlags | placementFlags () const |
Returns the line placement flags, which dictate how line labels can be placed above or below the lines. | |
bool | reverseDirectionSymbol () const |
Returns true if direction symbols should be reversed. | |
QString | rightDirectionSymbol () const |
Returns the string to use for right direction arrows. | |
void | setAddDirectionSymbol (bool enabled) |
Sets whether '<' or '>' (or custom strings set via leftDirectionSymbol and rightDirectionSymbol) will be automatically added to the label text, pointing in the direction of the line or polygon ring. | |
void | setAnchorClipping (AnchorClipping clipping) |
Sets the line anchor clipping mode, which dictates how line strings are clipped before calculating the line anchor placement. | |
void | setAnchorTextPoint (AnchorTextPoint point) |
Sets the line anchor text point, which dictates which part of the label text should be placed at the lineAnchorPercent(). | |
void | setAnchorType (AnchorType type) |
Sets the line anchor type, which dictates how the lineAnchorPercent() setting is handled. | |
void | setDirectionSymbolPlacement (DirectionSymbolPlacement placement) |
Sets the placement for direction symbols. | |
void | setLeftDirectionSymbol (const QString &symbol) |
Sets the string to use for left direction arrows. | |
void | setLineAnchorPercent (double percent) |
Sets the percent along the line at which labels should be placed. | |
void | setMergeLines (bool merge) |
Sets whether connected line features with identical label text should be merged prior to generating label positions. | |
void | setOverrunDistance (double distance) |
Sets the distance which labels are allowed to overrun past the start or end of line features. | |
void | setOverrunDistanceMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for label overrun distance. | |
void | setOverrunDistanceUnit (const Qgis::RenderUnit &unit) |
Sets the unit for label overrun distance. | |
void | setPlacementFlags (Qgis::LabelLinePlacementFlags flags) |
Returns the line placement flags, which dictate how line labels can be placed above or below the lines. | |
void | setReverseDirectionSymbol (bool reversed) |
Sets whether the direction symbols should be reversed. | |
void | setRightDirectionSymbol (const QString &symbol) |
Sets the string to use for right direction arrows. | |
void | updateDataDefinedProperties (const QgsPropertyCollection &properties, QgsExpressionContext &context) |
Updates the line 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 line features (or polygon features which are labeled in a "perimeter" style mode).
Definition at line 37 of file qgslabellinesettings.h.
|
strong |
Clipping behavior for line anchor calculation.
Definition at line 69 of file qgslabellinesettings.h.
|
strong |
Anchor point of label text.
Enumerator | |
---|---|
StartOfText | Anchor using start of text. |
CenterOfText | Anchor using center of text. |
EndOfText | Anchor using end of text. |
FollowPlacement | Automatically set the anchor point based on the lineAnchorPercent() value. Values <25% will use the start of text, values > 75% will use the end of text, and values in between will use the center of the text. |
Definition at line 81 of file qgslabellinesettings.h.
|
strong |
Line anchor types.
Definition at line 57 of file qgslabellinesettings.h.
|
strong |
Placement options for direction symbols.
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 46 of file qgslabellinesettings.h.
|
inline |
Returns true
if '<' or '>' (or custom strings set via leftDirectionSymbol and rightDirectionSymbol) will be automatically added to the label text, pointing in the direction of the line or polygon ring.
Definition at line 139 of file qgslabellinesettings.h.
|
inline |
Returns the line anchor clipping mode, which dictates how line strings are clipped before calculating the line anchor placement.
Definition at line 332 of file qgslabellinesettings.h.
|
inline |
Returns the line anchor text point, which dictates which part of the label text should be placed at the lineAnchorPercent().
Definition at line 354 of file qgslabellinesettings.h.
|
inline |
Returns the line anchor type, which dictates how the lineAnchorPercent() setting is handled.
Definition at line 310 of file qgslabellinesettings.h.
|
inline |
Returns the placement for direction symbols.
This setting controls whether to place direction symbols to the left/right, above or below label.
Definition at line 212 of file qgslabellinesettings.h.
|
inline |
Returns the string to use for left direction arrows.
Definition at line 161 of file qgslabellinesettings.h.
|
inline |
Returns the percent along the line at which labels should be placed.
By default, this is 0.5 which indicates that labels should be placed as close to the center of the line as possible. A value of 0.0 indicates that the labels should be placed as close to the start of the line as possible, while a value of 1.0 pushes labels towards the end of the line.
Definition at line 285 of file qgslabellinesettings.h.
|
inline |
Returns true
if connected line features with identical label text should be merged prior to generating label positions.
Definition at line 112 of file qgslabellinesettings.h.
|
inline |
Returns the distance which labels are allowed to overrun past the start or end of line features.
Definition at line 230 of file qgslabellinesettings.h.
|
inline |
Returns the map unit scale for label overrun distance.
Definition at line 262 of file qgslabellinesettings.h.
|
inline |
Returns the units for label overrun distance.
Definition at line 246 of file qgslabellinesettings.h.
|
inline |
Returns the line placement flags, which dictate how line labels can be placed above or below the lines.
Definition at line 96 of file qgslabellinesettings.h.
|
inline |
Returns true
if direction symbols should be reversed.
Definition at line 195 of file qgslabellinesettings.h.
|
inline |
Returns the string to use for right direction arrows.
Definition at line 179 of file qgslabellinesettings.h.
|
inline |
Sets whether '<' or '>' (or custom strings set via leftDirectionSymbol and rightDirectionSymbol) will be automatically added to the label text, pointing in the direction of the line or polygon ring.
Definition at line 152 of file qgslabellinesettings.h.
|
inline |
Sets the line anchor clipping mode, which dictates how line strings are clipped before calculating the line anchor placement.
Definition at line 344 of file qgslabellinesettings.h.
|
inline |
Sets the line anchor text point, which dictates which part of the label text should be placed at the lineAnchorPercent().
Definition at line 364 of file qgslabellinesettings.h.
|
inline |
Sets the line anchor type, which dictates how the lineAnchorPercent() setting is handled.
Definition at line 320 of file qgslabellinesettings.h.
|
inline |
Sets the placement for direction symbols.
This setting controls whether to place direction symbols to the left/right, above or below label.
Definition at line 222 of file qgslabellinesettings.h.
|
inline |
Sets the string to use for left direction arrows.
Definition at line 170 of file qgslabellinesettings.h.
|
inline |
Sets the percent along the line at which labels should be placed.
By default, this is 0.5 which indicates that labels should be placed as close to the center of the line as possible. A value of 0.0 indicates that the labels should be placed as close to the start of the line as possible, while a value of 1.0 pushes labels towards the end of the line.
Definition at line 300 of file qgslabellinesettings.h.
|
inline |
Sets whether connected line features with identical label text should be merged prior to generating label positions.
Definition at line 120 of file qgslabellinesettings.h.
|
inline |
Sets the distance which labels are allowed to overrun past the start or end of line features.
Definition at line 238 of file qgslabellinesettings.h.
|
inline |
Sets the map unit scale for label overrun distance.
Definition at line 270 of file qgslabellinesettings.h.
|
inline |
Sets the unit for label overrun distance.
Definition at line 254 of file qgslabellinesettings.h.
|
inline |
Returns the line placement flags, which dictate how line labels can be placed above or below the lines.
Definition at line 104 of file qgslabellinesettings.h.
|
inline |
Sets whether the direction symbols should be reversed.
Definition at line 202 of file qgslabellinesettings.h.
|
inline |
Sets the string to use for right direction arrows.
Definition at line 188 of file qgslabellinesettings.h.
void QgsLabelLineSettings::updateDataDefinedProperties | ( | const QgsPropertyCollection & | properties, |
QgsExpressionContext & | context | ||
) |
Updates the line settings to respect any data defined properties set within the specified properties collection.
Definition at line 24 of file qgslabellinesettings.cpp.