org.eclipse.birt.chart.script.api

Interface IChart

All Known Subinterfaces:

IChartWithAxes, IChartWithoutAxes

public interface IChart

Represents the design of a Chart in the scripting environment

Method Summary

Methods

Modifier and Type	Method and Description
ICategory	getCategory() Gets the Category that represents category(X) series in Chart model
IText	getDescription() Gets the description of Chart
java.lang.String	getDimension() Gets the name of ChartDimension.
IComponentFactory	getFactory() Gets factory to create simple API classes.
ILegend	getLegend() Gets Legend in Chart model
java.lang.String	getOutputType() Gets the output type of Chart
ILabel	getTitle() Gets the title of Chart
boolean	isColorByCategory() Checks if color in value series is ordered by category
void	setColorByCategory(boolean byCategory) Sets the color in value series is ordered by category
void	setDimension(java.lang.String dimensionName) Sets ChartDimension by dimension name.
void	setOutputType(java.lang.String type) Sets the output type of Chart.

Method Detail

getDescription

IText getDescription()

Gets the description of Chart

Returns:

description

getTitle

ILabel getTitle()

Gets the title of Chart

Returns:

title

getLegend

ILegend getLegend()

Gets Legend in Chart model

Returns:

Legend component

getCategory

ICategory getCategory()

Gets the Category that represents category(X) series in Chart model

Returns:

category series

isColorByCategory

boolean isColorByCategory()

Checks if color in value series is ordered by category

Returns:

true by category, false by series

setColorByCategory

void setColorByCategory(boolean byCategory)

Sets the color in value series is ordered by category

Parameters:

byCategory - true by category, false by series

getOutputType

java.lang.String getOutputType()

Gets the output type of Chart

Returns:

output type

setOutputType

void setOutputType(java.lang.String type)

Sets the output type of Chart. Supported output types include SVG, PNG, JPG, BMP and PDF. Default value is SVG.

Parameters:

type - output type

getDimension

java.lang.String getDimension()

Gets the name of ChartDimension. Return values are an enumeration including "TwoDimensional", "TwoDimensionalWithDepth" and "ThreeDimensional". Default value is "TwoDimensional".

Returns:

dimension name

See Also:

org.eclipse.birt.chart.model.attribute.ChartDimension

setDimension

void setDimension(java.lang.String dimensionName)

Sets ChartDimension by dimension name. Dimension names are an enumeration including "TwoDimensional", "TwoDimensionalWithDepth" and "ThreeDimensional". Default value is "TwoDimensional". If dimension name is invalid, will set the default value.

Parameters:

dimensionName - dimension name

See Also:

org.eclipse.birt.chart.model.attribute.ChartDimension

getFactory

IComponentFactory getFactory()

Gets factory to create simple API classes.

Returns:

factory class