Class: QgsRasterLayerElevationProperties

class qgis.core.QgsRasterLayerElevationProperties

Bases: QgsMapLayerElevationProperties

Raster layer specific subclass of QgsMapLayerElevationProperties.

New in version 3.26.

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

Methods

bandNumber

Returns the band number from which the elevation should be taken.

calculateZRange

param layer

childEvent

clone

rtype

QgsRasterLayerElevationProperties

connectNotify

copyCommonProperties

Copies common properties from another object.

customEvent

disconnectNotify

hasElevation

rtype

bool

htmlSummary

rtype

str

isEnabled

Returns True if the elevation properties are enabled, i.e. the raster layer values represent an elevation surface.

isSignalConnected

isVisibleInZRange

param range

profileFillSymbol

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

profileLineSymbol

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

profileSymbology

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

readCommonProperties

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

readXml

param element

receivers

sender

senderSignalIndex

setBandNumber

Sets the band number from which the elevation should be taken.

setEnabled

Sets whether the elevation properties are enabled, i.e. the raster layer values represent an elevation surface.

setProfileFillSymbol

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

setProfileLineSymbol

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

setProfileSymbology

Sets the symbology option used to render the raster 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

bandNumber(self) int

Returns the band number from which the elevation should be taken.

See also

setBandNumber()

Return type

int

calculateZRange(self, layer: QgsMapLayer) QgsDoubleRange
Parameters

layer (QgsMapLayer) –

Return type

QgsDoubleRange

childEvent(self, QChildEvent)
clone(self) QgsRasterLayerElevationProperties
Return type

QgsRasterLayerElevationProperties

connectNotify(self, QMetaMethod)
copyCommonProperties(self, other: QgsMapLayerElevationProperties)

Copies common properties from another object.

New in version 3.26.

customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
hasElevation(self) bool
Return type

bool

htmlSummary(self) str
Return type

str

isEnabled(self) bool

Returns True if the elevation properties are enabled, i.e. the raster layer values represent an elevation surface.

See also

setEnabled()

Return type

bool

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 raster profile in elevation profile plots.

Return type

QgsFillSymbol

profileLineSymbol(self) QgsLineSymbol

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

Return type

QgsLineSymbol

profileSymbology(self) Qgis.ProfileSurfaceSymbology

Returns the symbology option used to render the raster 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
setBandNumber(self, band: int)

Sets the band number from which the elevation should be taken.

See also

bandNumber()

Parameters

band (int) –

setEnabled(self, enabled: bool)

Sets whether the elevation properties are enabled, i.e. the raster layer values represent an elevation surface.

See also

isEnabled()

Parameters

enabled (bool) –

setProfileFillSymbol(self, symbol: QgsFillSymbol)

Sets the fill symbol used to render the raster 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 raster 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 raster 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