Interface SeriesDefinition
- All Superinterfaces:
org.eclipse.emf.ecore.EObject
,IChartObject
,org.eclipse.emf.common.notify.Notifier
- All Known Implementing Classes:
SeriesDefinitionImpl
A representation of the model object 'Series
Definition'.
This type represents design-time definition for a series.
The following features are supported:
- See Also:
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of the 'Format Specifier' containment reference.Returns the value of the 'Grouping' containment reference.getQuery()
Returns the value of the 'Query' containment reference.org.eclipse.emf.common.util.EList<Series>
Returns the value of the 'Series' containment reference list.org.eclipse.emf.common.util.EList<SeriesDefinition>
Returns the value of the 'Series Definitions' containment reference list.Returns the value of the 'Series Palette' containment reference.Returns the value of the 'Sorting' attribute.Returns the value of the 'Sort Key' containment reference.Returns the value of the 'Sort Locale' attribute.int
Returns the value of the 'Sort Strength' attribute.int
Returns the value of the 'ZOrder' attribute.boolean
Returns whether the value of the 'Sorting
' attribute is set.boolean
Returns whether the value of the 'Sort Strength
' attribute is set.boolean
Returns whether the value of the 'ZOrder
' attribute is set.void
Sets the value of the 'Format Specifier
' containment reference.void
setGrouping
(SeriesGrouping value) Sets the value of the 'Grouping
' containment reference.void
Sets the value of the 'Query
' containment reference.void
setSeriesPalette
(Palette value) Sets the value of the 'Series Palette
' containment reference.void
setSorting
(SortOption value) Sets the value of the 'Sorting
' attribute.void
setSortKey
(Query value) Sets the value of the 'Sort Key
' containment reference.void
setSortLocale
(String value) Sets the value of the 'Sort Locale
' attribute.void
setSortStrength
(int value) Sets the value of the 'Sort Strength
' attribute.void
setZOrder
(int value) Sets the value of the 'ZOrder
' attribute.void
Unsets the value of the 'Sorting
' attribute.void
Unsets the value of the 'Sort Strength
' attribute.void
Unsets the value of the 'ZOrder
' 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
-
Field Details
-
EMPTY_ARRAY
-
-
Method Details
-
getQuery
Query getQuery()Returns the value of the 'Query' containment reference.- Returns:
- the value of the 'Query' containment reference.
- See Also:
-
setQuery
Sets the value of the 'Query
' containment reference.- Parameters:
value
- the new value of the 'Query' containment reference.- See Also:
-
getSeriesPalette
Palette getSeriesPalette()Returns the value of the 'Series Palette' containment reference. Gets the palette associated with the series definiton instance. This palette will be used to determine the sequence of colors for the series that are represented by this definition.- Returns:
- the value of the 'Series Palette' containment reference.
- See Also:
-
setSeriesPalette
Sets the value of the 'Series Palette
' containment reference.- Parameters:
value
- the new value of the 'Series Palette' containment reference.- See Also:
-
getSeriesDefinitions
org.eclipse.emf.common.util.EList<SeriesDefinition> getSeriesDefinitions()Returns the value of the 'Series Definitions' containment reference list. The list contents are of typeSeriesDefinition
.- Returns:
- the value of the 'Series Definitions' containment reference list.
- See Also:
-
getFormatSpecifier
FormatSpecifier getFormatSpecifier()Returns the value of the 'Format Specifier' containment reference.- Returns:
- the value of the 'Format Specifier' containment reference.
- See Also:
-
setFormatSpecifier
Sets the value of the 'Format Specifier
' containment reference.- Parameters:
value
- the new value of the 'Format Specifier' containment reference.- See Also:
-
getSeries
org.eclipse.emf.common.util.EList<Series> getSeries()Returns the value of the 'Series' containment reference list. The list contents are of typeSeries
. Holds all the series for the chart.- Returns:
- the value of the 'Series' containment reference list.
- See Also:
-
getGrouping
SeriesGrouping getGrouping()Returns the value of the 'Grouping' containment reference. Defines if and how the series data is to be grouped for display. This should only be applied to Base Series.- Returns:
- the value of the 'Grouping' containment reference.
- See Also:
-
setGrouping
Sets the value of the 'Grouping
' containment reference.- Parameters:
value
- the new value of the 'Grouping' containment reference.- See Also:
-
getSorting
SortOption getSorting()Returns the value of the 'Sorting' attribute. The default value is"Ascending"
. The literals are from the enumerationSortOption
. Defines if and how the series data is to be sorted for display. This should only be applied to Base Series.- Returns:
- the value of the 'Sorting' attribute.
- See Also:
-
setSorting
Sets the value of the 'Sorting
' attribute.- Parameters:
value
- the new value of the 'Sorting' attribute.- See Also:
-
unsetSorting
void unsetSorting()Unsets the value of the 'Sorting
' attribute.- See Also:
-
isSetSorting
boolean isSetSorting()Returns whether the value of the 'Sorting
' attribute is set.- Returns:
- whether the value of the 'Sorting' attribute is set.
- See Also:
-
getSortKey
Query getSortKey()Returns the value of the 'Sort Key' containment reference.If the meaning of the 'Sort Key' containment reference isn't clear, there really should be more of a description here...
- Returns:
- the value of the 'Sort Key' containment reference.
- See Also:
-
setSortKey
Sets the value of the 'Sort Key
' containment reference.- Parameters:
value
- the new value of the 'Sort Key' containment reference.- See Also:
-
getSortLocale
String getSortLocale()Returns the value of the 'Sort Locale' attribute. Specifies the locale on which the sorting will base, the value is the locale ID ofcom.ibm.icu.util.ULocale
.- Returns:
- the value of the 'Sort Locale' attribute.
- See Also:
-
setSortLocale
Sets the value of the 'Sort Locale
' attribute.- Parameters:
value
- the new value of the 'Sort Locale' attribute.- See Also:
-
getSortStrength
int getSortStrength()Returns the value of the 'Sort Strength' attribute. Specifies the strength of sorting, this attribute just uses the field values defined incom.ibm.icu.text.Collator
. The available values are ASCII=-1, PRIMARY=0, SECONDARY=1,TERTIARY=2,QUATERNARY=3,IDENTICAL=15.- Returns:
- the value of the 'Sort Strength' attribute.
- See Also:
-
setSortStrength
void setSortStrength(int value) Sets the value of the 'Sort Strength
' attribute.- Parameters:
value
- the new value of the 'Sort Strength' attribute.- See Also:
-
unsetSortStrength
void unsetSortStrength()Unsets the value of the 'Sort Strength
' attribute. -
isSetSortStrength
boolean isSetSortStrength()Returns whether the value of the 'Sort Strength
' attribute is set.- Returns:
- whether the value of the 'Sort Strength' attribute is set.
- See Also:
-
getZOrder
int getZOrder()Returns the value of the 'ZOrder' attribute. The default value is"0"
. Specifies Z order among multiple series renderers. Default value is 0. The series renderer with higher z order value will overlay the one with lower value.- Returns:
- the value of the 'ZOrder' attribute.
- See Also:
-
setZOrder
void setZOrder(int value) Sets the value of the 'ZOrder
' attribute.- Parameters:
value
- the new value of the 'ZOrder' attribute.- See Also:
-
unsetZOrder
void unsetZOrder()Unsets the value of the 'ZOrder
' attribute.- See Also:
-
isSetZOrder
boolean isSetZOrder()Returns whether the value of the 'ZOrder
' attribute is set.- Returns:
- whether the value of the 'ZOrder' attribute is set.
- See Also:
-
getDesignTimeSeries
Series getDesignTimeSeries()- Returns:
- The design-time series associated with the series definition
-
getRunTimeSeries
- Returns:
- The runtime-time series' associated with the series definition
-
copyInstance
SeriesDefinition copyInstance()- Specified by:
copyInstance
in interfaceIChartObject
-