com.esri.arcgis.carto
Interface IRasterLayer

All Superinterfaces:

ILayer, java.io.Serializable

All Known Implementing Classes:

ImageServerLayer, IRasterLayerProxy, RasterLayer, WCSLayer

public interface IRasterLayer
extends ILayer, java.io.Serializable

COM Interface 'IRasterLayer'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that create or modify a raster layer.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDd02371c7_35f7_11d2_b1f2_00c04f8edeff
static int	xxDummy Deprecated. Internal use only

Method Summary

void	createFromDataset(IRasterDataset rasterDataset) Creates a layer from a RasterDataset object.
void	createFromFilePath(java.lang.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.
java.lang.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

Field Detail

IIDd02371c7_35f7_11d2_b1f2_00c04f8edeff

static final int IIDd02371c7_35f7_11d2_b1f2_00c04f8edeff

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getFilePath

java.lang.String getFilePath()
                             throws java.io.IOException,
                                    AutomationException

Filepath of the data source.

Returns:

The filePath

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRaster

IRaster getRaster()
                  throws java.io.IOException,
                         AutomationException

Layer's Raster object.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFromRaster

void createFromRaster(IRaster raster)
                      throws java.io.IOException,
                             AutomationException

Creates a layer from a Raster object.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFromDataset

void createFromDataset(IRasterDataset rasterDataset)
                       throws java.io.IOException,
                              AutomationException

Creates a layer from a RasterDataset object.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFromFilePath

void createFromFilePath(java.lang.String filePath)
                        throws java.io.IOException,
                               AutomationException

Creates a layer from a file path to raster data.

Parameters:

filePath - The filePath (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRenderer

IRasterRenderer getRenderer()
                            throws java.io.IOException,
                                   AutomationException

Layer's renderer.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRendererByRef

void setRendererByRef(IRasterRenderer renderer)
                      throws java.io.IOException,
                             AutomationException

Layer's renderer.

Parameters:

renderer - A reference to a com.esri.arcgis.carto.IRasterRenderer (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBandCount

int getBandCount()
                 throws java.io.IOException,
                        AutomationException

Number of bands in the layer.

Returns:

The bandCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumnCount

int getColumnCount()
                   throws java.io.IOException,
                          AutomationException

Number of columns in the layer.

Returns:

The columnCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRowCount

int getRowCount()
                throws java.io.IOException,
                       AutomationException

Number of rows in the layer.

Returns:

The rowCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPyramidPresent

boolean isPyramidPresent()
                         throws java.io.IOException,
                                AutomationException

Indicates if pyramids are present for the layer.

Returns:

The pbPyramidPresent

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPyramidPresent

void setPyramidPresent(boolean pbPyramidPresent)
                       throws java.io.IOException,
                              AutomationException

Indicates if pyramids are present for the layer.

Parameters:

pbPyramidPresent - The pbPyramidPresent (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataFrameExtent

IEnvelope getDataFrameExtent()
                             throws java.io.IOException,
                                    AutomationException

Extent of the dataframe that contains the layer.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisibleExtent

void setVisibleExtent(IEnvelope ppVisibleExtent)
                      throws java.io.IOException,
                             AutomationException

Visible extent of the layer in the data frame.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVisibleExtent

IEnvelope getVisibleExtent()
                           throws java.io.IOException,
                                  AutomationException

Visible extent of the layer in the data frame.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrimaryField

void setPrimaryField(int pnField)
                     throws java.io.IOException,
                            AutomationException

Layer's primary field.

Parameters:

pnField - The pnField (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrimaryField

int getPrimaryField()
                    throws java.io.IOException,
                           AutomationException

Layer's primary field.

Returns:

The pnField

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowResolution

void setShowResolution(boolean b)
                       throws java.io.IOException,
                              AutomationException

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

Parameters:

b - The b (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowResolution

boolean isShowResolution()
                         throws java.io.IOException,
                                AutomationException

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

Returns:

The b

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayResolutionFactor

void setDisplayResolutionFactor(int pnFactor)
                                throws java.io.IOException,
                                       AutomationException

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

Parameters:

pnFactor - The pnFactor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayResolutionFactor

int getDisplayResolutionFactor()
                               throws java.io.IOException,
                                      AutomationException

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

Returns:

The pnFactor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.