org.eclipse.birt.chart.script.api.data
Interface ISeriesGrouping


public interface ISeriesGrouping

Represents the grouping for series in the scripting environment.

See Also:
org.eclipse.birt.chart.model.data.SeriesGrouping

Method Summary
 int getGroupInterval()
          Gets the interval value between two groups.
 java.lang.String getGroupType()
          Gets the type of group.
 java.lang.String getGroupUnit()
          Gets the unit of group.
 boolean isEnabled()
          Checks if grouping is enabled
 void setEnabled(boolean value)
          Sets if grouping is enabled
 void setGroupInterval(int value)
          Sets the interval value between two groups.
 void setGroupType(java.lang.String type)
          Sets the type of group.
 void setGroupUnit(java.lang.String unit)
          Sets the unit of group.
 

Method Detail

isEnabled

public boolean isEnabled()
Checks if grouping is enabled

Returns:
enable state

setEnabled

public void setEnabled(boolean value)
Sets if grouping is enabled

Parameters:
value - enable state

getGroupInterval

public int getGroupInterval()
Gets the interval value between two groups.

Returns:
group interval

setGroupInterval

public void setGroupInterval(int value)
Sets the interval value between two groups.

Parameters:
value - group interval

getGroupType

public java.lang.String getGroupType()
Gets the type of group. Return values are an enumeration including "Numeric", "DateTime" and "Text". Default value is "Numeric".

Returns:
group type
See Also:
org.eclipse.birt.chart.model.attribute.DataType

setGroupType

public void setGroupType(java.lang.String type)
Sets the type of group. Group types are an enumeration including "Numeric", "DateTime" and "Text". Default value is "Numeric". If group types are invalid, will set the default value.

Parameters:
type - group type
See Also:
org.eclipse.birt.chart.model.attribute.DataType

getGroupUnit

public java.lang.String getGroupUnit()
Gets the unit of group. Return values are an enumeration including "Seconds", "Minutes", "Hours", "Days", "Weeks", "Months" and "Years". Default value is "Seconds".

Returns:
group unit
See Also:
org.eclipse.birt.chart.model.attribute.GroupingUnitType

setGroupUnit

public void setGroupUnit(java.lang.String unit)
Sets the unit of group. Group units are an enumeration including "Seconds", "Minutes", "Hours", "Days", "Weeks", "Months" and "Years". Default value is "Seconds". If group units are invalid, will set the default value.

Parameters:
unit - group unit
See Also:
org.eclipse.birt.chart.model.attribute.GroupingUnitType


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