|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Series
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:
Visible
Label
Data Definition
Series Identifier
Data Point
Data Sets
Label Position
Stacked
Triggers
Translucent
Curve Fitting
Cursor
ComponentPackage.getSeries()
Method Summary | |
---|---|
boolean |
canBeStacked()
Indicates if this series type may be rendered stacked with other series instances of the same type NOTE: Manually written |
boolean |
canParticipateInCombination()
This method should return true if the series type can be used in a combination chart. |
boolean |
canShareAxisUnit()
Indicates if this series graphic element may share a scale unit with other similar elements. |
Series |
copyInstance()
A convenient method to get an instance copy. |
Cursor |
getCursor()
Returns the value of the 'Cursor' containment reference. |
CurveFitting |
getCurveFitting()
Returns the value of the 'Curve Fitting' containment reference. |
org.eclipse.emf.common.util.EList<Query> |
getDataDefinition()
Returns the value of the 'Data Definition' containment reference list. |
DataPoint |
getDataPoint()
Returns the value of the 'Data Point' containment reference. |
DataSet |
getDataSet()
Returns the value dataSet. |
DataSet |
getDataSet(java.lang.String userkey)
Returns the user dataSet. |
org.eclipse.emf.common.util.EMap<java.lang.String,DataSet> |
getDataSets()
Returns the value of the 'Data Sets' map. |
java.lang.String |
getDisplayName()
This method should return a user-friendly name for the series type. |
Label |
getLabel()
Returns the value of the 'Label' containment reference. |
Position |
getLabelPosition()
Returns the value of the 'Label Position' attribute. |
java.lang.Object |
getSeriesIdentifier()
Returns the value of the 'Series Identifier' attribute. |
org.eclipse.emf.common.util.EList<Trigger> |
getTriggers()
Returns the value of the 'Triggers' containment reference list. |
boolean |
isSetLabelPosition()
Returns whether the value of the ' Label Position ' attribute is set. |
boolean |
isSetStacked()
Returns whether the value of the ' Stacked ' attribute is set. |
boolean |
isSetTranslucent()
Returns whether the value of the ' Translucent ' attribute is set. |
boolean |
isSetVisible()
Returns whether the value of the ' Visible ' attribute is set. |
boolean |
isSingleCache()
The method indicates if painting requests of series should be added to a single cache. |
boolean |
isStacked()
Returns the value of the 'Stacked' attribute. |
boolean |
isTranslucent()
Returns the value of the 'Translucent' attribute. |
boolean |
isVisible()
Returns the value of the 'Visible' attribute. |
void |
setCursor(Cursor value)
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(DataSet dataSet)
Sets the value dataSet. |
void |
setDataSet(java.lang.String userKey,
DataSet dataSet)
Sets the user dataSet. |
void |
setLabel(Label value)
Sets the value of the ' Label ' containment reference. |
void |
setLabelPosition(Position value)
Sets the value of the ' Label Position ' attribute. |
void |
setSeriesIdentifier(java.lang.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 |
unsetLabelPosition()
Unsets the value of the ' Label Position ' attribute. |
void |
unsetStacked()
Unsets the value of the ' Stacked ' attribute. |
void |
unsetTranslucent()
Unsets the value of the ' Translucent ' attribute. |
void |
unsetVisible()
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, eIsProxy, eIsSet, eResource, eSet, eUnset |
Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
---|
eAdapters, eDeliver, eNotify, eSetDeliver |
Method Detail |
---|
boolean isVisible()
"true"
. Gets
visibility of the series.
Determines visibility of the series.
isSetVisible()
,
unsetVisible()
,
setVisible(boolean)
,
ComponentPackage.getSeries_Visible()
void setVisible(boolean value)
Visible
' attribute.
Sets visibility of the series.
value
- the new value of the 'Visible' attribute.isSetVisible()
,
unsetVisible()
,
isVisible()
void unsetVisible()
Visible
' attribute.
isSetVisible()
,
isVisible()
,
setVisible(boolean)
boolean isSetVisible()
Visible
' attribute is set.
unsetVisible()
,
isVisible()
,
setVisible(boolean)
Label getLabel()
setLabel(Label)
,
ComponentPackage.getSeries_Label()
void setLabel(Label value)
Label
' containment reference.
value
- the new value of the 'Label' containment reference.getLabel()
org.eclipse.emf.common.util.EList<Query> getDataDefinition()
org.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).
ComponentPackage.getSeries_DataDefinition()
java.lang.Object getSeriesIdentifier()
#setSeriesIdentifier(String)
,
ComponentPackage.getSeries_SeriesIdentifier()
void setSeriesIdentifier(java.lang.Object value)
Series Identifier
' attribute.
value
- the new value of the 'Series Identifier' attribute.getSeriesIdentifier()
DataPoint getDataPoint()
setDataPoint(DataPoint)
,
ComponentPackage.getSeries_DataPoint()
void setDataPoint(DataPoint value)
Data Point
' containment reference.
value
- the new value of the 'Data Point' containment reference.getDataPoint()
org.eclipse.emf.common.util.EMap<java.lang.String,DataSet> getDataSets()
String
, and the value is of type
DataSet
,
Holds the runtime data for the series.
ComponentPackage.getSeries_DataSets()
Position getLabelPosition()
"Above"
. The literals are from the
enumeration Position
.
Gets where the data label for the series should
be displayed.
Specifies where the data label for the series should be displayed.
Position
,
isSetLabelPosition()
,
unsetLabelPosition()
,
setLabelPosition(Position)
,
ComponentPackage.getSeries_LabelPosition()
void setLabelPosition(Position value)
Label Position
' attribute.
value
- the new value of the 'Label Position' attribute.Position
,
isSetLabelPosition()
,
unsetLabelPosition()
,
getLabelPosition()
void unsetLabelPosition()
Label Position
' attribute.
isSetLabelPosition()
,
getLabelPosition()
,
setLabelPosition(Position)
boolean isSetLabelPosition()
Label Position
' attribute is set.
unsetLabelPosition()
,
getLabelPosition()
,
setLabelPosition(Position)
boolean isStacked()
isSetStacked()
,
unsetStacked()
,
setStacked(boolean)
,
ComponentPackage.getSeries_Stacked()
void setStacked(boolean value)
Stacked
' attribute.
value
- the new value of the 'Stacked' attribute.isSetStacked()
,
unsetStacked()
,
isStacked()
void unsetStacked()
Stacked
' attribute.
isSetStacked()
,
isStacked()
,
setStacked(boolean)
boolean isSetStacked()
Stacked
' attribute is set.
unsetStacked()
,
isStacked()
,
setStacked(boolean)
org.eclipse.emf.common.util.EList<Trigger> getTriggers()
Trigger
. 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.
ComponentPackage.getSeries_Triggers()
boolean isTranslucent()
isSetTranslucent()
,
unsetTranslucent()
,
setTranslucent(boolean)
,
ComponentPackage.getSeries_Translucent()
void setTranslucent(boolean value)
Translucent
' attribute.
value
- the new value of the 'Translucent' attribute.isSetTranslucent()
,
unsetTranslucent()
,
isTranslucent()
void unsetTranslucent()
Translucent
' attribute.
isSetTranslucent()
,
isTranslucent()
,
setTranslucent(boolean)
boolean isSetTranslucent()
Translucent
' attribute is set.
unsetTranslucent()
,
isTranslucent()
,
setTranslucent(boolean)
CurveFitting getCurveFitting()
setCurveFitting(CurveFitting)
,
ComponentPackage.getSeries_CurveFitting()
void setCurveFitting(CurveFitting value)
Curve Fitting
' containment reference.
value
- the new value of the 'Curve Fitting' containment reference.getCurveFitting()
Cursor getCursor()
setCursor(Cursor)
,
ComponentPackage.getSeries_Cursor()
void setCursor(Cursor value)
Cursor
' containment reference.
value
- the new value of the 'Cursor' containment reference.getCursor()
boolean canBeStacked()
boolean canShareAxisUnit()
boolean canParticipateInCombination()
void translateFrom(Series sourceSeries, int iSeriesDefinitionIndex, Chart chart)
java.lang.String getDisplayName()
void setDataSet(DataSet dataSet)
dataSet
- DataSet getDataSet()
void setDataSet(java.lang.String userKey, DataSet dataSet)
userKey
- dataSet
- DataSet getDataSet(java.lang.String userkey)
userkey
-
boolean isSingleCache()
true
if painting requests of series should be
added to a single cache. False means creating a new Cache for
each series.Series copyInstance()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |