Class: QgsScaleWidget

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

Bases: PyQt5.QtWidgets.QWidget

QgsScaleWidget creates a combobox which lets the user select map scale from predefined list and highlights nearest to current scale value

A combobox which lets the user select map scale from predefined list and highlights nearest to current scale value

Enums

Methods

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

metric

minScale

Returns the minimum scale, or 0 if no minimum scale set.

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

paintEvent

receivers

resizeEvent

scale

Returns the selected scale as a double.

scaleString

Returns the selected scale as a string, e.g.

sender

senderSignalIndex

setMapCanvas

Set the map canvas associated to the current button.

setMinScale

Set the minimum allowed scale.

setScale

Set the selected scale from a double.

setScaleFromCanvas

Assigns the current scale from the map canvas, if set.

setScaleString

Set the selected scale from a string, e.g.

setShowCurrentScaleButton

Sets whether to show a button to set the scale to the current scale of the map canvas next to the combobox.

sharedPainter

showCurrentScaleButton

Returns whether a button to set the scale from map canvas is shown or not.

showEvent

tabletEvent

timerEvent

toDouble

Helper function to convert a scale string to double.

toString

Helper function to convert a scale double to scale string.

updateMicroFocus

updateScales

Sets the list of predefined scales to show in the combobox.

wheelEvent

Signals

scaleChanged

Emitted when user has finished editing/selecting a new scale.

Attributes

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()
metric()
minScale(self) → float

Returns the minimum scale, or 0 if no minimum scale set. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. Any scale lower than the minimum scale will automatically be converted to the minimum scale. Except for 0 which is always allowed.

mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
receivers()
resizeEvent()
scale(self) → float

Returns the selected scale as a double. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also

setScale()

scaleChanged

Emitted when user has finished editing/selecting a new scale. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. [signal]

scaleString(self) → str

Returns the selected scale as a string, e.g. “1:150”.

See also

setScaleString()

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

Set the map canvas associated to the current button.

setMinScale(self, scale: float)

Set the minimum allowed scale. Set to 0 to disable the minimum scale. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. Any scale lower than the minimum scale will automatically be converted to the minimum scale. Except for 0 which is always allowed.

setScale(self, scale: float)

Set the selected scale from a double. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also

scale()

setScaleFromCanvas(self)

Assigns the current scale from the map canvas, if set.

See also

setMapCanvas()

setScaleString(self, string: str) → bool

Set the selected scale from a string, e.g. “1:150”.

See also

scaleString()

setShowCurrentScaleButton(self, showCurrentScaleButton: bool)

Sets whether to show a button to set the scale to the current scale of the map canvas next to the combobox.

Note

the map canvas must be defined to show the button

See also

setMapCanvas()

sharedPainter()
showCurrentScaleButton(self) → bool

Returns whether a button to set the scale from map canvas is shown or not.

showEvent()
tabletEvent()
timerEvent()
toDouble(scaleString: str) → Tuple[float, bool]

Helper function to convert a scale string to double. The returned value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. If specified, ok will be set to true if the string was successfully interpreted as a scale.

See also

toString()

toString(scale: float) → str

Helper function to convert a scale double to scale string. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

The returned string will be rounded (e.g. 1:1000, not 1:1000.345).

See also

toDouble()

updateMicroFocus()
updateScales(self, scales: Iterable[str] = [])

Sets the list of predefined scales to show in the combobox. List elements are expected to be valid scale strings, such as “1:1000000”.

wheelEvent()