com.esri.arcgis.carto
Class Graticule

java.lang.Object
  com.esri.arcgis.carto.Graticule

All Implemented Interfaces:

IGraphicsComposite, IGraticule, IGridAxisTicks, IGridHatch, IGridInteriorLabels, IMapGrid, IMeasuredGrid, IReferenceSystem, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class Graticule
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGraticule, IMapGrid, IMeasuredGrid, IGridHatch, IGridInteriorLabels, IGridAxisTicks, IPersistStream, IPersist, IClone, IGraphicsComposite, IReferenceSystem, Externalizable

A map grid that divides the map with meridians and parallels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

Graticule()
Constructs a Graticule using ArcGIS Engine.

Graticule(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Graticule theGraticule = (Graticule) obj;

Method Summary

void	addElement(String label, double location, boolean isLatitude, ITextSymbol labelSymbol) Adds a grid line at custom location to the graticule.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	boundsChanged() Called when the extent of the parent map frame changes.
void	draw(IDisplay display, IMapFrame pMapFrame) Draws the map grid for a map frame to the given display.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	generateGraphics(IMapFrame pMapFrame, IGraphicsContainer graphicsContainer) Generates graphic elements corresponding to the grid lines and stores them in the specified graphics container.
double	getAxisTickOffset() The offset (in points) for ticks that fall along the axes.
IMapGridBorder	getBorder() The map grid border.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
double	getExteriorWidth(IDisplay pDisplay, IMapFrame pMapFrame) The width (in display units) of the portion of the grid that is outside of the frame.
IEnumElement	getGraphics(IDisplay display, Object data) Graphic elements that are used to render this object.
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.
double	getInteriorLabelIntervalX() The interval along the X axis between interior labels.
double	getInteriorLabelIntervalY() The interval along the Y axis between interior labels.
IGridLabel	getLabelFormat() The label format for map grid labels.
ILineSymbol	getLineSymbol() The symbol used to draw grid lines - null will draw no lines.
String	getName() The name of the map grid.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
short	getSubTickCount() The number of subticks to draw between the major ticks.
double	getSubTickLength() The length of the subticks in points.
ILineSymbol	getSubTickLineSymbol() The symbol used to draw the subtick lines.
double	getTickLength() The length of the major ticks in points.
ILineSymbol	getTickLineSymbol() The line symbol used to draw the major ticks.
IMarkerSymbol	getTickMarkSymbol() The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.
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.
int	hashCode() the hashcode for this object
boolean	isAutoInterval() Indicates if the graticule automatically and interactively computes the interval size.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
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).
boolean	isHatchDirectional() Indicates if the direction of the hatches is from the prime meridian and equator.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isShowInteriorLabels() Indicates if interior labels should be displayed.
boolean	isVisible() Indicates if the map grid is visible.
void	load(IStream pstm) load
void	prepareForOutput(int hDC, int dpi, tagRECT pixelBounds, IMapFrame pMapFrame) Prepares the map grid for output to a device.
void	queryBounds(IDisplay pDisplay, IMapFrame pMapFrame, IEnvelope bounds) The extent of the reference system in page space.
void	queryLabelVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis) Returns the visibility of the labels along all four sides of the map grid.
void	querySubTickVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis) Returns the visibility of the subticks along all four sides of the map grid.
void	queryTickVisibility(boolean[] leftVis, boolean[] topVis, boolean[] rightVis, boolean[] bottomVis) Returns the visibility of the ticks along all four sides of the map grid.
void	readExternal(ObjectInput in)
void	removeElement(String label) Removes a grid line in a custom location.
void	save(IStream pstm, int fClearDirty) save
void	setAutoInterval(boolean autoInterval) Indicates if the graticule automatically and interactively computes the interval size.
void	setAxisTickOffset(double offsetPts) The offset (in points) for ticks that fall along the axes.
void	setBorder(IMapGridBorder gridBorder) The map grid border.
void	setDefaults(IMapFrame pMapFrame) Sets the properties of the map grid to default values.
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	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.
void	setInteriorLabelIntervalX(double interval) The interval along the X axis between interior labels.
void	setInteriorLabelIntervalY(double interval) The interval along the Y axis between interior labels.
void	setLabelFormat(IGridLabel format) The label format for map grid labels.
void	setLabelVisibility(boolean leftVis, boolean topVis, boolean rightVis, boolean bottomVis) Sets the visibility of the labels along all four sides of the map grid.
void	setLineSymbol(ILineSymbol symbol) The symbol used to draw grid lines - null will draw no lines.
void	setName(String gridName) The name of the map grid.
void	setShowInteriorLabels(boolean show) Indicates if interior labels should be displayed.
void	setSubTickCount(short count) The number of subticks to draw between the major ticks.
void	setSubTickLength(double lengthPoints) The length of the subticks in points.
void	setSubTickLineSymbol(ILineSymbol symbol) The symbol used to draw the subtick lines.
void	setSubTickVisibility(boolean leftVis, boolean topVis, boolean rightVis, boolean bottomVis) Sets the visibility of the subticks along all four sides of the map grid.
void	setTickLength(double lengthPoints) The length of the major ticks in points.
void	setTickLineSymbol(ILineSymbol symbol) The line symbol used to draw the major ticks.
void	setTickMarkSymbol(IMarkerSymbol symbol) The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.
void	setTickVisibility(boolean leftVis, boolean topVis, boolean rightVis, boolean bottomVis) Sets the visibility of the ticks along all four sides of the map grid.
void	setUnits(int unitsCode) The units for the intervals and origin.
void	setVisible(boolean visible) Indicates if the map grid is visible.
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.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

