Class: QgsVectorLayerElevationProperties

class qgis.core.QgsVectorLayerElevationProperties

Bases: QgsMapLayerElevationProperties

Vector layer specific subclass of QgsMapLayerElevationProperties.

New in version 3.26.

QgsVectorLayerElevationProperties(parent: QObject) Constructor for QgsVectorLayerElevationProperties, with the specified parent object.

Methods

binding	Returns the altitude binding method, which determines how altitude is bound to individual vertices in features.
calculateZRange	param layer
childEvent
clamping	Returns the altitude clamping method, which dictates how feature heights are interpreted with respect to terrain heights.
clone	rtype QgsVectorLayerElevationProperties
connectNotify
copyCommonProperties	Copies common properties from another object.
customEvent
disconnectNotify
extrusionEnabled	Returns True if extrusion is enabled.
extrusionHeight	Returns the feature extrusion height.
hasElevation	rtype bool
htmlSummary	rtype str
isSignalConnected
isVisibleInZRange	param range
profileFillSymbol	Returns the symbol used to render polygons for the layer in elevation profile plots.
profileLineSymbol	Returns the symbol used to render lines for the layer in elevation profile plots.
profileMarkerSymbol	Returns the symbol used to render points for the layer in elevation profile plots.
profileSymbology	Returns the symbology option used to render the vector profile in elevation profile plots.
readCommonProperties	Reads common class properties from a DOM element previously written by writeXml().
readXml	param element
receivers
respectLayerSymbology	Returns True if layer symbology should be respected when rendering elevation profile plots.
sender
senderSignalIndex
setBinding	Sets the altitude binding method, which determines how altitude is bound to individual vertices in features.
setClamping	Sets the altitude clamping method, which dictates how feature heights are interpreted with respect to terrain heights.
setDefaultsFromLayer	param layer
setExtrusionEnabled	Sets whether extrusion is enabled.
setExtrusionHeight	Sets the feature extrusion height.
setProfileFillSymbol	Sets the fill symbol used to render polygons for the layer in elevation profile plots.
setProfileLineSymbol	Sets the line symbol used to render lines for the layer in elevation profile plots.
setProfileMarkerSymbol	Sets the marker symbol used to render points for the layer in elevation profile plots.
setProfileSymbology	Sets the symbology option used to render the vector profile in elevation profile plots.
setRespectLayerSymbology	Sets whether layer symbology should be respected when rendering elevation profile plots.
setShowMarkerSymbolInSurfacePlots	Sets whehter the marker symbol should also be shown in continuous surface plots.
setType	Sets the type of profile the layer represents.
showByDefaultInElevationProfilePlots	rtype bool
showMarkerSymbolInSurfacePlots	Returns True if the marker symbol should also be shown in continuous surface plots.
timerEvent
type	Returns the type of profile the layer represents.
writeCommonProperties	Writes common class properties to a DOM element, to be used later with readXml().
writeXml	param element

binding(self) → Qgis.AltitudeBinding

Returns the altitude binding method, which determines how altitude is bound to individual vertices in features.

Note

Binding only relevant for line or polygon feature types – it is not applicable for point layers.

See also

setBinding()

Return type

Qgis.AltitudeBinding

calculateZRange(self, layer: QgsMapLayer) → QgsDoubleRange

Parameters

layer (QgsMapLayer) –

Return type

QgsDoubleRange

childEvent(self, QChildEvent)

clamping(self) → Qgis.AltitudeClamping

Returns the altitude clamping method, which dictates how feature heights are interpreted with respect to terrain heights.

See also

setClamping()

Return type

Qgis.AltitudeClamping

clone(self) → QgsVectorLayerElevationProperties

Return type

QgsVectorLayerElevationProperties

connectNotify(self, QMetaMethod)

copyCommonProperties(self, other: QgsMapLayerElevationProperties)

Copies common properties from another object.

New in version 3.26.

customEvent(self, QEvent)

disconnectNotify(self, QMetaMethod)

extrusionEnabled(self) → bool

Returns True if extrusion is enabled.

See also

setExtrusionEnabled()

See also

extrusionHeight()

Return type

bool

extrusionHeight(self) → float

Returns the feature extrusion height.

Warning

extrusion is only applied if extrusionEnabled() is True.

Note

the zScale() factor is NOT applied to extrusion heights.

See also

setExtrusionHeight()

Return type

float

hasElevation(self) → bool

Return type

bool

htmlSummary(self) → str

Return type

str

isSignalConnected(self, QMetaMethod) → bool

isVisibleInZRange(self, range: QgsDoubleRange) → bool

Parameters

range (QgsDoubleRange) –

Return type

bool

profileFillSymbol(self) → QgsFillSymbol

Returns the symbol used to render polygons for the layer in elevation profile plots.

The symbol will be used in the following circumstances:

• A polygon feature is intersected by a profile line and extrusionEnabled() is True

See also

setProfileFillSymbol()

Return type

QgsFillSymbol

profileLineSymbol(self) → QgsLineSymbol

Returns the symbol used to render lines for the layer in elevation profile plots.

The symbol will be used in the following circumstances:

• A point feature is shown on the profile chart when extrusionEnabled() is True

• A line feature is intersected by a profile line and extrusionEnabled() is True

• A polygon feature is intersected by a profile line and extrusionEnabled() is False

See also

setProfileLineSymbol()

Return type

QgsLineSymbol

profileMarkerSymbol(self) → QgsMarkerSymbol

Returns the symbol used to render points for the layer in elevation profile plots.

The symbol will be used in the following circumstances:

• A point feature is shown on the profile chart when extrusionEnabled() is False

