org.eclipse.birt.chart.model.type
Interface PieSeries

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier, Series
All Known Implementing Classes:
PieSeriesImpl

public interface PieSeries
extends Series

A representation of the model object 'Pie Series'. This is a Series type that holds data for Pie Charts.

The following features are supported:

See Also:
TypePackage.getPieSeries()

Method Summary
 int getExplosion()
          Returns the value of the 'Explosion' attribute.
 java.lang.String getExplosionExpression()
          Returns the value of the 'Explosion Expression' attribute.
 LineAttributes getLeaderLineAttributes()
          Returns the value of the 'Leader Line Attributes' containment reference.
 double getLeaderLineLength()
          Returns the value of the 'Leader Line Length' attribute.
 LeaderLineStyle getLeaderLineStyle()
          Returns the value of the 'Leader Line Style' attribute.
 double getRatio()
          Returns the value of the 'Ratio' attribute.
 double getRotation()
          Returns the value of the 'Rotation' attribute.
 ColorDefinition getSliceOutline()
          Returns the value of the 'Slice Outline' containment reference.
 Label getTitle()
          Returns the value of the 'Title' containment reference.
 Position getTitlePosition()
          Returns the value of the 'Title Position' attribute.
 boolean isSetExplosion()
          Returns whether the value of the ' Explosion' attribute is set.
 boolean isSetLeaderLineLength()
          Returns whether the value of the 'Leader Line Length' attribute is set.
 boolean isSetLeaderLineStyle()
          Returns whether the value of the 'Leader Line Style' attribute is set.
 boolean isSetRatio()
          Returns whether the value of the 'Ratio' attribute is set.
 boolean isSetRotation()
          Returns whether the value of the 'Rotation' attribute is set.
 boolean isSetTitlePosition()
          Returns whether the value of the 'Title Position' attribute is set.
 void setExplosion(int value)
          Sets the value of the 'Explosion' attribute.
 void setExplosionExpression(java.lang.String value)
          Sets the value of the 'Explosion Expression' attribute.
 void setLeaderLineAttributes(LineAttributes value)
          Sets the value of the 'Leader Line Attributes' containment reference.
 void setLeaderLineLength(double value)
          Sets the value of the 'Leader Line Length' attribute.
 void setLeaderLineStyle(LeaderLineStyle value)
          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 setTitle(Label value)
          Sets the value of the 'Title' containment reference.
 void setTitlePosition(Position value)
          Sets the value of the ' Title Position' attribute.
 void unsetExplosion()
          Unsets the value of the 'Explosion' attribute.
 void unsetLeaderLineLength()
          Unsets the value of the 'Leader Line Length' attribute.
 void unsetLeaderLineStyle()
          Unsets the value of the 'Leader Line Style' attribute.
 void unsetRatio()
          Unsets the value of the 'Ratio' attribute.
 void unsetRotation()
          Unsets the value of the 'Rotation' attribute.
 void unsetTitlePosition()
          Unsets the value of the ' Title Position' attribute.
 
Methods inherited from interface org.eclipse.birt.chart.model.component.Series
canBeStacked, canParticipateInCombination, canShareAxisUnit, getCurveFitting, getDataDefinition, getDataPoint, getDataSet, getDataSet, getDataSets, getDisplayName, getLabel, getLabelPosition, getSeriesIdentifier, getTriggers, isSetLabelPosition, isSetStacked, isSetTranslucent, isSetVisible, isSingleCache, isStacked, isTranslucent, isVisible, setCurveFitting, setDataPoint, setDataSet, setDataSet, setLabel, setLabelPosition, setSeriesIdentifier, setStacked, setTranslucent, setVisible, translateFrom, unsetLabelPosition, unsetStacked, unsetTranslucent, unsetVisible
 
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

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:
isSetExplosion(), unsetExplosion(), setExplosion(int), TypePackage.getPieSeries_Explosion()

setExplosion

void setExplosion(int value)
Sets the value of the 'Explosion' attribute.

Parameters:
value - the new value of the 'Explosion' attribute.
See Also:
isSetExplosion(), unsetExplosion(), getExplosion()

unsetExplosion

void unsetExplosion()
Unsets the value of the 'Explosion' attribute.

See Also:
isSetExplosion(), getExplosion(), setExplosion(int)

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:
unsetExplosion(), getExplosion(), setExplosion(int)

getExplosionExpression

java.lang.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(String), TypePackage.getPieSeries_ExplosionExpression()

setExplosionExpression

void setExplosionExpression(java.lang.String value)
Sets the value of the 'Explosion Expression' attribute.

Parameters:
value - the new value of the 'Explosion Expression' attribute.
See Also:
getExplosionExpression()

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(Label), TypePackage.getPieSeries_Title()

setTitle

