com.esri.arcgis.carto
Class RasterClassifyColorRampRenderer

java.lang.Object
  com.esri.arcgis.carto.RasterClassifyColorRampRenderer

All Implemented Interfaces:

IDisplayTableExchange, IHillShadeInfo, IIdentify, ILegendInfo, IRasterClassifyColorRampRenderer, IRasterClassifyUIProperties, IRasterDataExclusion, IRasterDisplayProps, IRasterRenderer, IRasterRenderer2, IRasterRendererClassInfo, IRasterRendererColorRamp, IRasterRendererInfo, IRasterRendererUniqueValues, IRasterRendererUpdate, IDisplayAdmin, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class RasterClassifyColorRampRenderer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterClassifyColorRampRenderer, IRasterClassifyUIProperties, IRasterDataExclusion, IRasterRenderer, IRasterRenderer2, IRasterRendererInfo, IRasterRendererColorRamp, IRasterDisplayProps, IIdentify, ILegendInfo, IDisplayAdmin, IPersistStream, IRasterRendererClassInfo, IRasterRendererUniqueValues, IHillShadeInfo, IDisplayTableExchange, IRasterRendererUpdate, IXMLSerialize, Externalizable

A renderer with a color ramp for rasters with classified values.

Description

The RasterClassifyColorRampRenderer visualizes a raster as a set of classes. Each class is displayed using a unique color. Each class contains one or more values from within the raster. This renderer allows you to control the way the raster is split into classes and determine the color used to paint each class to the screen.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RasterClassifyColorRampRenderer()
Constructs a RasterClassifyColorRampRenderer using ArcGIS Engine.

RasterClassifyColorRampRenderer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterClassifyColorRampRenderer theRasterClassifyColorRampRenderer = (RasterClassifyColorRampRenderer) obj;

Method Summary

