com.esri.arcgis.carto
Interface IIndexGrid

All Superinterfaces:

IMapGrid, Serializable

All Known Implementing Classes:

IndexGrid

public interface IIndexGrid
extends IMapGrid, Serializable

Provides access to members that control the index grid.

Remarks

IIndexGrid gives you access to the functionality common to all index grids.

Using the XLabel and the YLabel properties, you can set or retrieve the label for each column and index in the grid. You can access the number of rows and columns of the grid with RowCount and ColumnCount.

The QueryCellExtent method allows you to get the envelope of any given cell in the grid.

See also the Carto Library Overview.

Product Availability

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

See Also:

IGraticule, ICustomOverlayGrid, IMeasuredGrid, IIndexGrid, IMapGrid

Method Summary

int	getColumnCount() The number of columns in the index grid.
int	getRowCount() The number of rows in the index grid.
String	getXLabel(int column) The label for the given column in the index grid.
String	getYLabel(int row) The label for the given row in the index grid.
void	queryCellExtent(int row, int column, IMapFrame pMapFrame, IEnvelope extent) Provides access to the cell extent in page space for the given row and column.
void	setColumnCount(int count) The number of columns in the index grid.
void	setRowCount(int count) The number of rows in the index grid.
void	setXLabel(int column, String label) The label for the given column in the index grid.
void	setYLabel(int row, String label) The label for the given row in the index grid.

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

getColumnCount

int getColumnCount()
                   throws IOException,
                          AutomationException

The number of columns in the index grid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColumnCount

void setColumnCount(int count)
                    throws IOException,
                           AutomationException

The number of columns in the index grid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRowCount

int getRowCount()
                throws IOException,
                       AutomationException

The number of rows in the index grid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRowCount

void setRowCount(int count)
                 throws IOException,
                        AutomationException

The number of rows in the index grid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXLabel

String getXLabel(int column)
                 throws IOException,
                        AutomationException

The label for the given column in the index grid.

Product Availability

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

Parameters:

column - The column (in)

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXLabel

void setXLabel(int column,
               String label)
               throws IOException,
                      AutomationException

The label for the given column in the index grid.

Product Availability

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

Parameters:

column - The column (in)

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYLabel

String getYLabel(int row)
                 throws IOException,
                        AutomationException

The label for the given row in the index grid.

Product Availability

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

Parameters:

row - The row (in)

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYLabel

void setYLabel(int row,
               String label)
               throws IOException,
                      AutomationException

The label for the given row in the index grid.

Product Availability

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

Parameters:

row - The row (in)

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryCellExtent

void queryCellExtent(int row,
                     int column,
                     IMapFrame pMapFrame,
                     IEnvelope extent)
                     throws IOException,
                            AutomationException

Provides access to the cell extent in page space for the given row and column.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

row - The row (in)

column - The column (in)

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

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