QGIS API Documentation  3.10.0-A Coruña (6c816b4204)
Classes | Public Types | Public Member Functions | Friends | List of all members
QgsLayoutItemMapGrid Class Reference

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

#include <qgslayoutitemmapgrid.h>

Inheritance diagram for QgsLayoutItemMapGrid:
Inheritance graph
[legend]

Public Types

enum  AnnotationCoordinate { Longitude = 0, Latitude }
 Annotation coordinate type. More...
 
enum  AnnotationDirection { Horizontal = 0, Vertical, VerticalDescending, BoundaryDirection }
 Direction of grid annotations. More...
 
enum  AnnotationFormat {
  Decimal = 0, DegreeMinute, DegreeMinuteSecond, DecimalWithSuffix,
  DegreeMinuteNoSuffix, DegreeMinutePadded, DegreeMinuteSecondNoSuffix, DegreeMinuteSecondPadded,
  CustomFormat
}
 Format for displaying grid annotations. More...
 
enum  AnnotationPosition { InsideMapFrame = 0, OutsideMapFrame }
 Position for grid annotations. More...
 
enum  BorderSide { Left, Right, Bottom, Top }
 Border sides for annotations. More...
 
enum  DisplayMode { ShowAll = 0, LatitudeOnly, LongitudeOnly, HideAll }
 Display settings for grid annotations and frames. More...
 
enum  FrameSideFlag { FrameLeft = 0x01, FrameRight = 0x02, FrameTop = 0x04, FrameBottom = 0x08 }
 Flags for controlling which side of the map a frame is drawn on. More...
 
enum  FrameStyle {
  NoFrame = 0, Zebra, InteriorTicks, ExteriorTicks,
  InteriorExteriorTicks, LineBorder, LineBorderNautical, ZebraNautical
}
 Style for grid frame. More...
 
enum  GridStyle { Solid = 0, Cross, Markers, FrameAnnotationsOnly }
 Grid drawing style. More...
 
enum  GridUnit { MapUnit, MM, CM, DynamicPageSizeBased }
 Unit for grid values. More...
 
- Public Types inherited from QgsLayoutItemMapItem
enum  StackingPosition {
  StackBelowMap, StackBelowMapLayer, StackAboveMapLayer, StackBelowMapLabels,
  StackAboveMapLabels
}
 Item stacking position, specifies where the in the map's stack the item should be rendered. More...
 
- Public Types inherited from QgsLayoutObject
enum  DataDefinedProperty {
  NoProperty = 0, AllProperties, TestProperty, PresetPaperSize,
  PaperWidth, PaperHeight, NumPages, PaperOrientation,
  PageNumber, PositionX, PositionY, ItemWidth,
  ItemHeight, ItemRotation, Transparency, Opacity,
  BlendMode, ExcludeFromExports, FrameColor, BackgroundColor,
  MapRotation, MapScale, MapXMin, MapYMin,
  MapXMax, MapYMax, MapAtlasMargin, MapLayers,
  MapStylePreset, MapLabelMargin, MapGridEnabled, MapGridIntervalX,
  MapGridIntervalY, MapGridOffsetX, MapGridOffsetY, MapGridFrameSize,
  MapGridFrameMargin, MapGridLabelDistance, MapGridCrossSize, MapGridFrameLineThickness,
  PictureSource, PictureSvgBackgroundColor, PictureSvgStrokeColor, PictureSvgStrokeWidth,
  SourceUrl, LegendTitle, LegendColumnCount, ScalebarFillColor,
  ScalebarFillColor2, ScalebarLineColor, ScalebarLineWidth, AttributeTableSourceLayer
}
 Data defined properties for different item types. More...
 
enum  PropertyValueType { EvaluatedValue = 0, OriginalValue }
 Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More...
 

Public Member Functions

 QgsLayoutItemMapGrid (const QString &name, QgsLayoutItemMap *map)
 Constructor for QgsLayoutItemMapGrid. More...
 
bool accept (QgsStyleEntityVisitorInterface *visitor) const override
 Accepts the specified style entity visitor, causing it to visit all style entities associated with the map item. More...
 
AnnotationDirection annotationDirection (BorderSide border) const
 Returns the direction for drawing frame annotations, on the specified side of the map. More...
 
DisplayMode annotationDisplay (BorderSide border) const
 Returns the display mode for the grid annotations on a specified side of the map frame. More...
 
bool annotationEnabled () const
 Returns whether annotations are shown for the grid. More...
 
QString annotationExpression () const
 Returns the expression used for drawing grid annotations. More...
 
QFont annotationFont () const
 Returns the font used for drawing grid annotations. More...
 
QColor annotationFontColor () const
 Returns the font color used for drawing grid annotations. More...
 
AnnotationFormat annotationFormat () const
 Returns the format for drawing grid annotations. More...
 
double annotationFrameDistance () const
 Returns the distance between the map frame and annotations. More...
 
AnnotationPosition annotationPosition (BorderSide side) const
 Returns the position for the grid annotations on a specified side of the map frame. More...
 
int annotationPrecision () const
 Returns the coordinate precision for grid annotations, which is the number of decimal places shown when drawing grid annotations. More...
 
QPainter::CompositionMode blendMode () const
 Retrieves the blending mode used for drawing the grid. More...
 
void calculateMaxExtension (double &top, double &right, double &bottom, double &left) const
 Calculates the maximum distance the grid extends beyond the QgsLayoutItemMap's item rect. More...
 
QgsExpressionContext createExpressionContext () const override
 This method needs to be reimplemented in all classes which implement this interface and return an expression context. More...
 
double crossLength () const
 Retrieves the length (in layout units) of the cross segments drawn for the grid. More...
 
QgsCoordinateReferenceSystem crs () const
 Retrieves the CRS for the grid. More...
 