• A line feature is intersected by a profile line and extrusionEnabled() is False

See also

setProfileMarkerSymbol()

Return type

QgsMarkerSymbol

profileSymbology(self) → Qgis.ProfileSurfaceSymbology

Returns the symbology option used to render the vector profile in elevation profile plots.

Note

This setting is only used when type() is Qgis.VectorProfileType.ContinuousSurface.

See also

setProfileSymbology()

Return type

Qgis.ProfileSurfaceSymbology

readCommonProperties(self, element: QDomElement, context: QgsReadWriteContext)

Reads common class properties from a DOM element previously written by writeXml().

See also

writeCommonProperties()

New in version 3.26.

readXml(self, element: QDomElement, context: QgsReadWriteContext) → bool

Parameters

• element (QDomElement) –

• context (QgsReadWriteContext) –

Return type

bool

receivers(self, PYQT_SIGNAL) → int

respectLayerSymbology(self) → bool

Returns True if layer symbology should be respected when rendering elevation profile plots.

Specifically, this will result in the layer’s symbols (or symbol colors) being used to draw features in the profile plots.

See also

setRespectLayerSymbology()

Return type

bool

sender(self) → QObject

senderSignalIndex(self) → int

setBinding(self, binding: Qgis.AltitudeBinding)

Sets the altitude binding method, which determines how altitude is bound to individual vertices in features.

Note

Binding only relevant for line or polygon feature types – it is not applicable for point layers.

See also

binding()

Parameters

binding (Qgis.AltitudeBinding) –

setClamping(self, clamping: Qgis.AltitudeClamping)

Sets the altitude clamping method, which dictates how feature heights are interpreted with respect to terrain heights.

See also

clamping()

Parameters

clamping (Qgis.AltitudeClamping) –

setDefaultsFromLayer(self, layer: QgsMapLayer)

Parameters

layer (QgsMapLayer) –

setExtrusionEnabled(self, enabled: bool)

Sets whether extrusion is enabled.

See also

extrusionEnabled()

See also

setExtrusionHeight()

Parameters

enabled (bool) –

setExtrusionHeight(self, height: float)

Sets the feature extrusion height.

Warning

extrusion is only applied if extrusionEnabled() is True.

Note

the zScale() factor is NOT applied to extrusion heights.

See also

extrusionHeight()

Parameters

height (float) –

setProfileFillSymbol(self, symbol: QgsFillSymbol)

Sets the fill symbol used to render polygons for the layer in elevation profile plots.

Ownership of symbol is transferred to the plot.

The symbol will be used in the following circumstances:

• A polygon feature is intersected by a profile line and extrusionEnabled() is True

See also

profileFillSymbol()

Parameters

symbol (QgsFillSymbol) –

setProfileLineSymbol(self, symbol: QgsLineSymbol)

Sets the line symbol used to render lines for the layer in elevation profile plots.

Ownership of symbol is transferred to the plot.

The symbol will be used in the following circumstances:

• A point feature is shown on the profile chart when extrusionEnabled() is True

• A line feature is intersected by a profile line and extrusionEnabled() is True

• A polygon feature is intersected by a profile line and extrusionEnabled() is False

See also

profileLineSymbol()

Parameters

symbol (QgsLineSymbol) –

setProfileMarkerSymbol(self, symbol: QgsMarkerSymbol)

Sets the marker symbol used to render points for the layer in elevation profile plots.

Ownership of symbol is transferred to the plot.

The symbol will be used in the following circumstances:

• A point feature is shown on the profile chart when extrusionEnabled() is False

• A line feature is intersected by a profile line and extrusionEnabled() is False

See also

profileMarkerSymbol()

Parameters

symbol (QgsMarkerSymbol) –

setProfileSymbology(self, symbology: Qgis.ProfileSurfaceSymbology)

Sets the symbology option used to render the vector profile in elevation profile plots.

Note

This setting is only used when type() is Qgis.VectorProfileType.ContinuousSurface.

See also

setProfileSymbology()

Parameters

symbology (Qgis.ProfileSurfaceSymbology) –

setRespectLayerSymbology(self, enabled: bool)

Sets whether layer symbology should be respected when rendering elevation profile plots.

Specifically, this will result in the layer’s symbols (or symbol colors) being used to draw features in the profile plots.

See also

respectLayerSymbology()

Parameters

enabled (bool) –

setShowMarkerSymbolInSurfacePlots(self, show: bool)

Sets whehter the marker symbol should also be shown in continuous surface plots.

Note

This setting is only used when type() is Qgis.VectorProfileType.ContinuousSurface.

See also

showMarkerSymbolInSurfacePlots()

Parameters

show (bool) –

setType(self, type: Qgis.VectorProfileType)

Sets the type of profile the layer represents.

See also

type()

Parameters

type (Qgis.VectorProfileType) –

showByDefaultInElevationProfilePlots(self) → bool

Return type

bool

showMarkerSymbolInSurfacePlots(self) → bool

Returns True if the marker symbol should also be shown in continuous surface plots.

Note

This setting is only used when type() is Qgis.VectorProfileType.ContinuousSurface.

See also

setShowMarkerSymbolInSurfacePlots()

Return type

bool

timerEvent(self, QTimerEvent)

type(self) → Qgis.VectorProfileType

Returns the type of profile the layer represents.

See also

setType()

Return type

Qgis.VectorProfileType

writeCommonProperties(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext)

Writes common class properties to a DOM element, to be used later with readXml().

See also

readCommonProperties()

New in version 3.26.

writeXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement

Parameters

• element (QDomElement) –

• doc (QDomDocument) –

• context (QgsReadWriteContext) –

Return type

QDomElement