Interface PieSeries
- All Superinterfaces:
org.eclipse.emf.ecore.EObject
,IChartObject
,org.eclipse.emf.common.notify.Notifier
,Series
- All Known Implementing Classes:
PieSeriesImpl
A representation of the model object 'Pie
Series'.
This is a Series type that, during design time,
holds the query data for Pie charts, and during run time, holds the value for
each data point in the pie that represents the series. When rendered, each
series is drawn as a complete pie, and each data point in that series defines
the size of the pie's slices. A pie chart with multiple series will draw
multiple pies.
The following features are supported:
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionint
Returns the value of the 'Explosion' attribute.Returns the value of the 'Explosion Expression' attribute.double
Returns the value of the 'Inner Radius' attribute.Returns the value of the 'Leader Line Attributes' containment reference.double
Returns the value of the 'Leader Line Length' attribute.Returns the value of the 'Leader Line Style' attribute.double
getRatio()
Returns the value of the 'Ratio' attribute.double
Returns the value of the 'Rotation' attribute.Returns the value of the 'Slice Outline' containment reference.getTitle()
Returns the value of the 'Title' containment reference.Returns the value of the 'Title Position' attribute.boolean
Returns the value of the 'Clockwise' attribute.boolean
Returns the value of the 'Inner Radius Percent' attribute.boolean
Returns whether the value of the 'Clockwise
' attribute is set.boolean
Returns whether the value of the 'Explosion
' attribute is set.boolean
Returns whether the value of the 'Inner Radius
' attribute is set.boolean
Returns whether the value of the 'Inner Radius Percent
' attribute is set.boolean
Returns whether the value of the 'Leader Line Length
' attribute is set.boolean
Returns whether the value of the 'Leader Line Style
' attribute is set.boolean
Returns whether the value of the 'Ratio
' attribute is set.boolean
Returns whether the value of the 'Rotation
' attribute is set.boolean
Returns whether the value of the 'Title Position
' attribute is set.void
setClockwise
(boolean value) Sets the value of the 'Clockwise
' attribute.void
setExplosion
(int value) Sets the value of the 'Explosion
' attribute.void
setExplosionExpression
(String value) Sets the value of the 'Explosion Expression
' attribute.void
setInnerRadius
(double value) Sets the value of the 'Inner Radius
' attribute.void
setInnerRadiusPercent
(boolean value) Sets the value of the 'Inner Radius Percent
' attribute.void
Sets the value of the 'Leader Line Attributes
' containment reference.void
setLeaderLineLength
(double value) Sets the value of the 'Leader Line Length
' attribute.void
Sets the value of the 'Leader Line Style
' attribute.void
setRatio
(double value) Sets the value of the 'Ratio
' attribute.void
setRotation
(double value) Sets the value of the 'Rotation
' attribute.void
setSliceOutline
(ColorDefinition value) Sets the value of the 'Slice Outline
' containment reference.void
Sets the value of the 'Title
' containment reference.void
setTitlePosition
(Position value) Sets the value of the 'Title Position
' attribute.void
Unsets the value of the 'Clockwise
' attribute.void
Unsets the value of the 'Explosion
' attribute.void
Unsets the value of the 'Inner Radius
' attribute.void
Unsets the value of the 'Inner Radius Percent
' attribute.void
Unsets the value of the 'Leader Line Length
' attribute.void
Unsets the value of the 'Leader Line Style
' attribute.void
Unsets the value of the 'Ratio
' attribute.void
Unsets the value of the 'Rotation
' attribute.void
Unsets the value of the 'Title Position
' 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
Methods inherited from interface org.eclipse.birt.chart.model.component.Series
canBeStacked, canParticipateInCombination, canShareAxisUnit, getCursor, getCurveFitting, getDataDefinition, getDataPoint, getDataSet, getDataSet, getDataSets, getDefinedDataDefinitionIndex, getDisplayName, getLabel, getLabelPosition, getLabelPositionScope, getSeriesIdentifier, getTriggers, isSetLabelPosition, isSetStacked, isSetTranslucent, isSetVisible, isSingleCache, isStacked, isTranslucent, isVisible, setCursor, setCurveFitting, setDataPoint, setDataSet, setDataSet, setLabel, setLabelPosition, setSeriesIdentifier, setStacked, setTranslucent, setVisible, translateFrom, unsetLabelPosition, unsetStacked, unsetTranslucent, unsetVisible
-
Method Details
-
getExplosion
int getExplosion()Returns the value of the 'Explosion' attribute. Get the explosion value to be used for the chart. This defines the amount by which the slices are displaced from the center of the pie. Specifies the 'Explosion' value to be used while displaying the pie slices.- Returns:
- the value of the 'Explosion' attribute.
- See Also:
-
setExplosion
void setExplosion(int value) Sets the value of the 'Explosion
' attribute.- Parameters:
value
- the new value of the 'Explosion' attribute.- See Also:
-
unsetExplosion
void unsetExplosion()Unsets the value of the 'Explosion
' attribute.- See Also:
-
isSetExplosion
boolean isSetExplosion()Returns whether the value of the 'Explosion
' attribute is set.- Returns:
- whether the value of the 'Explosion' attribute is set.
- See Also:
-
getExplosionExpression
String getExplosionExpression()Returns the value of the 'Explosion Expression' attribute. Specifies an expression to determine if the explosion will be applied to each slice.- Returns:
- the value of the 'Explosion Expression' attribute.
- See Also:
-
setExplosionExpression
Sets the value of the 'Explosion Expression
' attribute.- Parameters:
value
- the new value of the 'Explosion Expression' attribute.- See Also:
-
getTitle
Label getTitle()Returns the value of the 'Title' containment reference. Holds the properties for a series title.- Returns:
- the value of the 'Title' containment reference.
- See Also:
-
setTitle
Sets the value of the 'Title
' containment reference.- Parameters:
value
- the new value of the 'Title' containment reference.- See Also:
-
getTitlePosition
Position getTitlePosition()Returns the value of the 'Title Position' attribute. The default value is"Above"
. The literals are from the enumerationPosition
. Holds the position property for a series title.- Returns:
- the value of the 'Title Position' attribute.
- See Also:
-
setTitlePosition
Sets the value of the 'Title Position
' attribute.- Parameters:
value
- the new value of the 'Title Position' attribute.- See Also:
-
unsetTitlePosition
void unsetTitlePosition()Unsets the value of the 'Title Position
' attribute. -
isSetTitlePosition
boolean isSetTitlePosition()Returns whether the value of the 'Title Position
' attribute is set.- Returns:
- whether the value of the 'Title Position' attribute is set.
- See Also:
-
getLeaderLineAttributes
LineAttributes getLeaderLineAttributes()Returns the value of the 'Leader Line Attributes' containment reference. Holds the attributes for leader lines.- Returns:
- the value of the 'Leader Line Attributes' containment reference.
- See Also:
-
setLeaderLineAttributes
Sets the value of the 'Leader Line Attributes
' containment reference.- Parameters:
value
- the new value of the 'Leader Line Attributes' containment reference.- See Also:
-
getLeaderLineStyle
LeaderLineStyle getLeaderLineStyle()Returns the value of the 'Leader Line Style' attribute. The default value is"Fixed_Length"
. The literals are from the enumerationLeaderLineStyle
. Specifies how the leader lines are to be shown.- Returns:
- the value of the 'Leader Line Style' attribute.
- See Also:
-
setLeaderLineStyle
Sets the value of the 'Leader Line Style
' attribute.- Parameters:
value
- the new value of the 'Leader Line Style' attribute.- See Also:
-
unsetLeaderLineStyle
void unsetLeaderLineStyle()Unsets the value of the 'Leader Line Style
' attribute. -
isSetLeaderLineStyle
boolean isSetLeaderLineStyle()Returns whether the value of the 'Leader Line Style
' attribute is set.- Returns:
- whether the value of the 'Leader Line Style' attribute is set.
- See Also:
-
getLeaderLineLength
double getLeaderLineLength()Returns the value of the 'Leader Line Length' attribute. Length for the leader lines. Used only if style is 'FIXED_LENGTH'.- Returns:
- the value of the 'Leader Line Length' attribute.
- See Also:
-
setLeaderLineLength
void setLeaderLineLength(double value) Sets the value of the 'Leader Line Length
' attribute.- Parameters:
value
- the new value of the 'Leader Line Length' attribute.- See Also:
-
unsetLeaderLineLength
void unsetLeaderLineLength()Unsets the value of the 'Leader Line Length
' attribute. -
isSetLeaderLineLength
boolean isSetLeaderLineLength()Returns whether the value of the 'Leader Line Length
' attribute is set.- Returns:
- whether the value of the 'Leader Line Length' attribute is set.
- See Also:
-
getSliceOutline
ColorDefinition getSliceOutline()Returns the value of the 'Slice Outline' containment reference. Defines the color to be used for the slice outline.- Returns:
- the value of the 'Slice Outline' containment reference.
- See Also:
-
setSliceOutline
Sets the value of the 'Slice Outline
' containment reference.- Parameters:
value
- the new value of the 'Slice Outline' containment reference.- See Also:
-
getRatio
double getRatio()Returns the value of the 'Ratio' attribute. The default value is"1"
. Defines the ratio(height/width) of the oval, 1 means it's a circle, 0 means stretch automatically.- Returns:
- the value of the 'Ratio' attribute.
- See Also:
-
setRatio
void setRatio(double value) Sets the value of the 'Ratio
' attribute.- Parameters:
value
- the new value of the 'Ratio' attribute.- See Also:
-
unsetRatio
void unsetRatio()Unsets the value of the 'Ratio
' attribute.- See Also:
-
isSetRatio
boolean isSetRatio()Returns whether the value of the 'Ratio
' attribute is set.- Returns:
- whether the value of the 'Ratio' attribute is set.
- See Also:
-
getRotation
double getRotation()Returns the value of the 'Rotation' attribute. The default value is"0"
. Defines the rotation of the pie, 0 means start drawing the first slice from the east.- Returns:
- the value of the 'Rotation' attribute.
- See Also:
-
setRotation
void setRotation(double value) Sets the value of the 'Rotation
' attribute.- Parameters:
value
- the new value of the 'Rotation' attribute.- See Also:
-
unsetRotation
void unsetRotation()Unsets the value of the 'Rotation
' attribute.- See Also:
-
isSetRotation
boolean isSetRotation()Returns whether the value of the 'Rotation
' attribute is set.- Returns:
- whether the value of the 'Rotation' attribute is set.
- See Also:
-
isClockwise
boolean isClockwise()Returns the value of the 'Clockwise' attribute. The default value is"false"
. Attribute "Clockwise" Specifies whether the pie slices are rendered in clockwise direction, by default they will be rendered in counter-clockwise direction.- Returns:
- the value of the 'Clockwise' attribute.
- See Also:
-
setClockwise
void setClockwise(boolean value) Sets the value of the 'Clockwise
' attribute.- Parameters:
value
- the new value of the 'Clockwise' attribute.- See Also:
-
unsetClockwise
void unsetClockwise()Unsets the value of the 'Clockwise
' attribute. -
isSetClockwise
boolean isSetClockwise()Returns whether the value of the 'Clockwise
' attribute is set.- Returns:
- whether the value of the 'Clockwise' attribute is set.
- See Also:
-
getInnerRadius
double getInnerRadius()Returns the value of the 'Inner Radius' attribute. The default value is"0"
. Defines inner radius, if inner radius greater than 0, it should be a dount pie. If value of inner radius is between 0 and 1, the inner radius is percentage value of width/height of pie, otherwise it is actual size.- Returns:
- the value of the 'Inner Radius' attribute.
- See Also:
-
setInnerRadius
void setInnerRadius(double value) Sets the value of the 'Inner Radius
' attribute.- Parameters:
value
- the new value of the 'Inner Radius' attribute.- See Also:
-
unsetInnerRadius
void unsetInnerRadius()Unsets the value of the 'Inner Radius
' attribute. -
isSetInnerRadius
boolean isSetInnerRadius()Returns whether the value of the 'Inner Radius
' attribute is set.- Returns:
- whether the value of the 'Inner Radius' attribute is set.
- See Also:
-
isInnerRadiusPercent
boolean isInnerRadiusPercent()Returns the value of the 'Inner Radius Percent' attribute. The default value is"true"
. Indicates if the value of inner radius is a percent value or actual value.- Returns:
- the value of the 'Inner Radius Percent' attribute.
- See Also:
-
setInnerRadiusPercent
void setInnerRadiusPercent(boolean value) Sets the value of the 'Inner Radius Percent
' attribute.- Parameters:
value
- the new value of the 'Inner Radius Percent' attribute.- See Also:
-
unsetInnerRadiusPercent
void unsetInnerRadiusPercent()Unsets the value of the 'Inner Radius Percent
' attribute. -
isSetInnerRadiusPercent
boolean isSetInnerRadiusPercent()Returns whether the value of the 'Inner Radius Percent
' attribute is set.- Returns:
- whether the value of the 'Inner Radius Percent' attribute is set.
- See Also:
-
copyInstance
PieSeries copyInstance()- Specified by:
copyInstance
in interfaceIChartObject
- Specified by:
copyInstance
in interfaceSeries
-