Class: QgsMeshLayerElevationProperties¶

class qgis.core.QgsMeshLayerElevationProperties¶

Bases: QgsMapLayerElevationProperties

Mesh layer specific subclass of QgsMapLayerElevationProperties.

Added in version 3.26.

QgsMeshLayerElevationProperties(parent: Optional[QObject]) Constructor for QgsMeshLayerElevationProperties, with the specified parent object.

Methods

calculateZRange

param layer:

childEvent

clone

rtype:

Optional[QgsMeshLayerElevationProperties]

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.

fixedRange

Returns the fixed elevation range for the mesh.

fixedRangePerGroup

Returns the fixed elevation range for each group.

flags

rtype:

QgsMapLayerElevationProperties.Flags

hasElevation

rtype:

bool

htmlSummary

rtype:

str

isSignalConnected

isVisibleInZRange

param range:

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.

readCommonProperties

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

readXml

param element:

receivers

sender

senderSignalIndex

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.

showByDefaultInElevationProfilePlots

rtype:

bool

significantZValues

param layer:

timerEvent

writeCommonProperties

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

writeXml

param element:

calculateZRange(self, layer: QgsMapLayer | None) → QgsDoubleRange¶

Parameters:: layer (Optional[QgsMapLayer])
Return type:: QgsDoubleRange

childEvent(self, a0: QChildEvent | None)¶

clone(self) → QgsMeshLayerElevationProperties | None¶

Return type:: Optional[QgsMeshLayerElevationProperties]

connectNotify(self, signal: QMetaMethod)¶

copyCommonProperties(self, other: QgsMapLayerElevationProperties | None)¶: Copies common properties from another object.

Added in version 3.26.

customEvent(self, a0: QEvent | None)¶

disconnectNotify(self, signal: 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.

See also

setElevationLimit()

Added in version 3.32.

Return type:: float

fixedRange(self) → QgsDoubleRange¶

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]

flags(self) → QgsMapLayerElevationProperties.Flags¶

Return type:: QgsMapLayerElevationProperties.Flags

hasElevation(self) → bool¶

Return type:: bool

htmlSummary(self) → str¶

Return type:: str

isSignalConnected(self, signal: QMetaMethod) → bool¶

isVisibleInZRange(self, range: QgsDoubleRange, layer: QgsMapLayer | None = None) → bool¶

Parameters:

range (QgsDoubleRange)
layer (Optional[QgsMapLayer] = None)

Return type:

bool

mode(self) → Qgis.MeshElevationMode¶

Returns the elevation mode.

See also

setMode()

Added in version 3.38.

Return type:: Qgis.MeshElevationMode

profileFillSymbol(self) → QgsFillSymbol | None¶

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¶

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¶

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

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

Added in version 3.26.

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

Parameters:

element (QDomElement)
context (QgsReadWriteContext)

Return type:

bool

receivers(self, signal: PYQT_SIGNAL) → int¶

sender(self) → QObject | None¶

senderSignalIndex(self) → int¶

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)

setFixedRange(self, range: QgsDoubleRange)¶

Sets 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

fixedRange()

Added in version 3.38.

Parameters:: range (QgsDoubleRange)

setFixedRangePerGroup(self, ranges: Dict[int, QgsDoubleRange])¶

Sets 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

fixedRangePerGroup()

Added in version 3.38.

Parameters:: ranges (Dict[int)

setMode(self, mode: Qgis.MeshElevationMode)¶

Sets the elevation mode.

See also

mode()

Added in version 3.38.

Parameters:: mode (Qgis.MeshElevationMode)

setProfileFillSymbol(self, symbol: QgsFillSymbol | None)¶

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

Ownership of symbol is transferred to the plot.

See also

profileFillSymbol()

Parameters:: symbol (Optional[QgsFillSymbol])

setProfileLineSymbol(self, symbol: QgsLineSymbol | None)¶

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

Ownership of symbol is transferred to the plot.

See also

profileLineSymbol()

Parameters:: symbol (Optional[QgsLineSymbol])

setProfileSymbology(self, symbology: Qgis.ProfileSurfaceSymbology)¶

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

See also

setProfileSymbology()

Parameters:: symbology (Qgis.ProfileSurfaceSymbology)

showByDefaultInElevationProfilePlots(self) → bool¶

Return type:: bool

significantZValues(self, layer: QgsMapLayer | None) → List[float]¶

Parameters:: layer (Optional[QgsMapLayer])
Return type:: List[float]

timerEvent(self, a0: QTimerEvent | None)¶

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

Added in version 3.26.

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

Parameters:

element (QDomElement)
doc (QDomDocument)
context (QgsReadWriteContext)

Return type:

QDomElement