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 specifiedparent
object.Methods
Returns the band number from which the elevation should be taken.
- param layer
- rtype
QgsRasterLayerElevationProperties
Copies common properties from another object.
- rtype
bool
- rtype
str
Returns
True
if the elevation properties are enabled, i.e. the raster layer values represent an elevation surface.- param range
Returns the fill symbol used to render the raster profile in elevation profile plots.
Returns the line symbol used to render the raster profile in elevation profile plots.
Returns the symbology option used to render the raster profile in elevation profile plots.
Reads common class properties from a DOM
element
previously written bywriteXml()
.- param element
Sets the
band
number from which the elevation should be taken.Sets whether the elevation properties are enabled, i.e. the raster layer values represent an elevation surface.
Sets the fill
symbol
used to render the raster profile in elevation profile plots.Sets the line
symbol
used to render the raster profile in elevation profile plots.Sets the
symbology
option used to render the raster profile in elevation profile plots.- rtype
bool
Writes common class properties to a DOM
element
, to be used later withreadXml()
.- param element
- bandNumber(self) int ¶
Returns the band number from which the elevation should be taken.
See also
- Return type
int
- calculateZRange(self, layer: QgsMapLayer) QgsDoubleRange ¶
- Parameters
layer (QgsMapLayer) –
- Return type
- childEvent(self, QChildEvent)¶
- clone(self) QgsRasterLayerElevationProperties ¶
- Return type
- 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
- 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.
See also
- Return type
- profileLineSymbol(self) QgsLineSymbol ¶
Returns the line symbol used to render the raster profile in elevation profile plots.
See also
- Return type
- profileSymbology(self) Qgis.ProfileSurfaceSymbology ¶
Returns the symbology option used to render the raster profile in elevation profile plots.
See also
- Return type
- readCommonProperties(self, element: QDomElement, context: QgsReadWriteContext)¶
Reads common class properties from a DOM
element
previously written bywriteXml()
.See also
New in version 3.26.
- readXml(self, element: QDomElement, context: QgsReadWriteContext) bool ¶
- Parameters
element (QDomElement) –
context (QgsReadWriteContext) –
- 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
- 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
- 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.See also
- 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.See also
- Parameters
symbol (QgsLineSymbol) –
- setProfileSymbology(self, symbology: Qgis.ProfileSurfaceSymbology)¶
Sets the
symbology
option used to render the raster profile in elevation profile plots.See also
- 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 withreadXml()
.See also
New in version 3.26.
- writeXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) QDomElement ¶
- Parameters
element (QDomElement) –
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
QDomElement