com.esri.arcgis.carto
Interface IRasterDataExclusion

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterClassifyColorRampRenderer

public interface IRasterDataExclusion
extends Serializable

Provides access to members that exclude data values from classification.

Remarks

The IRasterDataExclusion interface controls the display of values that are not in any class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 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.
 boolean isExcludeShowClass()
          Indicates if color is shown for the excluded values.
 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.
 

Method Detail

setExcludeValues

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

Parameters:
values - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExcludeValues

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

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExcludeRanges

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

Parameters:
values - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExcludeRanges

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

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExcludeShowClass

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

Parameters:
show - The show (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExcludeShowClass

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

Returns:
The show
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExcludeColor

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

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

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

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

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

Parameters:
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExcludeLabel

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

Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExcludeDescription

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

Parameters:
description - The description (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExcludeDescription

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

Returns:
The description
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.