Class: QgsLayoutItemMapGrid¶

class qgis.core.QgsLayoutItemMapGrid(name: str, map: QgsLayoutItemMap)¶

Bases: qgis._core.QgsLayoutItemMapItem

Constructor for QgsLayoutItemMapGrid.

Parameters

name – friendly display name for grid
map – QgsLayoutItemMap the grid is attached to

An individual grid which is drawn above the map content in a QgsLayoutItemMap.

See also

QgsLayoutItemMapGridStack

New in version 3.0: Enums

Methods

`annotationDirection`	Returns the direction for drawing frame annotations, on the specified `side` of the map.
`annotationDisplay`	Returns the display mode for the grid annotations on a specified side of the map frame.
`annotationEnabled`	Returns whether annotations are shown for the grid.
`annotationExpression`	Returns the expression used for drawing grid annotations.
`annotationFont`	Returns the font used for drawing grid annotations.
`annotationFontColor`	Returns the font color used for drawing grid annotations.
`annotationFormat`	Returns the format for drawing grid annotations.
`annotationFrameDistance`	Returns the distance between the map frame and annotations.
`annotationPosition`	Returns the position for the grid annotations on a specified `side` of the map frame.
`annotationPrecision`	Returns the coordinate precision for grid annotations, which is the number of decimal places shown when drawing grid annotations.
`blendMode`	Retrieves the blending mode used for drawing the grid.
`calculateMaxExtension`	Calculates the maximum distance the grid extends beyond the QgsLayoutItemMap’s item rect.
`childEvent`
`connectNotify`
`createExpressionContext`
`crossLength`	Retrieves the length (in layout units) of the cross segments drawn for the grid.
`crs`	Retrieves the CRS for the grid.
`customEvent`
`disconnectNotify`
`draw`
`frameDivisions`	Returns the type of grid divisions which are used for frames on a specified `side` of the map.
`frameFillColor1`	Retrieves the first fill color for the grid frame.
`frameFillColor2`	Retrieves the second fill color for the grid frame.
`frameMargin`	Sets the grid frame Margin (in layout units).
`framePenColor`	Retrieves the color of the stroke drawn in the grid frame.
`framePenSize`	Retrieves the width of the stroke drawn in the grid frame.
`frameSideFlags`	Returns the flags which control which sides of the map item the grid frame is drawn on.
`frameStyle`	Returns the grid frame style.
`frameWidth`	Gets the grid frame width in layout units.
`intervalX`	Returns the interval between grid lines in the x-direction.
`intervalY`	Returns the interval between grid lines in the y-direction.
`isSignalConnected`
`lineSymbol`	Returns the line symbol used for drawing grid lines.
`markerSymbol`	Returns the marker symbol used for drawing grid points.
`maxExtension`	Calculates the maximum distance the grid extends beyond the QgsLayoutItemMap’s item rect (in layout units).
`offsetX`	Returns the offset for grid lines in the x-direction.
`offsetY`	Returns the offset for grid lines in the y-direction.
`readObjectPropertiesFromElement`
`readXml`
`receivers`
`sender`
`senderSignalIndex`
`setAnnotationDirection`	Sets the `direction` for drawing frame annotations for the specified map `side`.
`setAnnotationDisplay`	Sets what types of grid annotations should be drawn for a specified side of the map frame, or whether grid annotations should be disabled for the side.
`setAnnotationEnabled`	Sets whether annotations should be shown for the grid.
`setAnnotationExpression`	Sets the `expression` used for drawing grid annotations.
`setAnnotationFont`	Sets the `font` used for drawing grid annotations.
`setAnnotationFontColor`	Sets the font `color` used for drawing grid annotations.
`setAnnotationFormat`	Sets the `format` for drawing grid annotations.
`setAnnotationFrameDistance`	Sets the `distance` between the map frame and annotations.
`setAnnotationPosition`	Sets the `position` for the grid annotations on a specified `side` of the map frame.
`setAnnotationPrecision`	Sets the coordinate `precision` for grid annotations.
`setBlendMode`	Sets the blending `mode` used for drawing the grid.
`setCrossLength`	Sets the `length` (in layout units) of the cross segments drawn for the grid.
`setCrs`	Sets the `crs` for the grid.
`setFrameDivisions`	Sets what type of grid `divisions` should be used for frames on a specified `side` of the map.
`setFrameFillColor1`	Sets the first fill `color` used for the grid frame.
`setFrameFillColor2`	Sets the second fill `color` used for the grid frame.
`setFrameMargin`	Sets the grid frame margin (in layout units).
`setFramePenColor`	Sets the `color` of the stroke drawn in the grid frame.
`setFramePenSize`	Sets the `width` of the stroke drawn in the grid frame.
`setFrameSideFlag`	Sets whether the grid frame is drawn for a certain side of the map item.
`setFrameSideFlags`	Sets `flags` for grid frame sides.
`setFrameStyle`	Sets the grid frame `style`.
`setFrameWidth`	Sets the grid frame `width` (in layout units).
`setGridLineColor`	Sets the `color` of grid lines.
`setGridLineWidth`	Sets the `width` of grid lines (in layout units).
`setIntervalX`	Sets the `interval` between grid lines in the x-direction.
`setIntervalY`	Sets the `interval` between grid lines in the y-direction.
`setLineSymbol`	Sets the line `symbol` used for drawing grid lines.
`setMarkerSymbol`	Sets the marker `symbol` used for drawing grid points.
`setOffsetX`	Sets the `offset` for grid lines in the x-direction.
`setOffsetY`	Sets the `offset` for grid lines in the y-direction.
`setStyle`	Sets the grid `style`, which controls how the grid is drawn over the map’s contents.
`setUnits`	Sets the `unit` to use for grid measurements such as the interval and offset for grid lines.
`style`	Returns the grid’s style, which controls how the grid is drawn over the map’s contents.
`testFrameSideFlag`	Tests whether the grid frame should be drawn on a specified side of the map item.
`timerEvent`
`units`	Returns the units used for grid measurements such as the interval and offset for grid lines.
`usesAdvancedEffects`
`writeObjectPropertiesToElement`
`writeXml`

