com.esri.arcgis.carto
Interface IRasterClassifyUIProperties

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterClassifyColorRampRenderer

public interface IRasterClassifyUIProperties
extends Serializable

Provides access to members that control the classification properties in the UI.

Remarks

The IRasterClassifyUIProperties interface controls the properties that appear in the Classification dialog box of the raster property page.


When To Use

The IRasterClassifyUIProperties interface is used to set the classification method for RasterClassifyColorRampRenderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IUID getClassificationMethod()
          Classification method.
 String getColorRamp()
          Color ramp name.
 double getDeviationInterval()
          Deviation interval.
 INumberFormat getNumberFormat()
          Number format for labels.
 boolean isShowClassGaps()
          Indicates if gaps between classes are shown.
 void setClassificationMethodByRef(IUID ppClsid)
          Classification method.
 void setColorRamp(String colorRamp)
          Color ramp name.
 void setDeviationInterval(double interval)
          Deviation interval.
 void setNumberFormatByRef(INumberFormat format)
          Number format for labels.
 void setShowClassGaps(boolean showGaps)
          Indicates if gaps between classes are shown.
 

Method Detail

getClassificationMethod

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

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

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

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

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

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
Color ramp name.

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.

getNumberFormat

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

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

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

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

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 gaps between classes are shown.

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

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

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