com.esri.arcgis.carto
Interface IRasterClassifyColorRampRenderer

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterClassifyColorRampRenderer

public interface IRasterClassifyColorRampRenderer
extends Serializable

Provides access to members that relate to the classified rendering of rasters.

Description

The IRasterClassifyColorRampRenderer controls the classes used by the renderer and how they are displayed.

Remarks

The default classification method for RasterClassifyColorRampRenderer is NaturalBreaks. To set other classification method use interface IRasterClassifyUIProperties.

TheClassFieldproperty determines the field of the raster on which the classification will be performed. With theNormFieldproperty, you may optionally specify another field by which the class field will be divided 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.

Method Summary

double	getBreak(int index) Break at the index.
int	getClassCount() Number of classes.
String	getClassField() Field this renderer is using.
String	getDescription(int index) Description for the class at the given index.
String	getLabel(int index) Label for the class at the given index.
String	getNormField() Normalization field this renderer is using.
ISymbol	getSymbol(int index) Symbol representing the class at the index.
boolean	isSortClassesAscending() Indicates if the sort direction for the class labels is ascending.
void	setBreak(int index, double value) Break at the index.
void	setClassCount(int value) Number of classes.
void	setClassField(String field) Field this renderer is using.
void	setDescription(int index, String description) Description for the class at the given index.
void	setLabel(int index, String label) Label for the class at the given index.
void	setNormField(String field) Normalization field this renderer is using.
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.

Method Detail

getClassField

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

Returns:

The field

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassField

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

Parameters:

field - The field (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNormField

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

Returns:

The field

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNormField

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

Parameters:

field - The field (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassCount

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassCount

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

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreak

double getBreak(int index)
                throws IOException,
                       AutomationException

Break at the index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreak

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

Break at the index.

Product Availability

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

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

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.

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

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.

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

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.

Parameters:

index - The index (in)

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

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.

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

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.

Parameters:

index - The index (in)

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

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.

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

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

Returns:

The ascending

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSortClassesAscending

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

Parameters:

ascending - The ascending (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.