Grid draw object: Difference between revisions

From Maria GDK Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
[[File:Grid draw object.png|right|thumb]]
[[File:Grid draw object.png|right|thumb]]
The grid draw object has two display modes: * '''UTM''' where the grid lines are displayed according to the UTM zones. * '''Standard''' where the grid lines are displayed according to selected map projection.
The grid draw object has 3 display modes: * '''UTM''' displaying an UTM grid, '''MGRS''' displaying the related cell oriented MGRS grid, and * '''Standard''' not related to any specific coordinate system, but allowing a more arbitrary cell size setting. The grids are intended for minor or moderate size areas only.


This page lists all the fields that control the grid draw object's appearance and behavior.
This page lists all the fields that control the grid draw object's appearance and behavior. The rightmost column (if present) indicates which grid type for which the corresponding style is available.  
<br clear=all>
<br clear=all>
{| class="wikitable"
{| class="wikitable"
!width="33%"| Field
!width="25%"| Field
!width="33%"| Value
!width="25%"| Value
!width="33%"| Description
!width="25%"| Description
!width="25%"| Grid type
|-
|-
| AreCoordinatesVisible
| AreCoordinatesVisible
| true, false
| true, false
| Show or hide UTM coordinates.
| Show or hide UTM coordinates.
| UTM, MGRS
|-
| BorderOutlineFontColor
| R,G,B,A
| Font outline color for grid borders
|-
| CellOutlineFontColor
| R,G,B,A
| Font outline color for grid cells
|-
| CoordinatesFontColor
| R,G,B,A
| Font color for coordinates
| MGRS, UTM
|-
| CoordinatesFontSize
| Double value greater than 0
| Font size for coordinates
| MGRS, UTM
|-
| CoordinatesOutlineFontColor
| R,G,B,A
| Font outline color for coordinates
| MGRS, UTM
|-
|-
| GridBorderColor
| GridBorderColor
Line 17: Line 42:
| Color of the border around the grid.
| Color of the border around the grid.
|-
|-
| GridCellLabelFontSize
| GridReferenceFontSize
| Double value greater than 0
| Double value greater than 0
| Cell label font size.
| Cell label font size.
|-
|-
| GridCellLabelFontColor
| GridReferenceFontColor
| R,G,B,A
| R,G,B,A
| Cell label font color.
| Cell label font color.
Line 28: Line 53:
| Pipe separated list of cell:pattern tuples where patterns are defined in the GDK enum FillStyle
| Pipe separated list of cell:pattern tuples where patterns are defined in the GDK enum FillStyle
| Cell background pattern. Example 2A:cross|3F:solid.
| Cell background pattern. Example 2A:cross|3F:solid.
| Standard
|-
|-
| GridCellBackgroundColor
| GridCellBackgroundColor
| Pipe separated list of cell:R,G,B,A tuples
| Pipe separated list of cell:R,G,B,A tuples
| Cell background color. Example 2A:255,0,0,180|3F:255,0,255,180.
| Cell background color. Example 2A:255,0,0,180|3F:255,0,255,180.
| Standard
|-
|-
| GridCellCustomLabel
| GridCellCustomLabel
| Pipe separated list of cell:text tuples
| Pipe separated list of cell:text tuples
| Custom label for cells. Example 2A:Text|4D:Test.
| Custom label for cells. Example 2A:Text|4D:Test.
| Standard
|-
|-
| GridHorizontalRulerFontSize
| GridHorizontalRulerFontSize
| Double value greater than 0
| Double value greater than 0
| Font size of labels on horizontal axis.
| Font size of labels on horizontal axis. (not coordinates)
|-
|-
| GridHorizontalRulerFontColor
| GridHorizontalRulerFontColor
| R,G,B,A
| R,G,B,A
| Font color of labels on horizontal axis.
| Font color of labels on horizontal axis. (not coordinates)
|-
|-
| GridLabelAxis
| GridLabelAxis
| Comma separated list of Top, Left, Right, Bottom
| Comma separated list of Top, Left, Right, Bottom
| List of which axes to show labels.
| List of which axes to show labels.
|-
| GridReferenceFontSize
| Double value greater than 0
| Font size of UTM references.
|-
| GridReferenceFontColor
| R,G,B,A
| Font color of UTM references.
|-
|-
| GridSize
| GridSize
| Integer
| Integer
| Grid size in meters.
| Grid size in meters. For MGRS and UTM grids, values are limited to the set {10000, 1000, 100, 10}. For Standard grids, the size is arbitrary.
|-
|-
| GridType
| GridType
| UTM, Standard
| UTM, MGRS or Standard
| Grid display mode.
| Grid display mode.
|-
|-
| GridVerticalRulerFontSize
| GridVerticalRulerFontSize
| Double value greater than 0
| Double value greater than 0
| Font size of labels on vertical axis.
| Font size of labels on vertical axis. (not coordinates)
|-
|-
| GridVerticalRulerFontColor
| GridVerticalRulerFontColor
| R,G,B,A
| R,G,B,A
| Font color of labels on vertical axis.
| Font color of labels on vertical axis. (not coordinates)
|-
| IsCellLabelsVisible
| true/false
| Show cell labels
|-
|-
| HorizontalLabelSkipList
| HorizontalLabelSkipList
Line 92: Line 116:
| true, false
| true, false
| Reverse the axis order of the cell labels. Example 2A &lt;-&gt; A2.
| Reverse the axis order of the cell labels. Example 2A &lt;-&gt; A2.
| Standard
|-
|-
| ShowGridBorder
| ShowGridBorder
| true, false
| true, false
| Show or hide border around the grid.
| Show or hide border around the grid.
|-
| ShowGridLabelsOnViewportEdge
| true, false
| Show or hide axis labels on the viewport edge when the grid axis labels are outside the viewport.
|-
|-
| VerticalLabelSkipList
| VerticalLabelSkipList

Revision as of 13:43, 19 August 2025

Grid draw object.png

The grid draw object has 3 display modes: * UTM displaying an UTM grid, MGRS displaying the related cell oriented MGRS grid, and * Standard not related to any specific coordinate system, but allowing a more arbitrary cell size setting. The grids are intended for minor or moderate size areas only.

This page lists all the fields that control the grid draw object's appearance and behavior. The rightmost column (if present) indicates which grid type for which the corresponding style is available.

Field Value Description Grid type
AreCoordinatesVisible true, false Show or hide UTM coordinates. UTM, MGRS
BorderOutlineFontColor R,G,B,A Font outline color for grid borders
CellOutlineFontColor R,G,B,A Font outline color for grid cells
CoordinatesFontColor R,G,B,A Font color for coordinates MGRS, UTM
CoordinatesFontSize Double value greater than 0 Font size for coordinates MGRS, UTM
CoordinatesOutlineFontColor R,G,B,A Font outline color for coordinates MGRS, UTM
GridBorderColor R,G,B,A Color of the border around the grid.
GridReferenceFontSize Double value greater than 0 Cell label font size.
GridReferenceFontColor R,G,B,A Cell label font color.
GridCellBackgroundPattern Pipe separated list of cell:pattern tuples where patterns are defined in the GDK enum FillStyle 3F:solid. Standard
GridCellBackgroundColor Pipe separated list of cell:R,G,B,A tuples 3F:255,0,255,180. Standard
GridCellCustomLabel Pipe separated list of cell:text tuples 4D:Test. Standard
GridHorizontalRulerFontSize Double value greater than 0 Font size of labels on horizontal axis. (not coordinates)
GridHorizontalRulerFontColor R,G,B,A Font color of labels on horizontal axis. (not coordinates)
GridLabelAxis Comma separated list of Top, Left, Right, Bottom List of which axes to show labels.
GridSize Integer Grid size in meters. For MGRS and UTM grids, values are limited to the set {10000, 1000, 100, 10}. For Standard grids, the size is arbitrary.
GridType UTM, MGRS or Standard Grid display mode.
GridVerticalRulerFontSize Double value greater than 0 Font size of labels on vertical axis. (not coordinates)
GridVerticalRulerFontColor R,G,B,A Font color of labels on vertical axis. (not coordinates)
IsCellLabelsVisible true/false Show cell labels
HorizontalLabelSkipList Comma separated list of labels to skip List of labels to skip on the horizontal axis.
HorizontalStartLabel Axis label Label to start with on the horizontal axis.
IsCellLabelsVisible true, false Show or hide cell labels.
NumberPadReference Comma separated list of cell references List of cell references where number pads should be displayed.
ReverseCellLabel true, false Reverse the axis order of the cell labels. Example 2A <-> A2. Standard
ShowGridBorder true, false Show or hide border around the grid.
VerticalLabelSkipList Comma separated list of labels to skip List of labels to skip on the vertical axis.
VerticalStartLabel Axis label Label to start with on the vertical axis.