Class: QgsHeatmapRenderer

class qgis.core.QgsHeatmapRenderer

Bases: qgis._core.QgsFeatureRenderer

A renderer which draws points as a live heatmap

New in version 2.7: Enums

Methods

clone
colorRamp Returns the color ramp used for shading the heatmap.
convertFromRenderer
convertSymbolRotation
convertSymbolSizeScale
copyRendererData
create Creates a new heatmap renderer instance from XML
dump
maximumValue Returns the maximum value used for shading the heatmap.
modifyRequestExtent
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.
setMaximumValue Sets the maximum value used for shading the heatmap.
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.
setWeightExpression Sets the expression used for weighting points when generating the heatmap.
startRender
stopRender
symbolForFeature
symbols
usedAttributes
weightExpression Returns the expression used for weighting points when generating the heatmap.

Signals

Attributes

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.
modifyRequestExtent(self, extent: QgsRectangle, context: QgsRenderContext)
radius(self) → float

Returns the radius for the heatmap

Returns:heatmap radius

See also

setRadius()

See also

radiusUnit()

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()

radiusUnit(self) → QgsUnitTypes.RenderUnit

Returns the units used for the heatmap’s radius

Returns:units for heatmap radius

See also

radius()

See also

setRadiusUnit()

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.
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()

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()

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()

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.
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.