AGSUSNGGrid Class Reference

Description

A grid representing United States National Grid (USNG) coordinate system.

Instances of this class represent a grid based on United States National Grid (USNG) for displaying on a map. The United States National Grid (USNG) is a point reference system of grid references commonly used in the United States. It provides a nationally consistent language of location in a user friendly format. It is similar in design to the national grid reference systems used throughout other nations. The USNG was developed by the Federal Geographic Data Committee.

The grid is supported in spatial references which are continuously pannable or some polar spatial references. (You can check AGSSpatialReference::isPannable on the spatial reference)

Examples of continuously pannable spatial references include WGS84 (WKID 4326) and Web Mercator Auxilliary Sphere (WKID 102113, 102100, or 3857).

The following polar spatial references are also supported:

• North pole Azimuthal Equidistant (WKID 102016)
• North pole gnomic (WKID 102034)
• North pole lambert equal area (WKID 102017)
• North pole orthographic (WKID 102035)
• North pole stereographic (WKID 102018)
• NSIDE EASE North (WKID 3408)
• NSIDC Sea Ice polar stereographic north (WKID 3411)
• WGS 1984 NSIDC Sea Ice Polar Stereographic North (WKID 3413)
• UPS North (WKID 32661)
• South pole Azimuthal Equidistant (WKID 102019)
• South pole gnomic (WKID 102036)
• South pole lambert equal area (WKID 102020)
• South pole orthographic (WKID 102037)
• South pole stereographic (WKID 102021)
• NSIDE EASE South (WKID 3409)
• NSIDC Sea Ice polar stereographic South (WKID 3412)
• UPS South (WKID 32761)
• WGS1984 Antarctic polar stereographic (WKID 3031)

Since

100

Inheritance diagram for AGSUSNGGrid:

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

Class Methods
(instancetype)	+ USNGGrid

Properties
double	labelOffset
AGSGridLabelPosition	labelPosition
AGSUSNGGridLabelUnit	labelUnit
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

USNGGrid

+ (instancetype) USNGGrid

Creates a USNG grid.

Returns

A new USNG grid.

Since

100

Property Documentation

labelOffset

- (double) labelOffset

readwritenonatomicassigninherited

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

Since

100

labelPosition

- (AGSGridLabelPosition) labelPosition

readwritenonatomicassigninherited

Specifies the positioning of the grid's text labels.

Since

100

labelUnit

- (AGSUSNGGridLabelUnit) labelUnit

readwritenonatomicassign

Specifies the units used in grid labels.

Since

100

labelVisibility

- (BOOL) labelVisibility

readwritenonatomicassigninherited

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

Since

100

levelCount

- (NSInteger) levelCount

readnonatomicassigninherited

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

readwritenonatomicassigninherited

Specifies whether the grid is visible or not.

Since

100