com.esri.arcgis.display
Interface IStackedChartSymbol

All Superinterfaces:

Serializable

All Known Implementing Classes:

StackedChartSymbol

public interface IStackedChartSymbol
extends Serializable

Provides access to stacked chart symbol properties.

Description

This interface provides access to a StackedChartSymbol which is a symbol used by a ChartRenderer to draw stacked bar or stacked column charts for a feature layer.

Remarks

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

When setting up a ChartRenderer to draw stacked bar and column 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 symbol for the chart outline.
double	getWidth() The width of the bar in points.
boolean	isFixed() Indicates if the bars are of a fixed length (the alternative is graduated length bars).
boolean	isUseOutline() Indicates if the outline symbol is drawn.
boolean	isVerticalBar() Indicates if the bar is oriented vertically.
void	setFixed(boolean flag) Indicates if the bars are of a fixed length (the alternative is graduated length bars).
void	setOutline(ILineSymbol symbol) The symbol for the chart outline.
void	setUseOutline(boolean flag) Indicates if the outline symbol is drawn.
void	setVerticalBar(boolean flag) Indicates if the bar is oriented vertically.
void	setWidth(double points) The width of the bar in points.

Method Detail

getWidth

double getWidth()
                throws IOException,
                       AutomationException

The width of the bar in points.

Description

This property is the width of the stacked bar or column in points.

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

isVerticalBar

boolean isVerticalBar()
                      throws IOException,
                             AutomationException

Indicates if the bar is oriented vertically.

Description

This property specifies whether or not the stacked chart is a column. If True then it's a stacked column, oriented vertically. If False, then it's a stacked bar, oriented horizontally.

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.

setVerticalBar

void setVerticalBar(boolean flag)
                    throws IOException,
                           AutomationException

Indicates if the bar is 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.

isUseOutline

boolean isUseOutline()
                     throws IOException,
                            AutomationException

Indicates if the outline symbol is drawn.

Description

This property specifies whether or not to draw the Outline symbol around the outside of the 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 symbol for the chart outline.

Description

This property is the line symbol used to draw an outline around the char. This symbol 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 symbol for the chart outline.

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.

isFixed

boolean isFixed()
                throws IOException,
                       AutomationException

Indicates if the bars are of a fixed length (the alternative is graduated length bars).

Description

This property specifies whether or not the stacked bar or column chart will have a fixed length when used by a CharRenderer. If True then the bar or columns will all be the same length. This is useful to compare the relative ratio of each value field for each feature, while ignoring the difference in overall magnitude between features. If this property is False, then the stacked charts will have varying length, depending on the magnitudes of the values for the fields that comprise the renderer/symbol.

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.

setFixed

void setFixed(boolean flag)
              throws IOException,
                     AutomationException

Indicates if the bars are of a fixed length (the alternative is graduated length bars).

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.