Class: QgsScaleRangeWidget

class qgis.gui.QgsScaleRangeWidget(parent: QWidget = None)

Bases: PyQt5.QtWidgets.QWidget

Constructor for QgsScaleRangeWidget.

A widget allowing entry of a range of map scales, e.g. minimum scale and maximum scale.

Parameters

parent

actionEvent()
changeEvent()
childEvent()
closeEvent()
connectNotify()
contextMenuEvent()
create()
customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
maximumScale(self) → float

Returns the selected maximum scale (i.e. most “zoomed in” scale), or 0 if maximum scale is not set. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also

minimumScale()

Return type

float

metric()
minimumScale(self) → float

Returns the selected minimum scale (i.e. most “zoomed out” scale), or 0 if minimum scale is not set. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also

maximumScale()

Return type

float

mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
rangeChanged

Emitted when the scale range set in the widget is changed. The scale values indicates the scale denominator, e.g. 1000.0 for a 1:1000 map, or 0 to indicate not set.

New in version 2.16: [signal]

Parameters
  • min (float) –

  • max (float) –

receivers()
reloadProjectScales(self)

Call to reload the preset scales from the current project and apply them to the 2 scales combo boxes.

resizeEvent()
sender()
senderSignalIndex()
setMapCanvas(self, canvas: QgsMapCanvas)

Sets the map canvas which will be used for the current scale buttons. If not set, the buttons are hidden.

Parameters

canvas (QgsMapCanvas) –

setMaximumScale(self, scale: float)

Set the maximum scale (i.e. most “zoomed in” scale), or 0 to indicate the minimum is not set. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also

maximumScale()

See also

setScaleRange()

Warning

Calling setMinimumScale() places a restriction on the acceptable maximum scale for the widget, and will alter any previously set maximum scale to pass this constraint. Always call setMinimumScale() before setMaximumScale() when restoring a scale range in the widget, or use the convenience method setScaleRange() instead.

Parameters

scale (float) –

setMinimumScale(self, scale: float)

Set the minimum scale (i.e. most “zoomed out” scale), or 0 to indicate the minimum is not set. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also

minimumScale()

See also

setScaleRange()

Warning

Calling setMinimumScale() places a restriction on the acceptable maximum scale for the widget, and will alter any previously set maximum scale to pass this constraint. Always call setMinimumScale() before setMaximumScale() when restoring a scale range in the widget, or use the convenience method setScaleRange() instead.

Parameters

scale (float) –

setScaleRange(self, min: float, max: float)

Sets the scale range, from min scale (i.e. most “zoomed out” scale) to max scale (most “zoomed in” scale). The scale values indicates the scale denominator, e.g. 1000.0 for a 1:1000 map, or 0 to indicate not set.

Parameters
  • min (float) –

  • max (float) –

sharedPainter()
showEvent()
tabletEvent()
timerEvent()
updateMicroFocus()
wheelEvent()