com.esri.arcgis.carto
Interface IDataExclusion

All Superinterfaces:
Serializable
All Known Implementing Classes:
ChartRenderer, ClassBreaksRenderer, DotDensityRenderer, ProportionalSymbolRenderer

public interface IDataExclusion
extends Serializable

Provides access to members that control the exclusion of data values from a renderer.

Remarks

This interface is implemented by some feature renderers and is used to prevent a set of features from drawing. Use this interface to exclude erroneous values from rendering. For example, you might exclude features with values less than or equal to zero from drawing with a ProportionalSymbolRenderer. Also, you might exclude other special values, such as Null values. You can choose to draw these excluded features with their own symbol and have that symbol labeled in the table of contents and legend if applicable.

Exclusion works by specifying an SQL expression for the ExclusionClause. If an invalid expression is set, no features will be drawn. To specify a symbol to be used for excluded features, set the ExclusionSymbol. If this property is Nothing, then excluded features will not be drawn. Also, if ShowExclusionClass is False, then excluded features will also not be drawn on the map, or appear in the table of contents or legend, regardless of whether or not a valid ExclusionClause is set.

Exclusion prevents features from drawing. To prevent features from drawing as well as from appearing in tables and in query results, set a layer definition query using IFeatureLayerDefinition.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 String getExclusionClause()
          Data exclusion where clause.
 String getExclusionDescription()
          Description for the excluded data.
 String getExclusionLabel()
          Label for the excluded data.
 ISymbol getExclusionSymbol()
          Symbol used to draw excluded values.
 boolean isShowExclusionClass()
          Indicates if the exclusion symbol is used.
 void setExclusionClause(String clause)
          Data exclusion where clause.
 void setExclusionDescription(String text)
          Description for the excluded data.
 void setExclusionLabel(String label)
          Label for the excluded data.
 void setExclusionSymbol(ISymbol symbol)
          Symbol used to draw excluded values.
 void setShowExclusionClass(boolean show)
          Indicates if the exclusion symbol is used.
 

Method Detail

getExclusionClause

String getExclusionClause()
                          throws IOException,
                                 AutomationException
Data exclusion where clause.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setExclusionClause

void setExclusionClause(String clause)
                        throws IOException,
                               AutomationException
Data exclusion where clause.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getExclusionSymbol

ISymbol getExclusionSymbol()
                           throws IOException,
                                  AutomationException
Symbol used to draw excluded values.

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.ISymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExclusionSymbol

void setExclusionSymbol(ISymbol symbol)
                        throws IOException,
                               AutomationException
Symbol used to draw excluded values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
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.

isShowExclusionClass

boolean isShowExclusionClass()
                             throws IOException,
                                    AutomationException
Indicates if the exclusion symbol is used.

Description

Setting ShowExclusionClass to TRUE creates a new LegendClass that appears in the TOC containing the ExclusionSymbol, ExclusionLabel, and ExclusionDescription. Also, use this property to control whether the ExclusionSymbol is drawn on the map. IDataExclusion provides no mechanism to make the symbol appear on the map, but not in the TOC.

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.

setShowExclusionClass

void setShowExclusionClass(boolean show)
                           throws IOException,
                                  AutomationException
Indicates if the exclusion symbol is used.

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.

getExclusionLabel

String getExclusionLabel()
                         throws IOException,
                                AutomationException
Label for the excluded data.

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.

setExclusionLabel

void setExclusionLabel(String label)
                       throws IOException,
                              AutomationException
Label for the excluded data.

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.

getExclusionDescription

String getExclusionDescription()
                               throws IOException,
                                      AutomationException
Description for the excluded data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setExclusionDescription

void setExclusionDescription(String text)
                             throws IOException,
                                    AutomationException
Description for the excluded data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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