AGSGrid Class Reference

Description

A base class for displaying coordinate system grids on a map.

A base class for displaying coordinate system grids such as MGRS, USNG, UTM and LatitudeLongitude. It contains all of the common operations and properties that apply to displaying and working with the different grids currently supported. This includes toggling visibility and configuring layout and appearance preferences.

Since

100

Inheritance diagram for AGSGrid:

Instance Methods
(AGSSymbol *)	- lineSymbolForLevel:
(void)	- setLineSymbol:forLevel:
(void)	- setTextSymbol:forLevel:
(AGSSymbol *)	- textSymbolForLevel:

Properties
double	labelOffset
AGSGridLabelPosition	labelPosition
BOOL	labelVisibility
NSInteger	levelCount
BOOL	visible

Method Documentation

lineSymbolForLevel:

- (AGSSymbol*) lineSymbolForLevel:

(NSInteger)

level

Returns the line symbol used for the grid lines at the given resolution level.

Parameters

level

specifiying the resolution level for which the symbol is desired.

Returns

The symbol at the specified resolution level.

Since

100

setLineSymbol:forLevel:

- (void) setLineSymbol:		(AGSSymbol *)	symbol
forLevel:		(NSInteger)	level

Set the line symbol used for the grid lines at the given resolution level.

Parameters

symbol	to be used for grid lines
level	The level specifiying the resolution level for which the symbol is desired.

Since

100

setTextSymbol:forLevel:

- (void) setTextSymbol:		(AGSSymbol *)	symbol
forLevel:		(NSInteger)	level

Set the text symbol used for the grid text labels at the given resolution level.

Parameters

symbol	to be used for grid text label
level	specifiying the resolution level for which the symbol is desired

Since

100

textSymbolForLevel:

- (AGSSymbol*) textSymbolForLevel:

(NSInteger)

level

Returns the text symbol used for the grid text labels at the given resolution level.

Parameters

level

specifiying the resolution level for which the symbol is desired.

Returns

The symbol at the specified resolution level.

Since

100

Property Documentation

labelOffset

- (double) labelOffset

readwritenonatomicassign

Specifies the grid's text label offset (in screen points) from the edge of the map view.

Since

100

labelPosition

- (AGSGridLabelPosition) labelPosition

readwritenonatomicassign

Specifies the positioning of the grid's text labels.

Since

100

labelVisibility

- (BOOL) labelVisibility

readwritenonatomicassign

Specifies whether the grid's text labels are visible or not.

Since

100

levelCount

- (NSInteger) levelCount

readnonatomicassign

Returns the number of levels of resolution supported by the grid. The line and label style can be set for each of these resolution levels. The resolution of the displayed grid may adapt as the scale of the displayed map changes.

Since

100

visible

- (BOOL) visible

readwritenonatomicassign

Specifies whether the grid is visible or not.

Since

100