Class: QgsLayoutNorthArrowHandler¶
An object which handles north-arrow type behavior for layout items.
Added in version 3.14.
Class Hierarchy¶
Base classes¶
Methods
Returns the rotation to be used for the arrow, in degrees clockwise. |
|
Returns the linked rotation map, if set. |
|
Returns the mode used to calculate the arrow rotation. |
|
Returns the offset added to the arrows's rotation from a map's North. |
|
Sets the linked map item. |
|
Sets the mode used to calculate the arrow rotation. |
|
Sets the offset added to the arrows's rotation from a map's North. |
Signals
Emitted on arrow rotation change |
Attributes
- class qgis.core.QgsLayoutNorthArrowHandler[source]¶
Bases:
QObject
- __init__(parent: QObject | None)
Constructor for QgsLayoutNorthArrowHandler, with the specified parent
object
.- Parameters:
parent (Optional[QObject])
- GridNorth = 0¶
- class NorthMode¶
Bases:
int
- TrueNorth = 1¶
- arrowRotation(self) float [source]¶
Returns the rotation to be used for the arrow, in degrees clockwise.
- Return type:
float
- signal arrowRotationChanged(newRotation: float)[source]¶
Emitted on arrow rotation change
- Parameters:
newRotation (float)
- linkedMap(self) QgsLayoutItemMap | None [source]¶
Returns the linked rotation map, if set. An
None
means arrow calculation is disabled.See also
- Return type:
Optional[QgsLayoutItemMap]
- northMode(self) QgsLayoutNorthArrowHandler.NorthMode [source]¶
Returns the mode used to calculate the arrow rotation.
See also
See also
- Return type:
- northOffset(self) float [source]¶
Returns the offset added to the arrows’s rotation from a map’s North.
See also
See also
- Return type:
float
- setLinkedMap(self, map: QgsLayoutItemMap | None)[source]¶
Sets the linked
map
item.See also
- Parameters:
map (Optional[QgsLayoutItemMap])
- setNorthMode(self, mode: QgsLayoutNorthArrowHandler.NorthMode)[source]¶
Sets the
mode
used to calculate the arrow rotation.See also
See also
- Parameters: