com.esri.arcgis.carto
Interface IChartRenderer

All Superinterfaces:

Serializable

All Known Implementing Classes:

ChartRenderer

public interface IChartRenderer
extends Serializable

Provides access to members that control the drawing of chart symbols (pie, bar, stacked bar) on a map to represent features.

Description

This interface provides access to members that control chart renderering of features.

Remarks

The ChartRenderer requires a list of fields whose values are used to generate the pie slices, individual bars/columns, and stacked chart slices for each feature. Assign fields using IRendererFields. The chart type (pie, bar/column, or stacked bar/column) depends on the symbol assigned to ChartSymbol.

Set other properties for a ChartRenderer using this interface. Additionally, set properties for the chart symbol via IChartSymbol and also through interfaces specific to the chart symbol coclasses: PieChartSymbol, BarChartSymbol, and StackedChartSymbol. Also, use IPieChartRenderer to set properties specific to rendering with pie charts.

Product Availability

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

Method Summary

void	createLegend() Creates the legend.
ISymbol	getBaseSymbol() Background fill symbol, (used when chart symbols are drawn for polygon features).
IChartSymbol	getChartSymbol() Chart symbol object.
String	getColorScheme() Color scheme (user interface property only).
double	getFieldTotal(int index) Field total for the field at the specified index.
String	getLabel() Chart label.
boolean	isUseOverposter() Indicates if the overposter is used for positioning the chart symbols.
void	setBaseSymbolByRef(ISymbol symbol) Background fill symbol, (used when chart symbols are drawn for polygon features).
void	setChartSymbolByRef(IChartSymbol symbol) Chart symbol object.
void	setColorScheme(String name) Color scheme (user interface property only).
void	setFieldTotal(int index, double total) Field total for the field at the specified index.
void	setLabel(String name) Chart label.
void	setUseOverposter(boolean flag) Indicates if the overposter is used for positioning the chart symbols.

Method Detail

getFieldTotal

double getFieldTotal(int index)
                     throws IOException,
                            AutomationException

Field total for the field at the specified index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The total

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldTotal

void setFieldTotal(int index,
                   double total)
                   throws IOException,
                          AutomationException

Field total for the field at the specified index.

Product Availability

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

Parameters:

index - The index (in)

total - The total (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChartSymbol

IChartSymbol getChartSymbol()
                            throws IOException,
                                   AutomationException

Chart symbol object.

Description

This is the chart symbol used by the renderer. The type of charts drawn will depend on the type of chart symbol set for this property. The choices are: PieChartSymbol, BarChartSymbol (for both bar and column charts), and StackedChartSymbol (for stacked bar and stacked column charts.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChartSymbolByRef

void setChartSymbolByRef(IChartSymbol symbol)
                         throws IOException,
                                AutomationException

Chart symbol object.

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.IChartSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseSymbol

ISymbol getBaseSymbol()
                      throws IOException,
                             AutomationException

Background fill symbol, (used when chart symbols are drawn for polygon features).

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.

setBaseSymbolByRef

void setBaseSymbolByRef(ISymbol symbol)
                        throws IOException,
                               AutomationException

Background fill symbol, (used when chart symbols are drawn for polygon features).

Product Availability

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

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.

getColorScheme

String getColorScheme()
                      throws IOException,
                             AutomationException

Color scheme (user interface property only).

Description

This property is a string that represents the name of a random color ramp used to determine the color of the pie slices, individual bars/columns, or stacked chart slices in the user interface. This property doesn't affect the display of charts on the map. If you are building a chart renderer through code, and assigning colors using a random color ramp to your slices, bars, or columns, then it's good practice to set this property to the name of the ramp you use. This just keeps the user interface up to date with your renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorScheme

void setColorScheme(String name)
                    throws IOException,
                           AutomationException

Color scheme (user interface property only).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

String getLabel()
                throws IOException,
                       AutomationException

Chart label.

Remarks

This property provides access to the label corresponding to a pie slice, bar/column, or stacked slice. These items in turn correspond to a renderer field. Use IRendererFields to access these fields. By default a label will match its corresponding field name.

Labels appear in the legend entry for the renderer, and therefore appear in the ArcMap table of contents and can appear in legends depending on the LegendItem applied to the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

void setLabel(String name)
              throws IOException,
                     AutomationException

Chart label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseOverposter

boolean isUseOverposter()
                        throws IOException,
                               AutomationException

Indicates if the overposter is used for positioning the chart symbols.

Description

This property indicates whether or not overposting logic is used to position charts on the map so that they do not overlap. The overposting logic employed is that of the standard ESRI labeling engine.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseOverposter

void setUseOverposter(boolean flag)
                      throws IOException,
                             AutomationException

Indicates if the overposter is used for positioning the chart symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createLegend

void createLegend()
                  throws IOException,
                         AutomationException

Creates the legend. Call after all properties are set.

Remarks

Call this property after making changes to renderer properties. This updates the legend information for the renderer which appears in the ArcMap table of contents and can appear in the legend.

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.