com.esri.arcgis.carto
Interface IRasterCatalogLayer

All Superinterfaces:
ILayer, Serializable
All Known Implementing Classes:
RasterCatalogLayer

public interface IRasterCatalogLayer
extends ILayer, Serializable

Provides access to members that create or modify a raster catalog.

Remarks

RasterCatalogLayer can be created from a RasterCatalogTable by using the Create method.

The RasterCatalogLayer is rendered by default using the statistics of the first raster dataset in the raster catalog table. You can change the renderer using method Renderer property.

When To Use

IRasterCatalogLayer displays raster catalogs.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void create(IRasterCatalogTable pCatalog)
          Creates a raster catalog layer.
 IRasterCatalogTable getCatalogTable()
          Raster catalog table.
 int getDisplayRasters()
          Indicates whether to display rasters.
 int getPrimaryField()
          Layer's primary field.
 IRasterRenderer getRenderer()
          Layer's RasterRenderer.
 ISymbol getSymbol()
          Layer's symbol.
 void setDisplayRasters(int pNum)
          Indicates whether to display rasters.
 void setPrimaryField(int pnField)
          Layer's primary field.
 void setRendererByRef(IRasterRenderer renderer)
          Layer's RasterRenderer.
 void setSymbolByRef(ISymbol ppSymbol)
          Layer's symbol.
 
Methods inherited from interface com.esri.arcgis.carto.ILayer
draw, getAreaOfInterest, getMaximumScale, getMinimumScale, getName, getSupportedDrawPhases, getTipText, isCached, isShowTips, isValid, isVisible, setCached, setMaximumScale, setMinimumScale, setName, setShowTips, setSpatialReferenceByRef, setVisible
 

Method Detail

create

void create(IRasterCatalogTable pCatalog)
            throws IOException,
                   AutomationException
Creates a raster catalog layer.

Remarks

The DisplayRasters property specifies a threshold (the number of raster datasets are within the display extent) that controls the raster catalog display mode. If the number of the raster datasets in the display extent is greater than the threshold, the raster catalog displays as a wireframe. Otherwise the raster datasets within the display extent will be drawn. The default threshold is 9.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pCatalog - A reference to a com.esri.arcgis.datasourcesraster.IRasterCatalogTable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCatalogTable

IRasterCatalogTable getCatalogTable()
                                    throws IOException,
                                           AutomationException
Raster catalog table.

Description

The RasterCatalogTable can be retrieved from the layer using the CatalogTable property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.datasourcesraster.IRasterCatalogTable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPrimaryField

void setPrimaryField(int pnField)
                     throws IOException,
                            AutomationException
Layer's primary field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPrimaryField

int getPrimaryField()
                    throws IOException,
                           AutomationException
Layer's primary field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getRenderer

IRasterRenderer getRenderer()
                            throws IOException,
                                   AutomationException
Layer's RasterRenderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.carto.IRasterRenderer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRendererByRef

void setRendererByRef(IRasterRenderer renderer)
                      throws IOException,
                             AutomationException
Layer's RasterRenderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
renderer - A reference to a com.esri.arcgis.carto.IRasterRenderer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayRasters

int getDisplayRasters()
                      throws IOException,
                             AutomationException
Indicates whether to display rasters.

Remarks

The DisplayRasters property specifies the threshold, in raster datasets, of how many datasets must be visible for the pixel data to be drawn. If too many datasets are within the display extent, a wire frame will show the bounding box of each raster dataset with the name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDisplayRasters

void setDisplayRasters(int pNum)
                       throws IOException,
                              AutomationException
Indicates whether to display rasters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSymbol

ISymbol getSymbol()
                  throws IOException,
                         AutomationException
Layer's symbol.

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.ISymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

void setSymbolByRef(ISymbol ppSymbol)
                    throws IOException,
                           AutomationException
Layer's symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
ppSymbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.