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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/symbology/qgsheatmaprenderer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsHeatmapRenderer : QgsFeatureRenderer
{
%Docstring(signature="appended")
A renderer which draws points as a live heatmap
%End
%TypeHeaderCode
#include "qgsheatmaprenderer.h"
%End
public:
QgsHeatmapRenderer();
~QgsHeatmapRenderer();
virtual QgsHeatmapRenderer *clone() const /Factory/;
virtual void startRender( QgsRenderContext &context, const QgsFields &fields );
virtual bool renderFeature( const QgsFeature &feature, QgsRenderContext &context, int layer = -1, bool selected = false, bool drawVertexMarker = false ) throw( QgsCsException );
virtual void stopRender( QgsRenderContext &context );
virtual QgsSymbol *symbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const;
%Docstring
.. note::
symbolForFeature2 in Python bindings
%End
virtual QgsSymbolList symbols( QgsRenderContext &context ) const;
%Docstring
.. note::
symbol2 in Python bindings
%End
virtual QString dump() const;
virtual QSet<QString> usedAttributes( const QgsRenderContext &context ) const;
static QgsFeatureRenderer *create( QDomElement &element, const QgsReadWriteContext &context ) /Factory/;
%Docstring
Creates a new heatmap renderer instance from XML
%End
virtual QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context );
static QgsHeatmapRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) /Factory/;
virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;
virtual QList<QgsLayerTreeModelLegendNode *> createLegendNodes( QgsLayerTreeLayer *nodeLayer ) const /Factory/;
virtual void modifyRequestExtent( QgsRectangle &extent, QgsRenderContext &context );
QgsColorRamp *colorRamp() const;
%Docstring
Returns the color ramp used for shading the heatmap.
:return: color ramp for heatmap
.. seealso:: :py:func:`setColorRamp`
%End
void setColorRamp( QgsColorRamp *ramp /Transfer/ );
%Docstring
Sets the color ramp to use for shading the heatmap.
:param ramp: color ramp for heatmap. Ownership of ramp is transferred to
the renderer.
.. seealso:: :py:func:`colorRamp`
%End
const QgsColorRampLegendNodeSettings &legendSettings() const;
%Docstring
Returns the color ramp legend settings.
.. seealso:: :py:func:`setLegendSettings`
.. versionadded:: 3.38
%End
void setLegendSettings( const QgsColorRampLegendNodeSettings &settings );
%Docstring
Sets the color ramp legend ``settings``.
.. seealso:: :py:func:`legendSettings`
.. versionadded:: 3.38
%End
double radius() const;
%Docstring
Returns the radius for the heatmap
:return: heatmap radius
.. seealso:: :py:func:`setRadius`
.. seealso:: :py:func:`radiusUnit`
.. seealso:: :py:func:`radiusMapUnitScale`
%End
void setRadius( const double radius );
%Docstring
Sets the radius for the heatmap
:param radius: heatmap radius
.. seealso:: :py:func:`radius`
.. seealso:: :py:func:`setRadiusUnit`
.. seealso:: :py:func:`setRadiusMapUnitScale`
%End
Qgis::RenderUnit radiusUnit() const;
%Docstring
Returns the units used for the heatmap's radius
:return: units for heatmap radius
.. seealso:: :py:func:`radius`
.. seealso:: :py:func:`setRadiusUnit`
.. seealso:: :py:func:`radiusMapUnitScale`
%End
void setRadiusUnit( const Qgis::RenderUnit unit );
%Docstring
Sets the units used for the heatmap's radius
:param unit: units for heatmap radius
.. seealso:: :py:func:`radiusUnit`
.. seealso:: :py:func:`setRadius`
.. seealso:: :py:func:`radiusMapUnitScale`
%End
const QgsMapUnitScale &radiusMapUnitScale() const;
%Docstring
Returns the map unit scale used for the heatmap's radius
:return: map unit scale for heatmap's radius
.. seealso:: :py:func:`radius`
.. seealso:: :py:func:`radiusUnit`
.. seealso:: :py:func:`setRadiusMapUnitScale`
%End
void setRadiusMapUnitScale( const QgsMapUnitScale &scale );
%Docstring
Sets the map unit scale used for the heatmap's radius
:param scale: map unit scale for heatmap's radius
.. seealso:: :py:func:`setRadius`
.. seealso:: :py:func:`setRadiusUnit`
.. seealso:: :py:func:`radiusMapUnitScale`
%End
double maximumValue() const;
%Docstring
Returns the maximum value used for shading the heatmap.
:return: maximum value for heatmap shading. If 0, then maximum value
will be automatically calculated.
.. seealso:: :py:func:`setMaximumValue`
%End
void setMaximumValue( const double value );
%Docstring
Sets the maximum value used for shading the heatmap.
:param value: maximum value for heatmap shading. Set to 0 for automatic
calculation of maximum value.
.. seealso:: :py:func:`maximumValue`
%End
double renderQuality() const;
%Docstring
Returns the render quality used for drawing the heatmap.
:return: render quality. A value of 1 indicates maximum quality, and
increasing the value will result in faster drawing but lower
quality rendering.
.. seealso:: :py:func:`setRenderQuality`
%End
void setRenderQuality( const int quality );
%Docstring
Sets the render quality used for drawing the heatmap.
:param quality: render quality. A value of 1 indicates maximum quality,
and increasing the value will result in faster drawing
but lower quality rendering.
.. seealso:: :py:func:`renderQuality`
%End
QString weightExpression() const;
%Docstring
Returns the expression used for weighting points when generating the
heatmap.
:return: point weight expression. If empty, all points are equally
weighted.
.. seealso:: :py:func:`setWeightExpression`
%End
void setWeightExpression( const QString &expression );
%Docstring
Sets the expression used for weighting points when generating the
heatmap.
:param expression: point weight expression. If set to empty, all points
are equally weighted.
.. seealso:: :py:func:`weightExpression`
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/symbology/qgsheatmaprenderer.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
