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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/labeling/qgslabelthinningsettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsLabelThinningSettings
{
%Docstring(signature="appended")
Contains settings related to how the label engine removes candidate
label positions and reduces the number of displayed labels.
.. versionadded:: 3.12
%End
%TypeHeaderCode
#include "qgslabelthinningsettings.h"
%End
public:
bool limitNumberOfLabelsEnabled() const;
%Docstring
Returns ``True`` if the number of labels drawn for the layer should be
limited.
.. seealso:: :py:func:`maximumNumberLabels`
.. seealso:: :py:func:`setLimitNumberLabelsEnabled`
%End
void setLimitNumberLabelsEnabled( bool enabled );
%Docstring
Sets whether the the number of labels drawn for the layer should be
limited.
.. seealso:: :py:func:`setMaximumNumberLabels`
.. seealso:: :py:func:`limitNumberOfLabelsEnabled`
%End
int maximumNumberLabels() const;
%Docstring
Returns the maximum number of labels which should be drawn for this
layer. This only has an effect if
:py:func:`~QgsLabelThinningSettings.limitNumberOfLabelsEnabled` is
``True``.
.. seealso:: :py:func:`limitNumberOfLabelsEnabled`
.. seealso:: :py:func:`setMaximumNumberLabels`
%End
void setMaximumNumberLabels( int number );
%Docstring
Sets the maximum ``number`` of labels which should be drawn for this
layer. This only has an effect if
:py:func:`~QgsLabelThinningSettings.limitNumberOfLabelsEnabled` is
``True``.
.. seealso:: :py:func:`setLimitNumberLabelsEnabled`
.. seealso:: :py:func:`maximumNumberLabels`
%End
double minimumFeatureSize() const;
%Docstring
Returns the minimum feature size (in millimeters) for a feature to be
labelled.
.. seealso:: :py:func:`setMinimumFeatureSize`
%End
void setMinimumFeatureSize( double size );
%Docstring
Sets the minimum feature ``size`` (in millimeters) for a feature to be
labelled.
.. seealso:: :py:func:`minimumFeatureSize`
%End
void updateDataDefinedProperties( const QgsPropertyCollection &properties, QgsExpressionContext &context );
%Docstring
Updates the thinning settings to respect any data defined properties set
within the specified ``properties`` collection.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/labeling/qgslabelthinningsettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
