com.esri.arcgis.carto
Interface ICalcRendererValues

All Superinterfaces:

Serializable

All Known Subinterfaces:

ICalcRendererValues2

All Known Implementing Classes:

CalcRendererValues

public interface ICalcRendererValues
extends Serializable

Provides access to members that are used to calculate the renderer statistics required for some uses of a ChartRenderer.

Superseded By

ICalcRendererValues2

Description

This interface provides access to methods of an object that calculates field statistics for a dataset. This object can be used to set up a ChartRenderer.

Remarks

When setting up a ChartRenderer with charts that either vary in size, or that use normalization by percent of total, you can use a CalcRendererValues object to calculate some statistics that you set to the chart symbol and renderer so that: 1) the charts appear correctly on the map, and 2) and the chart legend information is correct

Product Availability

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

Method Summary

void	calcMinMax(double[] minValue, double[] maxValue) Calculates minimum and maximum values.
Object	getFieldTotals() Gets totals for all fields.
void	setData(IFeatureLayer layer, IFeatureRenderer renderer) Sets data for calculation.
void	setDirty() Sets object to state where values will be recalculated.
void	setMinMax(double minValue, double maxValue) Manually sets minimum and maximum values.

Method Detail

setData

void setData(IFeatureLayer layer,
             IFeatureRenderer renderer)
             throws IOException,
                    AutomationException

Sets data for calculation.

Remarks

Use this method to connect the CalcRendererValues object to a feature layer and feature renderer. The renderer is usually a ChartRenderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

layer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

renderer - A reference to a com.esri.arcgis.carto.IFeatureRenderer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calcMinMax

void calcMinMax(double[] minValue,
                double[] maxValue)
                throws IOException,
                       AutomationException

Calculates minimum and maximum values.

Remarks

Use this method to calculate the MinValue and MaxValue in the data referenced by the feature layer in the fields defined by the feature renderer. You must first set the feature layer and feature renderer using SetData. The feature renderer is usually a ChartRenderer which contains multiple fields, and MinValue and MaxValue are calculated for you based only on the fields defined for the ChartRenderer using IRendererFields .

Use this method to calculate a value to set to IChartSymbol::MaxValue. This property represents the maximum value for all of the renderer fields for all of the features. The value is used by the ChartRenderer to properly set up a the legend information for the ChartRenderer which appears in the table of contents and can also appear in a legend.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

minValue - The minValue (out: use single element array)

maxValue - The maxValue (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirty

void setDirty()
              throws IOException,
                     AutomationException

Sets object to state where values will be recalculated.

Remarks

Call this method after calling SetData or SetMinMax, and before calling CalcMinMax or GetFieldTotals.

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.

setMinMax

void setMinMax(double minValue,
               double maxValue)
               throws IOException,
                      AutomationException

Manually sets minimum and maximum values.

Remarks

This method allows you to manually set the minimum and maximum values that are calculated and returned when you call CalcMinMax.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

minValue - The minValue (in)

maxValue - The maxValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldTotals

Object getFieldTotals()
                      throws IOException,
                             AutomationException

Gets totals for all fields.

Remarks

This method calculates the field totals for the data referenced by the feature layer and the fields defined by the feature renderer. Before calling this method you must call SetData to set the feature layer and feature renderer.

This method is used to calculate field totals which can then be set to IChartRenderer::FieldTotal to support chart rendering with normalization by percent of total.

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.