Interface IChart
-
- All Superinterfaces:
org.eclipse.birt.report.model.api.simpleapi.IDesignElement,org.eclipse.birt.report.model.api.simpleapi.IMultiRowItem,org.eclipse.birt.report.model.api.simpleapi.IReportElement,org.eclipse.birt.report.model.api.simpleapi.IReportItem
- All Known Subinterfaces:
IChartWithAxes,IChartWithoutAxes
public interface IChart extends org.eclipse.birt.report.model.api.simpleapi.IMultiRowItemRepresents the design of a Chart in the scripting environment
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ICategorygetCategory()Gets the Category that represents category(X) series in Chart modelITextgetDescription()Gets the description of Chartjava.lang.StringgetDimension()Gets the name of ChartDimension.IComponentFactorygetFactory()Gets factory to create simple API classes.ILegendgetLegend()Gets Legend in Chart modeljava.lang.StringgetOutputType()Gets the output type of ChartILabelgetTitle()Gets the title of ChartbooleanisColorByCategory()Checks if color in value series is ordered by categoryvoidsetColorByCategory(boolean byCategory)Sets the color in value series is ordered by categoryvoidsetDimension(java.lang.String dimensionName)Sets ChartDimension by dimension name.voidsetOutputType(java.lang.String type)Sets the output type of Chart.-
Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IDesignElement
getNamedExpression, getParent, getQualifiedName, getReport, getStyle, getUserProperty, getUserPropertyExpression, setNamedExpression, setUserProperty, setUserProperty
-
Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IMultiRowItem
addFilterCondition, addSortCondition, getFilterConditions, getSortConditions, removeFilterCondition, removeFilterConditions, removeSortCondition, removeSortConditions
-
Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IReportElement
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getName, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setName
-
Methods inherited from interface org.eclipse.birt.report.model.api.simpleapi.IReportItem
addDataBinding, addHideRule, addHighlightRule, getBookmark, getDataBinding, getDataBindings, getHeight, getHideRules, getHighlightRules, getTocExpression, getWidth, getX, getY, removeDataBinding, removeDataBindings, removeHideRule, removeHideRules, removeHighlightRule, removeHighlightRules, setBookmark, setCurrentView, setHeight, setHeight, setTocExpression, setWidth, setWidth, setX, setX, setY, setY
-
-
-
-
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:
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:
ChartDimension
-
getFactory
IComponentFactory getFactory()
Gets factory to create simple API classes.- Returns:
- factory class
-
-