void	adaptRaster(IRaster pRaster) Adapts to the new raster.
boolean	canRender(IRaster raster) Indicates if the raster can be rendered.
void	copy(IRasterRenderer pSource) Selects a raster as the current copy object.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	draw(IRaster raster, int drawPhase, IDisplay pDisplay, ITrackCancel pTrackCancel) Draws the raster on the display.
boolean	equals(Object o) Compare this object with another
double	getBreak(int index) Break at the index.
int	getBrightnessValue() Brightness value for a raster.
int	getClassCount() Number of classes.
String	getClassField() Field this renderer is using.
void	getClassID(GUID[] pClassID) getClassID
String	getClassificationField() Classification field name or an empty string if a table doesn't exist.
IUID	getClassificationMethod() Classification method.
static String	getClsid() getClsid.
String	getColorRamp() Color ramp name.
String	getColorScheme() The color scheme name.
int	getContrastValue() Contrast value for a raster.
String	getDescription() The description of the raster renderer.
String	getDescription(int index) Description for the class at the given index.
double	getDeviationInterval() Deviation interval.
int	getDisplayResolutionFactor() Display resolution factor.
ITable	getDisplayTable() The renderer display table.
IColor	getExcludeColor() Color for the excluded values.
String	getExcludeDescription() Description for the excluded values.
String	getExcludeLabel() Label for the excluded values.
Object	getExcludeRanges() Array of doubles indicating the excluded ranges.
Object	getExcludeValues() Array of doubles indicating the excluded values.
String	getLabel(int index) Label for the class at the given index.
ILegendGroup	getLegendGroup(int index) Legend group at the specified index.
int	getLegendGroupCount() Number of legend groups contained by the object.
ILegendItem	getLegendItem() Optional.
String	getName() The name of the raster renderer.
IColor	getNoDataColor() Nodata color for a raster.
String	getNormalizationField() Normalization field name or an empty string if none.
String	getNormField() Normalization field this renderer is using.
INumberFormat	getNumberFormat() Number format for labels.
IRaster	getRaster() Raster to be rendered.
int	getResamplingType() Resampling method for displaying a raster.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISymbol	getSymbol(int index) Symbol representing the class at the index.
int	getTransparencyValue() Transparency value for a raster.
IUniqueValues	getUniqueValues() The list of unique values.
double	getZScale() The Z factor multipled to z valuesg.
int	hashCode() the hashcode for this object
IArray	identify(IGeometry pGeom) Identifies objects at the specified location.
IColorRamp	IRasterRendererColorRamp_getColorRamp() The color ramp of the color map.
void	isDirty() isDirty
boolean	isExcludeShowClass() Indicates if color is shown for the excluded values.
boolean	isNumericClasses() Indicates if the classification field is numeric.
boolean	isShowClassGaps() Indicates if gaps between classes are shown.
boolean	isSortClassesAscending() Indicates if the sort direction for the class labels is ascending.
boolean	isSymbolsAreGraduated() Indicates if symbols are graduated.
boolean	isUpdated() Indicates whether the renderer requires updating.
boolean	isUseHillShade() Indicates whether the hill shading is being used.
boolean	isUsesFilter() Indicates if the current object draws using a filter.
void	load(IStream pstm) load
void	queryNumberClass(int classIndex, double[] minValue, double[] maxValue, int[] outValue) Information for a number class by index.
void	queryStringClass(int classIndex, String[] inValue, int[] outValue) Information for a string class by index.
void	readExternal(ObjectInput in)
void	recreateRaster(IRasterDataset pDataset, IRaster pRaster) Recreates a raster, if necessary, from a given RasterDataset.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setBreak(int index, double value) Break at the index.
void	setBrightnessValue(int pValue) Brightness value for a raster.
void	setClassCount(int value) Number of classes.
void	setClassField(String field) Field this renderer is using.
void	setClassificationMethodByRef(IUID ppClsid) Classification method.
void	setColorRamp(IColorRamp ppColorRamp) The color ramp of the color map.
void	setColorRamp(String colorRamp) Color ramp name.
void	setColorScheme(String colorScheme) The color scheme name.
void	setContrastValue(int iValue) Contrast value for a raster.
void	setDescription(int index, String description) Description for the class at the given index.
void	setDeviationInterval(double interval) Deviation interval.
void	setDisplayResolutionFactor(int pnFactor) Display resolution factor.
void	setDisplayTableByRef(ITable ppTable) The renderer display table.
void	setExcludeColor(IColor color) Color for the excluded values.
void	setExcludeDescription(String description) Description for the excluded values.
void	setExcludeLabel(String label) Label for the excluded values.
void	setExcludeRanges(Object values) Array of doubles indicating the excluded ranges.
void	setExcludeShowClass(boolean show) Indicates if color is shown for the excluded values.
void	setExcludeValues(Object values) Array of doubles indicating the excluded values.
void	setLabel(int index, String label) Label for the class at the given index.
void	setNoDataColorByRef(IColor ppColor) Nodata color for a raster.
void	setNormField(String field) Normalization field this renderer is using.
void	setNumberFormatByRef(INumberFormat format) Number format for labels.
void	setRasterByRef(IRaster raster) Raster to be rendered.
void	setResamplingType(int pResamplingType) Resampling method for displaying a raster.
void	setShowClassGaps(boolean showGaps) Indicates if gaps between classes are shown.
void	setSortClassesAscending(boolean ascending) Indicates if the sort direction for the class labels is ascending.
void	setSymbol(int index, ISymbol symbol) Symbol representing the class at the index.
void	setSymbolsAreGraduated(boolean symbolsAreGraduated) Indicates if symbols are graduated.
void	setTransparencyValue(int pValue) Transparency value for a raster.
void	setUniqueValuesByRef(IUniqueValues ppUniqueValues) The list of unique values.
void	setUseHillShade(boolean bUse) Indicates whether the hill shading is being used.
void	setZScale(double pZScale) The Z factor multipled to z valuesg.
void	update() Updates the renderer for any changes that have been made.
void	update(IRasterLayer pRasterLayer) Updates this raster renderer using a given raster layer.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

RasterClassifyColorRampRenderer

public RasterClassifyColorRampRenderer()
                                throws IOException,
                                       UnknownHostException

Constructs a RasterClassifyColorRampRenderer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterClassifyColorRampRenderer

public RasterClassifyColorRampRenderer(Object obj)
                                throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterClassifyColorRampRenderer theRasterClassifyColorRampRenderer = (RasterClassifyColorRampRenderer) obj;

Construct a RasterClassifyColorRampRenderer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterClassifyColorRampRenderer.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getClassField

public String getClassField()
                     throws IOException,
                            AutomationException

Field this renderer is using.

Remarks

The ClassField property determines the field of the raster on which the classification will be performed. With the NormField property, you may optionally specify another field by which the class field will be divided/normalized before the classes are determined. The ClassField and NormField must be numeric. By default, the ClassField is Value and the NormField is empty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassField in interface IRasterClassifyColorRampRenderer

