com.esri.arcgis.carto
Interface IBasicHistogram

All Superinterfaces:
Serializable
All Known Implementing Classes:
BasicTableHistogram

public interface IBasicHistogram
extends Serializable

Provides access to members that control histogram objects created from different data sources.

Description

Use BasicTableHistogram::ITableHistogram to produce a histogram data structure based on input from an object that supports ITable. This data structure is commonly used as input to the classification coclasses (e.g. NaturalBreaks, Quantile). Use this object if you are developing against only ArcEngine components. The BasicTableHistogram performs a simliar function to TableHistogram, but unlike TableHistogram, it is available to ArcEngine developers.

Remarks

IBasicHistogram performs a function similar to IHistogram, but it is available to Engine developers. Use IBasicHistogram with a BasicTableHistogram like you would use IHistogram with a TableHistogram.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 boolean getHistogram(Object[] doubleArrayValues, Object[] longArrayFrequencies)
          Histogram as an array of values (doubles) and a paired array of frequencies (longs).
 void invalidate()
          Causes to recreate the Histogram from the Table for the next GetHistogram call.
 void resetCustomMinMax()
          Resets custom minimum and maximum.
 void setCustomMax(double rhs1)
          Custom maximum.
 void setCustomMin(double rhs1)
          Custom minimum.
 

Method Detail

getHistogram

boolean getHistogram(Object[] doubleArrayValues,
                     Object[] longArrayFrequencies)
                     throws IOException,
                            AutomationException
Histogram as an array of values (doubles) and a paired array of frequencies (longs).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
doubleArrayValues - A Variant (out: use single element array)
longArrayFrequencies - A Variant (out: use single element array)
Returns:
The isSampled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomMin

void setCustomMin(double rhs1)
                  throws IOException,
                         AutomationException
Custom minimum.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCustomMax

void setCustomMax(double rhs1)
                  throws IOException,
                         AutomationException
Custom maximum.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

resetCustomMinMax

void resetCustomMinMax()
                       throws IOException,
                              AutomationException
Resets custom minimum and maximum.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

invalidate

void invalidate()
                throws IOException,
                       AutomationException
Causes to recreate the Histogram from the Table for the next GetHistogram call.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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