com.esri.arcgis.carto
Interface IRasterLayer

All Superinterfaces:

ILayer, Serializable

All Known Implementing Classes:

ImageServerLayer, RasterLayer, WCSLayer

public interface IRasterLayer
extends ILayer, Serializable

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

Remarks

The RasterLayer must be initialized with data before it can be used. When the layer is initialized, a default renderer is selected for the dataset based on the number of bands, statistics, and whether a colormap or other table exists for the data. Other internal properties of the layer are also set at this time.

Product Availability

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

Method Summary

void	createFromDataset(IRasterDataset rasterDataset) Creates a layer from a RasterDataset object.
void	createFromFilePath(String filePath) Creates a layer from a file path to raster data.
void	createFromRaster(IRaster raster) Creates a layer from a Raster object.
int	getBandCount() Number of bands in the layer.
int	getColumnCount() Number of columns in the layer.
IEnvelope	getDataFrameExtent() Extent of the dataframe that contains the layer.
int	getDisplayResolutionFactor() Display resolution factor.
String	getFilePath() Filepath of the data source.
int	getPrimaryField() Layer's primary field.
IRaster	getRaster() Layer's Raster object.
IRasterRenderer	getRenderer() Layer's renderer.
int	getRowCount() Number of rows in the layer.
IEnvelope	getVisibleExtent() Visible extent of the layer in the data frame.
boolean	isPyramidPresent() Indicates if pyramids are present for the layer.
boolean	isShowResolution() Indicates if the raster resolution should be displayed in the Table of Contents.
void	setDisplayResolutionFactor(int pnFactor) Display resolution factor.
void	setPrimaryField(int pnField) Layer's primary field.
void	setPyramidPresent(boolean pbPyramidPresent) Indicates if pyramids are present for the layer.
void	setRendererByRef(IRasterRenderer renderer) Layer's renderer.
void	setShowResolution(boolean b) Indicates if the raster resolution should be displayed in the Table of Contents.
void	setVisibleExtent(IEnvelope ppVisibleExtent) Visible extent of the layer in the data frame.

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

getFilePath

String getFilePath()
                   throws IOException,
                          AutomationException

Filepath of the data source.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The filePath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRaster

IRaster getRaster()
                  throws IOException,
                         AutomationException

Layer's Raster object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFromRaster

void createFromRaster(IRaster raster)
                      throws IOException,
                             AutomationException

Creates a layer from a Raster object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFromDataset

void createFromDataset(IRasterDataset rasterDataset)
                       throws IOException,
                              AutomationException

Creates a layer from a RasterDataset object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rasterDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFromFilePath

void createFromFilePath(String filePath)
                        throws IOException,
                               AutomationException

Creates a layer from a file path to raster data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

filePath - The filePath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderer

IRasterRenderer getRenderer()
                            throws IOException,
                                   AutomationException

Layer's renderer.

Remarks

The Renderer property controls the renderer being used by the layer.

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

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.

getBandCount

int getBandCount()
                 throws IOException,
                        AutomationException

Number of bands in the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The bandCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnCount

int getColumnCount()
                   throws IOException,
                          AutomationException

Number of columns in the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The columnCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRowCount

int getRowCount()
                throws IOException,
                       AutomationException

Number of rows in the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The rowCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPyramidPresent

boolean isPyramidPresent()
                         throws IOException,
                                AutomationException

Indicates if pyramids are present for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pbPyramidPresent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPyramidPresent

void setPyramidPresent(boolean pbPyramidPresent)
                       throws IOException,
                              AutomationException

Indicates if pyramids are present for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pbPyramidPresent - The pbPyramidPresent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataFrameExtent

IEnvelope getDataFrameExtent()
                             throws IOException,
                                    AutomationException

Extent of the dataframe that contains the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisibleExtent

void setVisibleExtent(IEnvelope ppVisibleExtent)
                      throws IOException,
                             AutomationException

Visible extent of the layer in the data frame.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

getVisibleExtent

IEnvelope getVisibleExtent()
                           throws IOException,
                                  AutomationException

Visible extent of the layer in the data frame.

Remarks

The VisibleExtent specifies a subset of the raster layer to be drawn, which can speed the drawing of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

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.

Remarks

The PrimaryField property controls the field that provides map tips and the field that appears in the left pane of the Identify window. The integer property value represents the column number of the selected field, where the value field equals 1.

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.

setShowResolution

void setShowResolution(boolean b)
                       throws IOException,
                              AutomationException

Indicates if the raster resolution should be displayed in the Table of Contents.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

b - The b (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowResolution

boolean isShowResolution()
                         throws IOException,
                                AutomationException

Indicates if the raster resolution should be displayed in the Table of Contents.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The b

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayResolutionFactor

void setDisplayResolutionFactor(int pnFactor)
                                throws IOException,
                                       AutomationException

Display resolution factor. Factor value is expressed as a percentage between 0 and 100.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pnFactor - The pnFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayResolutionFactor

int getDisplayResolutionFactor()
                               throws IOException,
                                      AutomationException

Display resolution factor. Factor value is expressed as a percentage between 0 and 100.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pnFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.