Class: QgsLayoutItemMapGrid

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

See also

QgsLayoutItemMapGridStack

Class Hierarchy

Base classes

QgsLayoutItemMapItem	An item which is drawn inside a QgsLayoutItemMap, e.g., a grid or map overview.
QgsLayoutObject	A base class for objects which belong to a layout.
QObject
QgsExpressionContextGenerator	Abstract interface for generating an expression context.

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.
annotationTextFormat	Returns the text format used when rendering 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.
copyProperties	Copies properties from specified map grid.
crossLength	Retrieves the length (in layout units) of the cross segments drawn for the grid.
crs	Retrieves the CRS for the grid.
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.
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).
maximumIntervalWidth	Returns the maximum width (in millimeters) for grid segments.
minimumIntervalWidth	Returns the minimum width (in millimeters) for grid segments.
offsetX	Returns the offset for grid lines in the x-direction.
offsetY	Returns the offset for grid lines in the y-direction.
rotatedAnnotationsEnabled	Gets whether annotations rotation for rotated or reprojected grids is enabled.
rotatedAnnotationsLengthMode	Returns the annotation length calculation mode.
rotatedAnnotationsMarginToCorner	Gets the margin to corners (in canvas units) below which outwards facing annotations are not drawn.
rotatedAnnotationsMinimumAngle	Gets the minimum angle (in degrees) below which annotations are not drawn.
rotatedTicksEnabled	Gets whether ticks rotation for rotated or reprojected grids is enabled.
rotatedTicksLengthMode	Returns the grid frame style.
rotatedTicksMarginToCorner	Gets the margin to corners (in canvas units) below which outwards facing ticks are not drawn.
rotatedTicksMinimumAngle	Gets the minimum angle (in degrees) below which ticks are not drawn.
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.
setAnnotationTextFormat	Sets the text format to use when rendering 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.
setMaximumIntervalWidth	Sets the maximum width (in millimeters) for grid segments.
setMinimumIntervalWidth	Sets the minimum width (in millimeters) for grid segments.
setOffsetX	Sets the offset for grid lines in the x-direction.
setOffsetY	Sets the offset for grid lines in the y-direction.
setRotatedAnnotationsEnabled	Enable/disable annotations rotation for rotated or reprojected grids.
setRotatedAnnotationsLengthMode	Sets the annotation length calculation mode.
setRotatedAnnotationsMarginToCorner	Sets the margin to corners (in canvas units) below which outwards facing annotations are not drawn.
setRotatedAnnotationsMinimumAngle	Sets the minimum angle (in degrees) below which annotations are not drawn.
setRotatedTicksEnabled	Enable/disable ticks rotation for rotated or reprojected grids.
setRotatedTicksLengthMode	Sets the tick length calculation mode.
setRotatedTicksMarginToCorner	Sets the margin to corners (in canvas units) below which outwards facing ticks are not drawn.
setRotatedTicksMinimumAngle	Sets the minimum angle (in degrees) below which ticks are not drawn.
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.
units	Returns the units used for grid measurements such as the interval and offset for grid lines.

Signals

crsChanged

Emitted whenever the grid's CRS is changed.

Attributes

AboveTick
Bottom
BoundaryDirection
CM
Cross
CustomFormat
Decimal
DecimalWithSuffix
DegreeMinute
DegreeMinuteNoSuffix
DegreeMinutePadded
DegreeMinuteSecond
DegreeMinuteSecondNoSuffix
DegreeMinuteSecondPadded
DynamicPageSizeBased
ExteriorTicks
FrameAnnotationsOnly
FrameBottom
FrameLeft
FrameRight
FrameTop
HideAll
Horizontal
InsideMapFrame
InteriorExteriorTicks
InteriorTicks
Latitude
LatitudeOnly
Left
LineBorder
LineBorderNautical
Longitude
LongitudeOnly
MM
MapUnit
Markers
NoFrame
NormalizedTicks
OnTick
OrthogonalTicks
OutsideMapFrame
Right
ShowAll
Solid
Top
UnderTick
Vertical
VerticalDescending
Zebra
ZebraNautical

class qgis.core.QgsLayoutItemMapGrid

