Interface Series
- All Superinterfaces:
org.eclipse.emf.ecore.EObject
,IChartObject
,org.eclipse.emf.common.notify.Notifier
- All Known Subinterfaces:
AreaSeries
,BarSeries
,BubbleSeries
,DialSeries
,DifferenceSeries
,GanttSeries
,LineSeries
,PieSeries
,ScatterSeries
,StockSeries
- All Known Implementing Classes:
AreaSeriesImpl
,BarSeriesImpl
,BubbleSeriesImpl
,DialSeriesImpl
,DifferenceSeriesImpl
,GanttSeriesImpl
,LineSeriesImpl
,PieSeriesImpl
,ScatterSeriesImpl
,SeriesImpl
,StockSeriesImpl
A representation of the model object
'Series'.
This type defines a single (related) group of data
to be plotted in a chart. A series is usually expected to be associated with
a numerical axis. The series includes a name, visualization settings, and a
query definition used to retrieve the data point values. At designtime, the
series data set is null, while at runtime, each series' data set gets
populated with the data for that series.
The following features are supported:
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Indicates if this series type may be rendered stacked with other series instances of the same type NOTE: Manually writtenboolean
This method should return true if the series type can be used in a combination chart.boolean
Indicates if this series graphic element may share a scale unit with other similar elements.Returns the value of the 'Cursor' containment reference.Returns the value of the 'Curve Fitting' containment reference.org.eclipse.emf.common.util.EList<Query>
Returns the value of the 'Data Definition' containment reference list.Returns the value of the 'Data Point' containment reference.Returns the value dataSet.getDataSet
(String userkey) Returns the user dataSet.Returns the value of the 'Data Sets' map.int[]
Returns the index array of data definitions which must be defined.This method should return a user-friendly name for the series type.getLabel()
Returns the value of the 'Label' containment reference.Returns the value of the 'Label Position' attribute.org.eclipse.birt.chart.util.NameSet
getLabelPositionScope
(ChartDimension dimension) Returns supported label positions scope in current series.Returns the value of the 'Series Identifier' attribute.org.eclipse.emf.common.util.EList<Trigger>
Returns the value of the 'Triggers' containment reference list.boolean
Returns whether the value of the 'Label Position
' attribute is set.boolean
Returns whether the value of the 'Stacked
' attribute is set.boolean
Returns whether the value of the 'Translucent
' attribute is set.boolean
Returns whether the value of the 'Visible
' attribute is set.boolean
The method indicates if painting requests of series should be added to a single cache.boolean
Returns the value of the 'Stacked' attribute.boolean
Returns the value of the 'Translucent' attribute.boolean
Returns the value of the 'Visible' attribute.void
Sets the value of the 'Cursor
' containment reference.void
setCurveFitting
(CurveFitting value) Sets the value of the 'Curve Fitting
' containment reference.void
setDataPoint
(DataPoint value) Sets the value of the 'Data Point
' containment reference.void
setDataSet
(String userKey, DataSet dataSet) Sets the user dataSet.void
setDataSet
(DataSet dataSet) Sets the value dataSet.void
Sets the value of the 'Label
' containment reference.void
setLabelPosition
(Position value) Sets the value of the 'Label Position
' attribute.void
setSeriesIdentifier
(Object value) Sets the value of the 'Series Identifier
' attribute.void
setStacked
(boolean value) Sets the value of the 'Stacked
' attribute.void
setTranslucent
(boolean value) Sets the value of the 'Translucent
' attribute.void
setVisible
(boolean value) Sets the value of the 'Visible
' attribute.void
translateFrom
(Series sourceSeries, int iSeriesDefinitionIndex, Chart chart) This method should modify the series instance to extract whatever information it can from the series provided...updating the model if necessary.void
Unsets the value of the 'Label Position
' attribute.void
Unsets the value of the 'Stacked
' attribute.void
Unsets the value of the 'Translucent
' attribute.void
Unsets the value of the 'Visible
' attribute.Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
-
Method Details
-
isVisible
boolean isVisible()Returns the value of the 'Visible' attribute. The default value is"true"
. Gets visibility of the series. Determines visibility of the series.- Returns:
- the value of the 'Visible' attribute.
- See Also:
-
setVisible
void setVisible(boolean value) Sets the value of the 'Visible
' attribute. Sets visibility of the series.- Parameters:
value
- the new value of the 'Visible' attribute.- See Also:
-
unsetVisible
void unsetVisible()Unsets the value of the 'Visible
' attribute.- See Also:
-
isSetVisible
boolean isSetVisible()Returns whether the value of the 'Visible
' attribute is set.- Returns:
- whether the value of the 'Visible' attribute is set.
- See Also:
-
getLabel
Label getLabel()Returns the value of the 'Label' containment reference. Holds the properties for the Series data points.- Returns:
- the value of the 'Label' containment reference.
- See Also:
-
setLabel
Sets the value of the 'Label
' containment reference.- Parameters:
value
- the new value of the 'Label' containment reference.- See Also:
-
getDataDefinition
org.eclipse.emf.common.util.EList<Query> getDataDefinition()Returns the value of the 'Data Definition' containment reference list. The list contents are of typeorg.eclipse.birt.chart.model.data.DataDefinition
. Gets the list of data source definitions for this series. Defines the source of the data for the series. (e.g. Database field which will provide the values for the series).- Returns:
- the value of the 'Data Definition' containment reference list.
- See Also:
-
getSeriesIdentifier
Object getSeriesIdentifier()Returns the value of the 'Series Identifier' attribute. Returns an identifier that represents the seriesKey runtime value which is rendered in the legend (if grouped by series)- Returns:
- the value of the 'Series Identifier' attribute.
- See Also:
-
setSeriesIdentifier
Sets the value of the 'Series Identifier
' attribute.- Parameters:
value
- the new value of the 'Series Identifier' attribute.- See Also:
-
getDataPoint
DataPoint getDataPoint()Returns the value of the 'Data Point' containment reference. Specifies what (and how) information is shown in the data label.- Returns:
- the value of the 'Data Point' containment reference.
- See Also:
-
setDataPoint
Sets the value of the 'Data Point
' containment reference.- Parameters:
value
- the new value of the 'Data Point' containment reference.- See Also:
-
getDataSets
Returns the value of the 'Data Sets' map. The key is of typeString
, and the value is of typeDataSet
, Holds the runtime data for the series.- Returns:
- the value of the 'Data Sets' map.
- See Also:
-
getLabelPosition
Position getLabelPosition()Returns the value of the 'Label Position' attribute. The default value is"Above"
. The literals are from the enumerationPosition
. Gets where the data label for the series should be displayed. Specifies where the data label for the series should be displayed.- Returns:
- the value of the 'Label Position' attribute.
- See Also:
-
setLabelPosition
Sets the value of the 'Label Position
' attribute.- Parameters:
value
- the new value of the 'Label Position' attribute.- See Also:
-
unsetLabelPosition
void unsetLabelPosition()Unsets the value of the 'Label Position
' attribute. -
isSetLabelPosition
boolean isSetLabelPosition()Returns whether the value of the 'Label Position
' attribute is set.- Returns:
- whether the value of the 'Label Position' attribute is set.
- See Also:
-
isStacked
boolean isStacked()Returns the value of the 'Stacked' attribute. Specifies whether the series is to be rendered stacked.- Returns:
- the value of the 'Stacked' attribute.
- See Also:
-
setStacked
void setStacked(boolean value) Sets the value of the 'Stacked
' attribute.- Parameters:
value
- the new value of the 'Stacked' attribute.- See Also:
-
unsetStacked
void unsetStacked()Unsets the value of the 'Stacked
' attribute.- See Also:
-
isSetStacked
boolean isSetStacked()Returns whether the value of the 'Stacked
' attribute is set.- Returns:
- whether the value of the 'Stacked' attribute is set.
- See Also:
-
getTriggers
org.eclipse.emf.common.util.EList<Trigger> getTriggers()Returns the value of the 'Triggers' containment reference list. The list contents are of typeTrigger
. Triggers are the elements that define interactivity for chart components. They include the action to be performed as well as parameters that define the details of the action. Holds the triggers for the series.- Returns:
- the value of the 'Triggers' containment reference list.
- See Also:
-
isTranslucent
boolean isTranslucent()Returns the value of the 'Translucent' attribute. Specifies whether the series elements are to be rendered translucent. This setting is only applicable for elements with solid color fills.- Returns:
- the value of the 'Translucent' attribute.
- See Also:
-
setTranslucent
void setTranslucent(boolean value) Sets the value of the 'Translucent
' attribute.- Parameters:
value
- the new value of the 'Translucent' attribute.- See Also:
-
unsetTranslucent
void unsetTranslucent()Unsets the value of the 'Translucent
' attribute. -
isSetTranslucent
boolean isSetTranslucent()Returns whether the value of the 'Translucent
' attribute is set.- Returns:
- whether the value of the 'Translucent' attribute is set.
- See Also:
-
getCurveFitting
CurveFitting getCurveFitting()Returns the value of the 'Curve Fitting' containment reference. Specifies the curve fitting attributes for the series.- Returns:
- the value of the 'Curve Fitting' containment reference.
- See Also:
-
setCurveFitting
Sets the value of the 'Curve Fitting
' containment reference.- Parameters:
value
- the new value of the 'Curve Fitting' containment reference.- See Also:
-
getCursor
Cursor getCursor()Returns the value of the 'Cursor' containment reference. The element represents cursor for series area.- Returns:
- the value of the 'Cursor' containment reference.
- See Also:
-
setCursor
Sets the value of the 'Cursor
' containment reference.- Parameters:
value
- the new value of the 'Cursor' containment reference.- See Also:
-
canBeStacked
boolean canBeStacked()Indicates if this series type may be rendered stacked with other series instances of the same type NOTE: Manually written- Returns:
- true means this series can be stacked
-
canParticipateInCombination
boolean canParticipateInCombination()This method should return true if the series type can be used in a combination chart. NOTE: Manually written- Returns:
- true means this series can be used in combination chart
-
translateFrom
This method should modify the series instance to extract whatever information it can from the series provided...updating the model if necessary. This method should be overridden by each series type implementation in particular if the series type can participate in a combination. It will be called when converting from one series type to another. The iSeriesDefinitionIndex value is the index of the series definition among all series definitions at the same level (base or orthogonal) NOTE: Manually written -
getDisplayName
String getDisplayName()This method should return a user-friendly name for the series type. NOTE: Manually written- Returns:
- display name for the series type
-
getLabelPositionScope
Returns supported label positions scope in current series. Label position set in series must be in one of these types.- Parameters:
dimension
- chart dimension- Returns:
- NameSet with supported label positions.
-
setDataSet
Sets the value dataSet.- Parameters:
dataSet
-
-
getDataSet
DataSet getDataSet()Returns the value dataSet.- Returns:
- value data set
-
setDataSet
Sets the user dataSet.- Parameters:
userKey
-dataSet
-
-
getDataSet
Returns the user dataSet.- Parameters:
userkey
-- Returns:
- user data set
-
isSingleCache
boolean isSingleCache()The method indicates if painting requests of series should be added to a single cache.- Returns:
true
if painting requests of series should be added to a single cache. False means creating a new Cache for each series.
-
getDefinedDataDefinitionIndex
int[] getDefinedDataDefinitionIndex()Returns the index array of data definitions which must be defined. For instance, if there are two data definitions in series, and the first one can be not defined, this method will return 1 in integer array; if two of them must be defined, this method will return 0 and 1 in integer array.- Returns:
- index array
- Since:
- 2.6.1
-
copyInstance
Series copyInstance()- Specified by:
copyInstance
in interfaceIChartObject
-