void draw (QPainter *painter) override
 Draws the item on to a destination painter. More...
 
DisplayMode frameDivisions (BorderSide side) const
 Returns the type of grid divisions which are used for frames on a specified side of the map. More...
 
QColor frameFillColor1 () const
 Retrieves the first fill color for the grid frame. More...
 
QColor frameFillColor2 () const
 Retrieves the second fill color for the grid frame. More...
 
double frameMargin () const
 Sets the grid frame Margin (in layout units). More...
 
QColor framePenColor () const
 Retrieves the color of the stroke drawn in the grid frame. More...
 
double framePenSize () const
 Retrieves the width of the stroke drawn in the grid frame. More...
 
QgsLayoutItemMapGrid::FrameSideFlags frameSideFlags () const
 Returns the flags which control which sides of the map item the grid frame is drawn on. More...
 
FrameStyle frameStyle () const
 Returns the grid frame style. More...
 
double frameWidth () const
 Gets the grid frame width in layout units. More...
 
double intervalX () const
 Returns the interval between grid lines in the x-direction. More...
 
double intervalY () const
 Returns the interval between grid lines in the y-direction. More...
 
const QgsLineSymbollineSymbol () const
 Returns the line symbol used for drawing grid lines. More...
 
QgsLineSymbollineSymbol ()
 Returns the line symbol used for drawing grid lines. More...
 
const QgsMarkerSymbolmarkerSymbol () const
 Returns the marker symbol used for drawing grid points. More...
 
QgsMarkerSymbolmarkerSymbol ()
 Returns the marker symbol used for drawing grid points. More...
 
double maxExtension () const
 Calculates the maximum distance the grid extends beyond the QgsLayoutItemMap's item rect (in layout units). More...
 
double maximumIntervalWidth () const
 Returns the maximum width (in millimeters) for grid segments. More...
 
double minimumIntervalWidth () const
 Returns the minimum width (in millimeters) for grid segments. More...
 
double offsetX () const
 Returns the offset for grid lines in the x-direction. More...
 
double offsetY () const
 Returns the offset for grid lines in the y-direction. More...
 
bool readXml (const QDomElement &itemElem, const QDomDocument &doc, const QgsReadWriteContext &context) override
 Sets the map item state from a DOM document, where element is the DOM node corresponding to a 'LayoutMapGrid' tag. More...
 
void refresh () override
 Refreshes the object, causing a recalculation of any property overrides. More...
 
void setAnnotationDirection (AnnotationDirection direction, BorderSide side)
 Sets the direction for drawing frame annotations for the specified map side. More...
 
void setAnnotationDirection (AnnotationDirection direction)
 Sets the direction for drawing all frame annotations. More...
 
void setAnnotationDisplay (DisplayMode display, BorderSide border)
 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. More...
 
void setAnnotationEnabled (const bool enabled)
 Sets whether annotations should be shown for the grid. More...
 
void setAnnotationExpression (const QString &expression)
 Sets the expression used for drawing grid annotations. More...
 
void setAnnotationFont (const QFont &font)
 Sets the font used for drawing grid annotations. More...
 
void setAnnotationFontColor (const QColor &color)
 Sets the font color used for drawing grid annotations. More...
 
void setAnnotationFormat (const AnnotationFormat format)
 Sets the format for drawing grid annotations. More...
 
void setAnnotationFrameDistance (const double distance)
 Sets the distance between the map frame and annotations. More...
 
void setAnnotationPosition (AnnotationPosition position, BorderSide side)
 Sets the position for the grid annotations on a specified side of the map frame. More...
 
void setAnnotationPrecision (const int precision)
 Sets the coordinate precision for grid annotations. More...
 
void setBlendMode (const QPainter::CompositionMode mode)
 Sets the blending mode used for drawing the grid. More...
 
void setCrossLength (const double length)
 Sets the length (in layout units) of the cross segments drawn for the grid. More...
 
void setCrs (const QgsCoordinateReferenceSystem &crs)
 Sets the crs for the grid. More...
 
void setEnabled (bool enabled) override
 Controls whether the item will be drawn. More...
 
void setFrameDivisions (DisplayMode divisions, BorderSide side)
 Sets what type of grid divisions should be used for frames on a specified side of the map. More...
 
void setFrameFillColor1 (const QColor &color)
 Sets the first fill color used for the grid frame. More...
 
void setFrameFillColor2 (const QColor &color)
 Sets the second fill color used for the grid frame. More...
 
void setFrameMargin (const double margin)
 Sets the grid frame margin (in layout units). More...
 
void setFramePenColor (const QColor &color)
 Sets the color of the stroke drawn in the grid frame. More...
 
void setFramePenSize (const double width)
 Sets the width of the stroke drawn in the grid frame. More...
 
void setFrameSideFlag (QgsLayoutItemMapGrid::FrameSideFlag flag, bool on=true)
 Sets whether the grid frame is drawn for a certain side of the map item. More...
 
void setFrameSideFlags (QgsLayoutItemMapGrid::FrameSideFlags flags)
 Sets flags for grid frame sides. More...
 
void setFrameStyle (const FrameStyle style)
 Sets the grid frame style. More...
 
void setFrameWidth (const double width)
 Sets the grid frame width (in layout units). More...
 
void setGridLineColor (const QColor &color)
 Sets the color of grid lines. More...
 
void setGridLineWidth (double width)
 Sets the width of grid lines (in layout units). More...
 
void setIntervalX (double interval)
 Sets the interval between grid lines in the x-direction. More...
 
void setIntervalY (double interval)
 Sets the interval between grid lines in the y-direction. More...
 
void setLineSymbol (QgsLineSymbol *symbol)
 Sets the line symbol used for drawing grid lines. More...
 