Bases: QgsLayoutItemMapItem

__init__(name: str | None, map: QgsLayoutItemMap | None)

Constructor for QgsLayoutItemMapGrid.

Parameters:

• name (Optional[str]) – friendly display name for grid

• map (Optional[QgsLayoutItemMap]) – QgsLayoutItemMap the grid is attached to

AboveTick = 4

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

DynamicPageSizeBased = 3

ExteriorTicks = 3

FrameAnnotationsOnly = 3

FrameBottom = 8

FrameLeft = 1

FrameRight = 2

class FrameSideFlag

Bases: int

class FrameSideFlags

class FrameSideFlags(f: QgsLayoutItemMapGrid.FrameSideFlags | QgsLayoutItemMapGrid.FrameSideFlag)

class FrameSideFlags(a0: QgsLayoutItemMapGrid.FrameSideFlags)

Bases: object

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

NormalizedTicks = 1

OnTick = 5

OrthogonalTicks = 0

OutsideMapFrame = 1

Right = 1

ShowAll = 0

Solid = 0

class TickLengthMode

Bases: int

Top = 3

UnderTick = 6

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

Parameters:

border (QgsLayoutItemMapGrid.BorderSide)

Return type:

QgsLayoutItemMapGrid.AnnotationDirection

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 (QgsLayoutItemMapGrid.BorderSide) – side of map for annotations

Return type:

QgsLayoutItemMapGrid.DisplayMode

Returns:

display mode for grid annotations

See also

setAnnotationDisplay()

annotationEnabled(self) → bool

Returns whether annotations are shown for the grid.

See also

setAnnotationEnabled()

Return type:

bool

annotationExpression(self) → str

Returns the expression used for drawing grid annotations. This is only used when annotationFormat() is QgsLayoutItemMapGrid.CustomFormat.

See also

setAnnotationExpression()

Return type:

str

annotationFont(self) → QFont

Returns the font used for drawing grid annotations. Shortcut for annotationTextFormat().font().

See also

setAnnotationFont()

Deprecated since version 3.40: Use annotationTextFormat() instead.

Return type:

QFont

annotationFontColor(self) → QColor

Returns the font color used for drawing grid annotations. Shortcut for annotationTextFormat().color() and annotationTextFormat().opacity().

See also

setAnnotationFontColor()

Deprecated since version 3.40: Use annotationTextFormat() instead.

Return type:

QColor

annotationFormat(self) → QgsLayoutItemMapGrid.AnnotationFormat

Returns the format for drawing grid annotations.

See also

setAnnotationFormat()

Return type:

QgsLayoutItemMapGrid.AnnotationFormat

annotationFrameDistance(self) → float

Returns the distance between the map frame and annotations. Units are in layout units.

See also

setAnnotationFrameDistance()

Return type:

float

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

Parameters:

side (QgsLayoutItemMapGrid.BorderSide)

Return type:

QgsLayoutItemMapGrid.AnnotationPosition

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

Return type:

int

annotationTextFormat(self) → QgsTextFormat

Returns the text format used when rendering grid annotations.

See also

setAnnotationTextFormat()

Added in version 3.16.

Return type:

QgsTextFormat

blendMode(self) → QPainter.CompositionMode

Retrieves the blending mode used for drawing the grid.

See also

setBlendMode()

Return type:

QPainter.CompositionMode

calculateMaxExtension(self)

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

copyProperties(self, other: QgsLayoutItemMapGrid | None)

Copies properties from specified map grid.

Added in version 3.38.

Parameters:

other (Optional[QgsLayoutItemMapGrid])

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

Return type:

float

crs(self) → QgsCoordinateReferenceSystem

Retrieves the CRS for the grid.

See also

setCrs()

Return type:

QgsCoordinateReferenceSystem

signal crsChanged

Emitted whenever the grid’s CRS is changed.

Added in version 3.18.

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

Parameters:

side (QgsLayoutItemMapGrid.BorderSide)

Return type:

QgsLayoutItemMapGrid.DisplayMode

frameFillColor1(self) → QColor

Retrieves the first fill color for the grid frame.

See also

setFrameFillColor1()

See also

framePenColor()

