ArcGIS Runtime SDK for iOS: AGSBackgroundGrid Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSBackgroundGrid Class Reference

Description

A background grid defines the default color and context grid for display behind a map or scene surface.

The background grid determines what an empty AGSMapView or scene AGSSurface looks like. An instance of this class can be used to set a default backdrop that an AGSMap or AGSScene will display on top of.

See also
AGSMapView::backgroundGrid, AGSSurface::backgroundGrid, AGSMap::backgroundColor
Since
100.0
Inheritance diagram for AGSBackgroundGrid:
AGSObject

Instance Methods

(instancetype) - initWithColor:gridLineColor:gridLineWidth:gridSize:
 

Class Methods

(instancetype) + backgroundGridWithColor:gridLineColor:gridLineWidth:gridSize:
 

Properties

AGSColorcolor
 
AGSColorgridLineColor
 
double gridLineWidth
 
double gridSize
 
BOOL visible
 

Method Documentation

◆ backgroundGridWithColor:gridLineColor:gridLineWidth:gridSize:

+ (instancetype) backgroundGridWithColor: (AGSColor *)  color
gridLineColor: (AGSColor *)  gridLineColor
gridLineWidth: (double)  gridLineWidth
gridSize: (double)  gridSize 

Initialize the background grid with specified properties

Parameters
colorFill color of the background
gridLineColorColor of background grid lines
gridLineWidthWidth (in points) of background grid lines
gridSizeSize (in points) of the background grid
Returns
initialized background
Since
100

◆ initWithColor:gridLineColor:gridLineWidth:gridSize:

- (instancetype) initWithColor: (AGSColor *)  color
gridLineColor: (AGSColor *)  gridLineColor
gridLineWidth: (double)  gridLineWidth
gridSize: (double)  gridSize 

Initialize the background grid with specified properties

Parameters
colorFill color of the background
gridLineColorColor of background grid lines
gridLineWidthWidth (in points) of background grid lines
gridSizeSize (in points) of the background grid
Returns
initialized background
Since
100

Property Documentation

◆ color

- (AGSColor*) color
readwritenonatomicstrong

The background color of the grid. The default value is gray - RGBA(192,192,192,255).

Since
100

◆ gridLineColor

- (AGSColor*) gridLineColor
readwritenonatomicstrong

The color of background grid lines. The default value is black - RGBA(0,0,0,255).

Since
100

◆ gridLineWidth

- (double) gridLineWidth
readwritenonatomicassign

The width (in points) of background grid lines. The default value is 0.1.

Note
This value must be greater than or equal to 0. Setting the grid line width to 0 will make grid lines invisible.
Since
100

◆ gridSize

- (double) gridSize
readwritenonatomicassign

The size (in points) of the background grid. The default value is 20 x 20 (in points).

Since
100

◆ visible

- (BOOL) visible
readwritenonatomicassign

A value indicating if grid lines are visible on the background. If this value is true, grid lines will display on top of the AGSBackgroundGrid::color. If this value is false, the AGSBackgroundGrid::color will display without the grid lines. The default value is true.

Since
100.1