com.cete.dynamicpdf.pageelements.charting.series
Class PieSeries

java.lang.Object
  com.cete.dynamicpdf.pageelements.charting.PlotAreaElement
      com.cete.dynamicpdf.pageelements.charting.SeriesBase
          com.cete.dynamicpdf.pageelements.charting.series.PieSeries

public class PieSeries
extends SeriesBase

Represents a pie series.

Licensing:
This is a DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Enterprise Edition

View Example

Constructor Summary

PieSeries()
Initializes a new instance of the PieSeries class.

PieSeries(float borderWidth, Color borderColor)
Initializes a new instance of the PieSeries class.

PieSeries(float borderWidth, Color borderColor, Legend legend)
Initializes a new instance of the PieSeries class.

PieSeries(Legend legend)
Initializes a new instance of the PieSeries class.

PieSeries(SeriesLabel seriesLabel)
Initializes a new instance of the PieSeries class.

PieSeries(SeriesLabel seriesLabel, float borderWidth, Color borderColor, Legend legend)
Initializes a new instance of the PieSeries class.

Method Summary

Color	getBorderColor() Gets the Color object to use for the borders of the pie series.
float	getBorderWidth() Gets the border width of the pie series.
ScalarDataLabel	getDataLabel() Gets the ScalarDataLabel object to use for the data label of the pie series.
ScalarDataLabelPosition	getDataLabelPosition() Gets ScalarDataLabelPosition enumeration that specifies the display position of data label.
PieSeriesElementList	getElements() Gets the PieSeriesElementList object contained in the pie series.
float	getHeight() Gets the height of the pie series.
SeriesLabel	getLabel() Gets the SeriesLabel object to use for the name of the pie series.
java.lang.String	getPercentageFormat() Gets the format to use for the percentage of the ScalarDataLabel object.
float	getRadius() Gets the radius of the pie series.
float	getStartAngle() Gets the start angle of the pie series.
java.lang.String	getValueFormat() Gets the format to use for the value of the ScalarDataLabel object.
float	getWidth() Gets the width of the pie series.
float	getX() Gets the X coordinate of the pie series.
float	getXOffset() Gets the x offset of the pie series.
float	getY() Gets the Y coordinate of the pie series.
float	getYOffset() Gets the y offset of the pie series.
void	setArea(float x, float y, float width, float height) Sets the area of the pie series.
void	setBorderColor(Color borderColor) Sets the Color object to use for the borders of the pie series.
void	setBorderWidth(float borderWidth) Sets the border width of the pie series.
void	setDataLabel(ScalarDataLabel scalarDataLabel) Sets the ScalarDataLabel object to use for the data label of the pie series.
void	setDataLabelPosition(ScalarDataLabelPosition scalarDataLabelPosition) Sets ScalarDataLabelPosition enumeration that specifies the display position of data label.
void	setLabel(SeriesLabel seriesLabel) Sets the SeriesLabel object to use for the name of the pie series.
void	setPercentageFormat(java.lang.String value) Sets the format to use for the percentage of the ScalarDataLabel object.
void	setRadius(float radius) Sets the radius of the pie series.
void	setStartAngle(float startAngle) Sets the start angle of the pie series.
void	setValueFormat(java.lang.String value) Sets the format to use for the value of the ScalarDataLabel object.
void	setXOffset(float xOffset) Sets the x offset of the pie series.
void	setYOffset(float yOffset) Sets the y offset of the pie series.

Methods inherited from class com.cete.dynamicpdf.pageelements.charting.SeriesBase

getDrawBehindAxis, setDrawBehindAxis

Methods inherited from class com.cete.dynamicpdf.pageelements.charting.PlotAreaElement

getLegend, getPlotArea, setLegend, setPlotArea

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PieSeries

public PieSeries()

Initializes a new instance of the PieSeries class.

PieSeries

public PieSeries(SeriesLabel seriesLabel)

Initializes a new instance of the PieSeries class.

Parameters:

seriesLabel - SeriesLabel of the pie series.

See Also:

SeriesLabel

PieSeries

public PieSeries(Legend legend)

Initializes a new instance of the PieSeries class.

Parameters:

legend - Legend of the pie series.

See Also:

Legend

PieSeries

public PieSeries(float borderWidth,
                 Color borderColor)

Initializes a new instance of the PieSeries class.

Parameters:

borderWidth - Border width of the pie series.

borderColor - Border Color of the pie series.

PieSeries

public PieSeries(float borderWidth,
                 Color borderColor,
                 Legend legend)

Initializes a new instance of the PieSeries class.

Parameters:

borderWidth - Border width of the pie series.

borderColor - Border Color of the pie series.

legend - Legend of the pie series.

See Also:

Legend

PieSeries

public PieSeries(SeriesLabel seriesLabel,
                 float borderWidth,
                 Color borderColor,
                 Legend legend)

Initializes a new instance of the PieSeries class.

Parameters:

seriesLabel - SeriesLabel of the pie series.

borderWidth - Border width of the pie series.

borderColor - Border Color of the pie series.

legend - Legend of the pie series.

See Also:

Legend

Method Detail

getElements

