com.esri.arcgis.carto
Interface IMeasuredGrid

All Superinterfaces:

Serializable

All Known Implementing Classes:

Graticule, MeasuredGrid

public interface IMeasuredGrid
extends Serializable

Provides access to the members that control the lines that make up the map grid.

Remarks

The IMeasuredGrid interface is implemented by the MeasuredGrid and Graticule coclasses. It exposes information on the origins, intervals, and units of the grid.

If you set FixedOrigin to False, the origin is computed from the data frame instead of from the XOrigin and YOrigin properties. Defining these properties will shift the grid. For instance you can create a grid with a 10° interval showing on meridians 5°, 15°, 25°, etc. by shifting the grid 5° in X.

Units need not be populated for a graticule. For a measured grid they can be set to any esriUnits constant, if this is not specified the map units will be used.

The XIntervalSize and YIntervalSize properties define the spacing of the meridians and parallels of the grid.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

IGraticule, ICustomOverlayGrid, IMeasuredGrid, IIndexGrid, IMapGrid

Method Summary

int	getUnits() The units for the intervals and origin.
double	getXIntervalSize() The interval between grid lines along the X axis.
double	getXOrigin() The origin of the grid on the X axis.
double	getYIntervalSize() The interval between grid lines along the Y axis.
double	getYOrigin() The origin of the grid on the Y axis.
boolean	isFixedOrigin() Indicates if the origin is read from the XOrigin and YOrigin properties (true) or if it is computed dynamically from the data frame (false).
void	setFixedOrigin(boolean fixed) Indicates if the origin is read from the XOrigin and YOrigin properties (true) or if it is computed dynamically from the data frame (false).
void	setUnits(int unitsCode) The units for the intervals and origin.
void	setXIntervalSize(double interval) The interval between grid lines along the X axis.
void	setXOrigin(double origin) The origin of the grid on the X axis.
void	setYIntervalSize(double interval) The interval between grid lines along the Y axis.
void	setYOrigin(double origin) The origin of the grid on the Y axis.

Method Detail

getXOrigin

double getXOrigin()
                  throws IOException,
                         AutomationException

The origin of the grid on the X axis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The origin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXOrigin

void setXOrigin(double origin)
                throws IOException,
                       AutomationException

The origin of the grid on the X axis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

origin - The origin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXIntervalSize

double getXIntervalSize()
                        throws IOException,
                               AutomationException

The interval between grid lines along the X axis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXIntervalSize

void setXIntervalSize(double interval)
                      throws IOException,
                             AutomationException

The interval between grid lines along the X axis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYOrigin

double getYOrigin()
                  throws IOException,
                         AutomationException

The origin of the grid on the Y axis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The origin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYOrigin

void setYOrigin(double origin)
                throws IOException,
                       AutomationException

The origin of the grid on the Y axis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

origin - The origin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYIntervalSize

double getYIntervalSize()
                        throws IOException,
                               AutomationException

The interval between grid lines along the Y axis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYIntervalSize

void setYIntervalSize(double interval)
                      throws IOException,
                             AutomationException

The interval between grid lines along the Y axis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnits

int getUnits()
             throws IOException,
                    AutomationException

The units for the intervals and origin.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnits

void setUnits(int unitsCode)
              throws IOException,
                     AutomationException

The units for the intervals and origin.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

unitsCode - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFixedOrigin

boolean isFixedOrigin()
                      throws IOException,
                             AutomationException

Indicates if the origin is read from the XOrigin and YOrigin properties (true) or if it is computed dynamically from the data frame (false).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The fixed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFixedOrigin

void setFixedOrigin(boolean fixed)
                    throws IOException,
                           AutomationException

Indicates if the origin is read from the XOrigin and YOrigin properties (true) or if it is computed dynamically from the data frame (false).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

fixed - The fixed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.