Class: QgsLayoutItemMapGridStack

class qgis.core.QgsLayoutItemMapGridStack

Bases: QgsLayoutItemMapItemStack

A collection of grids which is drawn above the map content in a QgsLayoutItemMap. The grid stack controls which grids are drawn and the order they are drawn in.

New in version 3.0.

QgsLayoutItemMapGridStack(map: QgsLayoutItemMap) Constructor for QgsLayoutItemMapGridStack, attached to the specified map.

QgsLayoutItemMapGridStack(QgsLayoutItemMapGridStack)

Methods

addGrid

Adds a new map grid to the stack and takes ownership of the grid.

asList

Returns a list of QgsLayoutItemMapGrids contained by the stack.

calculateMaxGridExtension

Calculates the maximum distance grids within the stack extend beyond the QgsLayoutItemMap's item rect.

grid

Returns a reference to a grid with matching gridId within the stack.

maxGridExtension

Calculates the maximum distance grids within the stack extend beyond the QgsLayoutItemMap's item rect.

moveGridDown

Moves a grid with matching gridId down the stack, causing it to be rendered below other grids.

moveGridUp

Moves a grid with matching gridId up the stack, causing it to be rendered above other grids.

readXml

param elem

removeGrid

Removes a grid with matching gridId from the stack and deletes the corresponding QgsLayoutItemMapGrid.

addGrid(self, grid: QgsLayoutItemMapGrid)

Adds a new map grid to the stack and takes ownership of the grid. The grid will be added to the end of the stack, and rendered above any existing map grids already present in the stack.

Note

After adding a grid to the stack, updateBoundingRect() and update() should be called for the QgsLayoutItemMap to prevent rendering artifacts.

See also

removeGrid()

Parameters

grid (QgsLayoutItemMapGrid) –

asList(self) List[QgsLayoutItemMapGrid]

Returns a list of QgsLayoutItemMapGrids contained by the stack.

Return type

List[QgsLayoutItemMapGrid]

calculateMaxGridExtension(self) Tuple[float, float, float, float]

Calculates the maximum distance grids within the stack extend beyond the QgsLayoutItemMap’s item rect. This method calculates the distance for each side of the map item separately.

Return type

Tuple[float, float, float, float]

grid(self, gridId: str) QgsLayoutItemMapGrid

Returns a reference to a grid with matching gridId within the stack.

grid(self, index: int) -> QgsLayoutItemMapGrid Returns a reference to a grid at the specified index within the stack.

Parameters

gridId (str) –

Return type

QgsLayoutItemMapGrid

maxGridExtension(self) float

Calculates the maximum distance grids within the stack extend beyond the QgsLayoutItemMap’s item rect.

Return type

float

moveGridDown(self, gridId: str)

Moves a grid with matching gridId down the stack, causing it to be rendered below other grids.

Note

After moving a grid within the stack, update() should be called for the QgsLayoutItemMap to redraw the map with the new grid stack order.

See also

moveGridUp()

Parameters

gridId (str) –

moveGridUp(self, gridId: str)

Moves a grid with matching gridId up the stack, causing it to be rendered above other grids.

Note

After moving a grid within the stack, update() should be called for the QgsLayoutItemMap to redraw the map with the new grid stack order.

See also

moveGridDown()

Parameters

gridId (str) –

readXml(self, elem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) bool
Parameters
Return type

bool

removeGrid(self, gridId: str)

Removes a grid with matching gridId from the stack and deletes the corresponding QgsLayoutItemMapGrid.

Note

After removing a grid from the stack, updateBoundingRect() and update() should be called for the QgsLayoutItemMap to prevent rendering artifacts.

See also

addGrid()

Parameters

gridId (str) –