void setTitle(Label value)
Sets the value of the 'Title' containment reference.

Parameters:
value - the new value of the 'Title' containment reference.
See Also:
getTitle()

getTitlePosition

Position getTitlePosition()
Returns the value of the 'Title Position' attribute. The default value is "Above". The literals are from the enumeration Position. Holds the position property for a series title.

Returns:
the value of the 'Title Position' attribute.
See Also:
Position, isSetTitlePosition(), unsetTitlePosition(), setTitlePosition(Position), TypePackage.getPieSeries_TitlePosition()

setTitlePosition

void setTitlePosition(Position value)
Sets the value of the ' Title Position' attribute.

Parameters:
value - the new value of the 'Title Position' attribute.
See Also:
Position, isSetTitlePosition(), unsetTitlePosition(), getTitlePosition()

unsetTitlePosition

void unsetTitlePosition()
Unsets the value of the ' Title Position' attribute.

See Also:
isSetTitlePosition(), getTitlePosition(), setTitlePosition(Position)

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:
unsetTitlePosition(), getTitlePosition(), setTitlePosition(Position)

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(LineAttributes), TypePackage.getPieSeries_LeaderLineAttributes()

setLeaderLineAttributes

void setLeaderLineAttributes(LineAttributes value)
Sets the value of the 'Leader Line Attributes' containment reference.

Parameters:
value - the new value of the 'Leader Line Attributes' containment reference.
See Also:
getLeaderLineAttributes()

getLeaderLineStyle

LeaderLineStyle getLeaderLineStyle()
Returns the value of the 'Leader Line Style' attribute. The default value is "Fixed_Length". The literals are from the enumeration LeaderLineStyle. Specifies how the leader lines are to be shown.

Returns:
the value of the 'Leader Line Style' attribute.
See Also:
LeaderLineStyle, isSetLeaderLineStyle(), unsetLeaderLineStyle(), setLeaderLineStyle(LeaderLineStyle), TypePackage.getPieSeries_LeaderLineStyle()

setLeaderLineStyle

void setLeaderLineStyle(LeaderLineStyle value)
Sets the value of the 'Leader Line Style' attribute.

Parameters:
value - the new value of the 'Leader Line Style' attribute.
See Also:
LeaderLineStyle, isSetLeaderLineStyle(), unsetLeaderLineStyle(), getLeaderLineStyle()

unsetLeaderLineStyle

void unsetLeaderLineStyle()
Unsets the value of the 'Leader Line Style' attribute.

See Also:
isSetLeaderLineStyle(), getLeaderLineStyle(), setLeaderLineStyle(LeaderLineStyle)

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:
unsetLeaderLineStyle(), getLeaderLineStyle(), setLeaderLineStyle(LeaderLineStyle)

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:
isSetLeaderLineLength(), unsetLeaderLineLength(), setLeaderLineLength(double), TypePackage.getPieSeries_LeaderLineLength()

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:
isSetLeaderLineLength(), unsetLeaderLineLength(), getLeaderLineLength()

unsetLeaderLineLength

void unsetLeaderLineLength()
Unsets the value of the 'Leader Line Length' attribute.

See Also:
isSetLeaderLineLength(), getLeaderLineLength(), setLeaderLineLength(double)

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:
unsetLeaderLineLength(), getLeaderLineLength(), setLeaderLineLength(double)

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(ColorDefinition), TypePackage.getPieSeries_SliceOutline()

setSliceOutline

void setSliceOutline(ColorDefinition value)
Sets the value of the 'Slice Outline' containment reference.

Parameters:
value - the new value of the 'Slice Outline' containment reference.
See Also:
getSliceOutline()

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:
isSetRatio(), unsetRatio(), setRatio(double), TypePackage.getPieSeries_Ratio()

setRatio

void setRatio(double value)
Sets the value of the 'Ratio' attribute.

Parameters:
value - the new value of the 'Ratio' attribute.
See Also:
isSetRatio(), unsetRatio(), getRatio()

unsetRatio

void unsetRatio()
Unsets the value of the 'Ratio' attribute.

See Also:
isSetRatio(), getRatio(), setRatio(double)

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:
unsetRatio(), getRatio(), setRatio(double)

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:
isSetRotation(), unsetRotation(), setRotation(double), TypePackage.getPieSeries_Rotation()

setRotation

void setRotation(double value)
Sets the value of the 'Rotation' attribute.

Parameters:
value - the new value of the 'Rotation' attribute.
See Also:
isSetRotation(), unsetRotation(), getRotation()

unsetRotation

void unsetRotation()
Unsets the value of the 'Rotation' attribute.

See Also:
isSetRotation(), getRotation(), setRotation(double)

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:
unsetRotation(), getRotation(), setRotation(double)


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