1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/labeling/qgslabelpointsettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsLabelPointSettings
{
%Docstring(signature="appended")
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.
.. versionadded:: 3.38
%End
%TypeHeaderCode
#include "qgslabelpointsettings.h"
%End
public:
static const QMetaObject staticMetaObject;
public:
void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );
%Docstring
Updates the point settings to respect any data defined properties set
within the specified ``properties`` collection.
%End
Qgis::LabelQuadrantPosition quadrant() const;
%Docstring
Returns the quadrant in which to offset labels from the point.
.. seealso:: :py:func:`setQuadrant`
%End
void setQuadrant( Qgis::LabelQuadrantPosition quadrant );
%Docstring
Sets the ``quadrant`` in which to offset labels from the point.
.. seealso:: :py:func:`quadrant`
%End
QVector< Qgis::LabelPredefinedPointPosition > predefinedPositionOrder() const;
%Docstring
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
:py:class:`Qgis`.LabelPlacement.OrderedPositionsAroundPoint.
.. seealso:: :py:func:`setPredefinedPositionOrder`
%End
void setPredefinedPositionOrder( const QVector< Qgis::LabelPredefinedPointPosition > &order );
%Docstring
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
:py:class:`Qgis`.LabelPlacement.OrderedPositionsAroundPoint.
.. seealso:: :py:func:`predefinedPositionOrder`
%End
double maximumDistance() const;
%Docstring
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.
.. seealso:: :py:func:`setMaximumDistance`
.. seealso:: :py:func:`maximumDistanceUnit`
.. seealso:: :py:func:`maximumDistanceMapUnitScale`
%End
void setMaximumDistance( double distance );
%Docstring
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.
.. seealso:: :py:func:`maximumDistance`
.. seealso:: :py:func:`maximumDistanceUnit`
.. seealso:: :py:func:`maximumDistanceMapUnitScale`
%End
Qgis::RenderUnit maximumDistanceUnit() const;
%Docstring
Returns the units for label maximum distance.
.. seealso:: :py:func:`setMaximumDistanceUnit`
.. seealso:: :py:func:`maximumDistance`
.. seealso:: :py:func:`maximumDistanceMapUnitScale`
%End
void setMaximumDistanceUnit( Qgis::RenderUnit unit );
%Docstring
Sets the ``unit`` for label maximum distance.
.. seealso:: :py:func:`maximumDistanceUnit`
.. seealso:: :py:func:`maximumDistance`
.. seealso:: :py:func:`maximumDistanceMapUnitScale`
%End
QgsMapUnitScale maximumDistanceMapUnitScale() const;
%Docstring
Returns the map unit scale for label maximum distance.
.. seealso:: :py:func:`setMaximumDistanceMapUnitScale`
.. seealso:: :py:func:`maximumDistance`
.. seealso:: :py:func:`maximumDistanceUnit`
%End
void setMaximumDistanceMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit ``scale`` for label maximum distance.
.. seealso:: :py:func:`maximumDistanceMapUnitScale`
.. seealso:: :py:func:`maximumDistance`
.. seealso:: :py:func:`maximumDistanceUnit`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/labeling/qgslabelpointsettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