See also

frameFillColor2()

Return type:

QColor

frameFillColor2(self) → QColor

Retrieves the second fill color for the grid frame.

See also

setFrameFillColor2()

See also

framePenColor()

See also

frameFillColor1()

Return type:

QColor

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

Added in version 3.6.

Return type:

float

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

Return type:

QColor

framePenSize(self) → float

Retrieves the width of the stroke drawn in the grid frame.

See also

setFramePenSize()

See also

framePenColor()

Return type:

float

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

Return type:

QgsLayoutItemMapGrid.FrameSideFlags

frameStyle(self) → QgsLayoutItemMapGrid.FrameStyle

Returns the grid frame style.

See also

setFrameStyle()

Return type:

QgsLayoutItemMapGrid.FrameStyle

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

Return type:

float

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

Return type:

float

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

Return type:

float

lineSymbol(self) → QgsLineSymbol | None

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

Return type:

Optional[QgsLineSymbol]

markerSymbol(self) → QgsMarkerSymbol | None

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

Return type:

Optional[QgsMarkerSymbol]

maxExtension(self) → float

Calculates the maximum distance the grid extends beyond the QgsLayoutItemMap’s item rect (in layout units).

Return type:

float

maximumIntervalWidth(self) → float

Returns the maximum width (in millimeters) for grid segments. This property is only effective if the units() is set to DynamicPageSizeBased.

See also

units()

See also

setMaximumIntervalWidth()

See also

minimumIntervalWidth()

Added in version 3.10.

Return type:

float

minimumIntervalWidth(self) → float

Returns the minimum width (in millimeters) for grid segments. This property is only effective if the units() is set to DynamicPageSizeBased.

See also

units()

See also

setMinimumIntervalWidth()

See also

maximumIntervalWidth()

Added in version 3.10.

Return type:

float

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

Return type:

float

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

Return type:

float

rotatedAnnotationsEnabled(self) → bool

Gets whether annotations rotation for rotated or reprojected grids is enabled.

See also

setRotatedAnnotationsEnabled()

Added in version 3.16.

Return type:

bool

rotatedAnnotationsLengthMode(self) → QgsLayoutItemMapGrid.TickLengthMode

Returns the annotation length calculation mode.

See also

setRotatedAnnotationsLengthMode()

Added in version 3.16.

Return type:

QgsLayoutItemMapGrid.TickLengthMode

rotatedAnnotationsMarginToCorner(self) → float

Gets the margin to corners (in canvas units) below which outwards facing annotations are not drawn.

See also

setRotatedAnnotationsMarginToCorner()

Added in version 3.16.

Return type:

float

rotatedAnnotationsMinimumAngle(self) → float

Gets the minimum angle (in degrees) below which annotations are not drawn.

See also

setRotatedAnnotationsMinimumAngle()

Added in version 3.16.

Return type:

float

rotatedTicksEnabled(self) → bool

Gets whether ticks rotation for rotated or reprojected grids is enabled.

See also

setRotatedTicksEnabled()

Added in version 3.16.

Return type:

bool

rotatedTicksLengthMode(self) → QgsLayoutItemMapGrid.TickLengthMode

Returns the grid frame style.

See also

setRotatedTicksLengthMode()

Added in version 3.16.

Return type:

QgsLayoutItemMapGrid.TickLengthMode

rotatedTicksMarginToCorner(self) → float

Gets the margin to corners (in canvas units) below which outwards facing ticks are not drawn.

See also

setRotatedTicksMarginToCorner()

Added in version 3.16.

Return type:

float

rotatedTicksMinimumAngle(self) → float

Gets the minimum angle (in degrees) below which ticks are not drawn.

See also

setRotatedTicksMinimumAngle()

Added in version 3.16.

Return type:

float

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

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

See also

annotationDirection()

Parameters:

• direction (QgsLayoutItemMapGrid.AnnotationDirection)

• side (QgsLayoutItemMapGrid.BorderSide)

setAnnotationDirection(self, direction: QgsLayoutItemMapGrid.AnnotationDirection)

Sets the direction for drawing all frame annotations.

See also

annotationDirection()

Parameters:

direction (QgsLayoutItemMapGrid.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 (QgsLayoutItemMapGrid.DisplayMode) – display mode for annotations

• border (QgsLayoutItemMapGrid.BorderSide) – side of map for annotations

See also

annotationDisplay()

setAnnotationEnabled(self, enabled: bool)

Sets whether annotations should be shown for the grid.

See also

annotationEnabled()

Parameters:

enabled (bool)

setAnnotationExpression(self, expression: str | None)

Sets the expression used for drawing grid annotations. This is only used when annotationFormat() is QgsLayoutItemMapGrid.CustomFormat.

See also

annotationExpression()

Parameters:

expression (Optional[str])

setAnnotationFont(self, font: QFont)

Sets the font used for drawing grid annotations. Shortcut for annotationTextFormat().setFont().

See also

annotationFont()

Deprecated since version 3.40: Use setAnnotationTextFormat() instead.

Parameters:

font (QFont)

setAnnotationFontColor(self, color: QColor | Qt.GlobalColor)

Sets the font color used for drawing grid annotations. Shortcut for annotationTextFormat().setColor() and annotationTextFormat().setOpacity().

See also

annotationFontColor()

Deprecated since version 3.40: Use setAnnotationTextFormat() instead.

Parameters:

color (Union[QColor, Qt.GlobalColor])

setAnnotationFormat(self, format: QgsLayoutItemMapGrid.AnnotationFormat)

Sets the format for drawing grid annotations.

See also

annotationFormat()

Parameters:

format (QgsLayoutItemMapGrid.AnnotationFormat)

setAnnotationFrameDistance(self, distance: float)

Sets the distance between the map frame and annotations. Units are layout units.

See also

annotationFrameDistance()

Parameters:

distance (float)

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

Parameters:

• position (QgsLayoutItemMapGrid.AnnotationPosition)

• side (QgsLayoutItemMapGrid.BorderSide)

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

Parameters:

precision (int)

setAnnotationTextFormat(self, format: QgsTextFormat)

Sets the text format to use when rendering grid annotations.

See also

annotationTextFormat()

Added in version 3.16.

Parameters:

format (QgsTextFormat)

setBlendMode(self, mode: QPainter.CompositionMode)

Sets the blending mode used for drawing the grid.

See also

blendMode()

Parameters:

mode (QPainter.CompositionMode)

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

Parameters:

length (float)

setCrs(self, crs: QgsCoordinateReferenceSystem)

Sets the crs for the grid.

See also

crs()

Parameters:

crs (QgsCoordinateReferenceSystem)

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

Parameters:

• divisions (QgsLayoutItemMapGrid.DisplayMode)

• side (QgsLayoutItemMapGrid.BorderSide)

setFrameFillColor1(self, color: QColor | Qt.GlobalColor)

Sets the first fill color used for the grid frame.

See also

frameFillColor1()

See also

setFramePenColor()

See also

setFrameFillColor2()

Parameters:

color (Union[QColor, Qt.GlobalColor])

setFrameFillColor2(self, color: QColor | Qt.GlobalColor)

Sets the second fill color used for the grid frame.

See also

frameFillColor2()

See also

setFramePenColor()

See also

setFrameFillColor1()

Parameters:

color (Union[QColor, Qt.GlobalColor])

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

Added in version 3.6.

Parameters:

margin (float)

setFramePenColor(self, color: 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()

Parameters:

color (Union[QColor, Qt.GlobalColor])

setFramePenSize(self, width: float)

Sets the width of the stroke drawn in the grid frame.

See also

framePenSize()

See also

setFramePenColor()

Parameters:

width (float)

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 (QgsLayoutItemMapGrid.FrameSideFlag) – flag for grid frame side

• on (bool = True) – 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: 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()

Parameters:

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

setFrameStyle(self, style: QgsLayoutItemMapGrid.FrameStyle)

Sets the grid frame style.

See also

frameStyle()

Parameters:

style (QgsLayoutItemMapGrid.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()

Parameters:

width (float)

setGridLineColor(self, color: 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()

Parameters:

color (Union[QColor, Qt.GlobalColor])

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

Parameters:

width (float)

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

Parameters:

interval (float)

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

Parameters:

interval (float)

setLineSymbol(self, symbol: QgsLineSymbol | None)

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

Parameters:

symbol (Optional[QgsLineSymbol])

setMarkerSymbol(self, symbol: QgsMarkerSymbol | None)

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

Parameters:

symbol (Optional[QgsMarkerSymbol])

setMaximumIntervalWidth(self, width: float)

Sets the maximum width (in millimeters) for grid segments. This property is only effective if the units() is set to DynamicPageSizeBased.

See also

maximumIntervalWidth()

See also

setMinimumIntervalWidth()

See also

setUnits()

Added in version 3.10.

Parameters:

width (float)

setMinimumIntervalWidth(self, width: float)

Sets the minimum width (in millimeters) for grid segments. This property is only effective if the units() is set to DynamicPageSizeBased.

See also

minimumIntervalWidth()

See also

setMaximumIntervalWidth()

See also

setUnits()

Added in version 3.10.

Parameters:

width (float)

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

Parameters:

offset (float)

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

Parameters:

offset (float)

setRotatedAnnotationsEnabled(self, state: bool)

Enable/disable annotations rotation for rotated or reprojected grids.

See also

rotatedAnnotationsEnabled()

Added in version 3.16.

Parameters:

state (bool)

setRotatedAnnotationsLengthMode(self, mode: QgsLayoutItemMapGrid.TickLengthMode)

Sets the annotation length calculation mode.

See also

rotatedAnnotationsLengthMode()

Added in version 3.16.

Parameters:

mode (QgsLayoutItemMapGrid.TickLengthMode)

setRotatedAnnotationsMarginToCorner(self, margin: float)

Sets the margin to corners (in canvas units) below which outwards facing annotations are not drawn.

See also

rotatedAnnotationsMarginToCorner()

Added in version 3.16.

Parameters:

margin (float)

setRotatedAnnotationsMinimumAngle(self, angle: float)

Sets the minimum angle (in degrees) below which annotations are not drawn.

See also

rotatedAnnotationsMinimumAngle()

Added in version 3.16.

Parameters:

angle (float)

setRotatedTicksEnabled(self, state: bool)

Enable/disable ticks rotation for rotated or reprojected grids.

See also

rotatedTicksEnabled()

Added in version 3.16.

Parameters:

state (bool)

setRotatedTicksLengthMode(self, mode: QgsLayoutItemMapGrid.TickLengthMode)

Sets the tick length calculation mode.

See also

rotatedTicksLengthMode()

Added in version 3.16.

Parameters:

mode (QgsLayoutItemMapGrid.TickLengthMode)

setRotatedTicksMarginToCorner(self, margin: float)

Sets the margin to corners (in canvas units) below which outwards facing ticks are not drawn.

See also

rotatedTicksMarginToCorner()

Added in version 3.16.

Parameters:

margin (float)

setRotatedTicksMinimumAngle(self, angle: float)

Sets the minimum angle (in degrees) below which ticks are not drawn.

See also

rotatedTicksMinimumAngle()

Added in version 3.16.

Parameters:

angle (float)

setStyle(self, style: QgsLayoutItemMapGrid.GridStyle)

Sets the grid style, which controls how the grid is drawn over the map’s contents.

See also

style()

Parameters:

style (QgsLayoutItemMapGrid.GridStyle)

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

Parameters:

unit (QgsLayoutItemMapGrid.GridUnit)

style(self) → QgsLayoutItemMapGrid.GridStyle

Returns the grid’s style, which controls how the grid is drawn over the map’s contents.

See also

setStyle()

Return type:

QgsLayoutItemMapGrid.GridStyle

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

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

Parameters:

flag (QgsLayoutItemMapGrid.FrameSideFlag) – flag for grid frame side

Return type:

bool

Returns:

True if grid frame should be drawn for that side of the map

See also

setFrameSideFlags()

See also

setFrameSideFlag()

See also

frameSideFlags()

units(self) → QgsLayoutItemMapGrid.GridUnit

Returns the units used for grid measurements such as the interval and offset for grid lines.

See also

setUnits()

Return type:

QgsLayoutItemMapGrid.GridUnit