Graticule

public Graticule()
          throws IOException,
                 UnknownHostException

Constructs a Graticule using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

Graticule

public Graticule(Object obj)
          throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Graticule theGraticule = (Graticule) obj;

Construct a Graticule using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Graticule.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

isAutoInterval

public 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

Specified by:

isAutoInterval in interface IGraticule

Returns:

The autoInterval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoInterval

public 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

Specified by:

setAutoInterval in interface IGraticule

Parameters:

autoInterval - The autoInterval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addElement

public 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

Specified by:

addElement in interface IGraticule

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

public 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

Specified by:

removeElement in interface IGraticule

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the map grid.

Description

Name is the name of the grid as it appears in the dataframe properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IMapGrid

Specified by:

getName in interface IReferenceSystem

Returns:

The gridName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String gridName)
             throws IOException,
                    AutomationException

The name of the map grid.

Description

Name is the name of the grid as it appears in the dataframe properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IMapGrid

Specified by:

setName in interface IReferenceSystem

Parameters:

gridName - The gridName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLineSymbol

public ILineSymbol getLineSymbol()
                          throws IOException,
                                 AutomationException

The symbol used to draw grid lines - null will draw no lines.

Description

LineSymbol is the line symbol that will be used to draw the grid lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLineSymbol in interface IMapGrid

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.

setLineSymbol

public void setLineSymbol(ILineSymbol symbol)
                   throws IOException,
                          AutomationException

The symbol used to draw grid lines - null will draw no lines.

Description

LineSymbol is the line symbol that will be used to draw the grid lines.
.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLineSymbol in interface IMapGrid

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.

getTickMarkSymbol

public IMarkerSymbol getTickMarkSymbol()
                                throws IOException,
                                       AutomationException

The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.

Description

TickMarkSymbol is the marker symbol that may be drawn at the intersection of grid lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTickMarkSymbol in interface IMapGrid

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.

setTickMarkSymbol

public void setTickMarkSymbol(IMarkerSymbol symbol)
                       throws IOException,
                              AutomationException

The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.

Description

TickMarkSymbol is the marker symbol that may be drawn at the intersection of grid lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTickMarkSymbol in interface IMapGrid

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.

getLabelFormat

public IGridLabel getLabelFormat()
                          throws IOException,
                                 AutomationException