public PieSeriesElementList getElements()

Gets the PieSeriesElementList object contained in the pie series.

Returns:

the pie series element list.

See Also:

PieSeriesElementList

getBorderWidth

public float getBorderWidth()

Gets the border width of the pie series.

Returns:

the float border width of the pie series.

setBorderWidth

public void setBorderWidth(float borderWidth)

Sets the border width of the pie series.

Parameters:

borderWidth - the float used to set border width of the pie series.

getBorderColor

public Color getBorderColor()

Gets the Color object to use for the borders of the pie series.

Returns:

the border color of the pie series.

See Also:

Color

setBorderColor

public void setBorderColor(Color borderColor)

Sets the Color object to use for the borders of the pie series.

Parameters:

borderColor - object to use for the borders of the pie series.

See Also:

Color

getLabel

public SeriesLabel getLabel()

Gets the SeriesLabel object to use for the name of the pie series.

Returns:

the label of the pie series.

See Also:

SeriesLabel

setLabel

public void setLabel(SeriesLabel seriesLabel)

Sets the SeriesLabel object to use for the name of the pie series.

Parameters:

seriesLabel - the label of the pie series.

See Also:

SeriesLabel

getDataLabel

public ScalarDataLabel getDataLabel()

Gets the ScalarDataLabel object to use for the data label of the pie series.

Returns:

the data label of the pie series.

See Also:

ScalarDataLabel

setDataLabel

public void setDataLabel(ScalarDataLabel scalarDataLabel)

Sets the ScalarDataLabel object to use for the data label of the pie series.

Parameters:

scalarDataLabel - the data label of the pie series.

See Also:

ScalarDataLabel

getDataLabelPosition

public ScalarDataLabelPosition getDataLabelPosition()

Gets ScalarDataLabelPosition enumeration that specifies the display position of data label.

Returns:

ScalarDataLabelPosition enumeration that specifies the display position of data label.

See Also:

ScalarDataLabelPosition

setDataLabelPosition

public void setDataLabelPosition(ScalarDataLabelPosition scalarDataLabelPosition)

Sets ScalarDataLabelPosition enumeration that specifies the display position of data label.

Parameters:

scalarDataLabelPosition - ScalarDataLabelPosition enumeration that specifies the display position of data label.

See Also:

ScalarDataLabelPosition

getXOffset

public float getXOffset()

Gets the x offset of the pie series.

Returns:

the float value specifying x offset of the pie series.

setXOffset

public void setXOffset(float xOffset)

Sets the x offset of the pie series.

Parameters:

xOffset - the float value used to set x offset of the pie series.

getYOffset

public float getYOffset()

Gets the y offset of the pie series.

Returns:

the float value specifying y offset of the pie series.

setYOffset

public void setYOffset(float yOffset)

Sets the y offset of the pie series.

Parameters:

yOffset - the float value used to set y offset of the pie series.

getRadius

public float getRadius()

Gets the radius of the pie series.

Returns:

the float value specifying radius of the pie series.

setRadius

public void setRadius(float radius)

Sets the radius of the pie series.

Parameters:

radius - the float value used to set radius of the pie series.

getStartAngle

public float getStartAngle()

Gets the start angle of the pie series.

Returns:

the float value specifying start angle of the pie series.

setStartAngle

public void setStartAngle(float startAngle)

Sets the start angle of the pie series.

Parameters:

startAngle - the float value used to set start angle of the pie series.

setArea

public void setArea(float x,
                    float y,
                    float width,
                    float height)

Sets the area of the pie series.

Parameters:

x - float value indicating X coordinate of the pie series.

y - float value indicating Y coordinate of the pie series.

width - float value indicating width of the pie series.

height - float value indicating height of the pie series.

getX

public float getX()

Gets the X coordinate of the pie series.

Returns:

the float value specifying X coordinate of the pie series.

getY

public float getY()

Gets the Y coordinate of the pie series.

Returns:

the float value specifying Y coordinate of the pie series.

getWidth

public float getWidth()

Gets the width of the pie series.

Returns:

the float value specifying width of the pie series.

getHeight

public float getHeight()

Gets the height of the pie series.

Returns:

the float value specifying height of the pie series.

getValueFormat

public java.lang.String getValueFormat()

Gets the format to use for the value of the ScalarDataLabel object.

Returns:

the string value specifying format to use for the value of the ScalarDataLabel object.

See Also:

ScalarDataLabel

setValueFormat

public void setValueFormat(java.lang.String value)

Sets the format to use for the value of the ScalarDataLabel object.

Parameters:

value - the string value used to set format for the value of the ScalarDataLabel object.

See Also:

ScalarDataLabel

getPercentageFormat

public java.lang.String getPercentageFormat()

Gets the format to use for the percentage of the ScalarDataLabel object.

Returns:

the string value specifying format to use for the percentage of the ScalarDataLabel object.

See Also:

ScalarDataLabel

setPercentageFormat

public void setPercentageFormat(java.lang.String value)

Sets the format to use for the percentage of the ScalarDataLabel object.

Parameters:

value - the string value used to set format for the percentage of the ScalarDataLabel object.

See Also:

ScalarDataLabel