Signals

Attributes

class AnnotationCoordinate¶: Bases: int

class AnnotationDirection¶: Bases: int

class AnnotationFormat¶: Bases: int

class AnnotationPosition¶: Bases: int

class BorderSide¶: Bases: int

Bottom = 2¶

BoundaryDirection = 3¶

CM = 2¶

Cross = 1¶

CustomFormat = 8¶

Decimal = 0¶

DecimalWithSuffix = 3¶

DegreeMinute = 1¶

DegreeMinuteNoSuffix = 4¶

DegreeMinutePadded = 5¶

DegreeMinuteSecond = 2¶

DegreeMinuteSecondNoSuffix = 6¶

DegreeMinuteSecondPadded = 7¶

class DisplayMode¶: Bases: int

ExteriorTicks = 3¶

FrameAnnotationsOnly = 3¶

FrameBottom = 8¶

FrameLeft = 1¶

FrameRight = 2¶

class FrameSideFlag¶: Bases: int

class FrameSideFlags¶

Bases: sip.wrapper

QgsLayoutItemMapGrid.FrameSideFlags(Union[QgsLayoutItemMapGrid.FrameSideFlags, QgsLayoutItemMapGrid.FrameSideFlag]) QgsLayoutItemMapGrid.FrameSideFlags(QgsLayoutItemMapGrid.FrameSideFlags)

class FrameStyle¶: Bases: int

FrameTop = 4¶

class GridStyle¶: Bases: int

class GridUnit¶: Bases: int

HideAll = 3¶

Horizontal = 0¶

InsideMapFrame = 0¶

InteriorExteriorTicks = 4¶

InteriorTicks = 2¶

Latitude = 1¶

LatitudeOnly = 1¶

Left = 0¶

LineBorder = 5¶

LineBorderNautical = 6¶

Longitude = 0¶

LongitudeOnly = 2¶

MM = 1¶

MapUnit = 0¶

Markers = 2¶

NoFrame = 0¶

OutsideMapFrame = 1¶

Right = 1¶

ShowAll = 0¶

Solid = 0¶

Top = 3¶

Vertical = 1¶

VerticalDescending = 2¶

Zebra = 1¶

ZebraNautical = 7¶

annotationDirection(self, border: QgsLayoutItemMapGrid.BorderSide) → QgsLayoutItemMapGrid.AnnotationDirection¶: Returns the direction for drawing frame annotations, on the specified side of the map.

See also

setAnnotationDirection()

annotationDisplay(self, border: QgsLayoutItemMapGrid.BorderSide) → QgsLayoutItemMapGrid.DisplayMode¶

Returns the display mode for the grid annotations on a specified side of the map frame. This property also specifies whether annotations have been disabled from a side of the map frame.

Parameters: border – side of map for annotations
Returns: display mode for grid annotations

See also

setAnnotationDisplay()

annotationEnabled(self) → bool¶: Returns whether annotations are shown for the grid.

See also

setAnnotationEnabled()

