Class: QgsVectorLayerElevationProperties

Vector layer specific subclass of QgsMapLayerElevationProperties.

Added in version 3.26.

Class Hierarchy

Base classes

QgsMapLayerElevationProperties	Base class for storage of map layer elevation properties.
QObject

Methods

binding	Returns the altitude binding method, which determines how altitude is bound to individual vertices in features.
clamping	Returns the altitude clamping method, which dictates how feature heights are interpreted with respect to terrain heights.
customTolerance	Returns the feature custom tolerance.
customToleranceEnabled	Returns True if custom tolerance is enabled.
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.
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.
respectLayerSymbology	Returns True if layer symbology should be respected when rendering elevation profile plots.
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.
setCustomTolerance	Sets the feature custom tolerance.
setCustomToleranceEnabled	Sets whether custom tolerance is enabled.
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.
showMarkerSymbolInSurfacePlots	Returns True if the marker symbol should also be shown in continuous surface plots.
type	Returns the type of profile the layer represents.

class qgis.core.QgsVectorLayerElevationProperties

Bases: QgsMapLayerElevationProperties

__init__(parent: QObject | None)

Constructor for QgsVectorLayerElevationProperties, with the specified parent object.

Parameters:

parent (Optional[QObject])

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

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

customTolerance(self) → float

Returns the feature custom tolerance.

Warning

custom tolerance is only applied if customToleranceEnabled() is True.

If enabled, the profile generator will use this tolerance instead of the one defined in the elevation profile widget.

See also

setCustomTolerance()

Return type:

float

customToleranceEnabled(self) → bool

Returns True if custom tolerance is enabled.

See also

setCustomToleranceEnabled()

See also

customTolerance()

Return type:

bool

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.

See also

setElevationLimit()

Added in version 3.32.

Return type:

float

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

profileFillSymbol(self) → QgsFillSymbol | None

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:

Optional[QgsFillSymbol]

profileLineSymbol(self) → QgsLineSymbol | None

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:

Optional[QgsLineSymbol]

profileMarkerSymbol(self) → QgsMarkerSymbol | None

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:

Optional[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

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

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)

setCustomTolerance(self, tolerance: float)

Sets the feature custom tolerance.

Warning

custom tolerance is only applied if customToleranceEnabled() is True.

If enabled, the profile generator will use this tolerance instead of the one defined in the elevation profile widget.

See also

customTolerance()

Parameters:

tolerance (float)

setCustomToleranceEnabled(self, enabled: bool)

Sets whether custom tolerance is enabled.

See also

customToleranceEnabled()

See also

setCustomTolerance()

Parameters:

enabled (bool)

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

Added in version 3.32.

Parameters:

limit (float)

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

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 (Optional[QgsFillSymbol])

setProfileLineSymbol(self, symbol: QgsLineSymbol | None)

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 (Optional[QgsLineSymbol])

setProfileMarkerSymbol(self, symbol: QgsMarkerSymbol | None)

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 (Optional[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 whether 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)

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

type(self) → Qgis.VectorProfileType

Returns the type of profile the layer represents.

See also

setType()

Return type:

Qgis.VectorProfileType