void setMarkerSymbol (QgsMarkerSymbol *symbol)
 Sets the marker symbol used for drawing grid points. More...
 
void setMaximumIntervalWidth (double width)
 Sets the maximum width (in millimeters) for grid segments. More...
 
void setMinimumIntervalWidth (double width)
 Sets the minimum width (in millimeters) for grid segments. More...
 
void setOffsetX (double offset)
 Sets the offset for grid lines in the x-direction. More...
 
void setOffsetY (double offset)
 Sets the offset for grid lines in the y-direction. More...
 
void setStyle (GridStyle style)
 Sets the grid style, which controls how the grid is drawn over the map's contents. More...
 
void setUnits (GridUnit unit)
 Sets the unit to use for grid measurements such as the interval and offset for grid lines. More...
 
GridStyle style () const
 Returns the grid's style, which controls how the grid is drawn over the map's contents. More...
 
bool testFrameSideFlag (FrameSideFlag flag) const
 Tests whether the grid frame should be drawn on a specified side of the map item. More...
 
GridUnit units () const
 Returns the units used for grid measurements such as the interval and offset for grid lines. More...
 
bool usesAdvancedEffects () const override
 Returns true if the item is drawn using advanced effects, such as blend modes. More...
 
bool writeXml (QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context) const override
 Stores map item state in a DOM element, where element is the DOM element corresponding to a 'LayoutMap' tag. More...
 
- Public Member Functions inherited from QgsLayoutItemMapItem
 QgsLayoutItemMapItem (const QString &name, QgsLayoutItemMap *map)
 Constructor for QgsLayoutItemMapItem, attached to the specified map. More...
 
QgsExpressionContext createExpressionContext () const override
 This method needs to be reimplemented in all classes which implement this interface and return an expression context. More...
 
bool enabled () const
 Returns whether the item will be drawn. More...
 
virtual void finalizeRestoreFromXml ()
 Called after all pending items have been restored from XML. More...
 
QString id () const
 Returns the unique id for the map item. More...
 
const QgsLayoutItemMapmap () const
 Returns the layout item map for the item. More...
 
QString name () const
 Returns the friendly display name for the item. More...
 
void setMap (QgsLayoutItemMap *map)
 Sets the corresponding layout map for the item. More...
 
void setName (const QString &name)
 Sets the friendly display name for the item. More...
 
void setStackingLayer (QgsMapLayer *layer)
 Sets the item's stacking layer, which specifies where the in the map's stack the item should be rendered. More...
 
void setStackingPosition (StackingPosition position)
 Sets the item's stacking position, which specifies where the in the map's stack the item should be rendered. More...
 
QgsMapLayerstackingLayer () const
 Returns the item's stacking layer, which specifies where the in the map's stack the item should be rendered. More...
 
StackingPosition stackingPosition () const
 Returns the item's stacking position, which specifies where the in the map's stack the item should be rendered. More...
 
- Public Member Functions inherited from QgsLayoutObject
 QgsLayoutObject (QgsLayout *layout)
 Constructor for QgsLayoutObject, with the specified parent layout. More...
 
QgsExpressionContext createExpressionContext () const override
 Creates an expression context relating to the objects' current state. More...
 
QStringList customProperties () const
 Returns list of keys stored in custom properties for the object. More...
 
QVariant customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const
 Read a custom property from the object. More...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the object's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the object's property collection, used for data defined overrides. More...
 
const QgsLayoutlayout () const
 Returns the layout the object is attached to. More...
 
QgsLayoutlayout ()
 Returns the layout the object is attached to. More...
 
void removeCustomProperty (const QString &key)
 Remove a custom property from the object. More...
 
void setCustomProperty (const QString &key, const QVariant &value)
 Set a custom property for the object. More...
 
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the objects's property collection, used for data defined overrides. More...
 
- Public Member Functions inherited from QgsExpressionContextGenerator
virtual ~QgsExpressionContextGenerator ()=default
 

Friends

class TestQgsLayoutMapGrid
 

Additional Inherited Members

- Public Slots inherited from QgsLayoutObject
- Signals inherited from QgsLayoutObject
void changed ()
 Emitted when the object's properties change. More...
 
- Static Public Member Functions inherited from QgsLayoutObject
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the layout object property definitions. More...
 
- Protected Member Functions inherited from QgsLayoutObject
bool readObjectPropertiesFromElement (const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context)
 Sets object properties from a DOM element. More...
 
bool writeObjectPropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const
 Stores object properties within an XML DOM element. More...
 
- Protected Attributes inherited from QgsLayoutItemMapItem
bool mEnabled
 True if item is to be displayed on map. More...
 
QgsLayoutItemMapmMap = nullptr
 Associated map. More...
 
QString mName
 Friendly display name. More...
 
QgsMapLayerRef mStackingLayer
 
StackingPosition mStackingPosition = StackBelowMapLabels
 
QString mUuid
 Unique id. More...
 
- Protected Attributes inherited from QgsLayoutObject
QgsObjectCustomProperties mCustomProperties
 Custom properties for object. More...
 
QgsPropertyCollection mDataDefinedProperties
 
QPointer< QgsLayoutmLayout
 

Detailed Description

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

See also
QgsLayoutItemMapGridStack
Since
QGIS 3.0

Definition at line 138 of file qgslayoutitemmapgrid.h.

Member Enumeration Documentation

◆ AnnotationCoordinate

Annotation coordinate type.

Enumerator
Longitude 

Coordinate is a longitude value.

Latitude 

Coordinate is a latitude value.

Definition at line 255 of file qgslayoutitemmapgrid.h.

◆ AnnotationDirection

Direction of grid annotations.

Enumerator
Horizontal 

Draw annotations horizontally.

Vertical 

Draw annotations vertically, ascending.

VerticalDescending 

Draw annotations vertically, descending.

BoundaryDirection 

Annotations follow the boundary direction.

Definition at line 190 of file qgslayoutitemmapgrid.h.

◆ AnnotationFormat

Format for displaying grid annotations.

Enumerator
Decimal 

Decimal degrees, use - for S/W coordinates.

DegreeMinute 

Degree/minutes, use NSEW suffix.

DegreeMinuteSecond 

Degree/minutes/seconds, use NSEW suffix.

DecimalWithSuffix 

Decimal degrees, use NSEW suffix.

DegreeMinuteNoSuffix 

Degree/minutes, use - for S/W coordinates.

DegreeMinutePadded 

Degree/minutes, with minutes using leading zeros where required.

DegreeMinuteSecondNoSuffix 

Degree/minutes/seconds, use - for S/W coordinates.

DegreeMinuteSecondPadded 

Degree/minutes/seconds, with minutes using leading zeros where required.

CustomFormat 

Custom expression-based format.

Definition at line 201 of file qgslayoutitemmapgrid.h.

◆ AnnotationPosition

Position for grid annotations.

Enumerator
InsideMapFrame 

Draw annotations inside the map frame.

OutsideMapFrame 

Draw annotations outside the map frame.

Definition at line 181 of file qgslayoutitemmapgrid.h.

◆ BorderSide

Border sides for annotations.

Enumerator
Left 

Left border.

Right 

Right border.

Bottom 

Bottom border.

Top 

Top border.

Definition at line 217 of file qgslayoutitemmapgrid.h.

◆ DisplayMode

Display settings for grid annotations and frames.

Enumerator
ShowAll 

Show both latitude and longitude annotations/divisions.

LatitudeOnly 

Show latitude/y annotations/divisions only.

LongitudeOnly 

Show longitude/x annotations/divisions only.

HideAll 

No annotations.

Definition at line 170 of file qgslayoutitemmapgrid.h.

◆ FrameSideFlag

Flags for controlling which side of the map a frame is drawn on.

Enumerator
FrameLeft 

Left side of map.

FrameRight 

Right side of map.

FrameTop 

Top side of map.

FrameBottom 

Bottom side of map.

Definition at line 243 of file qgslayoutitemmapgrid.h.

◆ FrameStyle

Style for grid frame.

Enumerator
NoFrame 

Disable grid frame.

Zebra 

Black/white pattern.

InteriorTicks 

Tick markers drawn inside map frame.

ExteriorTicks 

Tick markers drawn outside map frame.

InteriorExteriorTicks 

Tick markers drawn both inside and outside the map frame.

LineBorder 

Simple solid line frame.

LineBorderNautical 

Simple solid line frame, with nautical style diagonals on corners.

ZebraNautical 

Black/white pattern, with nautical style diagonals on corners.

Definition at line 228 of file qgslayoutitemmapgrid.h.

◆ GridStyle

Grid drawing style.

Enumerator
Solid 
Cross 

Draw line crosses at intersections of grid lines.

Markers 

Draw markers at intersections of grid lines.

FrameAnnotationsOnly 

No grid lines over the map, only draw frame and annotations.

Definition at line 159 of file qgslayoutitemmapgrid.h.

◆ GridUnit

Unit for grid values.

Enumerator
MapUnit 

Grid units follow map units.

MM 

Grid units in millimeters.

CM 

Grid units in centimeters.

DynamicPageSizeBased 

Dynamically sized, based on a on-page size range.

Definition at line 148 of file qgslayoutitemmapgrid.h.

Constructor & Destructor Documentation

◆ QgsLayoutItemMapGrid()

QgsLayoutItemMapGrid::QgsLayoutItemMapGrid ( const QString &  name,
QgsLayoutItemMap map 
)

Constructor for QgsLayoutItemMapGrid.

Parameters
namefriendly display name for grid
mapQgsLayoutItemMap the grid is attached to

Definition at line 159 of file qgslayoutitemmapgrid.cpp.

Member Function Documentation

◆ accept()

bool QgsLayoutItemMapGrid::accept ( QgsStyleEntityVisitorInterface visitor) const
overridevirtual

Accepts the specified style entity visitor, causing it to visit all style entities associated with the map item.

Returns true if the visitor should continue visiting other objects, or false if visiting should be canceled.

Since
QGIS 3.10

Reimplemented from QgsLayoutItemMapItem.

Definition at line 2384 of file qgslayoutitemmapgrid.cpp.

◆ annotationDirection()

QgsLayoutItemMapGrid::AnnotationDirection QgsLayoutItemMapGrid::annotationDirection ( BorderSide  border) const

Returns the direction for drawing frame annotations, on the specified side of the map.

See also
setAnnotationDirection()

Definition at line 2488 of file qgslayoutitemmapgrid.cpp.

◆ annotationDisplay()

QgsLayoutItemMapGrid::DisplayMode QgsLayoutItemMapGrid::annotationDisplay ( const QgsLayoutItemMapGrid::BorderSide  border) const

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
borderside of map for annotations
Returns
display mode for grid annotations
See also
setAnnotationDisplay()

Definition at line 2151 of file qgslayoutitemmapgrid.cpp.

◆ annotationEnabled()

bool QgsLayoutItemMapGrid::annotationEnabled ( ) const
inline

Returns whether annotations are shown for the grid.

See also
setAnnotationEnabled()

Definition at line 562 of file qgslayoutitemmapgrid.h.

◆ annotationExpression()

QString QgsLayoutItemMapGrid::annotationExpression ( ) const
inline

Returns the expression used for drawing grid annotations.

This is only used when annotationFormat() is QgsLayoutItemMapGrid::CustomFormat.

See also
setAnnotationExpression()

Definition at line 690 of file qgslayoutitemmapgrid.h.

◆ annotationFont()

QFont QgsLayoutItemMapGrid::annotationFont ( ) const
inline

Returns the font used for drawing grid annotations.

See also
setAnnotationFont()

Definition at line 574 of file qgslayoutitemmapgrid.h.

◆ annotationFontColor()

QColor QgsLayoutItemMapGrid::annotationFontColor ( ) const
inline

Returns the font color used for drawing grid annotations.

See also
setAnnotationFontColor()

Definition at line 586 of file qgslayoutitemmapgrid.h.

◆ annotationFormat()

AnnotationFormat QgsLayoutItemMapGrid::annotationFormat ( ) const
inline

Returns the format for drawing grid annotations.

See also
setAnnotationFormat()

Definition at line 676 of file qgslayoutitemmapgrid.h.

◆ annotationFrameDistance()

double QgsLayoutItemMapGrid::annotationFrameDistance ( ) const
inline

Returns the distance between the map frame and annotations.

Units are in layout units.

See also
setAnnotationFrameDistance()

Definition at line 645 of file qgslayoutitemmapgrid.h.

◆ annotationPosition()

QgsLayoutItemMapGrid::AnnotationPosition QgsLayoutItemMapGrid::annotationPosition ( const QgsLayoutItemMapGrid::BorderSide  border) const

Returns the position for the grid annotations on a specified side of the map frame.

See also
setAnnotationPosition()

Definition at line 2466 of file qgslayoutitemmapgrid.cpp.

◆ annotationPrecision()

int QgsLayoutItemMapGrid::annotationPrecision ( ) const
inline

Returns the coordinate precision for grid annotations, which is the number of decimal places shown when drawing grid annotations.

See also
setAnnotationPrecision()

Definition at line 600 of file qgslayoutitemmapgrid.h.

◆ blendMode()

QPainter::CompositionMode QgsLayoutItemMapGrid::blendMode ( ) const
inline

Retrieves the blending mode used for drawing the grid.

See also
setBlendMode()

Definition at line 294 of file qgslayoutitemmapgrid.h.

◆ calculateMaxExtension()

void QgsLayoutItemMapGrid::calculateMaxExtension ( double &  top,
double &  right,
double &  bottom,
double &  left 
) const

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

Definition at line 2177 of file qgslayoutitemmapgrid.cpp.

◆ createExpressionContext()

QgsExpressionContext QgsLayoutItemMapGrid::createExpressionContext ( ) const
overridevirtual

This method needs to be reimplemented in all classes which implement this interface and return an expression context.

Since
QGIS 3.0

Implements QgsExpressionContextGenerator.

Definition at line 2374 of file qgslayoutitemmapgrid.cpp.

◆ crossLength()

double QgsLayoutItemMapGrid::crossLength ( ) const
inline

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

Definition at line 470 of file qgslayoutitemmapgrid.h.

◆ crs()

QgsCoordinateReferenceSystem QgsLayoutItemMapGrid::crs ( ) const
inline

Retrieves the CRS for the grid.

See also
setCrs()

Definition at line 282 of file qgslayoutitemmapgrid.h.

◆ draw()

void QgsLayoutItemMapGrid::draw ( QPainter *  painter)
overridevirtual

Draws the item on to a destination painter.

Implements QgsLayoutItemMapItem.

Definition at line 556 of file qgslayoutitemmapgrid.cpp.

◆ frameDivisions()

QgsLayoutItemMapGrid::DisplayMode QgsLayoutItemMapGrid::frameDivisions ( const QgsLayoutItemMapGrid::BorderSide  border) const

Returns the type of grid divisions which are used for frames on a specified side of the map.

See also
setFrameDivisions()

Definition at line 2533 of file qgslayoutitemmapgrid.cpp.

◆ frameFillColor1()

QColor QgsLayoutItemMapGrid::frameFillColor1 ( ) const
inline

Retrieves the first fill color for the grid frame.

See also
setFrameFillColor1()
framePenColor()
frameFillColor2()

Definition at line 837 of file qgslayoutitemmapgrid.h.

◆ frameFillColor2()

QColor QgsLayoutItemMapGrid::frameFillColor2 ( ) const
inline

Retrieves the second fill color for the grid frame.

