Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.mapping.view

Class UsngGrid

java.lang.Object

com.esri.arcgisruntime.mapping.view.Grid

com.esri.arcgisruntime.mapping.view.UsngGrid

public final class UsngGrid
extends Grid

Represents a USNG (United States National Grid) for displaying on a MapView.

The grid is supported in spatial references which are continuously pannable or some polar spatial references. You can check that the SpatialReference.isPannable() property on your spatial reference is true.

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.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UsngGrid.LabelUnit	Represents possible grid label distance units that can be displayed to the grid.

Nested classes/interfaces inherited from class com.esri.arcgisruntime.mapping.view.Grid

Grid.LabelPosition

Constructor Summary

Constructors

Constructor	Description
UsngGrid()	Creates a new United States National Grid.

Method Summary

Modifier and Type	Method	Description
UsngGrid.LabelUnit	getLabelUnit()	Gets distance units used by grid labels.
void	setLabelUnit(UsngGrid.LabelUnit labelUnit)	Sets distance units used by grid labels.

Methods inherited from class com.esri.arcgisruntime.mapping.view.Grid

getLabelOffset, getLabelPosition, getLevelCount, getLineSymbol, getTextSymbol, isLabelVisible, isVisible, setLabelOffset, setLabelPosition, setLabelVisible, setLineSymbol, setTextSymbol, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UsngGrid

public UsngGrid()

Creates a new United States National Grid.

Has five grid resolution levels that covers the North America region.

Since:

100.0.0

Method Details

setLabelUnit

public void setLabelUnit(UsngGrid.LabelUnit labelUnit)

Sets distance units used by grid labels.

Parameters:

labelUnit - grid label units to use

Throws:

IllegalArgumentException - if labelUnit is null

Since:

100.0.0

getLabelUnit

public UsngGrid.LabelUnit getLabelUnit()

Gets distance units used by grid labels.

Default value is KILOMETERS_METERS.

Returns:

the grid label units used

Since:

100.0.0