com.esri.arcgis.datasourcesraster
Interface IColormapFunctionArguments

All Superinterfaces:

Serializable

All Known Implementing Classes:

ColormapFunctionArguments

public interface IColormapFunctionArguments
extends Serializable

Provides access to members that control colormap function arguments.

Product Availability

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

Method Summary

IRasterColormap	getColormap() The raster colormap.
String	getColormapName() The pre-defined colormap name, e.g.
IColorRamp	getColorRamp() The input color ramp.
Object	getRaster() The source raster object.
void	loadFrom(String colormapFileName) Loads from a colormap file.
void	setColormapByRef(IRasterColormap ppColormap) The raster colormap.
void	setColormapName(String pColormapName) The pre-defined colormap name, e.g.
void	setColorRampByRef(IColorRamp ppColorRamp) The input color ramp.
void	setRasterByRef(Object ppRaster) The source raster object.

Method Detail

getRaster

Object getRaster()
                 throws IOException,
                        AutomationException

The source raster object.

Product Availability

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

void setRasterByRef(Object ppRaster)
                    throws IOException,
                           AutomationException

The source raster object.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColormapName

String getColormapName()
                       throws IOException,
                              AutomationException

The pre-defined colormap name, e.g. 'Random', 'NDVI', and etc.

Product Availability

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

Returns:

The pColormapName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColormapName

void setColormapName(String pColormapName)
                     throws IOException,
                            AutomationException

The pre-defined colormap name, e.g. 'Random', 'NDVI', and etc.

Product Availability

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

Parameters:

pColormapName - The pColormapName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColormap

IRasterColormap getColormap()
                            throws IOException,
                                   AutomationException

The raster colormap.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColormapByRef

void setColormapByRef(IRasterColormap ppColormap)
                      throws IOException,
                             AutomationException

The raster colormap.

Product Availability

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

Parameters:

ppColormap - A reference to a com.esri.arcgis.geodatabase.IRasterColormap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColorRamp

IColorRamp getColorRamp()
                        throws IOException,
                               AutomationException

The input color ramp.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.display.IColorRamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorRampByRef

void setColorRampByRef(IColorRamp ppColorRamp)
                       throws IOException,
                              AutomationException

The input color ramp.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFrom

void loadFrom(String colormapFileName)
              throws IOException,
                     AutomationException

Loads from a colormap file.

Product Availability

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

Parameters:

colormapFileName - The colormapFileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.