QGIS API Documentation 3.39.0-Master (9ea1ddbe645)
|
An individual grid which is drawn above the map content in a QgsLayoutItemMap. More...
#include <qgslayoutitemmapgrid.h>
Signals | |
void | crsChanged () |
Emitted whenever the grid's CRS is changed. | |
![]() | |
void | changed () |
Emitted when the object's properties change. | |
Public Member Functions | |
QgsLayoutItemMapGrid (const QString &name, QgsLayoutItemMap *map) | |
Constructor for QgsLayoutItemMapGrid. | |
~QgsLayoutItemMapGrid () override | |
bool | accept (QgsStyleEntityVisitorInterface *visitor) const override |
Accepts the specified style entity visitor, causing it to visit all style entities associated with the map item. | |
AnnotationDirection | annotationDirection (BorderSide border) const |
Returns the direction for drawing frame annotations, on the specified side of the map. | |
DisplayMode | annotationDisplay (BorderSide border) const |
Returns the display mode for the grid annotations on a specified side of the map frame. | |
bool | annotationEnabled () const |
Returns whether annotations are shown for the grid. | |
QString | annotationExpression () const |
Returns the expression used for drawing grid annotations. | |
Q_DECL_DEPRECATED QFont | annotationFont () const |
Returns the font used for drawing grid annotations. | |
Q_DECL_DEPRECATED QColor | annotationFontColor () const |
Returns the font color used for drawing grid annotations. | |
AnnotationFormat | annotationFormat () const |
Returns the format for drawing grid annotations. | |
double | annotationFrameDistance () const |
Returns the distance between the map frame and annotations. | |
AnnotationPosition | annotationPosition (BorderSide side) const |
Returns the position for the grid annotations on a specified side of the map frame. | |
int | annotationPrecision () const |
Returns the coordinate precision for grid annotations, which is the number of decimal places shown when drawing grid annotations. | |
QgsTextFormat | annotationTextFormat () const |
Returns the text format used when rendering grid annotations. | |
QPainter::CompositionMode | blendMode () const |
Retrieves the blending mode used for drawing the grid. | |
void | calculateMaxExtension (double &top, double &right, double &bottom, double &left) const |
Calculates the maximum distance the grid extends beyond the QgsLayoutItemMap's item rect. | |
void | copyProperties (const QgsLayoutItemMapGrid *other) |
Copies properties from specified map grid. | |
QgsExpressionContext | createExpressionContext () const override |
This method needs to be reimplemented in all classes which implement this interface and return an expression context. | |
double | crossLength () const |
Retrieves the length (in layout units) of the cross segments drawn for the grid. | |
QgsCoordinateReferenceSystem | crs () const |
Retrieves the CRS for the grid. | |
void | draw (QPainter *painter) override |
Draws the item on to a destination painter. | |
DisplayMode | frameDivisions (BorderSide side) const |
Returns the type of grid divisions which are used for frames on a specified side of the map. | |
QColor | frameFillColor1 () const |
Retrieves the first fill color for the grid frame. | |
QColor | frameFillColor2 () const |
Retrieves the second fill color for the grid frame. | |
double | frameMargin () const |
Sets the grid frame Margin (in layout units). | |
QColor | framePenColor () const |
Retrieves the color of the stroke drawn in the grid frame. | |
double | framePenSize () const |
Retrieves the width of the stroke drawn in the grid frame. | |
QgsLayoutItemMapGrid::FrameSideFlags | frameSideFlags () const |
Returns the flags which control which sides of the map item the grid frame is drawn on. | |
FrameStyle | frameStyle () const |
Returns the grid frame style. | |
double | frameWidth () const |
Gets the grid frame width in layout units. | |
double | intervalX () const |
Returns the interval between grid lines in the x-direction. | |
double | intervalY () const |
Returns the interval between grid lines in the y-direction. | |
QgsLineSymbol * | lineSymbol () |
Returns the line symbol used for drawing grid lines. | |
const QgsLineSymbol * | lineSymbol () const |
Returns the line symbol used for drawing grid lines. | |
QgsMarkerSymbol * | markerSymbol () |
Returns the marker symbol used for drawing grid points. | |
const QgsMarkerSymbol * | markerSymbol () const |
Returns the marker symbol used for drawing grid points. | |
double | maxExtension () const |
Calculates the maximum distance the grid extends beyond the QgsLayoutItemMap's item rect (in layout units). | |
double | maximumIntervalWidth () const |
Returns the maximum width (in millimeters) for grid segments. | |
double | minimumIntervalWidth () const |
Returns the minimum width (in millimeters) for grid segments. | |
double | offsetX () const |
Returns the offset for grid lines in the x-direction. | |
double | offsetY () const |
Returns the offset for grid lines in the y-direction. | |
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. | |
void | refresh () override |
Refreshes the object, causing a recalculation of any property overrides. | |
double | rotatedAnnotationsEnabled () const |
Gets whether annotations rotation for rotated or reprojected grids is enabled. | |
TickLengthMode | rotatedAnnotationsLengthMode () const |
Returns the annotation length calculation mode. | |
double | rotatedAnnotationsMarginToCorner () const |
Gets the margin to corners (in canvas units) below which outwards facing annotations are not drawn. | |
double | rotatedAnnotationsMinimumAngle () const |
Gets the minimum angle (in degrees) below which annotations are not drawn. | |
double | rotatedTicksEnabled () const |
Gets whether ticks rotation for rotated or reprojected grids is enabled. | |
TickLengthMode | rotatedTicksLengthMode () const |
Returns the grid frame style. | |
double | rotatedTicksMarginToCorner () const |
Gets the margin to corners (in canvas units) below which outwards facing ticks are not drawn. | |
double | rotatedTicksMinimumAngle () const |
Gets the minimum angle (in degrees) below which ticks are not drawn. | |
void | setAnnotationDirection (AnnotationDirection direction) |
Sets the direction for drawing all frame annotations. | |
void | setAnnotationDirection (AnnotationDirection direction, BorderSide side) |
Sets the direction for drawing frame annotations for the specified map side. | |
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. | |
void | setAnnotationEnabled (const bool enabled) |
Sets whether annotations should be shown for the grid. | |
void | setAnnotationExpression (const QString &expression) |
Sets the expression used for drawing grid annotations. | |
Q_DECL_DEPRECATED void | setAnnotationFont (const QFont &font) |
Sets the font used for drawing grid annotations. | |
Q_DECL_DEPRECATED void | setAnnotationFontColor (const QColor &color) |
Sets the font color used for drawing grid annotations. | |
void | setAnnotationFormat (const AnnotationFormat format) |
Sets the format for drawing grid annotations. | |
void | setAnnotationFrameDistance (const double distance) |
Sets the distance between the map frame and annotations. | |
void | setAnnotationPosition (AnnotationPosition position, BorderSide side) |
Sets the position for the grid annotations on a specified side of the map frame. | |
void | setAnnotationPrecision (const int precision) |
Sets the coordinate precision for grid annotations. | |
void | setAnnotationTextFormat (const QgsTextFormat &format) |
Sets the text format to use when rendering grid annotations. | |
void | setBlendMode (const QPainter::CompositionMode mode) |
Sets the blending mode used for drawing the grid. | |
void | setCrossLength (const double length) |
Sets the length (in layout units) of the cross segments drawn for the grid. | |
void | setCrs (const QgsCoordinateReferenceSystem &crs) |
Sets the crs for the grid. | |
void | setEnabled (bool enabled) override |
Controls whether the item will be drawn. | |
void | setFrameDivisions (DisplayMode divisions, BorderSide side) |
Sets what type of grid divisions should be used for frames on a specified side of the map. | |
void | setFrameFillColor1 (const QColor &color) |
Sets the first fill color used for the grid frame. | |
void | setFrameFillColor2 (const QColor &color) |
Sets the second fill color used for the grid frame. | |
void | setFrameMargin (const double margin) |
Sets the grid frame margin (in layout units). | |
void | setFramePenColor (const QColor &color) |
Sets the color of the stroke drawn in the grid frame. | |
void | setFramePenSize (const double width) |
Sets the width of the stroke drawn in the grid frame. | |
void | setFrameSideFlag (QgsLayoutItemMapGrid::FrameSideFlag flag, bool on=true) |
Sets whether the grid frame is drawn for a certain side of the map item. | |
void | setFrameSideFlags (QgsLayoutItemMapGrid::FrameSideFlags flags) |
Sets flags for grid frame sides. | |
void | setFrameStyle (const FrameStyle style) |
Sets the grid frame style. | |
void | setFrameWidth (const double width) |
Sets the grid frame width (in layout units). | |
void | setGridLineColor (const QColor &color) |
Sets the color of grid lines. | |
void | setGridLineWidth (double width) |
Sets the width of grid lines (in layout units). | |
void | setIntervalX (double interval) |
Sets the interval between grid lines in the x-direction. | |
void | setIntervalY (double interval) |
Sets the interval between grid lines in the y-direction. | |
void | setLineSymbol (QgsLineSymbol *symbol) |
Sets the line symbol used for drawing grid lines. | |
void | setMarkerSymbol (QgsMarkerSymbol *symbol) |
Sets the marker symbol used for drawing grid points. | |
void | setMaximumIntervalWidth (double width) |
Sets the maximum width (in millimeters) for grid segments. | |
void | setMinimumIntervalWidth (double width) |
Sets the minimum width (in millimeters) for grid segments. | |
void | setOffsetX (double offset) |
Sets the offset for grid lines in the x-direction. | |
void | setOffsetY (double offset) |
Sets the offset for grid lines in the y-direction. | |
void | setRotatedAnnotationsEnabled (const bool state) |
Enable/disable annotations rotation for rotated or reprojected grids. | |
void | setRotatedAnnotationsLengthMode (const TickLengthMode mode) |
Sets the annotation length calculation mode. | |
void | setRotatedAnnotationsMarginToCorner (const double margin) |
Sets the margin to corners (in canvas units) below which outwards facing annotations are not drawn. | |
void | setRotatedAnnotationsMinimumAngle (const double angle) |
Sets the minimum angle (in degrees) below which annotations are not drawn. | |
void | setRotatedTicksEnabled (const bool state) |
Enable/disable ticks rotation for rotated or reprojected grids. | |
void | setRotatedTicksLengthMode (const TickLengthMode mode) |
Sets the tick length calculation mode. | |
void | setRotatedTicksMarginToCorner (const double margin) |
Sets the margin to corners (in canvas units) below which outwards facing ticks are not drawn. | |
void | setRotatedTicksMinimumAngle (const double angle) |
Sets the minimum angle (in degrees) below which ticks are not drawn. | |
void | setStyle (GridStyle style) |
Sets the grid style, which controls how the grid is drawn over the map's contents. | |
void | setUnits (GridUnit unit) |
Sets the unit to use for grid measurements such as the interval and offset for grid lines. | |
GridStyle | style () const |
Returns the grid's style, which controls how the grid is drawn over the map's contents. | |
bool | testFrameSideFlag (FrameSideFlag flag) const |
Tests whether the grid frame should be drawn on a specified side of the map item. | |
GridUnit | units () const |
Returns the units used for grid measurements such as the interval and offset for grid lines. | |
bool | usesAdvancedEffects () const override |
Returns true if the item is drawn using advanced effects, such as blend modes. | |
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. | |
![]() | |
QgsLayoutItemMapItem (const QString &name, QgsLayoutItemMap *map) | |
Constructor for QgsLayoutItemMapItem, attached to the specified map. | |
QgsExpressionContext | createExpressionContext () const override |
This method needs to be reimplemented in all classes which implement this interface and return an expression context. | |
bool | enabled () const |
Returns whether the item will be drawn. | |
virtual void | finalizeRestoreFromXml () |
Called after all pending items have been restored from XML. | |
QString | id () const |
Returns the unique id for the map item. | |
const QgsLayoutItemMap * | map () const |
Returns the layout item map for the item. | |
virtual QgsMapLayer * | mapLayer () |
Returns the internal map layer used by this item, if available. | |
QString | name () const |
Returns the friendly display name for the item. | |
void | setMap (QgsLayoutItemMap *map) |
Sets the corresponding layout map for the item. | |
void | setName (const QString &name) |
Sets the friendly display name for the item. | |
void | setStackingLayer (QgsMapLayer *layer) |
Sets the item's stacking layer, which specifies where the in the map's stack the item should be rendered. | |
void | setStackingPosition (StackingPosition position) |
Sets the item's stacking position, which specifies where the in the map's stack the item should be rendered. | |
QgsMapLayer * | stackingLayer () const |
Returns the item's stacking layer, which specifies where the in the map's stack the item should be rendered. | |
StackingPosition | stackingPosition () const |
Returns the item's stacking position, which specifies where the in the map's stack the item should be rendered. | |
![]() | |
QgsLayoutObject (QgsLayout *layout) | |
Constructor for QgsLayoutObject, with the specified parent layout. | |
QgsExpressionContext | createExpressionContext () const override |
Creates an expression context relating to the objects' current state. | |
QStringList | customProperties () const |
Returns list of keys stored in custom properties for the object. | |
QVariant | customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const |
Read a custom property from the object. | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the object's property collection, used for data defined overrides. | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the object's property collection, used for data defined overrides. | |
QgsLayout * | layout () |
Returns the layout the object is attached to. | |
const QgsLayout * | layout () const |
Returns the layout the object is attached to. | |
void | removeCustomProperty (const QString &key) |
Remove a custom property from the object. | |
void | setCustomProperty (const QString &key, const QVariant &value) |
Set a custom property for the object. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the objects's property collection, used for data defined overrides. | |
![]() | |
virtual | ~QgsExpressionContextGenerator ()=default |
Friends | |
class | QgsLayoutItemMap |
class | TestQgsLayoutMapGrid |
Additional Inherited Members | |
![]() | |
![]() | |
static bool | propertyAssociatesWithParentMultiframe (DataDefinedProperty property) |
Returns true if the specified property key is normally associated with the parent QgsLayoutMultiFrame object instead of a child QgsLayoutFrame object. | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the layout object property definitions. | |
![]() | |
bool | readObjectPropertiesFromElement (const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context) |
Sets object properties from a DOM element. | |
bool | writeObjectPropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores object properties within an XML DOM element. | |
![]() | |
bool | mEnabled |
True if item is to be displayed on map. | |
QgsLayoutItemMap * | mMap = nullptr |
Associated map. | |
QString | mName |
Friendly display name. | |
QgsMapLayerRef | mStackingLayer |
StackingPosition | mStackingPosition = StackBelowMapLabels |
QString | mUuid |
Unique id. | |
![]() | |
QgsObjectCustomProperties | mCustomProperties |
Custom properties for object. | |
QgsPropertyCollection | mDataDefinedProperties |
QPointer< QgsLayout > | mLayout |
An individual grid which is drawn above the map content in a QgsLayoutItemMap.
Definition at line 138 of file qgslayoutitemmapgrid.h.
typedef QFlags< FrameSideFlag > QgsLayoutItemMapGrid::FrameSideFlags |
Definition at line 262 of file qgslayoutitemmapgrid.h.
Annotation coordinate type.
Enumerator | |
---|---|
Longitude | Coordinate is a longitude value. |
Latitude | Coordinate is a latitude value. |
Definition at line 267 of file qgslayoutitemmapgrid.h.
Direction of grid annotations.
Definition at line 190 of file qgslayoutitemmapgrid.h.
Format for displaying grid annotations.
Definition at line 204 of file qgslayoutitemmapgrid.h.
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.
Border sides for annotations.
Enumerator | |
---|---|
Left | Left border. |
Right | Right border. |
Bottom | Bottom border. |
Top | Top border. |
Definition at line 220 of file qgslayoutitemmapgrid.h.
Display settings for grid annotations and frames.
Definition at line 170 of file qgslayoutitemmapgrid.h.
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 255 of file qgslayoutitemmapgrid.h.
Style for grid frame.
Definition at line 231 of file qgslayoutitemmapgrid.h.
Grid drawing style.
Definition at line 159 of file qgslayoutitemmapgrid.h.
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.
Tick length mode (useful for rotated grids)
Enumerator | |
---|---|
OrthogonalTicks | Align ticks orthogonaly. |
NormalizedTicks | Constant tick lengths. |
Definition at line 246 of file qgslayoutitemmapgrid.h.
QgsLayoutItemMapGrid::QgsLayoutItemMapGrid | ( | const QString & | name, |
QgsLayoutItemMap * | map | ||
) |
Constructor for QgsLayoutItemMapGrid.
name | friendly display name for grid |
map | QgsLayoutItemMap the grid is attached to |
Definition at line 188 of file qgslayoutitemmapgrid.cpp.
|
overridedefault |
|
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.
Reimplemented from QgsLayoutItemMapItem.
Definition at line 2395 of file qgslayoutitemmapgrid.cpp.
QgsLayoutItemMapGrid::AnnotationDirection QgsLayoutItemMapGrid::annotationDirection | ( | BorderSide | border | ) | const |
Returns the direction for drawing frame annotations, on the specified side of the map.
Definition at line 2499 of file qgslayoutitemmapgrid.cpp.
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.
border | side of map for annotations |
Definition at line 2161 of file qgslayoutitemmapgrid.cpp.
|
inline |
Returns whether annotations are shown for the grid.
Definition at line 575 of file qgslayoutitemmapgrid.h.
|
inline |
Returns the expression used for drawing grid annotations.
This is only used when annotationFormat() is QgsLayoutItemMapGrid::CustomFormat.
Definition at line 727 of file qgslayoutitemmapgrid.h.
QFont QgsLayoutItemMapGrid::annotationFont | ( | ) | const |
Returns the font used for drawing grid annotations.
Shortcut for annotationTextFormat().font().
Definition at line 2119 of file qgslayoutitemmapgrid.cpp.
QColor QgsLayoutItemMapGrid::annotationFontColor | ( | ) | const |
Returns the font color used for drawing grid annotations.
Shortcut for annotationTextFormat().color() and annotationTextFormat().opacity().
Definition at line 2129 of file qgslayoutitemmapgrid.cpp.
|
inline |
Returns the format for drawing grid annotations.
Definition at line 713 of file qgslayoutitemmapgrid.h.
|
inline |
Returns the distance between the map frame and annotations.
Units are in layout units.
Definition at line 682 of file qgslayoutitemmapgrid.h.
QgsLayoutItemMapGrid::AnnotationPosition QgsLayoutItemMapGrid::annotationPosition | ( | const QgsLayoutItemMapGrid::BorderSide | border | ) | const |
Returns the position for the grid annotations on a specified side of the map frame.
Definition at line 2477 of file qgslayoutitemmapgrid.cpp.
|
inline |
Returns the coordinate precision for grid annotations, which is the number of decimal places shown when drawing grid annotations.
Definition at line 637 of file qgslayoutitemmapgrid.h.
|
inline |
Returns the text format used when rendering grid annotations.
Definition at line 591 of file qgslayoutitemmapgrid.h.
|
inline |
Retrieves the blending mode used for drawing the grid.
Definition at line 307 of file qgslayoutitemmapgrid.h.
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.
Definition at line 2187 of file qgslayoutitemmapgrid.cpp.
void QgsLayoutItemMapGrid::copyProperties | ( | const QgsLayoutItemMapGrid * | other | ) |
Copies properties from specified map grid.
Definition at line 2638 of file qgslayoutitemmapgrid.cpp.
|
overridevirtual |
This method needs to be reimplemented in all classes which implement this interface and return an expression context.
Implements QgsExpressionContextGenerator.
Definition at line 2385 of file qgslayoutitemmapgrid.cpp.
|
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.
Definition at line 483 of file qgslayoutitemmapgrid.h.
|
inline |
Retrieves the CRS for the grid.
Definition at line 295 of file qgslayoutitemmapgrid.h.
|
signal |
Emitted whenever the grid's CRS is changed.
|
overridevirtual |
Draws the item on to a destination painter.
Implements QgsLayoutItemMapItem.
Definition at line 598 of file qgslayoutitemmapgrid.cpp.
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.
Definition at line 2552 of file qgslayoutitemmapgrid.cpp.
|
inline |
Retrieves the first fill color for the grid frame.
Definition at line 986 of file qgslayoutitemmapgrid.h.
|
inline |
Retrieves the second fill color for the grid frame.
Definition at line 1002 of file qgslayoutitemmapgrid.h.
|
inline |
Sets the grid frame Margin (in layout units).
This property controls distance between the map frame and the grid frame.
Definition at line 938 of file qgslayoutitemmapgrid.h.
|
inline |
Retrieves the color of the stroke drawn in the grid frame.
Definition at line 970 of file qgslayoutitemmapgrid.h.
|
inline |
Retrieves the width of the stroke drawn in the grid frame.
Definition at line 952 of file qgslayoutitemmapgrid.h.
QgsLayoutItemMapGrid::FrameSideFlags QgsLayoutItemMapGrid::frameSideFlags | ( | ) | const |
Returns the flags which control which sides of the map item the grid frame is drawn on.
Definition at line 2380 of file qgslayoutitemmapgrid.cpp.
|
inline |
Returns the grid frame style.
Definition at line 743 of file qgslayoutitemmapgrid.h.
|
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.
Definition at line 810 of file qgslayoutitemmapgrid.h.
|
inline |
Returns the interval between grid lines in the x-direction.
The units are retrieved through the units() method.
Definition at line 359 of file qgslayoutitemmapgrid.h.
|
inline |
Returns the interval between grid lines in the y-direction.
The units are retrieved through the units() method.
Definition at line 375 of file qgslayoutitemmapgrid.h.
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.
Definition at line 2084 of file qgslayoutitemmapgrid.cpp.
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.
Definition at line 2079 of file qgslayoutitemmapgrid.cpp.
QgsMarkerSymbol * QgsLayoutItemMapGrid::markerSymbol | ( | ) |
Returns the marker symbol used for drawing grid points.
This is only used for grids with a QgsLayoutItemMapGrid::Markers style.
Definition at line 2099 of file qgslayoutitemmapgrid.cpp.
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.
Definition at line 2094 of file qgslayoutitemmapgrid.cpp.
double QgsLayoutItemMapGrid::maxExtension | ( | ) | const |
Calculates the maximum distance the grid extends beyond the QgsLayoutItemMap's item rect (in layout units).
Definition at line 2177 of file qgslayoutitemmapgrid.cpp.
|
inline |
Returns the maximum width (in millimeters) for grid segments.
This property is only effective if the units() is set to DynamicPageSizeBased.
Definition at line 440 of file qgslayoutitemmapgrid.h.
|
inline |
Returns the minimum width (in millimeters) for grid segments.
This property is only effective if the units() is set to DynamicPageSizeBased.
Definition at line 418 of file qgslayoutitemmapgrid.h.
|
inline |
Returns the offset for grid lines in the x-direction.
The units are retrieved through the units() method.
Definition at line 391 of file qgslayoutitemmapgrid.h.
|
inline |
Returns the offset for grid lines in the y-direction.
The units are retrieved through the units() method.
Definition at line 407 of file qgslayoutitemmapgrid.h.
|
overridevirtual |
Sets the map item state from a DOM document, where element is the DOM node corresponding to a 'LayoutMapGrid' tag.
Reimplemented from QgsLayoutItemMapItem.
Definition at line 329 of file qgslayoutitemmapgrid.cpp.
|
overridevirtual |
Refreshes the object, causing a recalculation of any property overrides.
Reimplemented from QgsLayoutObject.
Definition at line 2413 of file qgslayoutitemmapgrid.cpp.
|
inline |
Gets whether annotations rotation for rotated or reprojected grids is enabled.
Definition at line 880 of file qgslayoutitemmapgrid.h.
|
inline |
Returns the annotation length calculation mode.
Definition at line 894 of file qgslayoutitemmapgrid.h.
|
inline |
Gets the margin to corners (in canvas units) below which outwards facing annotations are not drawn.
Definition at line 922 of file qgslayoutitemmapgrid.h.
|
inline |
Gets the minimum angle (in degrees) below which annotations are not drawn.
Definition at line 908 of file qgslayoutitemmapgrid.h.
|
inline |
Gets whether ticks rotation for rotated or reprojected grids is enabled.
Definition at line 824 of file qgslayoutitemmapgrid.h.
|
inline |
Returns the grid frame style.
Definition at line 838 of file qgslayoutitemmapgrid.h.
|
inline |
Gets the margin to corners (in canvas units) below which outwards facing ticks are not drawn.
Definition at line 866 of file qgslayoutitemmapgrid.h.
|
inline |
Gets the minimum angle (in degrees) below which ticks are not drawn.
Definition at line 852 of file qgslayoutitemmapgrid.h.
void QgsLayoutItemMapGrid::setAnnotationDirection | ( | AnnotationDirection | direction | ) |
Sets the direction for drawing all frame annotations.
Definition at line 2444 of file qgslayoutitemmapgrid.cpp.
void QgsLayoutItemMapGrid::setAnnotationDirection | ( | const QgsLayoutItemMapGrid::AnnotationDirection | direction, |
const QgsLayoutItemMapGrid::BorderSide | border | ||
) |
Sets the direction for drawing frame annotations for the specified map side.
Definition at line 2342 of file qgslayoutitemmapgrid.cpp.
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.
display | display mode for annotations |
border | side of map for annotations |
Definition at line 2134 of file qgslayoutitemmapgrid.cpp.
|
inline |
Sets whether annotations should be shown for the grid.
Definition at line 569 of file qgslayoutitemmapgrid.h.
void QgsLayoutItemMapGrid::setAnnotationExpression | ( | const QString & | expression | ) |
Sets the expression used for drawing grid annotations.
This is only used when annotationFormat() is QgsLayoutItemMapGrid::CustomFormat.
Definition at line 2520 of file qgslayoutitemmapgrid.cpp.
void QgsLayoutItemMapGrid::setAnnotationFont | ( | const QFont & | font | ) |
Sets the font used for drawing grid annotations.
Shortcut for annotationTextFormat().setFont().
Definition at line 2104 of file qgslayoutitemmapgrid.cpp.
void QgsLayoutItemMapGrid::setAnnotationFontColor | ( | const QColor & | color | ) |
Sets the font color used for drawing grid annotations.
Shortcut for annotationTextFormat().setColor() and annotationTextFormat().setOpacity().
Definition at line 2124 of file qgslayoutitemmapgrid.cpp.
|
inline |
Sets the format for drawing grid annotations.
Definition at line 707 of file qgslayoutitemmapgrid.h.
void QgsLayoutItemMapGrid::setAnnotationFrameDistance | ( | const double | distance | ) |
Sets the distance between the map frame and annotations.
Units are layout units.
Definition at line 2493 of file qgslayoutitemmapgrid.cpp.
void QgsLayoutItemMapGrid::setAnnotationPosition | ( | AnnotationPosition | position, |
BorderSide | side | ||
) |
Sets the position for the grid annotations on a specified side of the map frame.
Definition at line 2452 of file qgslayoutitemmapgrid.cpp.
|
inline |
Sets the coordinate precision for grid annotations.
The precision indicates the number of decimal places to show when drawing grid annotations.
Definition at line 630 of file qgslayoutitemmapgrid.h.
|
inline |
Sets the text format to use when rendering grid annotations.
Definition at line 583 of file qgslayoutitemmapgrid.h.
|
inline |
Sets the blending mode used for drawing the grid.
Definition at line 301 of file qgslayoutitemmapgrid.h.
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.
Definition at line 2336 of file qgslayoutitemmapgrid.cpp.
void QgsLayoutItemMapGrid::setCrs | ( | const QgsCoordinateReferenceSystem & | crs | ) |
|
overridevirtual |
Controls whether the item will be drawn.
Set enabled to true
to enable drawing of the item.
Reimplemented from QgsLayoutItemMapItem.
Definition at line 2244 of file qgslayoutitemmapgrid.cpp.
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.
Definition at line 2526 of file qgslayoutitemmapgrid.cpp.
|
inline |
Sets the first fill color used for the grid frame.
Definition at line 978 of file qgslayoutitemmapgrid.h.
|
inline |
Sets the second fill color used for the grid frame.
Definition at line 994 of file qgslayoutitemmapgrid.h.
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.
Definition at line 2432 of file qgslayoutitemmapgrid.cpp.
|
inline |
Sets the color of the stroke drawn in the grid frame.
Definition at line 961 of file qgslayoutitemmapgrid.h.
void QgsLayoutItemMapGrid::setFramePenSize | ( | const double | width | ) |
Sets the width of the stroke drawn in the grid frame.
Definition at line 2438 of file qgslayoutitemmapgrid.cpp.
void QgsLayoutItemMapGrid::setFrameSideFlag | ( | QgsLayoutItemMapGrid::FrameSideFlag | flag, |
bool | on = true |
||
) |
Sets whether the grid frame is drawn for a certain side of the map item.
flag | flag for grid frame side |
on | set to true to draw grid frame on that side of the map |
Definition at line 2372 of file qgslayoutitemmapgrid.cpp.
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.
Definition at line 2367 of file qgslayoutitemmapgrid.cpp.
|
inline |
Sets the grid frame style.
Definition at line 737 of file qgslayoutitemmapgrid.h.
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.
Definition at line 2426 of file qgslayoutitemmapgrid.cpp.
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.
Definition at line 243 of file qgslayoutitemmapgrid.cpp.
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.
Definition at line 235 of file qgslayoutitemmapgrid.cpp.
void QgsLayoutItemMapGrid::setIntervalX | ( | double | interval | ) |
Sets the interval between grid lines in the x-direction.
The units are controlled through the setUnits method
Definition at line 2260 of file qgslayoutitemmapgrid.cpp.
void QgsLayoutItemMapGrid::setIntervalY | ( | double | interval | ) |
Sets the interval between grid lines in the y-direction.
The units are controlled through the setUnits method
Definition at line 2271 of file qgslayoutitemmapgrid.cpp.
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.
Definition at line 2074 of file qgslayoutitemmapgrid.cpp.
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.
Definition at line 2089 of file qgslayoutitemmapgrid.cpp.
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.
Definition at line 2315 of file qgslayoutitemmapgrid.cpp.
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.
Definition at line 2304 of file qgslayoutitemmapgrid.cpp.
void QgsLayoutItemMapGrid::setOffsetX | ( | double | offset | ) |
Sets the offset for grid lines in the x-direction.
The units are controlled through the setUnits method.
Definition at line 2282 of file qgslayoutitemmapgrid.cpp.
void QgsLayoutItemMapGrid::setOffsetY | ( | double | offset | ) |
Sets the offset for grid lines in the y-direction.
The units are controlled through the setUnits method.
Definition at line 2293 of file qgslayoutitemmapgrid.cpp.
|
inline |
Enable/disable annotations rotation for rotated or reprojected grids.
Definition at line 873 of file qgslayoutitemmapgrid.h.
|
inline |
Sets the annotation length calculation mode.
Definition at line 887 of file qgslayoutitemmapgrid.h.
|
inline |
Sets the margin to corners (in canvas units) below which outwards facing annotations are not drawn.
Definition at line 915 of file qgslayoutitemmapgrid.h.
|
inline |
Sets the minimum angle (in degrees) below which annotations are not drawn.
Definition at line 901 of file qgslayoutitemmapgrid.h.
|
inline |
Enable/disable ticks rotation for rotated or reprojected grids.
Definition at line 817 of file qgslayoutitemmapgrid.h.
|
inline |
Sets the tick length calculation mode.
Definition at line 831 of file qgslayoutitemmapgrid.h.
|
inline |
Sets the margin to corners (in canvas units) below which outwards facing ticks are not drawn.
Definition at line 859 of file qgslayoutitemmapgrid.h.
|
inline |
Sets the minimum angle (in degrees) below which ticks are not drawn.
Definition at line 845 of file qgslayoutitemmapgrid.h.
void QgsLayoutItemMapGrid::setStyle | ( | const QgsLayoutItemMapGrid::GridStyle | style | ) |
Sets the grid style, which controls how the grid is drawn over the map's contents.
Definition at line 2326 of file qgslayoutitemmapgrid.cpp.
void QgsLayoutItemMapGrid::setUnits | ( | const QgsLayoutItemMapGrid::GridUnit | unit | ) |
Sets the unit to use for grid measurements such as the interval and offset for grid lines.
Definition at line 2250 of file qgslayoutitemmapgrid.cpp.
|
inline |
Returns the grid's style, which controls how the grid is drawn over the map's contents.
Definition at line 469 of file qgslayoutitemmapgrid.h.
bool QgsLayoutItemMapGrid::testFrameSideFlag | ( | QgsLayoutItemMapGrid::FrameSideFlag | flag | ) | const |
Tests whether the grid frame should be drawn on a specified side of the map item.
flag | flag for grid frame side |
true
if grid frame should be drawn for that side of the map Definition at line 2421 of file qgslayoutitemmapgrid.cpp.
|
inline |
Returns the units used for grid measurements such as the interval and offset for grid lines.
Definition at line 343 of file qgslayoutitemmapgrid.h.
|
overridevirtual |
Returns true
if the item is drawn using advanced effects, such as blend modes.
Reimplemented from QgsLayoutItemMapItem.
Definition at line 458 of file qgslayoutitemmapgrid.cpp.
|
overridevirtual |
Stores map item state in a DOM element, where element is the DOM element corresponding to a 'LayoutMap' tag.
Reimplemented from QgsLayoutItemMapItem.
Definition at line 251 of file qgslayoutitemmapgrid.cpp.
|
friend |
Definition at line 1313 of file qgslayoutitemmapgrid.h.
|
friend |
Definition at line 1310 of file qgslayoutitemmapgrid.h.