com.esri.arcgis.carto
Interface IGridHatch

All Superinterfaces:

Serializable

All Known Implementing Classes:

Graticule

public interface IGridHatch
extends Serializable

Provides access to members that control the hatch marks along the meridians and parallels of a grid.

Product Availability

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

Method Summary

double	getHatchIntervalX() The interval (in grid units) along the X axis for the grid hatches.
double	getHatchIntervalY() The interval (in grid units) along the Y axis for the grid hatches.
double	getHatchLength() The length (in points) of the grid hatches.
ILineSymbol	getHatchLineSymbol() The line symbol used to draw the grid hatches.
IMarkerSymbol	getHatchMarkerSymbol() The marker symbol used to draw markers at grid hatch locations.
boolean	isHatchDirectional() Indicates if the direction of the hatches is from the prime meridian and equator.
void	setHatchDirectional(boolean isDirectional) Indicates if the direction of the hatches is from the prime meridian and equator.
void	setHatchIntervalX(double interval) The interval (in grid units) along the X axis for the grid hatches.
void	setHatchIntervalY(double interval) The interval (in grid units) along the Y axis for the grid hatches.
void	setHatchLength(double length) The length (in points) of the grid hatches.
void	setHatchLineSymbol(ILineSymbol symbol) The line symbol used to draw the grid hatches.
void	setHatchMarkerSymbol(IMarkerSymbol symbol) The marker symbol used to draw markers at grid hatch locations.

Method Detail

getHatchIntervalX

double getHatchIntervalX()
                         throws IOException,
                                AutomationException

The interval (in grid units) along the X axis for the grid hatches.

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.

setHatchIntervalX

void setHatchIntervalX(double interval)
                       throws IOException,
                              AutomationException

The interval (in grid units) along the X axis for the grid hatches.

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.

getHatchIntervalY

double getHatchIntervalY()
                         throws IOException,
                                AutomationException

The interval (in grid units) along the Y axis for the grid hatches.

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.

setHatchIntervalY

void setHatchIntervalY(double interval)
                       throws IOException,
                              AutomationException

The interval (in grid units) along the Y axis for the grid hatches.

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.

getHatchLineSymbol

ILineSymbol getHatchLineSymbol()
                               throws IOException,
                                      AutomationException

The line symbol used to draw the grid hatches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.ILineSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHatchLineSymbol

void setHatchLineSymbol(ILineSymbol symbol)
                        throws IOException,
                               AutomationException

The line symbol used to draw the grid hatches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHatchMarkerSymbol

IMarkerSymbol getHatchMarkerSymbol()
                                   throws IOException,
                                          AutomationException

The marker symbol used to draw markers at grid hatch locations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHatchMarkerSymbol

void setHatchMarkerSymbol(IMarkerSymbol symbol)
                          throws IOException,
                                 AutomationException

The marker symbol used to draw markers at grid hatch locations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHatchLength

double getHatchLength()
                      throws IOException,
                             AutomationException

The length (in points) of the grid hatches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The length

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHatchLength

void setHatchLength(double length)
                    throws IOException,
                           AutomationException

The length (in points) of the grid hatches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

length - The length (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHatchDirectional

boolean isHatchDirectional()
                           throws IOException,
                                  AutomationException

Indicates if the direction of the hatches is from the prime meridian and equator. False if the hatch mark should straddle the grid line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The isDirectional

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHatchDirectional

void setHatchDirectional(boolean isDirectional)
                         throws IOException,
                                AutomationException

Indicates if the direction of the hatches is from the prime meridian and equator. False if the hatch mark should straddle the grid line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

isDirectional - The isDirectional (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.