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

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

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.

Return type: float

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

Return type: float

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

Return type: str

sender()¶

senderSignalIndex()¶

setMapCanvas(self, canvas: QgsMapCanvas)¶

Set the map canvas associated to the current button.

Parameters: canvas (QgsMapCanvas) –

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.

Parameters: scale (float) –

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

Parameters: scale (float) –

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

Parameters: string (str) –
Return type: bool

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

showCurrentScaleButton()

See also

setMapCanvas()

Parameters: showCurrentScaleButton (bool) –

sharedPainter()¶

showCurrentScaleButton(self) → bool¶

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

See also

setShowCurrentScaleButton()

Return type: bool

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

Parameters: scaleString (str) –
Return type: Tuple[float, bool]

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

Parameters: scale (float) –
Return type: str

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”.

Parameters: scales (Iterable[str] = []) –

wheelEvent()¶