com.esri.arcgis.carto
Interface IClassBreaksUIProperties

All Superinterfaces:

Serializable

All Known Implementing Classes:

ClassBreaksRenderer, TerrainPointAttributeRenderer, TerrainPointElevationRenderer, TinAspectRenderer, TinElevationRenderer, TinNodeElevationRenderer, TinSlopeRenderer

public interface IClassBreaksUIProperties
extends Serializable

Provides access to members that control some user interface properties of a ClassBreaksRenderer. The properties set through this interface do NOT affect what is drawn on the map.

Description

IClassBreaksUIProperties affects the properties of the user interface for ClassBreakRenderer objects (Graduated colors and Graduated symbols). Setting properties on this interface does NOT affect the map display. Instead, changes made through this interface affect what appears on the layer symbology dialog. Typically these changes will reflect real changes made to the renderer properties through IClassBreaksRenderer.

Remarks

This interface is used by layer properties dialog's symbology tab to store additional values reflecting what the user has chosen. The properties of this interface are not parameters to rendering features, however keeping these values up-to-date keeps the ArcGIS layer user interface consistent with the current renderer settings. For example, the LowBreak values appear on the layer properties dialog's symbology tab in the Range column to complete the list of class ranges. Only the upper value of each class actually affects rendering, but by calculating the LowBreak values you keep the class list up to date and looking nice for the dialog users.

See the associated example for use of this interface.

When To Use

Use this interface to make changes to the user interface for a ClassBreaksRenderer.

Product Availability

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

Method Summary

String	getColorRamp() File and path name of the color ramp.
double	getDeviationInterval() Deviation interval (0-1), where 0 means that no deviation is used.
double	getLowBreak(int index) Lower bound of the class at the specified index.
IUID	getMethod() Classification method.
INumberFormat	getNumberFormat() Number format for class labels.
boolean	isShowClassGaps() Indicates if each lower bound is adjusted up to the nearest existing data value.
void	setColorRamp(String colorRamp) File and path name of the color ramp.
void	setDeviationInterval(double interval) Deviation interval (0-1), where 0 means that no deviation is used.
void	setLowBreak(int index, double value) Lower bound of the class at the specified index.
void	setMethodByRef(IUID clsid) Classification method.
void	setNumberFormatByRef(INumberFormat format) Number format for class labels.
void	setShowClassGaps(boolean showGaps) Indicates if each lower bound is adjusted up to the nearest existing data value.

Method Detail

getLowBreak

double getLowBreak(int index)
                   throws IOException,
                          AutomationException

Lower bound of the class at the specified 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.

setLowBreak

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

Lower bound of the class at the specified 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.

getColorRamp

String getColorRamp()
                    throws IOException,
                           AutomationException

File and path name of the color ramp.

Description

ColorRamp is the name of the color ramp that is used to display the data. If that color ramp does not exist in the currently referenced styles, then use "Custom", this way something will appear in the user interface (versus a blank line, which can be confusing).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The colorRamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorRamp

void setColorRamp(String colorRamp)
                  throws IOException,
                         AutomationException

File and path name of the color ramp.

Description

ColorRamp is the name of the color ramp that is used to display the data. If that color ramp does not exist in the currently referenced styles, then use "Custom", this way something will appear in the user interface (versus a blank line, which can be confusing).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

colorRamp - The colorRamp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMethod

IUID getMethod()
               throws IOException,
                      AutomationException

Classification method.

Description

Method is the classification method used to create the class breaks. Use IClassify.MethodName to set this value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

setMethodByRef

void setMethodByRef(IUID clsid)
                    throws IOException,
                           AutomationException

Classification method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

getNumberFormat

INumberFormat getNumberFormat()
                              throws IOException,
                                     AutomationException

Number format for class labels.

Description

NumberFormat is the INumberFormat that defines how the labels of the classification appear.

Remarks

This property affects the formatting of the class labels on the layer properties dialog's symbology tab.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

See Also:

ILatLonFormat2, CustomNumberFormat, IRateFormat, IAngleFormat, NumericFormat, LatLonFormat, CurrencyFormat, INumericFormat, IFractionFormat, RateFormat, IScientificNumberFormat, ICustomNumberFormat, ILatLonFormat, IPercentageFormat, INumberFormat, ScientificFormat, FractionFormat, PercentageFormat, AngleFormat

setNumberFormatByRef

void setNumberFormatByRef(INumberFormat format)
                          throws IOException,
                                 AutomationException

Number format for class labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

boolean isShowClassGaps()
                        throws IOException,
                               AutomationException

Indicates if each lower bound is adjusted up to the nearest existing data value.

Description

This value indicates whether or not the minimum values of the classes are displayed on the layer properties dialog's symbology tab using actual data values. If False, then the values are displayed based on the precision specified in the NumberFormat property.

The framework sets this value internally. You cannot set this value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The showGaps

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowClassGaps

void setShowClassGaps(boolean showGaps)
                      throws IOException,
                             AutomationException

Indicates if each lower bound is adjusted up to the nearest existing data value.

Description

ShowClassGaps is whether the minimum and maximum values of the class are displayed using actual data values. If false, then the minimum and maximum values are displayed based on the precision specified in the NumberFormat property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

showGaps - The showGaps (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDeviationInterval

double getDeviationInterval()
                            throws IOException,
                                   AutomationException

Deviation interval (0-1), where 0 means that no deviation is used.

Description

DeviationInterval is the percentage of one standard deviation to be used as the interval of the class breaks. Range is 0 to 1. This is a user interface property only. Match this to the value of IDeviationInterval::DeviationInterval on the StandardDeviation object used to generate the class breaks for the ClassBreaksRenderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeviationInterval

void setDeviationInterval(double interval)
                          throws IOException,
                                 AutomationException

Deviation interval (0-1), where 0 means that no deviation is used.

Description

DeviationInterval is the percentage of one standard deviation to be used as the interval of the class breaks. Range is 0 to 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.