The label format for map grid labels.

Description

LabelFormat is the label format for the grid labels. This is an IGridLabel, which is the generic interface that supports all the other specific types of grid labels, which in turn support the various number formats.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabelFormat in interface IMapGrid

Specified by:

getLabelFormat in interface IReferenceSystem

Returns:

A reference to a com.esri.arcgis.carto.IGridLabel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelFormat

public void setLabelFormat(IGridLabel format)
                    throws IOException,
                           AutomationException

The label format for map grid labels.

Description

LabelFormat is the label format for the grid labels. This is an IGridLabel , which is the generic interface that supports all the other specific types of grid labels, which in turn support the various number formats.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabelFormat in interface IMapGrid

Specified by:

setLabelFormat in interface IReferenceSystem

Parameters:

format - A reference to a com.esri.arcgis.carto.IGridLabel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTickLineSymbol

public ILineSymbol getTickLineSymbol()
                              throws IOException,
                                     AutomationException

The line symbol used to draw the major ticks.

Description

TickLineSymbol is the line symbol that will be used to draw the major tick marks that are drawn just inside of or just outside of the Border.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTickLineSymbol in interface IMapGrid

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.

setTickLineSymbol

public void setTickLineSymbol(ILineSymbol symbol)
                       throws IOException,
                              AutomationException

The line symbol used to draw the major ticks.

Description

TickLineSymbol is the line symbol that will be used to draw the major tick marks that are drawn just inside of or just outside of the Border .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTickLineSymbol in interface IMapGrid

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.

getTickLength

public double getTickLength()
                     throws IOException,
                            AutomationException

The length of the major ticks in points.

Description

TickLength is the length of the line symbol in points (approx. 1/72 inch) that will be used to draw the major tick marks that are drawn just inside of or just outside of the Border.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTickLength in interface IMapGrid

Returns:

The lengthPoints

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTickLength

public void setTickLength(double lengthPoints)
                   throws IOException,
                          AutomationException

The length of the major ticks in points.

Description

TickLength is the length of the line symbol in points (approx. 1/72 inch) that will be used to draw the major tick marks that are drawn just inside of or just outside of the Border .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTickLength in interface IMapGrid

Parameters:

lengthPoints - The lengthPoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubTickCount

public short getSubTickCount()
                      throws IOException,
                             AutomationException

The number of subticks to draw between the major ticks.

Description

SubTickCount is the number of subticks that will be displayed between the TickLineSymbols. Or, if you optionally use an ICalibratedMapBorder it is the number of times the fill symbol of the calibrated border changes. To use subtick marks, use an ISimpleMapBorder.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSubTickCount in interface IMapGrid

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubTickCount

public void setSubTickCount(short count)
                     throws IOException,
                            AutomationException

The number of subticks to draw between the major ticks.

Description

SubTickCount is the number of subticks that will be displayed between the TickLineSymbols . Or, if you optionally use an ICalibratedMapBorder it is the number of times the fill symbol of the calibrated border changes. To use subtick marks, use an ISimpleMapBorder.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSubTickCount in interface IMapGrid

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubTickLineSymbol

public ILineSymbol getSubTickLineSymbol()
                                 throws IOException,
                                        AutomationException

The symbol used to draw the subtick lines.

Description

SubTickLineSymbol is the line symbol used to draw subticks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSubTickLineSymbol in interface IMapGrid

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.

setSubTickLineSymbol

public void setSubTickLineSymbol(ILineSymbol symbol)
                          throws IOException,
                                 AutomationException

The symbol used to draw the subtick lines.

Description

SubTickLineSymbol is the line symbol used to draw subticks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSubTickLineSymbol in interface IMapGrid

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.

getSubTickLength

public double getSubTickLength()
                        throws IOException,
                               AutomationException

The length of the subticks in points.

Description

