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

elevationLimit

Returns the elevation limit, which is used when profileSymbology() is Qgis.ProfileSurfaceSymbology.FillBelow or Qgis.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation range.

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:

setElevationLimit

Sets the elevation limit, which is used when profileSymbology() is Qgis.ProfileSurfaceSymbology.FillBelow or Qgis.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation range.

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 whether 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)
elevationLimit(self) float

Returns the elevation limit, which is used when profileSymbology() is Qgis.ProfileSurfaceSymbology.FillBelow or Qgis.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation range.

By default this is NaN, which indicates that there is no elevation limit.

New in version 3.32.

Return type:

float

extrusionEnabled(self) bool

Returns True if extrusion is enabled.

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.

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:

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:

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:

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.

Return type:

Qgis.ProfileSurfaceSymbology

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

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

New in version 3.26.

readXml(self, element: QDomElement, context: QgsReadWriteContext) bool
Parameters:
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.

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

setElevationLimit(self, limit: float)

Sets the elevation limit, which is used when profileSymbology() is Qgis.ProfileSurfaceSymbology.FillBelow or Qgis.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation range.

Set to NaN to indicate that there is no elevation limit.

See also

elevationLimit()

New in version 3.32.

Parameters:

limit (float) –

setExtrusionEnabled(self, enabled: bool)

Sets whether extrusion is enabled.

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.

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:

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:

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:

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.

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.

Parameters:

enabled (bool) –

setShowMarkerSymbolInSurfacePlots(self, show: bool)

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

Note

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

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.

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

New in version 3.26.

writeXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) QDomElement
Parameters:
Return type:

QDomElement