com.esri.arcgis.display
Interface IPieChartSymbol

All Superinterfaces:

Serializable

All Known Implementing Classes:

PieChartSymbol

public interface IPieChartSymbol
extends Serializable

Provides access to pie chart symbol properties.

Description

This interface provides access to the properties of a PieChartSymbol which is used by a ChartRenderer to draw pie charts for a feature layer.

Remarks

Use this interface to access the properties of a PieChartSymbol which is a data driven symbol used by a ChartRenderer to draw features with pie charts.

When setting up a ChartRenderer to draw pie charts through code, you need to work with this interface.

Product Availability

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

Method Summary

ILineSymbol	getOutline() The chart outline symbol.
boolean	isClockwise() Indicates if the slices are drawn in a clockwise direction.
boolean	isUseOutline() Indicates if the outline symbol is drawn.
void	setClockwise(boolean flag) Indicates if the slices are drawn in a clockwise direction.
void	setOutline(ILineSymbol symbol) The chart outline symbol.
void	setUseOutline(boolean flag) Indicates if the outline symbol is drawn.

Method Detail

isClockwise

boolean isClockwise()
                    throws IOException,
                           AutomationException

Indicates if the slices are drawn in a clockwise direction.

Description

This property specifies whether or not pie slices will be arranged using the geographic coordinate system. If True, then slices begin at 'North' and are arranged in a clockwise direction around the pie. If False, then slices begin at 'East' and are arranged in a counter-clockwise direction around the pie according to the arithmetic coordinate system.

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.

setClockwise

void setClockwise(boolean flag)
                  throws IOException,
                         AutomationException

Indicates if the slices are drawn in a clockwise direction.

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.

isUseOutline

boolean isUseOutline()
                     throws IOException,
                            AutomationException

Indicates if the outline symbol is drawn.

Description

This property specifies whether or not a line outline symbol is drawn around the pie chart.

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.

setUseOutline

void setUseOutline(boolean flag)
                   throws IOException,
                          AutomationException

Indicates if the outline symbol is drawn.

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.

getOutline

ILineSymbol getOutline()
                       throws IOException,
                              AutomationException

The chart outline symbol.

Description

This property provides access to the line symbol that can be used as the outline symbol around the pie chart. The property is only used if UseOutline = True.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutline

void setOutline(ILineSymbol symbol)
                throws IOException,
                       AutomationException

The chart outline symbol.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.