SubTickLength is the length of the subtick marks in points (approx. 1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSubTickLength in interface IMapGrid

Returns:

The lengthPoints

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubTickLength

public void setSubTickLength(double lengthPoints)
                      throws IOException,
                             AutomationException

The length of the subticks in points.

Description

SubTickLength is the length of the subtick marks in points (approx. 1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSubTickLength in interface IMapGrid

Parameters:

lengthPoints - The lengthPoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBorder

public IMapGridBorder getBorder()
                         throws IOException,
                                AutomationException

The map grid border.

Description

Border is the border that will be drawn around the map. Note that your LabelOffset will need to accomodate your border's width. There are two types of borders: ICalibratedMapBorder and ISimpleMapBorder.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBorder in interface IMapGrid

Returns:

A reference to a com.esri.arcgis.carto.IMapGridBorder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBorder

public void setBorder(IMapGridBorder gridBorder)
               throws IOException,
                      AutomationException

The map grid border.

Description

Border is the border that will be drawn around the map. Note that your LabelOffset will need to accomodate your border's width. There are two types of borders: ICalibratedMapBorder and ISimpleMapBorder .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBorder in interface IMapGrid

Parameters:

gridBorder - A reference to a com.esri.arcgis.carto.IMapGridBorder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the map grid is visible.

Description

Visible is whether the MapGrid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface IMapGrid

Specified by:

isVisible in interface IReferenceSystem

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates if the map grid is visible.

Description

Visible is whether the MapGrid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisible in interface IMapGrid

Specified by:

setVisible in interface IReferenceSystem

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryLabelVisibility

public void queryLabelVisibility(boolean[] leftVis,
                                 boolean[] topVis,
                                 boolean[] rightVis,
                                 boolean[] bottomVis)
                          throws IOException,
                                 AutomationException

Returns the visibility of the labels along all four sides of the map grid.

Description

QueryLabelVisibility is whether the labels on each of the sides of the map grid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryLabelVisibility in interface IMapGrid

Parameters:

leftVis - The leftVis (in/out: use single element array)

topVis - The topVis (in/out: use single element array)

rightVis - The rightVis (in/out: use single element array)

bottomVis - The bottomVis (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelVisibility

public void setLabelVisibility(boolean leftVis,
                               boolean topVis,
                               boolean rightVis,
                               boolean bottomVis)
                        throws IOException,
                               AutomationException

Sets the visibility of the labels along all four sides of the map grid.

Description

SetLabelVisibility sets whether the labels on each of the sides of the map grid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabelVisibility in interface IMapGrid

Parameters:

leftVis - The leftVis (in)

topVis - The topVis (in)

rightVis - The rightVis (in)

bottomVis - The bottomVis (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryTickVisibility

public void queryTickVisibility(boolean[] leftVis,
                                boolean[] topVis,
                                boolean[] rightVis,
                                boolean[] bottomVis)
                         throws IOException,
                                AutomationException

Returns the visibility of the ticks along all four sides of the map grid.

Description

QueryTickVisibility is whether the ticks on each side of the map grid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryTickVisibility in interface IMapGrid

Parameters:

leftVis - The leftVis (in/out: use single element array)

topVis - The topVis (in/out: use single element array)

rightVis - The rightVis (in/out: use single element array)

bottomVis - The bottomVis (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTickVisibility

public void setTickVisibility(boolean leftVis,
                              boolean topVis,
                              boolean rightVis,
                              boolean bottomVis)
                       throws IOException,
                              AutomationException

Sets the visibility of the ticks along all four sides of the map grid.

Description

SetTickVisibility sets whether the ticks on each side of the map grid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTickVisibility in interface IMapGrid

Parameters:

leftVis - The leftVis (in)

topVis - The topVis (in)

rightVis - The rightVis (in)

bottomVis - The bottomVis (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

querySubTickVisibility

public void querySubTickVisibility(boolean[] leftVis,
                                   boolean[] topVis,
                                   boolean[] rightVis,
                                   boolean[] bottomVis)
                            throws IOException,
                                   AutomationException

Returns the visibility of the subticks along all four sides of the map grid.

Description

QuerySubTickVisibility is whether the subticks on each side of the map grid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

querySubTickVisibility in interface IMapGrid

Parameters:

leftVis - The leftVis (in/out: use single element array)

topVis - The topVis (in/out: use single element array)

rightVis - The rightVis (in/out: use single element array)

bottomVis - The bottomVis (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubTickVisibility

public void setSubTickVisibility(boolean leftVis,
                                 boolean topVis,
                                 boolean rightVis,
                                 boolean bottomVis)
                          throws IOException,
                                 AutomationException

Sets the visibility of the subticks along all four sides of the map grid.

Description

SetSubTickVisibility sets whether the subticks on each side of the map grid will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSubTickVisibility in interface IMapGrid

Parameters:

leftVis - The leftVis (in)

topVis - The topVis (in)

rightVis - The rightVis (in)

bottomVis - The bottomVis (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaults

public void setDefaults(IMapFrame pMapFrame)
                 throws IOException,
                        AutomationException

Sets the properties of the map grid to default values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaults in interface IMapGrid

Specified by:

setDefaults in interface IReferenceSystem

Parameters:

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateGraphics

public void generateGraphics(IMapFrame pMapFrame,
                             IGraphicsContainer graphicsContainer)
                      throws IOException,
                             AutomationException

Generates graphic elements corresponding to the grid lines and stores them in the specified graphics container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

generateGraphics in interface IMapGrid

Specified by:

generateGraphics in interface IReferenceSystem

Parameters:

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

graphicsContainer - A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

prepareForOutput

public void prepareForOutput(int hDC,
                             int dpi,
                             tagRECT pixelBounds,
                             IMapFrame pMapFrame)
                      throws IOException,
                             AutomationException

Prepares the map grid for output to a device.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

prepareForOutput in interface IMapGrid

Specified by:

prepareForOutput in interface IReferenceSystem

Parameters:

hDC - The hDC (A COM typedef) (in)

dpi - The dpi (in)

pixelBounds - A Structure: com.esri.arcgis.system.tagRECT (in)

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IDisplay display,
                 IMapFrame pMapFrame)
          throws IOException,
                 AutomationException

Draws the map grid for a map frame to the given display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface IMapGrid

Specified by:

draw in interface IReferenceSystem

Parameters:

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

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExteriorWidth

public double getExteriorWidth(IDisplay pDisplay,
                               IMapFrame pMapFrame)
                        throws IOException,
                               AutomationException

The width (in display units) of the portion of the grid that is outside of the frame.

Product Availability

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

Specified by:

getExteriorWidth in interface IMapGrid

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

Returns:

The pWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXOrigin

public 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

Specified by:

getXOrigin in interface IMeasuredGrid

Returns:

The origin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXOrigin

public 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

Specified by:

setXOrigin in interface IMeasuredGrid

Parameters:

origin - The origin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXIntervalSize

public 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

Specified by:

getXIntervalSize in interface IMeasuredGrid

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXIntervalSize

public 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

Specified by:

setXIntervalSize in interface IMeasuredGrid

Parameters:

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYOrigin

public 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

Specified by:

getYOrigin in interface IMeasuredGrid

Returns:

The origin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYOrigin

public 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

Specified by:

setYOrigin in interface IMeasuredGrid

Parameters:

origin - The origin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYIntervalSize

public 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

Specified by:

getYIntervalSize in interface IMeasuredGrid

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYIntervalSize

public 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

Specified by:

setYIntervalSize in interface IMeasuredGrid

Parameters:

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnits

public 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

Specified by:

getUnits in interface IMeasuredGrid

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnits

public 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

Specified by:

setUnits in interface IMeasuredGrid

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

public 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

Specified by:

isFixedOrigin in interface IMeasuredGrid

Returns:

The fixed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFixedOrigin

public 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

Specified by:

setFixedOrigin in interface IMeasuredGrid

Parameters:

fixed - The fixed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHatchIntervalX

public 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

Specified by:

getHatchIntervalX in interface IGridHatch

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHatchIntervalX

public 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

Specified by:

setHatchIntervalX in interface IGridHatch

Parameters:

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHatchIntervalY

public 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

Specified by:

getHatchIntervalY in interface IGridHatch

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHatchIntervalY

public 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

Specified by:

setHatchIntervalY in interface IGridHatch

Parameters:

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHatchLineSymbol

public 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

Specified by:

getHatchLineSymbol in interface IGridHatch

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

public 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

Specified by:

setHatchLineSymbol in interface IGridHatch

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

public 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

Specified by:

getHatchMarkerSymbol in interface IGridHatch

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

public 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

Specified by:

setHatchMarkerSymbol in interface IGridHatch

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

public 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

Specified by:

getHatchLength in interface IGridHatch

Returns:

The length

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHatchLength

public 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

Specified by:

setHatchLength in interface IGridHatch

Parameters:

length - The length (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHatchDirectional

public 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

Specified by:

isHatchDirectional in interface IGridHatch

Returns:

The isDirectional

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHatchDirectional

public 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

Specified by:

setHatchDirectional in interface IGridHatch

Parameters:

isDirectional - The isDirectional (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowInteriorLabels

public boolean isShowInteriorLabels()
                             throws IOException,
                                    AutomationException

Indicates if interior labels should be displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowInteriorLabels in interface IGridInteriorLabels

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowInteriorLabels

public void setShowInteriorLabels(boolean show)
                           throws IOException,
                                  AutomationException

Indicates if interior labels should be displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowInteriorLabels in interface IGridInteriorLabels

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInteriorLabelIntervalX

public double getInteriorLabelIntervalX()
                                 throws IOException,
                                        AutomationException

The interval along the X axis between interior labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInteriorLabelIntervalX in interface IGridInteriorLabels

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInteriorLabelIntervalX

public void setInteriorLabelIntervalX(double interval)
                               throws IOException,
                                      AutomationException

The interval along the X axis between interior labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setInteriorLabelIntervalX in interface IGridInteriorLabels

Parameters:

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInteriorLabelIntervalY

public double getInteriorLabelIntervalY()
                                 throws IOException,
                                        AutomationException

The interval along the Y axis between interior labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInteriorLabelIntervalY in interface IGridInteriorLabels

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInteriorLabelIntervalY

public void setInteriorLabelIntervalY(double interval)
                               throws IOException,
                                      AutomationException

The interval along the Y axis between interior labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setInteriorLabelIntervalY in interface IGridInteriorLabels

Parameters:

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAxisTickOffset

public double getAxisTickOffset()
                         throws IOException,
                                AutomationException

The offset (in points) for ticks that fall along the axes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAxisTickOffset in interface IGridAxisTicks

Returns:

The offsetPts

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAxisTickOffset

public void setAxisTickOffset(double offsetPts)
                       throws IOException,
                              AutomationException

The offset (in points) for ticks that fall along the axes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAxisTickOffset in interface IGridAxisTicks

Parameters:

offsetPts - The offsetPts (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGraphics

public IEnumElement getGraphics(IDisplay display,
                                Object data)
                         throws IOException,
                                AutomationException

Graphic elements that are used to render this object. The data argument is defined by the coclass that implements this interface.

Product Availability

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

Specified by:

getGraphics in interface IGraphicsComposite

Parameters:

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

data - A reference to another Object (IUnknown) (in)

Returns:

A reference to a com.esri.arcgis.carto.IEnumElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBounds

public void queryBounds(IDisplay pDisplay,
                        IMapFrame pMapFrame,
                        IEnvelope bounds)
                 throws IOException,
                        AutomationException

The extent of the reference system in page space.

Product Availability

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

Specified by:

queryBounds in interface IReferenceSystem

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pMapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

boundsChanged

public void boundsChanged()
                   throws IOException,
                          AutomationException

Called when the extent of the parent map frame changes.

Product Availability

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

Specified by:

boundsChanged in interface IReferenceSystem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException