Class: QgsVectorLayerElevationProperties¶
- class qgis.core.QgsVectorLayerElevationProperties¶
Bases:
QgsMapLayerElevationProperties
Vector layer specific subclass of
QgsMapLayerElevationProperties
.New in version 3.26.
QgsVectorLayerElevationProperties(parent: QObject) Constructor for
QgsVectorLayerElevationProperties
, with the specifiedparent
object.Methods
Returns the altitude binding method, which determines how altitude is bound to individual vertices in features.
- param layer:
Returns the altitude clamping method, which dictates how feature heights are interpreted with respect to terrain heights.
- rtype:
QgsVectorLayerElevationProperties
Copies common properties from another object.
Returns
True
if extrusion is enabled.Returns the feature extrusion height.
- rtype:
bool
- rtype:
str
- param range:
Returns the symbol used to render polygons for the layer in elevation profile plots.
Returns the symbol used to render lines for the layer in elevation profile plots.
Returns the symbol used to render points for the layer in elevation profile plots.
Returns the symbology option used to render the vector profile in elevation profile plots.
Reads common class properties from a DOM
element
previously written bywriteXml()
.- param element:
Returns
True
if layer symbology should be respected when rendering elevation profile plots.Sets the altitude
binding
method, which determines how altitude is bound to individual vertices in features.Sets the altitude
clamping
method, which dictates how feature heights are interpreted with respect to terrain heights.- param layer:
Sets whether extrusion is
enabled
.Sets the feature extrusion height.
Sets the fill
symbol
used to render polygons for the layer in elevation profile plots.Sets the line
symbol
used to render lines for the layer in elevation profile plots.Sets the marker
symbol
used to render points for the layer in elevation profile plots.Sets the
symbology
option used to render the vector profile in elevation profile plots.Sets whether layer symbology should be respected when rendering elevation profile plots.
Sets whehter the marker symbol should also be shown in continuous surface plots.
Sets the
type
of profile the layer represents.- rtype:
bool
Returns
True
if the marker symbol should also be shown in continuous surface plots.Returns the type of profile the layer represents.
Writes common class properties to a DOM
element
, to be used later withreadXml()
.- param element:
- binding(self) Qgis.AltitudeBinding ¶
Returns the altitude binding method, which determines how altitude is bound to individual vertices in features.
Note
Binding only relevant for line or polygon feature types – it is not applicable for point layers.
See also
- Return type:
- calculateZRange(self, layer: QgsMapLayer) QgsDoubleRange ¶
- Parameters:
layer (QgsMapLayer) –
- Return type:
- childEvent(self, QChildEvent)¶
- clamping(self) Qgis.AltitudeClamping ¶
Returns the altitude clamping method, which dictates how feature heights are interpreted with respect to terrain heights.
See also
- Return type:
- clone(self) QgsVectorLayerElevationProperties ¶
- 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)¶
- extrusionEnabled(self) bool ¶
Returns
True
if extrusion is enabled.See also
See also
- Return type:
bool
- extrusionHeight(self) float ¶
Returns the feature extrusion height.
Warning
extrusion is only applied if
extrusionEnabled()
isTrue
.Note
the
zScale()
factor is NOT applied to extrusion heights.See also
- 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 symbol used to render polygons for the layer in elevation profile plots.
The symbol will be used in the following circumstances:
A polygon feature is intersected by a profile line and
extrusionEnabled()
isTrue
See also
- Return type:
- profileLineSymbol(self) QgsLineSymbol ¶
Returns the symbol used to render lines for the layer in elevation profile plots.
The symbol will be used in the following circumstances:
A point feature is shown on the profile chart when
extrusionEnabled()
isTrue
A line feature is intersected by a profile line and
extrusionEnabled()
isTrue
A polygon feature is intersected by a profile line and
extrusionEnabled()
isFalse
See also
- Return type:
- profileMarkerSymbol(self) QgsMarkerSymbol ¶
Returns the symbol used to render points for the layer in elevation profile plots.
The symbol will be used in the following circumstances:
A point feature is shown on the profile chart when
extrusionEnabled()
isFalse
A line feature is intersected by a profile line and
extrusionEnabled()
isFalse
See also
- Return type:
- profileSymbology(self) Qgis.ProfileSurfaceSymbology ¶
Returns the symbology option used to render the vector profile in elevation profile plots.
Note
This setting is only used when
type()
is Qgis.VectorProfileType.ContinuousSurface.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 ¶
- respectLayerSymbology(self) bool ¶
Returns
True
if layer symbology should be respected when rendering elevation profile plots.Specifically, this will result in the layer’s symbols (or symbol colors) being used to draw features in the profile plots.
See also
- Return type:
bool
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setBinding(self, binding: Qgis.AltitudeBinding)¶
Sets the altitude
binding
method, which determines how altitude is bound to individual vertices in features.Note
Binding only relevant for line or polygon feature types – it is not applicable for point layers.
See also
- Parameters:
binding (Qgis.AltitudeBinding) –
- setClamping(self, clamping: Qgis.AltitudeClamping)¶
Sets the altitude
clamping
method, which dictates how feature heights are interpreted with respect to terrain heights.See also
- Parameters:
clamping (Qgis.AltitudeClamping) –
- setDefaultsFromLayer(self, layer: QgsMapLayer)¶
- Parameters:
layer (QgsMapLayer) –
- setExtrusionEnabled(self, enabled: bool)¶
Sets whether extrusion is
enabled
.See also
See also
- Parameters:
enabled (bool) –
- setExtrusionHeight(self, height: float)¶
Sets the feature extrusion height.
Warning
extrusion is only applied if
extrusionEnabled()
isTrue
.Note
the
zScale()
factor is NOT applied to extrusion heights.See also
- Parameters:
height (float) –
- setProfileFillSymbol(self, symbol: QgsFillSymbol)¶
Sets the fill
symbol
used to render polygons for the layer in elevation profile plots.Ownership of
symbol
is transferred to the plot.The symbol will be used in the following circumstances:
A polygon feature is intersected by a profile line and
extrusionEnabled()
isTrue
See also
- Parameters:
symbol (QgsFillSymbol) –
- setProfileLineSymbol(self, symbol: QgsLineSymbol)¶
Sets the line
symbol
used to render lines for the layer in elevation profile plots.Ownership of
symbol
is transferred to the plot.The symbol will be used in the following circumstances:
A point feature is shown on the profile chart when
extrusionEnabled()
isTrue
A line feature is intersected by a profile line and
extrusionEnabled()
isTrue
A polygon feature is intersected by a profile line and
extrusionEnabled()
isFalse
See also
- Parameters:
symbol (QgsLineSymbol) –
- setProfileMarkerSymbol(self, symbol: QgsMarkerSymbol)¶
Sets the marker
symbol
used to render points for the layer in elevation profile plots.Ownership of
symbol
is transferred to the plot.The symbol will be used in the following circumstances:
A point feature is shown on the profile chart when
extrusionEnabled()
isFalse
A line feature is intersected by a profile line and
extrusionEnabled()
isFalse
See also
- Parameters:
symbol (QgsMarkerSymbol) –
- setProfileSymbology(self, symbology: Qgis.ProfileSurfaceSymbology)¶
Sets the
symbology
option used to render the vector profile in elevation profile plots.Note
This setting is only used when
type()
is Qgis.VectorProfileType.ContinuousSurface.See also
- Parameters:
symbology (Qgis.ProfileSurfaceSymbology) –
- setRespectLayerSymbology(self, enabled: bool)¶
Sets whether layer symbology should be respected when rendering elevation profile plots.
Specifically, this will result in the layer’s symbols (or symbol colors) being used to draw features in the profile plots.
See also
- Parameters:
enabled (bool) –
- setShowMarkerSymbolInSurfacePlots(self, show: bool)¶
Sets whehter the marker symbol should also be shown in continuous surface plots.
Note
This setting is only used when
type()
is Qgis.VectorProfileType.ContinuousSurface.See also
- Parameters:
show (bool) –
- setType(self, type: Qgis.VectorProfileType)¶
Sets the
type
of profile the layer represents.See also
- Parameters:
type (Qgis.VectorProfileType) –
- showByDefaultInElevationProfilePlots(self) bool ¶
- Return type:
bool
- showMarkerSymbolInSurfacePlots(self) bool ¶
Returns
True
if the marker symbol should also be shown in continuous surface plots.Note
This setting is only used when
type()
is Qgis.VectorProfileType.ContinuousSurface.See also
- Return type:
bool
- timerEvent(self, QTimerEvent)¶
- type(self) Qgis.VectorProfileType ¶
Returns the type of profile the layer represents.
See also
- Return type:
- 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