com.esri.arcgis.carto
Interface IGraticule

All Superinterfaces:
IMapGrid, Serializable
All Known Implementing Classes:
Graticule

public interface IGraticule
extends IMapGrid, Serializable

Provides access to the members that control the graticule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IGraticule, ICustomOverlayGrid, IMeasuredGrid, IIndexGrid, IMapGrid

Method Summary
 void addElement(String label, double location, boolean isLatitude, ITextSymbol labelSymbol)
          Adds a grid line at custom location to the graticule.
 boolean isAutoInterval()
          Indicates if the graticule automatically and interactively computes the interval size.
 void removeElement(String label)
          Removes a grid line in a custom location.
 void setAutoInterval(boolean autoInterval)
          Indicates if the graticule automatically and interactively computes the interval size.
 
Methods inherited from interface com.esri.arcgis.carto.IMapGrid
draw, generateGraphics, getBorder, getExteriorWidth, getLabelFormat, getLineSymbol, getName, getSubTickCount, getSubTickLength, getSubTickLineSymbol, getTickLength, getTickLineSymbol, getTickMarkSymbol, isVisible, prepareForOutput, queryLabelVisibility, querySubTickVisibility, queryTickVisibility, setBorder, setDefaults, setLabelFormat, setLabelVisibility, setLineSymbol, setName, setSubTickCount, setSubTickLength, setSubTickLineSymbol, setSubTickVisibility, setTickLength, setTickLineSymbol, setTickMarkSymbol, setTickVisibility, setVisible
 

Method Detail

isAutoInterval

boolean isAutoInterval()
                       throws IOException,
                              AutomationException
Indicates if the graticule automatically and interactively computes the interval size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The autoInterval
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAutoInterval

void setAutoInterval(boolean autoInterval)
                     throws IOException,
                            AutomationException
Indicates if the graticule automatically and interactively computes the interval size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
autoInterval - The autoInterval (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addElement

void addElement(String label,
                double location,
                boolean isLatitude,
                ITextSymbol labelSymbol)
                throws IOException,
                       AutomationException
Adds a grid line at custom location to the graticule.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
label - The label (in)
location - The location (in)
isLatitude - The isLatitude (in)
labelSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeElement

void removeElement(String label)
                   throws IOException,
                          AutomationException
Removes a grid line in a custom location.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.