org.eclipse.birt.chart.script.api.component
Interface ICategory


public interface ICategory

Represents the category(X) Series of a Chart in the scripting environment


Method Summary
 ISeriesData getDataExpr()
          Gets query expression in the Category
 ISeriesGrouping getGrouping()
          Gets grouping related information
 java.lang.String getOptionalValueGroupingExpr()
          Gets the query expression for optional grouping for value series.
 java.lang.String getSorting()
          Gets the name of SortOption.
 void setOptionalValueGroupingExpr(java.lang.String expr)
          Sets the query expression for optional grouping for value series.
 void setSorting(java.lang.String sorting)
          Sets SortOption by name.
 

Method Detail

getDataExpr

public ISeriesData getDataExpr()
Gets query expression in the Category

Returns:
query expression object

getGrouping

public ISeriesGrouping getGrouping()
Gets grouping related information

Returns:
series grouping object

getSorting

public java.lang.String getSorting()
Gets the name of SortOption. Return values are an enumeration including "Ascending" and "Descending". Default value is "Ascending"

Returns:
the name of SortOption
See Also:
org.eclipse.birt.chart.model.attribute.SortOption

setSorting

public void setSorting(java.lang.String sorting)
Sets SortOption by name. Sorting names are an enumeration including "Ascending" and "Descending". Default value is "Ascending". If sorting name is invalid, will set the default value.

Parameters:
sorting - the name of SortOption
See Also:
org.eclipse.birt.chart.model.attribute.SortOption

getOptionalValueGroupingExpr

public java.lang.String getOptionalValueGroupingExpr()
Gets the query expression for optional grouping for value series.

Returns:
query expression

setOptionalValueGroupingExpr

public void setOptionalValueGroupingExpr(java.lang.String expr)
Sets the query expression for optional grouping for value series.

Parameters:
expr - query expression


Copyright © 2005-2007 Actuate Corp. All rights reserved.