Subgroup: other

Class: QgsHeatmapRenderer¶

class qgis.core.QgsHeatmapRenderer¶

Bases: qgis._core.QgsFeatureRenderer

A renderer which draws points as a live heatmap

New in version 2.7: Methods

`capabilities`	Returns details about internals of this renderer.
`checkLegendSymbolItem`	item in symbology was checked
`clone`
`colorRamp`	Returns the color ramp used for shading the heatmap.
`convertFromRenderer`
`convertSymbolRotation`
`convertSymbolSizeScale`
`copyRendererData`
`create`	Creates a new heatmap renderer instance from XML
`defaultRenderer`	return a new renderer - used by default in vector layers
`dump`
`embeddedRenderer`	Returns the current embedded renderer (subrenderer) for this feature renderer.
`filter`	If a renderer does not require all the features this method may be overridden and return an expression used as where clause.
`filterNeedsGeometry`	Returns true if this renderer requires the geometry to apply the filter.
`forceRasterRender`	Returns whether the renderer must render as a raster.
`legendClassificationAttribute`	If supported by the renderer, return classification attribute for the use in legend
`legendKeysForFeature`	Return legend keys matching a specified feature.
`legendSymbolItemChecked`	items of symbology items in legend is checked
`legendSymbolItems`	Returns a list of symbology items for the legend
`legendSymbolItemsCheckable`	items of symbology items in legend should be checkable
`load`	create a renderer from XML element
`loadSld`	Create a new renderer according to the information contained in
`maximumValue`	Returns the maximum value used for shading the heatmap.
`modifyRequestExtent`
`orderBy`	Get the order in which features shall be processed by this renderer.
`orderByEnabled`	Returns whether custom ordering will be applied before features are processed by this renderer.
`originalSymbolForFeature`	Return symbol for feature.
`originalSymbolsForFeature`	Equivalent of originalSymbolsForFeature() call
`paintEffect`	Returns the current paint effect for the renderer.
`radius`	Returns the radius for the heatmap
`radiusMapUnitScale`	Returns the map unit scale used for the heatmap’s radius
`radiusUnit`	Returns the units used for the heatmap’s radius
`renderFeature`
`renderFeatureWithSymbol`
`renderQuality`	Returns the render quality used for drawing the heatmap.
`renderVertexMarker`
`renderVertexMarkerPolygon`
`renderVertexMarkerPolyline`
`save`
`setColorRamp`	Sets the color ramp to use for shading the heatmap.
`setEmbeddedRenderer`	Sets an embedded renderer (subrenderer) for this feature renderer.
`setForceRasterRender`	Sets whether the renderer should be rendered to a raster destination.
`setLegendSymbolItem`	Sets the symbol to be used for a legend symbol item.
`setMaximumValue`	Sets the maximum value used for shading the heatmap.
`setOrderBy`	Define the order in which features shall be processed by this renderer.
`setOrderByEnabled`	Sets whether custom ordering should be applied before features are processed by this renderer.
`setPaintEffect`	Sets the current paint effect for the renderer.
`setRadius`	Sets the radius for the heatmap
`setRadiusMapUnitScale`	Sets the map unit scale used for the heatmap’s radius
`setRadiusUnit`	Sets the units used for the heatmap’s radius
`setRenderQuality`	Sets the render quality used for drawing the heatmap.
`setUsingSymbolLevels`
`setVertexMarkerAppearance`	set type and size of editing vertex markers for subsequent rendering
`setWeightExpression`	Sets the expression used for weighting points when generating the heatmap.
`startRender`
`stopRender`
`symbolForFeature`
`symbols`
`symbolsForFeature`	Returns list of symbols used for rendering the feature.
`toSld`	used from subclasses to create SLD Rule elements following SLD v1.1 specs
`type`
`usedAttributes`
`usingSymbolLevels`
`weightExpression`	Returns the expression used for weighting points when generating the heatmap.
`willRenderFeature`	Returns whether the renderer will render a feature or not.
`writeSld`	create the SLD UserStyle element following the SLD v1.1 specs with the given name

Attributes

`Filter`
`MoreSymbolsPerFeature`
`ScaleDependent`
`SymbolLevels`

clone(self) → QgsHeatmapRenderer¶

colorRamp(self) → QgsColorRamp¶