See also
setFrameFillColor2()
framePenColor(
frameFillColor1()

Definition at line 853 of file qgslayoutitemmapgrid.h.

◆ frameMargin()

double QgsLayoutItemMapGrid::frameMargin ( ) const
inline

Sets the grid frame Margin (in layout units).

This property controls distance between the map frame and the grid frame.

See also
setFrameMargin()
Since
QGIS 3.6

Definition at line 789 of file qgslayoutitemmapgrid.h.

◆ framePenColor()

QColor QgsLayoutItemMapGrid::framePenColor ( ) const
inline

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

See also
setFramePenColor()
framePenSize()
frameFillColor1()
frameFillColor2()

Definition at line 821 of file qgslayoutitemmapgrid.h.

◆ framePenSize()

double QgsLayoutItemMapGrid::framePenSize ( ) const
inline

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

See also
setFramePenSize()
framePenColor()

Definition at line 803 of file qgslayoutitemmapgrid.h.

◆ frameSideFlags()

QgsLayoutItemMapGrid::FrameSideFlags QgsLayoutItemMapGrid::frameSideFlags ( ) const

Returns the flags which control which sides of the map item the grid frame is drawn on.

See also
setFrameSideFlags()
setFrameSideFlag()
testFrameSideFlag()

Definition at line 2369 of file qgslayoutitemmapgrid.cpp.

◆ frameStyle()

FrameStyle QgsLayoutItemMapGrid::frameStyle ( ) const
inline

Returns the grid frame style.

See also
setFrameStyle()

Definition at line 706 of file qgslayoutitemmapgrid.h.

◆ frameWidth()

double QgsLayoutItemMapGrid::frameWidth ( ) const
inline

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

Definition at line 773 of file qgslayoutitemmapgrid.h.

◆ intervalX()

double QgsLayoutItemMapGrid::intervalX ( ) const
inline

Returns the interval between grid lines in the x-direction.

The units are retrieved through the units() method.

See also
setIntervalX()
intervalY()

Definition at line 346 of file qgslayoutitemmapgrid.h.

◆ intervalY()

double QgsLayoutItemMapGrid::intervalY ( ) const
inline

Returns the interval between grid lines in the y-direction.

The units are retrieved through the units() method.

See also
setIntervalY()
intervalX()

Definition at line 362 of file qgslayoutitemmapgrid.h.

◆ lineSymbol() [1/2]

const QgsLineSymbol * QgsLayoutItemMapGrid::lineSymbol ( ) const

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()
markerSymbol()
style()
Note
not available in Python bindings

Definition at line 2101 of file qgslayoutitemmapgrid.cpp.

◆ lineSymbol() [2/2]

QgsLineSymbol * QgsLayoutItemMapGrid::lineSymbol ( )

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

Definition at line 2106 of file qgslayoutitemmapgrid.cpp.

◆ markerSymbol() [1/2]

const QgsMarkerSymbol * QgsLayoutItemMapGrid::markerSymbol ( ) const

Returns the marker symbol used for drawing grid points.

This is only used for grids with a QgsLayoutItemMapGrid::Markers style.

See also
setMarkerSymbol()
lineSymbol()
style()
Note
not available in Python bindings

Definition at line 2116 of file qgslayoutitemmapgrid.cpp.

◆ markerSymbol() [2/2]

QgsMarkerSymbol * QgsLayoutItemMapGrid::markerSymbol ( )

Returns the marker symbol used for drawing grid points.

This is only used for grids with a QgsLayoutItemMapGrid::Markers style.

See also
setMarkerSymbol()
lineSymbol()
style()

Definition at line 2121 of file qgslayoutitemmapgrid.cpp.

◆ maxExtension()

double QgsLayoutItemMapGrid::maxExtension ( ) const

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

Definition at line 2167 of file qgslayoutitemmapgrid.cpp.

◆ maximumIntervalWidth()

double QgsLayoutItemMapGrid::maximumIntervalWidth ( ) const
inline

Returns the maximum width (in millimeters) for grid segments.

This property is only effective if the units() is set to DynamicPageSizeBased.

See also
units()
setMaximumIntervalWidth()
minimumIntervalWidth()
Since
QGIS 3.10

Definition at line 427 of file qgslayoutitemmapgrid.h.

◆ minimumIntervalWidth()

double QgsLayoutItemMapGrid::minimumIntervalWidth ( ) const
inline

Returns the minimum width (in millimeters) for grid segments.

This property is only effective if the units() is set to DynamicPageSizeBased.

See also
units()
setMinimumIntervalWidth()
maximumIntervalWidth()
Since
QGIS 3.10

Definition at line 405 of file qgslayoutitemmapgrid.h.

◆ offsetX()

double QgsLayoutItemMapGrid::offsetX ( ) const
inline

Returns the offset for grid lines in the x-direction.

The units are retrieved through the units() method.

See also
setOffsetX()
offsetY()

Definition at line 378 of file qgslayoutitemmapgrid.h.

◆ offsetY()

double QgsLayoutItemMapGrid::offsetY ( ) const
inline

Returns the offset for grid lines in the y-direction.

The units are retrieved through the units() method.

See also
setOffsetY()
offsetX()

Definition at line 394 of file qgslayoutitemmapgrid.h.

◆ readXml()

bool QgsLayoutItemMapGrid::readXml ( const QDomElement &  element,
const QDomDocument &  doc,
const QgsReadWriteContext context 
)
overridevirtual

Sets the map item state from a DOM document, where element is the DOM node corresponding to a 'LayoutMapGrid' tag.

See also
writeXml()

Reimplemented from QgsLayoutItemMapItem.

Definition at line 284 of file qgslayoutitemmapgrid.cpp.

◆ refresh()

void QgsLayoutItemMapGrid::refresh ( )
overridevirtual

Refreshes the object, causing a recalculation of any property overrides.

Reimplemented from QgsLayoutObject.

Definition at line 2402 of file qgslayoutitemmapgrid.cpp.

◆ setAnnotationDirection() [1/2]

void QgsLayoutItemMapGrid::setAnnotationDirection ( const QgsLayoutItemMapGrid::AnnotationDirection  direction,
const QgsLayoutItemMapGrid::BorderSide  border 
)

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

See also
annotationDirection()

Definition at line 2331 of file qgslayoutitemmapgrid.cpp.

◆ setAnnotationDirection() [2/2]

void QgsLayoutItemMapGrid::setAnnotationDirection ( AnnotationDirection  direction)

Sets the direction for drawing all frame annotations.

See also
annotationDirection()

Definition at line 2433 of file qgslayoutitemmapgrid.cpp.

◆ setAnnotationDisplay()

void QgsLayoutItemMapGrid::setAnnotationDisplay ( const QgsLayoutItemMapGrid::DisplayMode  display,
const QgsLayoutItemMapGrid::BorderSide  border 
)

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
displaydisplay mode for annotations
borderside of map for annotations
See also
annotationDisplay()

Definition at line 2126 of file qgslayoutitemmapgrid.cpp.

◆ setAnnotationEnabled()

void QgsLayoutItemMapGrid::setAnnotationEnabled ( const bool  enabled)
inline

Sets whether annotations should be shown for the grid.

See also
annotationEnabled()

Definition at line 556 of file qgslayoutitemmapgrid.h.

◆ setAnnotationExpression()

void QgsLayoutItemMapGrid::setAnnotationExpression ( const QString &  expression)
inline

Sets the expression used for drawing grid annotations.

This is only used when annotationFormat() is QgsLayoutItemMapGrid::CustomFormat.

See also
annotationExpression()

Definition at line 683 of file qgslayoutitemmapgrid.h.

◆ setAnnotationFont()

void QgsLayoutItemMapGrid::setAnnotationFont ( const QFont &  font)
inline

Sets the font used for drawing grid annotations.

See also
annotationFont()

Definition at line 568 of file qgslayoutitemmapgrid.h.

◆ setAnnotationFontColor()

void QgsLayoutItemMapGrid::setAnnotationFontColor ( const QColor &  color)
inline

Sets the font color used for drawing grid annotations.

See also
annotationFontColor()

Definition at line 580 of file qgslayoutitemmapgrid.h.

◆ setAnnotationFormat()

void QgsLayoutItemMapGrid::setAnnotationFormat ( const AnnotationFormat  format)
inline

Sets the format for drawing grid annotations.

See also
annotationFormat()

Definition at line 670 of file qgslayoutitemmapgrid.h.

◆ setAnnotationFrameDistance()

void QgsLayoutItemMapGrid::setAnnotationFrameDistance ( const double  distance)

Sets the distance between the map frame and annotations.

Units are layout units.

See also
annotationFrameDistance()

Definition at line 2482 of file qgslayoutitemmapgrid.cpp.

◆ setAnnotationPosition()

void QgsLayoutItemMapGrid::setAnnotationPosition ( AnnotationPosition  position,
BorderSide  side 
)

Sets the position for the grid annotations on a specified side of the map frame.

See also
annotationPosition()

Definition at line 2441 of file qgslayoutitemmapgrid.cpp.

◆ setAnnotationPrecision()

void QgsLayoutItemMapGrid::setAnnotationPrecision ( const int  precision)
inline

Sets the coordinate precision for grid annotations.

The precision indicates the number of decimal places to show when drawing grid annotations.

See also
annotationPrecision()

Definition at line 593 of file qgslayoutitemmapgrid.h.

◆ setBlendMode()

void QgsLayoutItemMapGrid::setBlendMode ( const QPainter::CompositionMode  mode)
inline

Sets the blending mode used for drawing the grid.

See also
blendMode()

Definition at line 288 of file qgslayoutitemmapgrid.h.

◆ setCrossLength()

void QgsLayoutItemMapGrid::setCrossLength ( const double  length)

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

Definition at line 2325 of file qgslayoutitemmapgrid.cpp.

◆ setCrs()

void QgsLayoutItemMapGrid::setCrs ( const QgsCoordinateReferenceSystem crs)

Sets the crs for the grid.

See also
crs()

Definition at line 382 of file qgslayoutitemmapgrid.cpp.

◆ setEnabled()

void QgsLayoutItemMapGrid::setEnabled ( bool  enabled)
overridevirtual

Controls whether the item will be drawn.

Set enabled to true to enable drawing of the item.

See also
enabled()

Reimplemented from QgsLayoutItemMapItem.

Definition at line 2233 of file qgslayoutitemmapgrid.cpp.

◆ setFrameDivisions()

void QgsLayoutItemMapGrid::setFrameDivisions ( const QgsLayoutItemMapGrid::DisplayMode  divisions,
const QgsLayoutItemMapGrid::BorderSide  border 
)

Sets what type of grid divisions should be used for frames on a specified side of the map.

See also
frameDivisions()

Definition at line 2509 of file qgslayoutitemmapgrid.cpp.

◆ setFrameFillColor1()

void QgsLayoutItemMapGrid::setFrameFillColor1 ( const QColor &  color)
inline

Sets the first fill color used for the grid frame.

See also
frameFillColor1()
setFramePenColor()
setFrameFillColor2()

Definition at line 829 of file qgslayoutitemmapgrid.h.

◆ setFrameFillColor2()

void QgsLayoutItemMapGrid::setFrameFillColor2 ( const QColor &  color)
inline

Sets the second fill color used for the grid frame.

See also
frameFillColor2()
setFramePenColor()
setFrameFillColor1()

Definition at line 845 of file qgslayoutitemmapgrid.h.

◆ setFrameMargin()

void QgsLayoutItemMapGrid::setFrameMargin ( const double  margin)

Sets the grid frame margin (in layout units).

This property controls distance between the map frame and the grid frame.

See also
frameMargin()
Since
QGIS 3.6

Definition at line 2421 of file qgslayoutitemmapgrid.cpp.

◆ setFramePenColor()

void QgsLayoutItemMapGrid::setFramePenColor ( const QColor &  color)
inline

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

See also
framePenColor()
setFramePenSize()
setFrameFillColor1()
setFrameFillColor2()

Definition at line 812 of file qgslayoutitemmapgrid.h.

◆ setFramePenSize()

void QgsLayoutItemMapGrid::setFramePenSize ( const double  width)

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

See also
framePenSize()
setFramePenColor()

Definition at line 2427 of file qgslayoutitemmapgrid.cpp.

◆ setFrameSideFlag()

void QgsLayoutItemMapGrid::setFrameSideFlag ( QgsLayoutItemMapGrid::FrameSideFlag  flag,
bool  on = true 
)

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

Parameters
flagflag for grid frame side
onset to true to draw grid frame on that side of the map
See also
setFrameSideFlags()
frameSideFlags()
testFrameSideFlag()

Definition at line 2361 of file qgslayoutitemmapgrid.cpp.

◆ setFrameSideFlags()

void QgsLayoutItemMapGrid::setFrameSideFlags ( QgsLayoutItemMapGrid::FrameSideFlags  flags)

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

Definition at line 2356 of file qgslayoutitemmapgrid.cpp.

◆ setFrameStyle()

void QgsLayoutItemMapGrid::setFrameStyle ( const FrameStyle  style)
inline

Sets the grid frame style.

See also
frameStyle()

Definition at line 700 of file qgslayoutitemmapgrid.h.

◆ setFrameWidth()

void QgsLayoutItemMapGrid::setFrameWidth ( const double  width)

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

Definition at line 2415 of file qgslayoutitemmapgrid.cpp.

◆ setGridLineColor()

void QgsLayoutItemMapGrid::setGridLineColor ( const QColor &  color)

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

Definition at line 205 of file qgslayoutitemmapgrid.cpp.

◆ setGridLineWidth()

void QgsLayoutItemMapGrid::setGridLineWidth ( double  width)

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

Definition at line 197 of file qgslayoutitemmapgrid.cpp.

◆ setIntervalX()

void QgsLayoutItemMapGrid::setIntervalX ( double  interval)

Sets the interval between grid lines in the x-direction.

The units are controlled through the setUnits method

See also
setIntervalY()
intervalX()

Definition at line 2249 of file qgslayoutitemmapgrid.cpp.

◆ setIntervalY()

void QgsLayoutItemMapGrid::setIntervalY ( double  interval)

Sets the interval between grid lines in the y-direction.

The units are controlled through the setUnits method

See also
setIntervalX()
intervalY()

Definition at line 2260 of file qgslayoutitemmapgrid.cpp.

◆ setLineSymbol()

void QgsLayoutItemMapGrid::setLineSymbol ( QgsLineSymbol symbol)

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

Definition at line 2096 of file qgslayoutitemmapgrid.cpp.

◆ setMarkerSymbol()

void QgsLayoutItemMapGrid::setMarkerSymbol ( QgsMarkerSymbol symbol)

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

Definition at line 2111 of file qgslayoutitemmapgrid.cpp.

◆ setMaximumIntervalWidth()

void QgsLayoutItemMapGrid::setMaximumIntervalWidth ( double  width)

Sets the maximum width (in millimeters) for grid segments.

This property is only effective if the units() is set to DynamicPageSizeBased.

See also
maximumIntervalWidth()
setMinimumIntervalWidth()
setUnits()
Since
QGIS 3.10

Definition at line 2304 of file qgslayoutitemmapgrid.cpp.

◆ setMinimumIntervalWidth()

void QgsLayoutItemMapGrid::setMinimumIntervalWidth ( double  width)

Sets the minimum width (in millimeters) for grid segments.

This property is only effective if the units() is set to DynamicPageSizeBased.

See also
minimumIntervalWidth()
setMaximumIntervalWidth()
setUnits()
Since
QGIS 3.10

Definition at line 2293 of file qgslayoutitemmapgrid.cpp.

◆ setOffsetX()

void QgsLayoutItemMapGrid::setOffsetX ( double  offset)

Sets the offset for grid lines in the x-direction.

The units are controlled through the setUnits method.

See also
setOffsetY()
offsetX()

Definition at line 2271 of file qgslayoutitemmapgrid.cpp.

◆ setOffsetY()

void QgsLayoutItemMapGrid::setOffsetY ( double  offset)

Sets the offset for grid lines in the y-direction.

The units are controlled through the setUnits method.

See also
setOffsetX()
offsetY()

Definition at line 2282 of file qgslayoutitemmapgrid.cpp.

◆ setStyle()

void QgsLayoutItemMapGrid::setStyle ( const QgsLayoutItemMapGrid::GridStyle  style)

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

See also
style()

Definition at line 2315 of file qgslayoutitemmapgrid.cpp.

◆ setUnits()

void QgsLayoutItemMapGrid::setUnits ( const QgsLayoutItemMapGrid::GridUnit  unit)

Sets the unit to use for grid measurements such as the interval and offset for grid lines.

See also
units

Definition at line 2239 of file qgslayoutitemmapgrid.cpp.

◆ style()

GridStyle QgsLayoutItemMapGrid::style ( ) const
inline

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

See also
setStyle()

Definition at line 456 of file qgslayoutitemmapgrid.h.

◆ testFrameSideFlag()

bool QgsLayoutItemMapGrid::testFrameSideFlag ( QgsLayoutItemMapGrid::FrameSideFlag  flag) const

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

Parameters
flagflag for grid frame side
Returns
true if grid frame should be drawn for that side of the map
See also
setFrameSideFlags()
setFrameSideFlag()
frameSideFlags()

Definition at line 2410 of file qgslayoutitemmapgrid.cpp.

◆ units()

GridUnit QgsLayoutItemMapGrid::units ( ) const
inline

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

See also
setUnits()

Definition at line 330 of file qgslayoutitemmapgrid.h.

◆ usesAdvancedEffects()

bool QgsLayoutItemMapGrid::usesAdvancedEffects ( ) const
overridevirtual

Returns true if the item is drawn using advanced effects, such as blend modes.

Reimplemented from QgsLayoutItemMapItem.

Definition at line 388 of file qgslayoutitemmapgrid.cpp.

◆ writeXml()

bool QgsLayoutItemMapGrid::writeXml ( QDomElement &  element,
QDomDocument &  document,
const QgsReadWriteContext context 
) const
overridevirtual

Stores map item state in a DOM element, where element is the DOM element corresponding to a 'LayoutMap' tag.

See also
readXml()

Reimplemented from QgsLayoutItemMapItem.

Definition at line 213 of file qgslayoutitemmapgrid.cpp.

Friends And Related Function Documentation

◆ TestQgsLayoutMapGrid

friend class TestQgsLayoutMapGrid
friend

Definition at line 1086 of file qgslayoutitemmapgrid.h.


The documentation for this class was generated from the following files: