Class: QgsElevationControllerWidget

A widget for configuring vertical elevation slicing behavior for maps.

Added in version 3.38.

Class Hierarchy

Inheritance diagram of qgis.gui.QgsElevationControllerWidget

Base classes

QWidget

QObject

QPaintDevice

class qgis.gui.QgsElevationControllerWidget[source]

Bases: QWidget

__init__(parent: QWidget | None = None)

Constructor for QgsElevationControllerWidget, with the specified parent widget.

Parameters:

parent (Optional[QWidget] = None)

fixedRangeSize(self) float[source]

Returns the fixed range size, or -1 if no fixed size is set.

A fixed size forces the selected elevation range to have a matching difference between the upper and lower elevation.

Return type:

float

signal fixedRangeSizeChanged[source]

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.

signal invertedChanged[source]

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.

menu(self) QMenu | None[source]

Returns a reference to the widget’s configuration menu, which can be used to add actions to the menu.

Return type:

Optional[QMenu]

range(self) QgsDoubleRange[source]

Returns the current visible range from the widget.

See also

setRange()

See also

rangeChanged()

Return type:

QgsDoubleRange

signal rangeChanged[source]

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.

rangeLimits(self) QgsDoubleRange[source]

Returns the limits of the elevation range which can be selected by the widget.

See also

rangeLimits()

Return type:

QgsDoubleRange

setFixedRangeSize(self, size: float)[source]

Sets the fixed range size. Set to -1 if no fixed size is desired.

A fixed size forces the selected elevation range to have a matching difference between the upper and lower elevation.

See also

fixedRangeSize()

Parameters:

size (float)

setInverted(self, inverted: bool)[source]

Sets whether the elevation slider should be inverted.

Parameters:

inverted (bool)

setRange(self, range: QgsDoubleRange)[source]

Sets the current visible range for the widget.

See also

range()

See also

rangeChanged()

Parameters:

range (QgsDoubleRange)

setRangeLimits(self, limits: QgsDoubleRange)[source]

Sets the limits of the elevation range which can be selected by the widget.

See also

rangeLimits()

Parameters:

limits (QgsDoubleRange)

setSignificantElevations(self, elevations: Iterable[float])[source]

Sets a list of significant elevations to highlight in the widget.

Parameters:

elevations (Iterable[float])

slider(self) QgsRangeSlider | None[source]

Returns a reference to the slider component of the widget.

Return type:

Optional[QgsRangeSlider]