annotationExpression(self) → str¶: Returns the expression used for drawing grid annotations. This is only used when annotationFormat() is QgsLayoutItemMapGrid.CustomFormat.

See also

setAnnotationExpression()

annotationFont(self) → QFont¶: Returns the font used for drawing grid annotations.

See also

setAnnotationFont()

annotationFontColor(self) → QColor¶: Returns the font color used for drawing grid annotations.

See also

setAnnotationFontColor()

annotationFormat(self) → QgsLayoutItemMapGrid.AnnotationFormat¶: Returns the format for drawing grid annotations.

See also

setAnnotationFormat()

annotationFrameDistance(self) → float¶: Returns the distance between the map frame and annotations. Units are in layout units.

See also

setAnnotationFrameDistance()

annotationPosition(self, side: QgsLayoutItemMapGrid.BorderSide) → QgsLayoutItemMapGrid.AnnotationPosition¶: Returns the position for the grid annotations on a specified side of the map frame.

See also

setAnnotationPosition()

annotationPrecision(self) → int¶: Returns the coordinate precision for grid annotations, which is the number of decimal places shown when drawing grid annotations.

See also

setAnnotationPrecision()

blendMode(self) → QPainter.CompositionMode¶: Retrieves the blending mode used for drawing the grid.

See also

setBlendMode()

calculateMaxExtension(self) → Tuple[float, float, float, float]¶: Calculates the maximum distance the grid extends beyond the QgsLayoutItemMap’s item rect. This method calculates the distance for each side of the map item separately.

See also

maxExtension()

childEvent()¶

connectNotify()¶

createExpressionContext(self) → QgsExpressionContext¶

crossLength(self) → float¶: Retrieves the length (in layout units) of the cross segments drawn for the grid. This is only used for grids with QgsLayoutItemMapGrid.Cross styles.

See also

setCrossLength()

crs(self) → QgsCoordinateReferenceSystem¶: Retrieves the CRS for the grid.

See also

setCrs()

customEvent()¶

disconnectNotify()¶

draw(self, painter: QPainter)¶

frameDivisions(self, side: QgsLayoutItemMapGrid.BorderSide) → QgsLayoutItemMapGrid.DisplayMode¶: Returns the type of grid divisions which are used for frames on a specified side of the map.

See also

setFrameDivisions()

frameFillColor1(self) → QColor¶: Retrieves the first fill color for the grid frame.

See also

setFrameFillColor1()

See also

framePenColor()

See also

frameFillColor2()

frameFillColor2(self) → QColor¶: Retrieves the second fill color for the grid frame.

See also

setFrameFillColor2()

See also

framePenColor()

See also

frameFillColor1()

frameMargin(self) → float¶: Sets the grid frame Margin (in layout units). This property controls distance between the map frame and the grid frame.

See also

setFrameMargin()

New in version 3.6.

framePenColor(self) → QColor¶: Retrieves the color of the stroke drawn in the grid frame.

See also

setFramePenColor()

See also

framePenSize()

See also

frameFillColor1()

See also

frameFillColor2()

framePenSize(self) → float¶: Retrieves the width of the stroke drawn in the grid frame.

See also

setFramePenSize()

See also

framePenColor()

frameSideFlags(self) → QgsLayoutItemMapGrid.FrameSideFlags¶: Returns the flags which control which sides of the map item the grid frame is drawn on.

See also

setFrameSideFlags()

See also

setFrameSideFlag()

See also

testFrameSideFlag()

frameStyle(self) → QgsLayoutItemMapGrid.FrameStyle¶: Returns the grid frame style.

See also

setFrameStyle()

frameWidth(self) → float¶: Gets the grid frame width in layout units. This property controls how wide the grid frame is. The size of the line outlines drawn in the frame can be retrieved via the framePenSize method.

See also

setFrameWidth()

intervalX(self) → float¶: Returns the interval between grid lines in the x-direction. The units are retrieved through the units() method.

See also

setIntervalX()

See also

intervalY()

intervalY(self) → float¶: Returns the interval between grid lines in the y-direction. The units are retrieved through the units() method.

See also

setIntervalY()

See also

intervalX()

isSignalConnected()¶

lineSymbol(self) → QgsLineSymbol¶: Returns the line symbol used for drawing grid lines. This is only used for grids with QgsLayoutItemMapGrid.Solid or QgsLayoutItemMapGrid.Cross styles.

See also

setLineSymbol()

See also

markerSymbol()

See also

style()

