Class: QgsMeshLayerElevationProperties¶

Mesh 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

`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.
`fixedRange`	Returns the fixed elevation range for the mesh.
`fixedRangePerGroup`	Returns the fixed elevation range for each group.
`mode`	Returns the elevation mode.
`profileFillSymbol`	Returns the fill symbol used to render the mesh profile in elevation profile plots.
`profileLineSymbol`	Returns the line symbol used to render the mesh profile in elevation profile plots.
`profileSymbology`	Returns the symbology option used to render the mesh profile in elevation profile plots.
`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.
`setFixedRange`	Sets the fixed elevation range for the mesh.
`setFixedRangePerGroup`	Sets the fixed elevation range for each group.
`setMode`	Sets the elevation mode.
`setProfileFillSymbol`	Sets the fill symbol used to render the mesh profile in elevation profile plots.
`setProfileLineSymbol`	Sets the line symbol used to render the mesh profile in elevation profile plots.
`setProfileSymbology`	Sets the symbology option used to render the mesh profile in elevation profile plots.

class qgis.core.QgsMeshLayerElevationProperties[source]¶

Bases: QgsMapLayerElevationProperties

__init__(parent: QObject | None)

Constructor for QgsMeshLayerElevationProperties, with the specified parent object.

Parameters:: parent (Optional[QObject])

elevationLimit(self) → float[source]¶

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

fixedRange(self) → QgsDoubleRange[source]¶

Returns the fixed elevation range for the mesh.

Note

This is only considered when mode() is Qgis.MeshElevationMode.FixedElevationRange.

Note

When a fixed range is set any zOffset() and zScale() is ignored.

See also

setFixedRange()

Added in version 3.38.

Return type:: QgsDoubleRange

fixedRangePerGroup(self) → Dict[int, QgsDoubleRange]¶

Returns the fixed elevation range for each group.

Note

This is only considered when mode() is Qgis.MeshElevationMode.FixedRangePerGroup.

Note

When a fixed range is set any zOffset() and zScale() is ignored.

See also

setFixedRangePerGroup()

Added in version 3.38.

Return type:: Dict[int, QgsDoubleRange]

mode(self) → Qgis.MeshElevationMode[source]¶

Returns the elevation mode.

See also

setMode()

Added in version 3.38.

Return type:: Qgis.MeshElevationMode

profileFillSymbol(self) → QgsFillSymbol | None[source]¶

Returns the fill symbol used to render the mesh profile in elevation profile plots.

See also

setProfileFillSymbol()

Return type:: Optional[QgsFillSymbol]

profileLineSymbol(self) → QgsLineSymbol | None[source]¶

Returns the line symbol used to render the mesh profile in elevation profile plots.

See also

setProfileLineSymbol()

Return type:: Optional[QgsLineSymbol]

profileSymbology(self) → Qgis.ProfileSurfaceSymbology[source]¶

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

See also

setProfileSymbology()

Return type:: Qgis.ProfileSurfaceSymbology

setElevationLimit(self, limit: float)[source]¶

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.