Class: QgsElevationControllerWidget¶

A widget for configuring vertical elevation slicing behavior for maps.

Added in version 3.38.

List of all members, including inherited members

Class Hierarchy¶

Base classes¶

QWidget
QObject
QPaintDevice

Constructor

__init__

Methods

`fixedRangeSize`	Returns the fixed range size, or -1 if no fixed size is set.
`mapCanvas`	Returns the map canvas the widget takes its layers from.
`menu`	Returns a reference to the widget's configuration menu, which can be used to add actions to the menu.
`range`	Returns the current visible range from the widget.
`rangeLimits`	Returns the limits of the elevation range which can be selected by the widget.
`setFixedRangeSize`	Sets the fixed range size.
`setInverted`	Sets whether the elevation slider should be inverted.
`setMapCanvas`	Sets the map canvas the widget takes its layers from.
`setRange`	Sets the current visible range for the widget.
`setRangeLimits`	Sets the limits of the elevation range which can be selected by the widget.
`setSignificantElevations`	Sets a list of significant elevations to highlight in the widget.
`slider`	Returns a reference to the slider component of the widget.

Signals

`fixedRangeSizeChanged`	Emitted when the fixed range size is changed from the widget.
`invertedChanged`	Emitted when the elevation filter slider is inverted.
`rangeChanged`	Emitted when the visible range from the widget is changed.

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.

See also

setFixedRangeSize()

Return type:: float

signal fixedRangeSizeChanged(size: float)[source]¶

Emitted when the fixed range size is changed from the widget.

See also

fixedRangeSize()

See also

setFixedRangeSize()

Parameters:: size (float)

signal invertedChanged(inverted: bool)[source]¶

Emitted when the elevation filter slider is inverted.

See also

setInverted()

Parameters:: inverted (bool)

mapCanvas(self) → QgsMapCanvas | None[source]¶

Returns the map canvas the widget takes its layers from.

See also

setMapCanvas()

Added in version 4.4.

Return type:: Optional[QgsMapCanvas]

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(range: QgsDoubleRange)[source]¶

Emitted when the visible range from the widget is changed.

See also

setRange()

See also

range()

Parameters:: range (QgsDoubleRange)

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()

See also

fixedRangeSizeChanged

Parameters:: size (float)

setInverted(self, inverted: bool)[source]¶

Sets whether the elevation slider should be inverted.

See also

invertedChanged

Parameters:: inverted (bool)

setMapCanvas(self, canvas: QgsMapCanvas | None)[source]¶

Sets the map canvas the widget takes its layers from.

The canvas provides the layer used by the “Current Layer” entry of the range limits button, and its layers give the initial limits when the project defines no elevation range of its own.

See also

mapCanvas()

Added in version 4.4.