com.esri.arcgis.display
Interface IBarChartSymbol

All Superinterfaces:

Serializable

All Known Implementing Classes:

BarChartSymbol

public interface IBarChartSymbol
extends Serializable

Provides access to members that control bar chart symbol properties.

Description

This interface provides access to the properties of a BarChartSymbol which is used by a ChartRenderer to draw bar or column charts for a feature layer.

Remarks

Use this interface to access the properties of a BarChartSymbol which is a data driven symbol used by a ChartRenderer to draw features with bar/column charts.

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

Product Availability

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

See Also:

IBarChartSymbol, IChartSymbol

Method Summary

ILineSymbol	getAxes() The axis symbol.
double	getSpacing() The spacing between bars in points.
double	getWidth() The width of each bar in points.
boolean	isShowAxes() Indicates if the axis are shown.
boolean	isVerticalBars() Indicates if the bars are oriented vertically.
void	setAxes(ILineSymbol symbol) The axis symbol.
void	setShowAxes(boolean flag) Indicates if the axis are shown.
void	setSpacing(double points) The spacing between bars in points.
void	setVerticalBars(boolean flag) Indicates if the bars are oriented vertically.
void	setWidth(double points) The width of each bar in points.

Method Detail

isVerticalBars

boolean isVerticalBars()
                       throws IOException,
                              AutomationException

Indicates if the bars are oriented vertically.

Description

This property specifies whether or not the chart symbol will be column chart. If True, then it's a column chart with vertical columns. If False, then it's a bar chart with horizontal bars.

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.

setVerticalBars

void setVerticalBars(boolean flag)
                     throws IOException,
                            AutomationException

Indicates if the bars are oriented vertically.

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.

isShowAxes

boolean isShowAxes()
                   throws IOException,
                          AutomationException

Indicates if the axis are shown.

Description

This property specifies whether or not x and y axes are shown for the bar/column charts.

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.

setShowAxes

void setShowAxes(boolean flag)
                 throws IOException,
                        AutomationException

Indicates if the axis are shown.

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.

getAxes

ILineSymbol getAxes()
                    throws IOException,
                           AutomationException

The axis symbol.

Description

This property provides acccess to the line symbol used for the chart x and y axes.

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.

setAxes

void setAxes(ILineSymbol symbol)
             throws IOException,
                    AutomationException

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

getWidth

double getWidth()
                throws IOException,
                       AutomationException

The width of each bar in points.

Description

This property provides access to the width of each bar or column in the charts. Only one width can be specified which applies to all of the bars/columns.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The points

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

void setWidth(double points)
              throws IOException,
                     AutomationException

The width of each bar in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

points - The points (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpacing

double getSpacing()
                  throws IOException,
                         AutomationException

The spacing between bars in points.

Description

This property provides access to the spacing distance between bars or columns.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The points

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpacing

void setSpacing(double points)
                throws IOException,
                       AutomationException

The spacing between bars in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

points - The points (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.