Class: QgsProjectElevationProperties¶
- class qgis.core.QgsProjectElevationProperties¶
Bases:
PyQt5.QtCore.QObject
Contains elevation properties for a
QgsProject
.Added in version 3.26.
QgsProjectElevationProperties(parent: Optional[QObject] = None) Constructor for
QgsProjectElevationProperties
with the specifiedparent
object.Methods
Returns the fixed size for elevation range filtering in the project, used when interactively filtering by elevation.
Returns the project's elevation range, which indicates the upper and lower elevation limits associated with the project.
Returns
True
if the elevation range filter slider should be inverted for this project.Reads the property state from a DOM
element
.Resets the properties to a default state.
Resolves reference to layers from stored layer ID.
Sets the fixed size for elevation range filtering in the project, used when interactively filtering by elevation.
Sets the project's elevation
range
, which indicates the upper and lower elevation limits associated with the project.Sets whether the elevation range filter slider should be inverted for this project.
Sets the project's terrain
provider
.Returns the project's terrain provider.
Returns a DOM element representing the properties.
- changed¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...)
revision (int = ...)
arguments (Sequence = ...)
- Return type:
PYQT_SIGNAL
- childEvent(self, a0: QChildEvent | None)¶
- connectNotify(self, signal: QMetaMethod)¶
- customEvent(self, a0: QEvent | None)¶
- disconnectNotify(self, signal: QMetaMethod)¶
- elevationFilterRangeSize(self) float ¶
Returns the fixed size for elevation range filtering in the project, used when interactively filtering by elevation.
Returns -1 if no fixed elevation range size is desired.
A fixed size forces the selected elevation range to have a matching difference between the upper and lower elevation.
See also
Added in version 3.38.
- Return type:
float
- elevationRange(self) QgsDoubleRange ¶
Returns the project’s elevation range, which indicates the upper and lower elevation limits associated with the project.
Note
This is a manual, use-set property, and does not necessarily coincide with the elevation ranges for individual layers in the project.
See also
See also
Added in version 3.38.
- Return type:
- elevationRangeChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...)
revision (int = ...)
arguments (Sequence = ...)
- Return type:
PYQT_SIGNAL
- invertElevationFilter(self) bool ¶
Returns
True
if the elevation range filter slider should be inverted for this project.See also
Added in version 3.38.
- Return type:
bool
- isSignalConnected(self, signal: QMetaMethod) bool ¶
- readXml(self, element: QDomElement, context: QgsReadWriteContext) bool ¶
Reads the property state from a DOM
element
.See also
- Parameters:
element (QDomElement)
context (QgsReadWriteContext)
- Return type:
bool
- receivers(self, signal: PYQT_SIGNAL) int ¶
- reset(self)¶
Resets the properties to a default state.
- resolveReferences(self, project: QgsProject | None)¶
Resolves reference to layers from stored layer ID.
- Parameters:
project (Optional[QgsProject])
- sender(self) QObject | None ¶
- senderSignalIndex(self) int ¶
- setElevationFilterRangeSize(self, size: float)¶
Sets the fixed size for elevation range filtering in the project, used when interactively filtering by elevation.
Set to -1 if no fixed elevation range size is desired.
A fixed size forces the selected elevation range to have a matching difference between the upper and lower elevation.
See also
Added in version 3.38.
- Parameters:
size (float)
- setElevationRange(self, range: QgsDoubleRange)¶
Sets the project’s elevation
range
, which indicates the upper and lower elevation limits associated with the project.Note
This is a manual, use-set property, and does not necessarily coincide with the elevation ranges for individual layers in the project.
See also
See also
Added in version 3.38.
- Parameters:
range (QgsDoubleRange)
- setInvertElevationFilter(self, invert: bool)¶
Sets whether the elevation range filter slider should be inverted for this project.
See also
Added in version 3.38.
- Parameters:
invert (bool)
- setTerrainProvider(self, provider: QgsAbstractTerrainProvider | None)¶
Sets the project’s terrain
provider
.Ownership of
provider
is transferred to this object.See also
- Parameters:
provider (Optional[QgsAbstractTerrainProvider])
- terrainProvider(self) QgsAbstractTerrainProvider | None ¶
Returns the project’s terrain provider.
See also
- Return type:
Optional[QgsAbstractTerrainProvider]
- timerEvent(self, a0: QTimerEvent | None)¶
- writeXml(self, document: QDomDocument, context: QgsReadWriteContext) QDomElement ¶
Returns a DOM element representing the properties.
See also
- Parameters:
document (QDomDocument)
context (QgsReadWriteContext)
- Return type:
QDomElement