Class: QgsMeshLayerElevationProperties

class qgis.core.QgsMeshLayerElevationProperties

Bases: QgsMapLayerElevationProperties

Mesh layer specific subclass of QgsMapLayerElevationProperties.

New in version 3.26.

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

Methods

calculateZRange

param layer:

childEvent

clone

rtype:

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.

hasElevation

rtype:

bool

htmlSummary

rtype:

str

isSignalConnected

isVisibleInZRange

param range:

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.

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

timerEvent

writeCommonProperties

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

writeXml

param element:

calculateZRange(self, layer: QgsMapLayer) QgsDoubleRange
Parameters:

layer (QgsMapLayer) –

Return type:

QgsDoubleRange

childEvent(self, QChildEvent)
clone(self) QgsMeshLayerElevationProperties
Return type:

QgsMeshLayerElevationProperties

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

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 fill symbol used to render the mesh profile in elevation profile plots.

Return type:

QgsFillSymbol

profileLineSymbol(self) QgsLineSymbol

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

Return type:

QgsLineSymbol

profileSymbology(self) Qgis.ProfileSurfaceSymbology

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

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
sender(self) QObject
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()

New in version 3.32.

Parameters:

limit (float) –

setProfileFillSymbol(self, symbol: QgsFillSymbol)

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

Ownership of symbol is transferred to the plot.

Parameters:

symbol (QgsFillSymbol) –

setProfileLineSymbol(self, symbol: QgsLineSymbol)

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

Ownership of symbol is transferred to the plot.

Parameters:

symbol (QgsLineSymbol) –

setProfileSymbology(self, symbology: Qgis.ProfileSurfaceSymbology)

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

Parameters:

symbology (Qgis.ProfileSurfaceSymbology) –

showByDefaultInElevationProfilePlots(self) bool
Return type:

bool

timerEvent(self, QTimerEvent)
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