QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Contains settings for how a map layer will be labeled. More...
#include <qgspallabeling.h>
Public Member Functions | |
QgsPalLayerSettings () | |
QgsPalLayerSettings (const QgsPalLayerSettings &s) | |
~QgsPalLayerSettings () | |
Q_DECL_DEPRECATED void | calculateLabelSize (const QFontMetricsF *fm, const QString &text, double &labelX, double &labelY, const QgsFeature *f=nullptr, QgsRenderContext *context=nullptr, double *rotatedLabelX=nullptr, double *rotatedLabelY=nullptr) |
Calculates the space required to render the provided text in map units. | |
QgsCallout * | callout () const |
Returns the label callout renderer, responsible for drawing label callouts. | |
bool | containsAdvancedEffects () const |
Returns true if any component of the label settings requires advanced effects such as blend modes, which require output in raster formats to be fully respected. | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the label's property collection, used for data defined overrides. | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the label's property collection, used for data defined overrides. | |
const QgsTextFormat & | format () const |
Returns the label text formatting settings, e.g., font settings, buffer settings, etc. | |
QgsExpression * | getLabelExpression () |
Returns the QgsExpression for this label settings. | |
QString | legendString () const |
legendString | |
QgsLabelLineSettings & | lineSettings () |
Returns the label line settings, which contain 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). | |
const QgsLabelLineSettings & | lineSettings () const |
Returns the label line settings, which contain 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). | |
QgsLabelObstacleSettings & | obstacleSettings () |
Returns the label obstacle settings. | |
const QgsLabelObstacleSettings & | obstacleSettings () const |
Returns the label obstacle settings. | |
QgsPalLayerSettings & | operator= (const QgsPalLayerSettings &s) |
copy operator - only copies the permanent members | |
QgsLabelPlacementSettings & | placementSettings () |
Returns the label placement settings. | |
const QgsLabelPlacementSettings & | placementSettings () const |
Returns the label placement settings. | |
QgsLabelPointSettings & | pointSettings () |
Returns the label point settings, which contain 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. | |
const QgsLabelPointSettings & | pointSettings () const |
Returns the label point settings, which contain 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. | |
Qgis::LabelPolygonPlacementFlags | polygonPlacementFlags () const |
Returns the polygon placement flags, which dictate how polygon labels can be placed. | |
bool | prepare (QgsRenderContext &context, QSet< QString > &attributeNames, const QgsFields &fields, const QgsMapSettings &mapSettings, const QgsCoordinateReferenceSystem &crs) |
Prepare for registration of features. | |
void | readXml (const QDomElement &elem, const QgsReadWriteContext &context) |
Read settings from a DOM element. | |
QSet< QString > | referencedFields (const QgsRenderContext &context) const |
Returns all field names referenced by the configuration (e.g. | |
void | registerFeature (const QgsFeature &f, QgsRenderContext &context) |
Registers a feature for labeling. | |
std::unique_ptr< QgsLabelFeature > | registerFeatureWithDetails (const QgsFeature &feature, QgsRenderContext &context, QgsGeometry obstacleGeometry=QgsGeometry(), const QgsSymbol *symbol=nullptr) |
Registers a feature for labeling. | |
Qgis::AngleUnit | rotationUnit () const |
Unit for rotation of labels. | |
void | setCallout (QgsCallout *callout) |
Sets the label callout renderer, responsible for drawing label callouts. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the label's property collection, used for data defined overrides. | |
void | setFormat (const QgsTextFormat &format) |
Sets the label text formatting settings, e.g., font settings, buffer settings, etc. | |
void | setLegendString (const QString &legendString) |
setLegendString | |
void | setLineSettings (const QgsLabelLineSettings &settings) |
Sets the label line settings, which contain 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). | |
void | setObstacleSettings (const QgsLabelObstacleSettings &settings) |
Sets the label obstacle settings. | |
void | setPlacementSettings (const QgsLabelPlacementSettings &settings) |
Sets the label placement settings. | |
void | setPointSettings (const QgsLabelPointSettings &settings) |
Sets the label point settings, which contain 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. | |
void | setPolygonPlacementFlags (Qgis::LabelPolygonPlacementFlags flags) |
Sets the polygon placement flags, which dictate how polygon labels can be placed. | |
void | setRotationUnit (Qgis::AngleUnit angleUnit) |
Set unit for rotation of labels. | |
void | setThinningSettings (const QgsLabelThinningSettings &settings) |
Sets the label thinning settings. | |
void | setUnplacedVisibility (Qgis::UnplacedLabelVisibility visibility) |
Sets the layer's unplaced label visibility. | |
void | startRender (QgsRenderContext &context) |
Prepares the label settings for rendering. | |
void | stopRender (QgsRenderContext &context) |
Finalises the label settings after use. | |
QgsLabelThinningSettings & | thinningSettings () |
Returns the label thinning settings. | |
const QgsLabelThinningSettings & | thinningSettings () const |
Returns the label thinning settings. | |
Qgis::UnplacedLabelVisibility | unplacedVisibility () const |
Returns the layer's unplaced label visibility. | |
QDomElement | writeXml (QDomDocument &doc, const QgsReadWriteContext &context) const |
Write settings into a DOM element. | |
Static Public Member Functions | |
static QPixmap | labelSettingsPreviewPixmap (const QgsPalLayerSettings &settings, QSize size, const QString &previewText=QString(), int padding=0, const QgsScreenProperties &screen=QgsScreenProperties()) |
Returns a pixmap preview for label settings. | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the labeling property definitions. | |
Public Attributes | |
double | angleOffset = 0 |
Label rotation, in degrees clockwise. | |
int | autoWrapLength = 0 |
If non-zero, indicates that label text should be automatically wrapped to (ideally) the specified number of characters. | |
bool | centroidInside = false |
true if centroid positioned labels must be placed inside their corresponding feature polygon, or false if centroids which fall outside the polygon are permitted. | |
bool | centroidWhole = false |
true if feature centroid should be calculated from the whole feature, or false if only the visible part of the feature should be considered. | |
QgsCoordinateTransform | ct |
int | decimals = 3 |
Number of decimal places to show for numeric labels. | |
double | dist = 0 |
Distance from feature to the label. | |
QgsMapUnitScale | distMapUnitScale |
Map unit scale for label feature distance. | |
Qgis::RenderUnit | distUnits = Qgis::RenderUnit::Millimeters |
Units the distance from feature to the label. | |
bool | drawLabels = true |
Whether to draw labels for this layer. | |
QgsGeometry | extentGeom |
int | fieldIndex = 0 |
QString | fieldName |
Name of field (or an expression) to use for label text. | |
bool | fitInPolygonOnly = false |
true if only labels which completely fit within a polygon are allowed. | |
bool | fontLimitPixelSize = false |
true if label sizes should be limited by pixel size. | |
int | fontMaxPixelSize = 10000 |
Maximum pixel size for showing rendered map unit labels (1 - 10000). | |
int | fontMinPixelSize = 0 |
Minimum pixel size for showing rendered map unit labels (1 - 1000). | |
bool | formatNumbers = false |
Set to true to format numeric label text as numbers (e.g. | |
QString | geometryGenerator |
The geometry generator expression. Null if disabled. | |
bool | geometryGeneratorEnabled = false |
Defines if the geometry generator is enabled or not. If disabled, the standard geometry will be taken. | |
Qgis::GeometryType | geometryGeneratorType = Qgis::GeometryType::Point |
The type of the result geometry of the geometry generator. | |
bool | isExpression = false |
true if this label is made from a expression string, e.g., FieldName || 'mm' | |
QgsMapUnitScale | labelOffsetMapUnitScale |
Map unit scale for label offset. | |
bool | labelPerPart = false |
true if every part of a multi-part feature should be labeled. | |
Qgis::GeometryType | layerType = Qgis::GeometryType::Unknown |
Geometry type of layers associated with these settings. | |
double | maxCurvedCharAngleIn = 25.0 |
Maximum angle between inside curved label characters (valid range 20.0 to 60.0). | |
double | maxCurvedCharAngleOut = -25.0 |
Maximum angle between outside curved label characters (valid range -20.0 to -95.0) | |
double | maximumScale = 0 |
The maximum map scale (i.e. | |
const QgsFeature * | mCurFeat = nullptr |
QgsFields | mCurFields |
int | mFeatsRegPal = 0 |
int | mFeatsSendingToPal = 0 |
int | mFeaturesToLabel = 0 |
double | minimumScale = 0 |
The minimum map scale (i.e. | |
Qgis::LabelMultiLineAlignment | multilineAlign = Qgis::LabelMultiLineAlignment::FollowPlacement |
Horizontal alignment of multi-line labels. | |
Qgis::LabelOffsetType | offsetType = Qgis::LabelOffsetType::FromPoint |
Offset type for layer (only applies in certain placement modes) | |
Qgis::RenderUnit | offsetUnits = Qgis::RenderUnit::Millimeters |
Units for offsets of label. | |
Qgis::LabelPlacement | placement = Qgis::LabelPlacement::AroundPoint |
Label placement mode. | |
bool | plusSign = false |
Whether '+' signs should be prepended to positive numeric labels. | |
bool | preserveRotation = true |
True if label rotation should be preserved during label pin/unpin operations. | |
Q_DECL_DEPRECATED QColor | previewBkgrdColor = Qt::white |
int | priority = 5 |
Label priority. | |
QgsPointXY | ptOne |
QgsPointXY | ptZero |
double | repeatDistance = 0 |
Distance for repeating labels for a single feature. | |
QgsMapUnitScale | repeatDistanceMapUnitScale |
Map unit scale for repeating labels for a single feature. | |
Qgis::RenderUnit | repeatDistanceUnit = Qgis::RenderUnit::Millimeters |
Units for repeating labels for a single feature. | |
bool | scaleVisibility = false |
Set to true to limit label visibility to a range of scales. | |
QgsStringReplacementCollection | substitutions |
Substitution collection for automatic text substitution with labels. | |
Qgis::UpsideDownLabelHandling | upsidedownLabels = Qgis::UpsideDownLabelHandling::FlipUpsideDownLabels |
Controls whether upside down labels are displayed and how they are handled. | |
bool | useMaxLineLengthForAutoWrap = true |
If true , indicates that when auto wrapping label text the autoWrapLength length indicates the maximum ideal length of text lines. | |
bool | useSubstitutions = false |
True if substitutions should be applied. | |
QString | wrapChar |
Wrapping character string. | |
const QgsMapToPixel * | xform = nullptr |
double | xOffset = 0 |
Horizontal offset of label. | |
double | yOffset = 0 |
Vertical offset of label. | |
double | zIndex = 0 |
Z-Index of label, where labels with a higher z-index are rendered on top of labels with a lower z-index. | |
Friends | |
class | QgsVectorLayer |
Contains settings for how a map layer will be labeled.
Definition at line 87 of file qgspallabeling.h.
|
strong |
Data definable properties.
Definition at line 99 of file qgspallabeling.h.
Q_NOWARN_DEPRECATED_PUSH QgsPalLayerSettings::QgsPalLayerSettings | ( | ) |
Definition at line 263 of file qgspallabeling.cpp.
Q_NOWARN_DEPRECATED_POP Q_NOWARN_DEPRECATED_PUSH QgsPalLayerSettings::QgsPalLayerSettings | ( | const QgsPalLayerSettings & | s | ) |
Definition at line 275 of file qgspallabeling.cpp.
QgsPalLayerSettings::~QgsPalLayerSettings | ( | ) |
Definition at line 593 of file qgspallabeling.cpp.
void QgsPalLayerSettings::calculateLabelSize | ( | const QFontMetricsF * | fm, |
const QString & | text, | ||
double & | labelX, | ||
double & | labelY, | ||
const QgsFeature * | f = nullptr , |
||
QgsRenderContext * | context = nullptr , |
||
double * | rotatedLabelX = nullptr , |
||
double * | rotatedLabelY = nullptr |
||
) |
Calculates the space required to render the provided text in map units.
Results will be written to labelX and labelY.
If the text orientation is set to rotation-based, the spaced taken to render vertically oriented text will be written to rotatedLabelX and rotatedLabelY.
Definition at line 1546 of file qgspallabeling.cpp.
|
inline |
Returns the label callout renderer, responsible for drawing label callouts.
Ownership is not transferred.
Definition at line 734 of file qgspallabeling.h.
bool QgsPalLayerSettings::containsAdvancedEffects | ( | ) | const |
Returns true
if any component of the label settings requires advanced effects such as blend modes, which require output in raster formats to be fully respected.
Definition at line 588 of file qgspallabeling.cpp.
|
inline |
Returns a reference to the label's property collection, used for data defined overrides.
Definition at line 695 of file qgspallabeling.h.
|
inline |
Returns a reference to the label's property collection, used for data defined overrides.
Definition at line 703 of file qgspallabeling.h.
|
inline |
Returns the label text formatting settings, e.g., font settings, buffer settings, etc.
Definition at line 717 of file qgspallabeling.h.
QgsExpression * QgsPalLayerSettings::getLabelExpression | ( | ) |
Returns the QgsExpression for this label settings.
May be nullptr
if isExpression is false
.
Definition at line 612 of file qgspallabeling.cpp.
|
static |
Returns a pixmap preview for label settings.
settings | label settings |
size | target pixmap size |
previewText | text to render in preview, or empty for default text |
padding | space between icon edge and color ramp |
screen | can be used to specify the destination screen properties for the icon. This allows the icon to be generated using the correct DPI and device pixel ratio for the target screen (since QGIS 3.32) |
Definition at line 1385 of file qgspallabeling.cpp.
|
inline |
legendString
Definition at line 631 of file qgspallabeling.h.
|
inline |
Returns the label line settings, which contain 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 763 of file qgspallabeling.h.
|
inline |
Returns the label line settings, which contain 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 754 of file qgspallabeling.h.
|
inline |
Returns the label obstacle settings.
Definition at line 818 of file qgspallabeling.h.
|
inline |
Returns the label obstacle settings.
Definition at line 811 of file qgspallabeling.h.
Q_NOWARN_DEPRECATED_POP QgsPalLayerSettings & QgsPalLayerSettings::operator= | ( | const QgsPalLayerSettings & | s | ) |
copy operator - only copies the permanent members
Definition at line 283 of file qgspallabeling.cpp.
|
inline |
Returns the label placement settings.
Definition at line 862 of file qgspallabeling.h.
|
inline |
Returns the label placement settings.
Definition at line 855 of file qgspallabeling.h.
|
inline |
Returns the label point settings, which contain 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 793 of file qgspallabeling.h.
|
inline |
Returns the label point settings, which contain 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 783 of file qgspallabeling.h.
|
inline |
Returns the polygon placement flags, which dictate how polygon labels can be placed.
Definition at line 397 of file qgspallabeling.h.
bool QgsPalLayerSettings::prepare | ( | QgsRenderContext & | context, |
QSet< QString > & | attributeNames, | ||
const QgsFields & | fields, | ||
const QgsMapSettings & | mapSettings, | ||
const QgsCoordinateReferenceSystem & | crs | ||
) |
Prepare for registration of features.
The context, mapSettings and fields parameters give more information about the rendering environment. If target crs is not specified, the targetCrs from mapSettings will be taken. The parameter attributeNames should be updated to contain all the field names which the labeling requires for the rendering.
Definition at line 369 of file qgspallabeling.cpp.
|
static |
Returns the labeling property definitions.
Definition at line 606 of file qgspallabeling.cpp.
void QgsPalLayerSettings::readXml | ( | const QDomElement & | elem, |
const QgsReadWriteContext & | context | ||
) |
Read settings from a DOM element.
Definition at line 960 of file qgspallabeling.cpp.
QSet< QString > QgsPalLayerSettings::referencedFields | ( | const QgsRenderContext & | context | ) | const |
Returns all field names referenced by the configuration (e.g.
field name or expression, data defined properties).
Definition at line 499 of file qgspallabeling.cpp.
void QgsPalLayerSettings::registerFeature | ( | const QgsFeature & | f, |
QgsRenderContext & | context | ||
) |
Registers a feature for labeling.
f | feature to label |
context | render context. The QgsExpressionContext contained within the render context must have already had the feature and fields sets prior to calling this method. |
Definition at line 1926 of file qgspallabeling.cpp.
std::unique_ptr< QgsLabelFeature > QgsPalLayerSettings::registerFeatureWithDetails | ( | const QgsFeature & | feature, |
QgsRenderContext & | context, | ||
QgsGeometry | obstacleGeometry = QgsGeometry() , |
||
const QgsSymbol * | symbol = nullptr |
||
) |
Registers a feature for labeling.
feature | feature to label |
context | render context. The QgsExpressionContext contained within the render context must have already had the feature and fields set prior to calling this method. |
obstacleGeometry | optional obstacle geometry, if a different geometry to the feature's geometry should be used as an obstacle for labels (e.g., if the feature has been rendered with an offset point symbol, the obstacle geometry should represent the bounds of the offset symbol). If not set, the feature's original geometry will be used as an obstacle for labels. |
symbol | feature symbol to label (ownership is not transferred, and symbol must exist until the labeling is complete) |
nullptr
if the feature will not be labeled in this context.Definition at line 1931 of file qgspallabeling.cpp.
Qgis::AngleUnit QgsPalLayerSettings::rotationUnit | ( | ) | const |
Unit for rotation of labels.
Definition at line 621 of file qgspallabeling.cpp.
void QgsPalLayerSettings::setCallout | ( | QgsCallout * | callout | ) |
Sets the label callout renderer, responsible for drawing label callouts.
Ownership of callout is transferred to the settings.
Definition at line 1380 of file qgspallabeling.cpp.
|
inline |
Sets the label's property collection, used for data defined overrides.
collection | property collection. Existing properties will be replaced. |
Definition at line 711 of file qgspallabeling.h.
|
inline |
Sets the label text formatting settings, e.g., font settings, buffer settings, etc.
format | label text format |
Definition at line 724 of file qgspallabeling.h.
|
inline |
setLegendString
legendString | the string to show in the legend and preview |
Definition at line 625 of file qgspallabeling.h.
|
inline |
Sets the label line settings, which contain 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 772 of file qgspallabeling.h.
|
inline |
Sets the label obstacle settings.
Definition at line 825 of file qgspallabeling.h.
|
inline |
Sets the label placement settings.
Definition at line 869 of file qgspallabeling.h.
|
inline |
Sets the label point settings, which contain 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 803 of file qgspallabeling.h.
|
inline |
Sets the polygon placement flags, which dictate how polygon labels can be placed.
Definition at line 405 of file qgspallabeling.h.
void QgsPalLayerSettings::setRotationUnit | ( | Qgis::AngleUnit | angleUnit | ) |
Set unit for rotation of labels.
Definition at line 626 of file qgspallabeling.cpp.
|
inline |
Sets the label thinning settings.
Definition at line 847 of file qgspallabeling.h.
void QgsPalLayerSettings::setUnplacedVisibility | ( | Qgis::UnplacedLabelVisibility | visibility | ) |
Sets the layer's unplaced label visibility.
Definition at line 1536 of file qgspallabeling.cpp.
void QgsPalLayerSettings::startRender | ( | QgsRenderContext & | context | ) |
Prepares the label settings for rendering.
This should be called before rendering any labels, and must be followed by a call to stopRender() in order to gracefully clean up symbols.
Definition at line 535 of file qgspallabeling.cpp.
void QgsPalLayerSettings::stopRender | ( | QgsRenderContext & | context | ) |
Finalises the label settings after use.
This must be called after a call to startRender(), in order to gracefully clean up symbols.
Definition at line 572 of file qgspallabeling.cpp.
|
inline |
Returns the label thinning settings.
Definition at line 840 of file qgspallabeling.h.
|
inline |
Returns the label thinning settings.
Definition at line 833 of file qgspallabeling.h.
Qgis::UnplacedLabelVisibility QgsPalLayerSettings::unplacedVisibility | ( | ) | const |
Returns the layer's unplaced label visibility.
Definition at line 1531 of file qgspallabeling.cpp.
QDomElement QgsPalLayerSettings::writeXml | ( | QDomDocument & | doc, |
const QgsReadWriteContext & | context | ||
) | const |
Write settings into a DOM element.
Definition at line 1258 of file qgspallabeling.cpp.
|
friend |
Definition at line 914 of file qgspallabeling.h.
double QgsPalLayerSettings::angleOffset = 0 |
Label rotation, in degrees clockwise.
Definition at line 503 of file qgspallabeling.h.
int QgsPalLayerSettings::autoWrapLength = 0 |
If non-zero, indicates that label text should be automatically wrapped to (ideally) the specified number of characters.
If zero, auto wrapping is disabled.
Definition at line 347 of file qgspallabeling.h.
bool QgsPalLayerSettings::centroidInside = false |
true
if centroid positioned labels must be placed inside their corresponding feature polygon, or false
if centroids which fall outside the polygon are permitted.
Definition at line 418 of file qgspallabeling.h.
bool QgsPalLayerSettings::centroidWhole = false |
true
if feature centroid should be calculated from the whole feature, or false
if only the visible part of the feature should be considered.
Definition at line 411 of file qgspallabeling.h.
QgsCoordinateTransform QgsPalLayerSettings::ct |
Definition at line 903 of file qgspallabeling.h.
int QgsPalLayerSettings::decimals = 3 |
Number of decimal places to show for numeric labels.
formatNumbers must be true
for this setting to have an effect.
Definition at line 377 of file qgspallabeling.h.
double QgsPalLayerSettings::dist = 0 |
Distance from feature to the label.
Units are specified via distUnits.
Definition at line 430 of file qgspallabeling.h.
QgsMapUnitScale QgsPalLayerSettings::distMapUnitScale |
Map unit scale for label feature distance.
Definition at line 444 of file qgspallabeling.h.
Qgis::RenderUnit QgsPalLayerSettings::distUnits = Qgis::RenderUnit::Millimeters |
Units the distance from feature to the label.
Definition at line 437 of file qgspallabeling.h.
bool QgsPalLayerSettings::drawLabels = true |
Whether to draw labels for this layer.
For some layers it may be desirable to register their features as obstacles for other labels without requiring labels to be drawn for the layer itself. In this case drawLabels can be set to false
and obstacle set to true
, which will result in the layer acting as an obstacle but having no labels of its own.
Definition at line 300 of file qgspallabeling.h.
QgsGeometry QgsPalLayerSettings::extentGeom |
Definition at line 907 of file qgspallabeling.h.
int QgsPalLayerSettings::fieldIndex = 0 |
Definition at line 901 of file qgspallabeling.h.
QString QgsPalLayerSettings::fieldName |
Name of field (or an expression) to use for label text.
If fieldName is an expression, then isExpression should be set to true
.
Definition at line 309 of file qgspallabeling.h.
bool QgsPalLayerSettings::fitInPolygonOnly = false |
true
if only labels which completely fit within a polygon are allowed.
Definition at line 423 of file qgspallabeling.h.
bool QgsPalLayerSettings::fontLimitPixelSize = false |
true
if label sizes should be limited by pixel size.
Definition at line 578 of file qgspallabeling.h.
int QgsPalLayerSettings::fontMaxPixelSize = 10000 |
Maximum pixel size for showing rendered map unit labels (1 - 10000).
Definition at line 592 of file qgspallabeling.h.
int QgsPalLayerSettings::fontMinPixelSize = 0 |
Minimum pixel size for showing rendered map unit labels (1 - 1000).
Definition at line 585 of file qgspallabeling.h.
bool QgsPalLayerSettings::formatNumbers = false |
Set to true
to format numeric label text as numbers (e.g.
inserting thousand separators and fixed number of decimal places).
Definition at line 370 of file qgspallabeling.h.
QString QgsPalLayerSettings::geometryGenerator |
The geometry generator expression. Null if disabled.
Definition at line 607 of file qgspallabeling.h.
bool QgsPalLayerSettings::geometryGeneratorEnabled = false |
Defines if the geometry generator is enabled or not. If disabled, the standard geometry will be taken.
Definition at line 613 of file qgspallabeling.h.
Qgis::GeometryType QgsPalLayerSettings::geometryGeneratorType = Qgis::GeometryType::Point |
The type of the result geometry of the geometry generator.
Definition at line 610 of file qgspallabeling.h.
bool QgsPalLayerSettings::isExpression = false |
true
if this label is made from a expression string, e.g., FieldName || 'mm'
Definition at line 315 of file qgspallabeling.h.
QgsMapUnitScale QgsPalLayerSettings::labelOffsetMapUnitScale |
Map unit scale for label offset.
Definition at line 500 of file qgspallabeling.h.
bool QgsPalLayerSettings::labelPerPart = false |
true
if every part of a multi-part feature should be labeled.
If false
, only the largest part will be labeled.
Definition at line 601 of file qgspallabeling.h.
Qgis::GeometryType QgsPalLayerSettings::layerType = Qgis::GeometryType::Unknown |
Geometry type of layers associated with these settings.
Definition at line 619 of file qgspallabeling.h.
double QgsPalLayerSettings::maxCurvedCharAngleIn = 25.0 |
Maximum angle between inside curved label characters (valid range 20.0 to 60.0).
Definition at line 526 of file qgspallabeling.h.
double QgsPalLayerSettings::maxCurvedCharAngleOut = -25.0 |
Maximum angle between outside curved label characters (valid range -20.0 to -95.0)
Definition at line 532 of file qgspallabeling.h.
double QgsPalLayerSettings::maximumScale = 0 |
The maximum map scale (i.e.
most "zoomed in" scale) at which the labels will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no maximum scale visibility.
This setting is only considered if scaleVisibility is true
.
Definition at line 559 of file qgspallabeling.h.
const QgsFeature* QgsPalLayerSettings::mCurFeat = nullptr |
Definition at line 899 of file qgspallabeling.h.
QgsFields QgsPalLayerSettings::mCurFields |
Definition at line 900 of file qgspallabeling.h.
int QgsPalLayerSettings::mFeatsRegPal = 0 |
Definition at line 910 of file qgspallabeling.h.
int QgsPalLayerSettings::mFeatsSendingToPal = 0 |
Definition at line 909 of file qgspallabeling.h.
int QgsPalLayerSettings::mFeaturesToLabel = 0 |
Definition at line 908 of file qgspallabeling.h.
double QgsPalLayerSettings::minimumScale = 0 |
The minimum map scale (i.e.
most "zoomed out" scale) at which the labels will be visible. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. A scale of 0 indicates no minimum scale visibility.
This setting is only considered if scaleVisibility is true
.
Definition at line 571 of file qgspallabeling.h.
Qgis::LabelMultiLineAlignment QgsPalLayerSettings::multilineAlign = Qgis::LabelMultiLineAlignment::FollowPlacement |
Horizontal alignment of multi-line labels.
Definition at line 362 of file qgspallabeling.h.
Qgis::LabelOffsetType QgsPalLayerSettings::offsetType = Qgis::LabelOffsetType::FromPoint |
Offset type for layer (only applies in certain placement modes)
Definition at line 447 of file qgspallabeling.h.
Qgis::RenderUnit QgsPalLayerSettings::offsetUnits = Qgis::RenderUnit::Millimeters |
Units for offsets of label.
Definition at line 492 of file qgspallabeling.h.
Qgis::LabelPlacement QgsPalLayerSettings::placement = Qgis::LabelPlacement::AroundPoint |
Label placement mode.
Definition at line 389 of file qgspallabeling.h.
bool QgsPalLayerSettings::plusSign = false |
Whether '+' signs should be prepended to positive numeric labels.
formatNumbers must be true
for this setting to have an effect.
Definition at line 384 of file qgspallabeling.h.
bool QgsPalLayerSettings::preserveRotation = true |
True if label rotation should be preserved during label pin/unpin operations.
Definition at line 506 of file qgspallabeling.h.
Q_DECL_DEPRECATED QColor QgsPalLayerSettings::previewBkgrdColor = Qt::white |
Definition at line 325 of file qgspallabeling.h.
int QgsPalLayerSettings::priority = 5 |
Label priority.
Valid ranges are from 0 to 10, where 0 = lowest priority and 10 = highest priority.
Definition at line 538 of file qgspallabeling.h.
QgsPointXY QgsPalLayerSettings::ptOne |
Definition at line 906 of file qgspallabeling.h.
QgsPointXY QgsPalLayerSettings::ptZero |
Definition at line 905 of file qgspallabeling.h.
double QgsPalLayerSettings::repeatDistance = 0 |
Distance for repeating labels for a single feature.
Definition at line 454 of file qgspallabeling.h.
QgsMapUnitScale QgsPalLayerSettings::repeatDistanceMapUnitScale |
Map unit scale for repeating labels for a single feature.
Definition at line 468 of file qgspallabeling.h.
Qgis::RenderUnit QgsPalLayerSettings::repeatDistanceUnit = Qgis::RenderUnit::Millimeters |
Units for repeating labels for a single feature.
Definition at line 461 of file qgspallabeling.h.
bool QgsPalLayerSettings::scaleVisibility = false |
Set to true
to limit label visibility to a range of scales.
Definition at line 547 of file qgspallabeling.h.
QgsStringReplacementCollection QgsPalLayerSettings::substitutions |
Substitution collection for automatic text substitution with labels.
Definition at line 328 of file qgspallabeling.h.
Qgis::UpsideDownLabelHandling QgsPalLayerSettings::upsidedownLabels = Qgis::UpsideDownLabelHandling::FlipUpsideDownLabels |
Controls whether upside down labels are displayed and how they are handled.
Definition at line 595 of file qgspallabeling.h.
bool QgsPalLayerSettings::useMaxLineLengthForAutoWrap = true |
If true
, indicates that when auto wrapping label text the autoWrapLength length indicates the maximum ideal length of text lines.
If false
, then autoWrapLength indicates the ideal minimum length of text lines.
If autoWrapLength is 0 then this value has no effect.
Definition at line 359 of file qgspallabeling.h.
bool QgsPalLayerSettings::useSubstitutions = false |
True if substitutions should be applied.
Definition at line 330 of file qgspallabeling.h.
QString QgsPalLayerSettings::wrapChar |
Wrapping character string.
If set, any occurrences of this string in the calculated label text will be replaced with new line characters.
Definition at line 338 of file qgspallabeling.h.
const QgsMapToPixel* QgsPalLayerSettings::xform = nullptr |
Definition at line 902 of file qgspallabeling.h.
double QgsPalLayerSettings::xOffset = 0 |
Horizontal offset of label.
Units are specified via offsetUnits.
Definition at line 476 of file qgspallabeling.h.
double QgsPalLayerSettings::yOffset = 0 |
Vertical offset of label.
Units are specified via offsetUnits.
Definition at line 484 of file qgspallabeling.h.
double QgsPalLayerSettings::zIndex = 0 |
Z-Index of label, where labels with a higher z-index are rendered on top of labels with a lower z-index.
Definition at line 604 of file qgspallabeling.h.