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 specifiedparent
object.Methods
- param layer:
- rtype:
QgsMeshLayerElevationProperties
Copies common properties from another object.
Returns the elevation limit, which is used when
profileSymbology()
isQgis
.ProfileSurfaceSymbology.FillBelow orQgis
.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation range.- rtype:
bool
- rtype:
str
- param range:
Returns the fill symbol used to render the mesh profile in elevation profile plots.
Returns the line symbol used to render the mesh profile in elevation profile plots.
Returns the symbology option used to render the mesh profile in elevation profile plots.
Reads common class properties from a DOM
element
previously written bywriteXml()
.- param element:
Sets the elevation
limit
, which is used whenprofileSymbology()
isQgis
.ProfileSurfaceSymbology.FillBelow orQgis
.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation range.Sets the fill
symbol
used to render the mesh profile in elevation profile plots.Sets the line
symbol
used to render the mesh profile in elevation profile plots.Sets the
symbology
option used to render the mesh profile in elevation profile plots.- rtype:
bool
Writes common class properties to a DOM
element
, to be used later withreadXml()
.- param element:
- calculateZRange(self, layer: QgsMapLayer) QgsDoubleRange ¶
- Parameters:
layer (QgsMapLayer) –
- Return type:
- childEvent(self, QChildEvent)¶
- clone(self) QgsMeshLayerElevationProperties ¶
- 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)¶
- elevationLimit(self) float ¶
Returns the elevation limit, which is used when
profileSymbology()
isQgis
.ProfileSurfaceSymbology.FillBelow orQgis
.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
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.
See also
- Return type:
- profileLineSymbol(self) QgsLineSymbol ¶
Returns the line symbol used to render the mesh profile in elevation profile plots.
See also
- Return type:
- profileSymbology(self) Qgis.ProfileSurfaceSymbology ¶
Returns the symbology option used to render the mesh 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 ¶
- setElevationLimit(self, limit: float)¶
Sets the elevation
limit
, which is used whenprofileSymbology()
isQgis
.ProfileSurfaceSymbology.FillBelow orQgis
.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation range.Set to NaN to indicate that there is no elevation limit.
See also
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.See also
- 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.See also
- Parameters:
symbol (QgsLineSymbol) –
- setProfileSymbology(self, symbology: Qgis.ProfileSurfaceSymbology)¶
Sets the
symbology
option used to render the mesh 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