markerSymbol(self) → QgsMarkerSymbol¶: Returns the marker symbol used for drawing grid points. This is only used for grids with a QgsLayoutItemMapGrid.Markers style.

See also

setMarkerSymbol()

See also

lineSymbol()

See also

style()

maxExtension(self) → float¶: Calculates the maximum distance the grid extends beyond the QgsLayoutItemMap’s item rect (in layout units).

offsetX(self) → float¶: Returns the offset for grid lines in the x-direction. The units are retrieved through the units() method.

See also

setOffsetX()

See also

offsetY()

offsetY(self) → float¶: Returns the offset for grid lines in the y-direction. The units are retrieved through the units() method.

See also

setOffsetY()

See also

offsetX()

readObjectPropertiesFromElement()¶

readXml(self, itemElem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool¶

receivers()¶

sender()¶

senderSignalIndex()¶

setAnnotationDirection(self, direction: QgsLayoutItemMapGrid.AnnotationDirection, side: QgsLayoutItemMapGrid.BorderSide)¶

Sets the direction for drawing frame annotations for the specified map side.

See also

annotationDirection()

setAnnotationDirection(self, direction: QgsLayoutItemMapGrid.AnnotationDirection) Sets the direction for drawing all frame annotations.

See also

annotationDirection()

setAnnotationDisplay(self, display: QgsLayoutItemMapGrid.DisplayMode, border: QgsLayoutItemMapGrid.BorderSide)¶

Sets what types of grid annotations should be drawn for a specified side of the map frame, or whether grid annotations should be disabled for the side.

Parameters

display – display mode for annotations
border – side of map for annotations

See also

annotationDisplay()

setAnnotationEnabled(self, enabled: bool)¶: Sets whether annotations should be shown for the grid.

See also

annotationEnabled()

setAnnotationExpression(self, expression: str)¶: Sets the expression used for drawing grid annotations. This is only used when annotationFormat() is QgsLayoutItemMapGrid.CustomFormat.

See also

annotationExpression()

setAnnotationFont(self, font: QFont)¶: Sets the font used for drawing grid annotations.

See also

annotationFont()

setAnnotationFontColor(self, color: Union[QColor, Qt.GlobalColor])¶: Sets the font color used for drawing grid annotations.

See also

annotationFontColor()

setAnnotationFormat(self, format: QgsLayoutItemMapGrid.AnnotationFormat)¶: Sets the format for drawing grid annotations.

See also

annotationFormat()

setAnnotationFrameDistance(self, distance: float)¶: Sets the distance between the map frame and annotations. Units are layout units.

See also

annotationFrameDistance()

setAnnotationPosition(self, position: QgsLayoutItemMapGrid.AnnotationPosition, side: QgsLayoutItemMapGrid.BorderSide)¶: Sets the position for the grid annotations on a specified side of the map frame.

See also

annotationPosition()

setAnnotationPrecision(self, precision: int)¶: Sets the coordinate precision for grid annotations. The precision indicates the number of decimal places to show when drawing grid annotations.

See also

annotationPrecision()

setBlendMode(self, mode: QPainter.CompositionMode)¶: Sets the blending mode used for drawing the grid.

See also

blendMode()

setCrossLength(self, length: float)¶: Sets the length (in layout units) of the cross segments drawn for the grid. This is only used for grids with QgsLayoutItemMapGrid.Cross styles.

See also

crossLength()

setCrs(self, crs: QgsCoordinateReferenceSystem)¶: Sets the crs for the grid.

See also

crs()

setFrameDivisions(self, divisions: QgsLayoutItemMapGrid.DisplayMode, side: QgsLayoutItemMapGrid.BorderSide)¶: Sets what type of grid divisions should be used for frames on a specified side of the map.

See also

frameDivisions()

setFrameFillColor1(self, color: Union[QColor, Qt.GlobalColor])¶: Sets the first fill color used for the grid frame.

See also

frameFillColor1()

See also

setFramePenColor()

See also

setFrameFillColor2()

setFrameFillColor2(self, color: Union[QColor, Qt.GlobalColor])¶: Sets the second fill color used for the grid frame.

See also

frameFillColor2()

See also

setFramePenColor()

See also

setFrameFillColor1()

setFrameMargin(self, margin: float)¶: Sets the grid frame margin (in layout units). This property controls distance between the map frame and the grid frame.

See also

frameMargin()

New in version 3.6.

setFramePenColor(self, color: Union[QColor, Qt.GlobalColor])¶: Sets the color of the stroke drawn in the grid frame.

See also

framePenColor()

See also

setFramePenSize()

See also

setFrameFillColor1()

See also

setFrameFillColor2()

setFramePenSize(self, width: float)¶: Sets the width of the stroke drawn in the grid frame.

See also

framePenSize()

See also

setFramePenColor()

setFrameSideFlag(self, flag: QgsLayoutItemMapGrid.FrameSideFlag, on: bool = True)¶

Sets whether the grid frame is drawn for a certain side of the map item.

Parameters

flag – flag for grid frame side
on – set to True to draw grid frame on that side of the map

See also

setFrameSideFlags()

See also

frameSideFlags()

See also

testFrameSideFlag()

setFrameSideFlags(self, flags: Union[QgsLayoutItemMapGrid.FrameSideFlags, QgsLayoutItemMapGrid.FrameSideFlag])¶: Sets flags for grid frame sides. Setting these flags controls which sides of the map item the grid frame is drawn on.

See also

setFrameSideFlag()

See also

frameSideFlags()

See also

testFrameSideFlag()

setFrameStyle(self, style: QgsLayoutItemMapGrid.FrameStyle)¶: Sets the grid frame style.

See also

frameStyle()

setFrameWidth(self, width: float)¶: Sets the grid frame width (in layout units). This property controls how wide the grid frame is. The size of the line outlines drawn in the frame is controlled through the setFramePenSize method.

See also

frameWidth()

setGridLineColor(self, color: Union[QColor, Qt.GlobalColor])¶: Sets the color of grid lines. This is only used for grids with QgsLayoutItemMapGrid.Solid or QgsLayoutItemMapGrid.Cross styles. For more control over grid line appearance, use setLineSymbol instead.

See also

setLineSymbol()

See also

setGridLineWidth()

setGridLineWidth(self, width: float)¶: Sets the width of grid lines (in layout units). This is only used for grids with QgsLayoutItemMapGrid.Solid or QgsLayoutItemMapGrid.Cross styles. For more control over grid line appearance, use setLineSymbol instead.

See also

setLineSymbol()

See also

setGridLineColor()

setIntervalX(self, interval: float)¶: Sets the interval between grid lines in the x-direction. The units are controlled through the setUnits method

See also

setIntervalY()

See also

intervalX()

setIntervalY(self, interval: float)¶: Sets the interval between grid lines in the y-direction. The units are controlled through the setUnits method

See also

setIntervalX()

See also

intervalY()

setLineSymbol(self, symbol: QgsLineSymbol)¶: Sets the line symbol used for drawing grid lines. This is only used for grids with QgsLayoutItemMapGrid.Solid or QgsLayoutItemMapGrid.Cross styles. Ownership of symbol is transferred to the grid.

See also

lineSymbol()

See also

setMarkerSymbol()

See also

setStyle()

setMarkerSymbol(self, symbol: QgsMarkerSymbol)¶: Sets the marker symbol used for drawing grid points. This is only used for grids with a QgsLayoutItemMapGrid.Markers style. Ownership of symbol is transferred to the grid.

See also

markerSymbol()

See also

setLineSymbol()

See also

setStyle()

setOffsetX(self, offset: float)¶: Sets the offset for grid lines in the x-direction. The units are controlled through the setUnits method.

See also

setOffsetY()

See also

offsetX()

setOffsetY(self, offset: float)¶: Sets the offset for grid lines in the y-direction. The units are controlled through the setUnits method.

See also

setOffsetX()

See also

offsetY()

setStyle(self, style: QgsLayoutItemMapGrid.GridStyle)¶: Sets the grid style, which controls how the grid is drawn over the map’s contents.

See also

style()

setUnits(self, unit: QgsLayoutItemMapGrid.GridUnit)¶: Sets the unit to use for grid measurements such as the interval and offset for grid lines.

See also

units()

style(self) → QgsLayoutItemMapGrid.GridStyle¶: Returns the grid’s style, which controls how the grid is drawn over the map’s contents.

See also

setStyle()

testFrameSideFlag(self, flag: QgsLayoutItemMapGrid.FrameSideFlag) → bool¶

Tests whether the grid frame should be drawn on a specified side of the map item.

Parameters: flag – flag for grid frame side
Returns: True if grid frame should be drawn for that side of the map

See also

setFrameSideFlags()

See also

setFrameSideFlag()

See also

frameSideFlags()

timerEvent()¶

units(self) → QgsLayoutItemMapGrid.GridUnit¶: Returns the units used for grid measurements such as the interval and offset for grid lines.

See also

setUnits()

usesAdvancedEffects(self) → bool¶

writeObjectPropertiesToElement()¶

writeXml(self, elem: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → bool¶