QGIS API Documentation 3.39.0-Master (e8f1b343c48)
|
Represents the calculated placement of a map label. More...
#include <qgslabelposition.h>
Public Member Functions | |
QgsLabelPosition ()=default | |
QgsLabelPosition (QgsFeatureId id, double r, const QVector< QgsPointXY > &corners, const QgsRectangle &rect, double w, double h, const QString &layer, const QString &labeltext, const QFont &labelfont, bool upside_down, bool diagram=false, bool pinned=false, const QString &providerId=QString(), const QgsGeometry &labelGeometry=QgsGeometry(), bool isUnplaced=false) | |
Constructor for QgsLabelPosition. | |
Public Attributes | |
QVector< QgsPointXY > | cornerPoints |
QgsFeatureId | featureId = FID_NULL |
ID of feature associated with this label. | |
long long | groupedLabelId = 0 |
If non zero, indicates that the label position is part of a group of label positions (i.e. | |
double | height = 0 |
Heeght of label bounding box, in map units. | |
bool | isDiagram = false |
true if label is a diagram. | |
bool | isPinned = false |
true if label position has been pinned. | |
bool | isUnplaced = false |
true if label position corresponds to an unplaced label. | |
QFont | labelFont |
Font which the label is rendered using. | |
QgsGeometry | labelGeometry |
A polygon geometry representing the label's bounds in map coordinates. | |
QgsRectangle | labelRect |
QString | labelText |
String shown in label. | |
QString | layerID |
ID of associated map layer. | |
QString | providerID |
ID of the associated label provider. | |
double | rotation = 0 |
Rotation of label, in degrees clockwise. | |
bool | upsideDown = false |
true if label is upside down. | |
double | width = 0 |
Width of label bounding box, in map units. | |
Represents the calculated placement of a map label.
Definition at line 33 of file qgslabelposition.h.
|
inline |
Constructor for QgsLabelPosition.
id | associated feature ID |
r | label rotation in degrees clockwise |
corners | corner points of label bounding box, in map units |
rect | label bounding box, in map units |
w | width of label, in map units |
h | height of label, in map units |
layer | ID of associated map layer |
labeltext | text rendered for label |
labelfont | font used to render label |
upside_down | true if label is upside down |
diagram | true if label is a diagram |
pinned | true if label has pinned placement |
providerId | ID of associated label provider |
labelGeometry | polygon geometry of label boundary |
isUnplaced | set to true if label was unplaced (e.g. due to collisions with other labels) |
Definition at line 55 of file qgslabelposition.h.
|
default |
QVector< QgsPointXY > QgsLabelPosition::cornerPoints |
Definition at line 95 of file qgslabelposition.h.
QgsFeatureId QgsLabelPosition::featureId = FID_NULL |
ID of feature associated with this label.
Definition at line 88 of file qgslabelposition.h.
long long QgsLabelPosition::groupedLabelId = 0 |
If non zero, indicates that the label position is part of a group of label positions (i.e.
a character in a curved label).
All other linked positions will share the same groupedLabelId.
Definition at line 160 of file qgslabelposition.h.
double QgsLabelPosition::height = 0 |
Heeght of label bounding box, in map units.
Definition at line 112 of file qgslabelposition.h.
bool QgsLabelPosition::isDiagram = false |
true
if label is a diagram.
Definition at line 137 of file qgslabelposition.h.
bool QgsLabelPosition::isPinned = false |
true
if label position has been pinned.
Definition at line 142 of file qgslabelposition.h.
bool QgsLabelPosition::isUnplaced = false |
true
if label position corresponds to an unplaced label.
Definition at line 153 of file qgslabelposition.h.
QFont QgsLabelPosition::labelFont |
Font which the label is rendered using.
Definition at line 127 of file qgslabelposition.h.
QgsGeometry QgsLabelPosition::labelGeometry |
A polygon geometry representing the label's bounds in map coordinates.
Definition at line 102 of file qgslabelposition.h.
QgsRectangle QgsLabelPosition::labelRect |
Definition at line 96 of file qgslabelposition.h.
QString QgsLabelPosition::labelText |
String shown in label.
Definition at line 122 of file qgslabelposition.h.
QString QgsLabelPosition::layerID |
ID of associated map layer.
Definition at line 117 of file qgslabelposition.h.
QString QgsLabelPosition::providerID |
ID of the associated label provider.
Definition at line 147 of file qgslabelposition.h.
double QgsLabelPosition::rotation = 0 |
Rotation of label, in degrees clockwise.
Definition at line 93 of file qgslabelposition.h.
bool QgsLabelPosition::upsideDown = false |
true
if label is upside down.
Definition at line 132 of file qgslabelposition.h.
double QgsLabelPosition::width = 0 |
Width of label bounding box, in map units.
Definition at line 107 of file qgslabelposition.h.