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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/symbology/qgsrendererrange.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsRendererRange
{
%TypeHeaderCode
#include "qgsrendererrange.h"
%End
public:
QgsRendererRange();
~QgsRendererRange();
QgsRendererRange( const QgsClassificationRange &range, QgsSymbol *symbol /Transfer/, bool render = true, const QString &uuid = QString() );
%Docstring
Creates a renderer symbol range
:param range: The classification range
:param symbol: The symbol for this renderer range
:param render: If ``True``, it will be renderered
:param uuid: Optional parameter to manually set the UUID key identifier
for the this range (since QGIS 3.34).
%End
QgsRendererRange( double lowerValue, double upperValue, QgsSymbol *symbol /Transfer/, const QString &label, bool render = true, const QString &uuid = QString() );
%Docstring
Creates a renderer symbol range
:param lowerValue: The lower bound of the range
:param upperValue: The upper bound of the range
:param symbol: The symbol for this renderer range
:param label: The label used for the range
:param render: If ``True``, it will be renderered
:param uuid: Optional parameter to manually set the UUID key identifier
for the this range (since QGIS 3.34).
%End
QgsRendererRange( const QgsRendererRange &range );
bool operator<( const QgsRendererRange &other ) const;
QString uuid() const;
%Docstring
Returns the unique identifier for this range.
.. versionadded:: 3.34
%End
double lowerValue() const;
%Docstring
Returns the lower bound of the range.
.. seealso:: :py:func:`setLowerValue`
.. seealso:: :py:func:`upperValue`
%End
double upperValue() const;
%Docstring
Returns the upper bound of the range.
.. seealso:: :py:func:`setUpperValue`
.. seealso:: :py:func:`lowerValue`
%End
QgsSymbol *symbol() const;
%Docstring
Returns the symbol used for the range.
.. seealso:: :py:func:`setSymbol`
%End
QString label() const;
%Docstring
Returns the label used for the range.
.. seealso:: :py:func:`setLabel`
%End
void setSymbol( QgsSymbol *s /Transfer/ );
%Docstring
Sets the symbol used for the range.
Ownership of the symbol is transferred.
.. seealso:: :py:func:`symbol`
%End
void setLabel( const QString &label );
%Docstring
Sets the label used for the range.
.. seealso:: :py:func:`label`
%End
void setLowerValue( double lowerValue );
%Docstring
Sets the lower bound of the range.
.. seealso:: :py:func:`lowerValue`
.. seealso:: :py:func:`setUpperValue`
%End
void setUpperValue( double upperValue );
%Docstring
Sets the upper bound of the range.
.. seealso:: :py:func:`upperValue`
.. seealso:: :py:func:`setLowerValue`
%End
bool renderState() const;
%Docstring
Returns ``True`` if the range should be rendered.
.. seealso:: :py:func:`setRenderState`
%End
void setRenderState( bool render );
%Docstring
Sets whether the range should be rendered.
.. seealso:: :py:func:`renderState`
%End
QString dump() const;
%Docstring
Dumps a string representation of the range.
%End
void toSld( QDomDocument &doc, QDomElement &element, QVariantMap props, bool firstRange = false ) const;
%Docstring
Creates a DOM element representing the range in SLD format.
:param doc: DOM document
:param element: destination DOM element
:param props: graduated renderer properties
:param firstRange: set to ``True`` if the range is the first range,
where the lower value uses a <= test rather than a <
test.
%End
SIP_PYOBJECT __repr__();
%MethodCode
const QString str = sipCpp->label().isEmpty()
? QStringLiteral( "<QgsRendererRange: %1 - %2>" ).arg( sipCpp->lowerValue() ).arg( sipCpp->upperValue() )
: QStringLiteral( "<QgsRendererRange: %1 - %2 (%3)>" ).arg( sipCpp->lowerValue() ).arg( sipCpp->upperValue() ).arg( sipCpp->label() );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End
SIP_PYOBJECT __getitem__( int );
%MethodCode
if ( a0 == 0 )
{
sipRes = Py_BuildValue( "d", sipCpp->lowerValue() );
}
else if ( a0 == 1 )
{
sipRes = Py_BuildValue( "d", sipCpp->upperValue() );
}
else
{
QString msg = QString( "Bad index: %1" ).arg( a0 );
PyErr_SetString( PyExc_IndexError, msg.toLatin1().constData() );
}
%End
protected:
};
typedef QList<QgsRendererRange> QgsRangeList;
class QgsRendererRangeLabelFormat /Deprecated/
{
%Docstring(signature="appended")
.. deprecated:: 3.10
Use :py:class:`QgsClassificationMethod` instead.
%End
%TypeHeaderCode
#include "qgsrendererrange.h"
%End
public:
QgsRendererRangeLabelFormat();
QgsRendererRangeLabelFormat( const QString &format, int precision = 4, bool trimTrailingZeroes = false );
bool operator==( const QgsRendererRangeLabelFormat &other ) const;
bool operator!=( const QgsRendererRangeLabelFormat &other ) const;
QString format() const;
void setFormat( const QString &format );
int precision() const;
void setPrecision( int precision );
bool trimTrailingZeroes() const;
void setTrimTrailingZeroes( bool trimTrailingZeroes );
QString labelForRange( double lower, double upper ) const /PyName=labelForLowerUpper/;
%Docstring
%End
QString labelForRange( const QgsRendererRange &range ) const;
QString formatNumber( double value ) const;
void setFromDomElement( QDomElement &element );
void saveToDomElement( QDomElement &element );
static const int MAX_PRECISION;
static const int MIN_PRECISION;
protected:
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/symbology/qgsrendererrange.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
