Class: QgsLayoutGridSettings

Contains settings relating to the appearance, spacing and offset for layout grids.

Class Hierarchy

Base classes

QgsLayoutSerializableObject	An interface for layout objects which can be stored and read from DOM elements.
QgsLayoutUndoObjectInterface	Interface for layout objects which support undo/redo commands.

Methods

loadFromSettings	Loads grid settings from the application layout settings.
offset	Returns the offset of the page/snap grid.
pen	Returns the pen used for drawing page/snap grids.
readXml	Sets the grid's state from a DOM element.
resolution	Returns the page/snap grid resolution.
setOffset	Sets the offset of the page/snap grid.
setPen	Sets the pen used for drawing page/snap grids.
setResolution	Sets the page/snap grid resolution.
setStyle	Sets the style used for drawing the page/snap grids.
style	Returns the style used for drawing the page/snap grids.
writeXml	Stores the grid's state in a DOM element.

Attributes

StyleCrosses
StyleDots
StyleLines

class qgis.core.QgsLayoutGridSettings

Bases: QgsLayoutSerializableObject

__init__(layout: QgsLayout | None)

Constructor for QgsLayoutGridSettings.

Parameters:

layout (Optional[QgsLayout])

__init__(a0: QgsLayoutGridSettings)

Parameters:

a0 (QgsLayoutGridSettings)

class Style

Bases: int

StyleCrosses = 2

StyleDots = 1

StyleLines = 0

loadFromSettings(self)

Loads grid settings from the application layout settings.

offset(self) → QgsLayoutPoint

Returns the offset of the page/snap grid.

See also

setOffset()

See also

resolution()

Return type:

QgsLayoutPoint

pen(self) → QPen

Returns the pen used for drawing page/snap grids.

See also

setPen()

See also

style()

Return type:

QPen

readXml(self, gridElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool

Sets the grid’s state from a DOM element. gridElement is the DOM node corresponding to the grid.

See also

writeXml()

Parameters:

• gridElement (QDomElement)

• document (QDomDocument)

• context (QgsReadWriteContext)

Return type:

bool

resolution(self) → QgsLayoutMeasurement

Returns the page/snap grid resolution.

See also

setResolution()

See also

offset()

Return type:

QgsLayoutMeasurement

setOffset(self, offset: QgsLayoutPoint)

Sets the offset of the page/snap grid.

See also

offset()

See also

setResolution()

Parameters:

offset (QgsLayoutPoint)

setPen(self, pen: QPen | QColor | Qt.GlobalColor)

Sets the pen used for drawing page/snap grids.

See also

pen()

See also

setStyle()

Parameters:

pen (Union[QPen, Union[QColor, Qt.GlobalColor]])

setResolution(self, resolution: QgsLayoutMeasurement)

Sets the page/snap grid resolution.

See also

resolution()

See also

setOffset()

Parameters:

resolution (QgsLayoutMeasurement)

setStyle(self, style: QgsLayoutGridSettings.Style)

Sets the style used for drawing the page/snap grids.

See also

style()

See also

setPen()

Parameters:

style (QgsLayoutGridSettings.Style)

style(self) → QgsLayoutGridSettings.Style

Returns the style used for drawing the page/snap grids.

See also

setStyle()

See also

pen()

Return type:

QgsLayoutGridSettings.Style

writeXml(self, parentElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext) → bool

Stores the grid’s state in a DOM element. The parentElement should refer to the parent layout’s DOM element.

See also

readXml()

Parameters:

• parentElement (QDomElement)

• document (QDomDocument)

• context (QgsReadWriteContext)

Return type:

bool