Returns the color ramp used for shading the heatmap.

Returns:	color ramp for heatmap

See also

setColorRamp()

convertFromRenderer(renderer: QgsFeatureRenderer) → QgsHeatmapRenderer¶

convertSymbolRotation()¶

convertSymbolSizeScale()¶

copyRendererData()¶

create(element: QDomElement, context: QgsReadWriteContext) → QgsFeatureRenderer¶: Creates a new heatmap renderer instance from XML

dump(self) → str¶

maximumValue(self) → float¶

Returns the maximum value used for shading the heatmap.

Returns:	maximum value for heatmap shading. If 0, then maximum value will be automatically

calculated.

See also

setMaximumValue()

modifyRequestExtent(self, extent: QgsRectangle, context: QgsRenderContext)¶

radius(self) → float¶

Returns the radius for the heatmap

Returns:	heatmap radius

See also

setRadius()

See also

radiusUnit()

See also

radiusMapUnitScale()

radiusMapUnitScale(self) → QgsMapUnitScale¶

Returns the map unit scale used for the heatmap’s radius

Returns:	map unit scale for heatmap’s radius

See also

radius()

See also

radiusUnit()

See also

setRadiusMapUnitScale()

radiusUnit(self) → QgsUnitTypes.RenderUnit¶

Returns the units used for the heatmap’s radius

Returns:	units for heatmap radius

See also

radius()

See also

setRadiusUnit()

See also

radiusMapUnitScale()

renderFeature(self, feature: QgsFeature, context: QgsRenderContext, layer: int = -1, selected: bool = False, drawVertexMarker: bool = False) → bool¶

renderFeatureWithSymbol()¶

renderQuality(self) → float¶

Returns the render quality used for drawing the heatmap.

Returns:	render quality. A value of 1 indicates maximum quality, and increasing the

value will result in faster drawing but lower quality rendering.

See also

setRenderQuality()

renderVertexMarker()¶

renderVertexMarkerPolygon()¶

renderVertexMarkerPolyline()¶

save(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement¶

setColorRamp(self, ramp: QgsColorRamp)¶

Sets the color ramp to use for shading the heatmap.

Parameters:	ramp – color ramp for heatmap. Ownership of ramp is transferred to the renderer.

See also

colorRamp()

setMaximumValue(self, value: float)¶

Sets the maximum value used for shading the heatmap.

Parameters:	value – maximum value for heatmap shading. Set to 0 for automatic calculation of

maximum value.

See also

maximumValue()

setRadius(self, radius: float)¶

Sets the radius for the heatmap

Parameters:	radius – heatmap radius

See also

radius()

See also

setRadiusUnit()

See also

setRadiusMapUnitScale()

setRadiusMapUnitScale(self, scale: QgsMapUnitScale)¶

Sets the map unit scale used for the heatmap’s radius

Parameters:	scale – map unit scale for heatmap’s radius

See also

setRadius()

See also

setRadiusUnit()

See also

radiusMapUnitScale()

setRadiusUnit(self, unit: QgsUnitTypes.RenderUnit)¶

Sets the units used for the heatmap’s radius

Parameters:	unit – units for heatmap radius

See also

radiusUnit()

See also

setRadius()

See also

radiusMapUnitScale()

setRenderQuality(self, quality: int)¶

Sets the render quality used for drawing the heatmap.

Parameters:	quality – render quality. A value of 1 indicates maximum quality, and increasing the

value will result in faster drawing but lower quality rendering.

See also

renderQuality()

setWeightExpression(self, expression: str)¶

Sets the expression used for weighting points when generating the heatmap.

Parameters:	expression – point weight expression. If set to empty, all points are equally weighted.

See also

weightExpression()

startRender(self, context: QgsRenderContext, fields: QgsFields)¶

stopRender(self, context: QgsRenderContext)¶

symbolForFeature(self, feature: QgsFeature, context: QgsRenderContext) → QgsSymbol¶: Note

symbolForFeature2 in Python bindings

symbols(self, context: QgsRenderContext) → object¶: Note

symbol2 in Python bindings

usedAttributes(self, context: QgsRenderContext) → Set[str]¶

weightExpression(self) → str¶

Returns the expression used for weighting points when generating the heatmap.

Returns:	point weight expression. If empty, all points are equally weighted.

See also

setWeightExpression()