Returns:

The field

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassField

public void setClassField(String field)
                   throws IOException,
                          AutomationException

Field this renderer is using.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setClassField in interface IRasterClassifyColorRampRenderer

Parameters:

field - The field (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNormField

public String getNormField()
                    throws IOException,
                           AutomationException

Normalization field this renderer is using.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNormField in interface IRasterClassifyColorRampRenderer

Returns:

The field

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNormField

public void setNormField(String field)
                  throws IOException,
                         AutomationException

Normalization field this renderer is using.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNormField in interface IRasterClassifyColorRampRenderer

Parameters:

field - The field (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassCount

public int getClassCount()
                  throws IOException,
                         AutomationException

Number of classes.

Remarks

The ClassCount property controls the number of classes into which the dataset is divided. The rest of the properties are specific to each class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassCount in interface IRasterClassifyColorRampRenderer

Specified by:

getClassCount in interface IRasterRendererClassInfo

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassCount

public void setClassCount(int value)
                   throws IOException,
                          AutomationException

Number of classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setClassCount in interface IRasterClassifyColorRampRenderer

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreak

public double getBreak(int index)
                throws IOException,
                       AutomationException

Break at the index.

Product Availability

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

Specified by:

getBreak in interface IRasterClassifyColorRampRenderer

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreak

public void setBreak(int index,
                     double value)
              throws IOException,
                     AutomationException

Break at the index.

Product Availability

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

Specified by:

setBreak in interface IRasterClassifyColorRampRenderer

Parameters:

index - The index (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

public ISymbol getSymbol(int index)
                  throws IOException,
                         AutomationException

Symbol representing the class at the index.

Product Availability

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

Specified by:

getSymbol in interface IRasterClassifyColorRampRenderer

Parameters:

index - The index (in)

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.

setSymbol

public void setSymbol(int index,
                      ISymbol symbol)
               throws IOException,
                      AutomationException

Symbol representing the class at the index.

Product Availability

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

Specified by:

setSymbol in interface IRasterClassifyColorRampRenderer

Parameters:

index - The index (in)

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

getLabel

public String getLabel(int index)
                throws IOException,
                       AutomationException

Label for the class at the given index.

Product Availability

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

Specified by:

getLabel in interface IRasterClassifyColorRampRenderer

Parameters:

index - The index (in)

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(int index,
                     String label)
              throws IOException,
                     AutomationException

Label for the class at the given index.

Product Availability

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

Specified by:

setLabel in interface IRasterClassifyColorRampRenderer

Parameters:

index - The index (in)

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription(int index)
                      throws IOException,
                             AutomationException

Description for the class at the given index.

Product Availability

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

Specified by:

getDescription in interface IRasterClassifyColorRampRenderer

Parameters:

index - The index (in)

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(int index,
                           String description)
                    throws IOException,
                           AutomationException

Description for the class at the given index.

Product Availability

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

Specified by:

setDescription in interface IRasterClassifyColorRampRenderer

Parameters:

index - The index (in)

description - The description (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSortClassesAscending

public boolean isSortClassesAscending()
                               throws IOException,
                                      AutomationException

Indicates if the sort direction for the class labels is ascending.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSortClassesAscending in interface IRasterClassifyColorRampRenderer

Returns:

The ascending

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSortClassesAscending

public void setSortClassesAscending(boolean ascending)
                             throws IOException,
                                    AutomationException

Indicates if the sort direction for the class labels is ascending.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSortClassesAscending in interface IRasterClassifyColorRampRenderer

Parameters:

ascending - The ascending (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassificationMethod

public IUID getClassificationMethod()
                             throws IOException,
                                    AutomationException

Classification method.

Description

The ClassificationMethod controls the classification method used to divide the dataset into classes. The default is a natural break classification. This must be specified as a ClassID of the classification coclass. This can be obtained by QI’ing for the IClassify interface on any of the coclasses that support IClassify, then passing the ClassID property to the ClassificationMethod property of the renderer.

If the ClassificationMethod uses standard deviations, the DeviationInterval property determines the number of standard deviations that separate each class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassificationMethod in interface IRasterClassifyUIProperties

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassificationMethodByRef

public void setClassificationMethodByRef(IUID ppClsid)
                                  throws IOException,
                                         AutomationException

Classification method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setClassificationMethodByRef in interface IRasterClassifyUIProperties

Parameters:

ppClsid - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColorRamp

public String getColorRamp()
                    throws IOException,
                           AutomationException

Color ramp name.

Description

The ColorRamp property controls the name of the color scheme from the style gallery that is selected in the dropdown list on the raster property page.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getColorRamp in interface IRasterClassifyUIProperties

Returns:

The colorRamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorRamp

public void setColorRamp(String colorRamp)
                  throws IOException,
                         AutomationException

Color ramp name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setColorRamp in interface IRasterClassifyUIProperties

Parameters:

colorRamp - The colorRamp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberFormat

public INumberFormat getNumberFormat()
                              throws IOException,
                                     AutomationException

Number format for labels.

Description

The NumberFormat property passes an object supporting the INumberFormat interface, which controls how the data values are formatted in the Classification dialog box.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNumberFormat in interface IRasterClassifyUIProperties

Returns:

A reference to a com.esri.arcgis.system.INumberFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberFormatByRef

public void setNumberFormatByRef(INumberFormat format)
                          throws IOException,
                                 AutomationException

Number format for labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNumberFormatByRef in interface IRasterClassifyUIProperties

Parameters:

format - A reference to a com.esri.arcgis.system.INumberFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowClassGaps

public boolean isShowClassGaps()
                        throws IOException,
                               AutomationException

Indicates if gaps between classes are shown.

Remarks

If ShowClassGaps is True, neighboring classes that have gaps between them will have classification boundaries that do not visibly match through the user interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowClassGaps in interface IRasterClassifyUIProperties

Returns:

The showGaps

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowClassGaps

public void setShowClassGaps(boolean showGaps)
                      throws IOException,
                             AutomationException

Indicates if gaps between classes are shown.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowClassGaps in interface IRasterClassifyUIProperties

Parameters:

showGaps - The showGaps (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDeviationInterval

public double getDeviationInterval()
                            throws IOException,
                                   AutomationException

Deviation interval. Range is 0 to 1, where 0 means no deviation is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDeviationInterval in interface IRasterClassifyUIProperties

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeviationInterval

public void setDeviationInterval(double interval)
                          throws IOException,
                                 AutomationException

Deviation interval. Range is 0 to 1, where 0 means no deviation is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDeviationInterval in interface IRasterClassifyUIProperties

Parameters:

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExcludeValues

public void setExcludeValues(Object values)
                      throws IOException,
                             AutomationException

Array of doubles indicating the excluded values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExcludeValues in interface IRasterDataExclusion

Parameters:

values - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExcludeValues

public Object getExcludeValues()
                        throws IOException,
                               AutomationException

Array of doubles indicating the excluded values.

Description

The ExcludeValues property allows you to select the value or values that will not be included in any class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExcludeValues in interface IRasterDataExclusion

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExcludeRanges

public void setExcludeRanges(Object values)
                      throws IOException,
                             AutomationException

Array of doubles indicating the excluded ranges.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExcludeRanges in interface IRasterDataExclusion

Parameters:

values - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExcludeRanges

public Object getExcludeRanges()
                        throws IOException,
                               AutomationException

Array of doubles indicating the excluded ranges.

Remarks

The ExcludeRanges property specifies a range of values to exclude. The ExcludeShowClass property determines whether this class will appear in the table of contents with the rest of the classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExcludeRanges in interface IRasterDataExclusion

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExcludeShowClass

public void setExcludeShowClass(boolean show)
                         throws IOException,
                                AutomationException

Indicates if color is shown for the excluded values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExcludeShowClass in interface IRasterDataExclusion

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExcludeShowClass

public boolean isExcludeShowClass()
                           throws IOException,
                                  AutomationException

Indicates if color is shown for the excluded values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isExcludeShowClass in interface IRasterDataExclusion

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExcludeColor

public void setExcludeColor(IColor color)
                     throws IOException,
                            AutomationException

Color for the excluded values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExcludeColor in interface IRasterDataExclusion

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExcludeColor

public IColor getExcludeColor()
                       throws IOException,
                              AutomationException

Color for the excluded values.

Remarks

The ExcludeColor property controls the color with which any excluded values will be displayed. The different display for excluded values is black.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExcludeColor in interface IRasterDataExclusion

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExcludeLabel

public void setExcludeLabel(String label)
                     throws IOException,
                            AutomationException

Label for the excluded values.

Remarks

The ExcludeLabel and ExcludeDescription properties determine the labels used for this class in the table of contents and the legend.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExcludeLabel in interface IRasterDataExclusion

Parameters:

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExcludeLabel

public String getExcludeLabel()
                       throws IOException,
                              AutomationException

Label for the excluded values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExcludeLabel in interface IRasterDataExclusion

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExcludeDescription

public void setExcludeDescription(String description)
                           throws IOException,
                                  AutomationException

Description for the excluded values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExcludeDescription in interface IRasterDataExclusion

Parameters:

description - The description (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExcludeDescription

public String getExcludeDescription()
                             throws IOException,
                                    AutomationException

Description for the excluded values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExcludeDescription in interface IRasterDataExclusion

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canRender

public boolean canRender(IRaster raster)
                  throws IOException,
                         AutomationException

Indicates if the raster can be rendered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canRender in interface IRasterRenderer

Parameters:

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

Returns:

The pCanRender

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

public void setRasterByRef(IRaster raster)
                    throws IOException,
                           AutomationException

Raster to be rendered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRasterByRef in interface IRasterRenderer

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.

getRaster

public IRaster getRaster()
                  throws IOException,
                         AutomationException

Raster to be rendered.

Description

The Raster property controls the raster being displayed by the renderer. Because the renderers depend on dataset statistics, after changing the raster to be displayed, the update method must be called before performing using the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRaster in interface IRasterRenderer

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.

draw

public void draw(IRaster raster,
                 int drawPhase,
                 IDisplay pDisplay,
                 ITrackCancel pTrackCancel)
          throws IOException,
                 AutomationException

Draws the raster on the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface IRasterRenderer

Parameters:

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

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUpdated

public boolean isUpdated()
                  throws IOException,
                         AutomationException

Indicates whether the renderer requires updating.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUpdated in interface IRasterRenderer

Returns:

The pUpdated

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

public void update()
            throws IOException,
                   AutomationException

Updates the renderer for any changes that have been made.

Remarks

The Update method should also be called after making changes to the renderer but before assigning the renderer to a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

update in interface IRasterRenderer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

public void copy(IRasterRenderer pSource)
          throws IOException,
                 AutomationException

Selects a raster as the current copy object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

copy in interface IRasterRenderer

Parameters:

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

getResamplingType

public int getResamplingType()
                      throws IOException,
                             AutomationException

Resampling method for displaying a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getResamplingType in interface IRasterRenderer

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResamplingType

public void setResamplingType(int pResamplingType)
                       throws IOException,
                              AutomationException

Resampling method for displaying a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setResamplingType in interface IRasterRenderer

Parameters:

pResamplingType - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayResolutionFactor

public 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

Specified by:

setDisplayResolutionFactor in interface IRasterRenderer

Parameters:

pnFactor - The pnFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayResolutionFactor

public 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

Specified by:

getDisplayResolutionFactor in interface IRasterRenderer

Returns:

The pnFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

recreateRaster

public void recreateRaster(IRasterDataset pDataset,
                           IRaster pRaster)
                    throws IOException,
                           AutomationException

Recreates a raster, if necessary, from a given RasterDataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

recreateRaster in interface IRasterRenderer2

Parameters:

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

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

adaptRaster

public void adaptRaster(IRaster pRaster)
                 throws IOException,
                        AutomationException

Adapts to the new raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

adaptRaster in interface IRasterRenderer2

Parameters:

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

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the raster renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IRasterRendererInfo

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The description of the raster renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDescription in interface IRasterRendererInfo

Returns:

The pDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColorScheme

public String getColorScheme()
                      throws IOException,
                             AutomationException

The color scheme name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getColorScheme in interface IRasterRendererColorRamp

Returns:

The colorScheme

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorScheme

public void setColorScheme(String colorScheme)
                    throws IOException,
                           AutomationException

The color scheme name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setColorScheme in interface IRasterRendererColorRamp

Parameters:

colorScheme - The colorScheme (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IRasterRendererColorRamp_getColorRamp

public IColorRamp IRasterRendererColorRamp_getColorRamp()
                                                 throws IOException,
                                                        AutomationException

The color ramp of the color map.

Product Availability

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

Specified by:

IRasterRendererColorRamp_getColorRamp in interface IRasterRendererColorRamp

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.

setColorRamp

public void setColorRamp(IColorRamp ppColorRamp)
                  throws IOException,
                         AutomationException

The color ramp of the color map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setColorRamp in interface IRasterRendererColorRamp

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.

setContrastValue

public void setContrastValue(int iValue)
                      throws IOException,
                             AutomationException

Contrast value for a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setContrastValue in interface IRasterDisplayProps

Parameters:

iValue - The iValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContrastValue

public int getContrastValue()
                     throws IOException,
                            AutomationException

Contrast value for a raster.

Remarks

The IRasterDisplayProps interface controls display properties common to all raster renderers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getContrastValue in interface IRasterDisplayProps

Returns:

The iValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBrightnessValue

public void setBrightnessValue(int pValue)
                        throws IOException,
                               AutomationException

Brightness value for a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBrightnessValue in interface IRasterDisplayProps

Parameters:

pValue - The pValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBrightnessValue

public int getBrightnessValue()
                       throws IOException,
                              AutomationException

Brightness value for a raster.

Remarks

The BrightnessValue property ranges from -100 to 100, representing a percentage of increase or decrease in the property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBrightnessValue in interface IRasterDisplayProps

Returns:

The pValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparencyValue

public void setTransparencyValue(int pValue)
                          throws IOException,
                                 AutomationException

Transparency value for a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTransparencyValue in interface IRasterDisplayProps

Parameters:

pValue - The pValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparencyValue

public int getTransparencyValue()
                         throws IOException,
                                AutomationException

Transparency value for a raster.

Remarks

The TransparencyValue value ranges from 0 to 100, with 0 representing opaque and 100 representing fully transparent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTransparencyValue in interface IRasterDisplayProps

Returns:

The pValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNoDataColor

public IColor getNoDataColor()
                      throws IOException,
                             AutomationException

Nodata color for a raster.

Remarks

The NoDataColor property controls how NoData cells in your raster are displayed. By default, NoData cells appear transparent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNoDataColor in interface IRasterDisplayProps

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNoDataColorByRef

public void setNoDataColorByRef(IColor ppColor)
                         throws IOException,
                                AutomationException

Nodata color for a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNoDataColorByRef in interface IRasterDisplayProps

Parameters:

ppColor - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom)
                throws IOException,
                       AutomationException

Identifies objects at the specified location.

Remarks

When the IIdentify interface is on a map layer, the Identify method returns an array of FeatureIdentifyObject objects.

On a FeatureIdentifyObject, you can do a QI to the IIdentifyObj interface to get more information about the identified feature. The IIdentifyObj interface returns the window handle, layer, and name of the feature; it has methods to flash the feature in the display and to display a context menu at the Identify location.

This method performs an identify operation with the provided geometry. When identifying layers, typically a small envelope is passed in rather than a point to account for differences in the precision of the display and the feature geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

identify in interface IIdentify

Parameters:

pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

public int getLegendGroupCount()
                        throws IOException,
                               AutomationException

Number of legend groups contained by the object.

Remarks

The number of legend groups is determined by the implementation of the renderer, consequently this property is read only. For example, SimpleRenderer has one group, while a BiUniqueValueRenderer has any number of groups.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendGroupCount in interface ILegendInfo

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws IOException,
                                   AutomationException

Legend group at the specified index.

Product Availability

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

Specified by:

getLegendGroup in interface ILegendInfo

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws IOException,
                                 AutomationException

Optional. Defines legend formatting for layer rendered with this object.

Remarks

Layer or renderer legend information is further formatted for display in ArcMap legends. A renderer can override this formatting by returning a LegendItem for this property. ESRI renderers typically do not return anything for this property. With this configuration, legend formatting becomes a user or developer choice on the legend object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendItem in interface ILegendInfo

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws IOException,
                                     AutomationException

Indicates if symbols are graduated.

Description

Indicates whether the symbols used for a layer or renderer's legend vary by size.

Remarks

For example the proportional symbol renderer returns True for this property.

You can use this property to distinguish between a layer symbolized with graduated color or graduated symbol type layer symbology. Both of these symbolizations use a ClassBreaksRenderer, but only a graduated symbol symbolization will return True for this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSymbolsAreGraduated in interface ILegendInfo

Returns:

The symbolsAreGraduated

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws IOException,
                                   AutomationException

Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSymbolsAreGraduated in interface ILegendInfo

Parameters:

symbolsAreGraduated - The symbolsAreGraduated (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUsesFilter

public boolean isUsesFilter()
                     throws IOException,
                            AutomationException

Indicates if the current object draws using a filter.

Remarks

The UsesFilter property returns true when the object in question will draw with a filter. Drawing with a filter means means that an object that would normally draw as vector graphics will instead draw as raster. The UsesFilter property is particularly useful for detecting vector map layers that will be rasterized at time of print or export.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isUsesFilter in interface IDisplayAdmin

Returns:

The usesFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassificationField

public String getClassificationField()
                              throws IOException,
                                     AutomationException

Classification field name or an empty string if a table doesn't exist.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassificationField in interface IRasterRendererClassInfo

Returns:

The classFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNormalizationField

public String getNormalizationField()
                             throws IOException,
                                    AutomationException

Normalization field name or an empty string if none.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNormalizationField in interface IRasterRendererClassInfo

Returns:

The normFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNumericClasses

public boolean isNumericClasses()
                         throws IOException,
                                AutomationException

Indicates if the classification field is numeric.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isNumericClasses in interface IRasterRendererClassInfo

Returns:

The bNumeric

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryNumberClass

public void queryNumberClass(int classIndex,
                             double[] minValue,
                             double[] maxValue,
                             int[] outValue)
                      throws IOException,
                             AutomationException

Information for a number class by index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryNumberClass in interface IRasterRendererClassInfo

Parameters:

classIndex - The classIndex (in)

minValue - The minValue (out: use single element array)

maxValue - The maxValue (out: use single element array)

outValue - The outValue (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryStringClass

public void queryStringClass(int classIndex,
                             String[] inValue,
                             int[] outValue)
                      throws IOException,
                             AutomationException

Information for a string class by index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryStringClass in interface IRasterRendererClassInfo

Parameters:

classIndex - The classIndex (in)

inValue - The inValue (out: use single element array)

outValue - The outValue (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUniqueValuesByRef

public void setUniqueValuesByRef(IUniqueValues ppUniqueValues)
                          throws IOException,
                                 AutomationException

The list of unique values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUniqueValuesByRef in interface IRasterRendererUniqueValues

Parameters:

ppUniqueValues - A reference to a com.esri.arcgis.datasourcesraster.IUniqueValues (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUniqueValues

public IUniqueValues getUniqueValues()
                              throws IOException,
                                     AutomationException

The list of unique values.

Remarks

The UniqueValues property specifies the UniqueValues (the pixel information of the raster) for the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUniqueValues in interface IRasterRendererUniqueValues

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IUniqueValues

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseHillShade

public boolean isUseHillShade()
                       throws IOException,
                              AutomationException

Indicates whether the hill shading is being used.

Product Availability

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

Specified by:

isUseHillShade in interface IHillShadeInfo

Returns:

The bUse

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseHillShade

public void setUseHillShade(boolean bUse)
                     throws IOException,
                            AutomationException

Indicates whether the hill shading is being used.

Product Availability

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

Specified by:

setUseHillShade in interface IHillShadeInfo

Parameters:

bUse - The bUse (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZScale

public double getZScale()
                 throws IOException,
                        AutomationException

The Z factor multipled to z valuesg.

Product Availability

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

Specified by:

getZScale in interface IHillShadeInfo

Returns:

The pZScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZScale

public void setZScale(double pZScale)
               throws IOException,
                      AutomationException

The Z factor multipled to z valuesg.

Product Availability

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

Specified by:

setZScale in interface IHillShadeInfo

Parameters:

pZScale - The pZScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayTableByRef

public void setDisplayTableByRef(ITable ppTable)
                          throws IOException,
                                 AutomationException

The renderer display table.

Product Availability

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

Specified by:

setDisplayTableByRef in interface IDisplayTableExchange

Parameters:

ppTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayTable

public ITable getDisplayTable()
                       throws IOException,
                              AutomationException

The renderer display table.

Product Availability

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

Specified by:

getDisplayTable in interface IDisplayTableExchange

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

public void update(IRasterLayer pRasterLayer)
            throws IOException,
                   AutomationException

Updates this raster renderer using a given raster layer.

Product Availability

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

Specified by:

update in interface IRasterRendererUpdate

Parameters:

pRasterLayer - A reference to a com.esri.arcgis.carto.IRasterLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException