com.telerik.widget.chart.visualization.pieChart

Class PieSeries

java.lang.Object

com.telerik.android.common.PropertyManager

com.telerik.widget.chart.visualization.common.PresenterBase

com.telerik.widget.chart.visualization.common.ChartElementPresenter

com.telerik.widget.chart.visualization.common.ChartSeries

com.telerik.widget.chart.visualization.pieChart.PieSeries

All Implemented Interfaces:

DataBindingListener, ChartSeriesModel.DataPointsChangedListener, ChartElementPresenter, ChartSeries, PaletteChangedListener

Direct Known Subclasses:

DoughnutSeries

public class PieSeries
extends ChartSeries

Represents a special type of ChartSeries which is used in RadPieChartView. Each data items provided through PieSeries is visually represented by a pie slice. The angle of each slice is calculated depending on the value of the data item that it represents in a way that all slices together form a pie.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARC_STROKE_WIDTH_KEY
static double	DEFAULT_SELECTION_OFFSET

Fields inherited from class com.telerik.widget.chart.visualization.common.ChartSeries

SERIES_Z_INDEX

Constructor Summary

Constructors

Constructor and Description
PieSeries() Initializes a new instance of the PieSeries class.

Method Summary

Modifier and Type	Method and Description
ElementCollection<PieDataPoint>	dataPoints() Gets the data points that are visualized by this instance.
DataPointInfo	findClosestPoint(Point location) Finds the closest DataPoint to the given location.
AngleRange	getAngleRange() Gets the AngleRange that is used to visualize the data points in this instance.
int	getDataPointColor(int dataPointIndex)
boolean	getDisplayPercentage() Gets a boolean value determining whether percentage is displayed in the slice label.
String	getLabelFormat() Gets the format that is applied to the percent value when creating labels for the data points.
double	getLabelOffset() Gets the offset in pixels that is applied to the labels relative to the arc of the data point.
DataPointBinding	getNameBinding() Gets a DataPointBinding which is used to obtain a name for the data points which will be displayed in the legend.
RadPoint	getPointLocation(PieDataPoint point)
double	getRadiusFactor() Gets the value of the radius factor.
double	getSelectedPointOffset()
double	getSliceOffset() Gets the offset in pixels that is applied to the slices relative to the center of the pie.
List<SliceStyle>	getSliceStyles() Gets a List of SliceStyle objects that define how the different slices in a pie will be visualized.
DataPointBinding	getValueBinding() Gets the DataPointBinding object that defines the way the value of a data point is calculated depending on the business object that it represents.
DataPoint	hitTestDataPoint(PointF touchLocation) Determines if the provided point argument is on a data point.
PieSeriesModel	model() Gets the series model for this instance.
void	setAngleRange(AngleRange value) Sets the AngleRange that is used to visualize the data points in this instance.
void	setData(Iterable value) Sets the items source of the series.
void	setDisplayPercentage(boolean value) Sets a boolean value determining whether percentage is displayed in the slice label.
void	setLabelFormat(String value) Sets a format that will be applied to the percent value when creating labels for the data points.
void	setLabelOffset(double value) Gets the offset in pixels that is applied to the labels relative to the arc of the data point.
void	setNameBinding(DataPointBinding value)
void	setRadiusFactor(double value) Gets the value of the radius factor.
void	setSelectedPointOffset(double value)
void	setSliceOffset(double value) Gets the offset in pixels that is applied to the slices relative to the center of the pie.
void	setSliceStyles(List<SliceStyle> value) Sets a List of SliceStyle objects that define how the different slices in a pie will be visualized.
void	setValueBinding(DataPointBinding value) Sets a DataPointBinding object that defines the way the value of a data point will be calculated depending on the values of the business object that it will represent.

Methods inherited from class com.telerik.widget.chart.visualization.common.ChartSeries

addPropertyChangedListener, dataSource, getClipToPlotArea, getData, getDistanceToPoint, getIsSelected, getIsVisibleInLegend, getLabelFillColor, getLabelFont, getLabelFontStyle, getLabelMargin, getLabelRenderer, getLabelSize, getLabelStrokeColor, getLabelTextColor, getLabelValueToStringConverter, getPlotAreaSize, getSelectionMode, getShowLabels, hitTest, onBoundItemPropertyChanged, onDataBindingComplete, onDataPointIsSelectedChanged, onPointAdded, onPointRemoved, postRender, removePropertyChangedListener, render, setClipToPlotArea, setIsSelected, setIsVisibleInLegend, setLabelFillColor, setLabelFont, setLabelFontStyle, setLabelMargin, setLabelPadding, setLabelRenderer, setLabelSize, setLabelStrokeColor, setLabelTextColor, setLabelValueToStringConverter, setSelectionMode, setShowLabels

Methods inherited from class com.telerik.widget.chart.visualization.common.ChartElementPresenter

attach, detach, getCanApplyPalette, getChart, getCollectionIndex, getPalette, getZIndex, invalidatePalette, onPaletteInvalidated, onPaletteUpdated, requestLayout, requestRender, setZIndex, updatePalette

Methods inherited from class com.telerik.widget.chart.visualization.common.PresenterBase

getPaletteFamily, getPaletteFamilyCore, isLoaded, isPaletteApplied, isVisible, measureContent, paletteFamily, refreshNode, setCanApplyPalette, setPaletteFamily, setVisible, setVisible

Methods inherited from class com.telerik.android.common.PropertyManager

getValue, resetPropertyValue, setValue, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.telerik.widget.chart.engine.view.ChartElementPresenter

getCollectionIndex, invalidatePalette, measureContent, refreshNode

Field Detail

ARC_STROKE_WIDTH_KEY

public static final String ARC_STROKE_WIDTH_KEY

See Also:

Constant Field Values

DEFAULT_SELECTION_OFFSET

public static final double DEFAULT_SELECTION_OFFSET

See Also:

Constant Field Values

Constructor Detail

PieSeries

public PieSeries()

Initializes a new instance of the PieSeries class.

Method Detail

dataPoints

public ElementCollection<PieDataPoint> dataPoints()

Gets the data points that are visualized by this instance. The data that needs to be visualized in RadPieChartView can be passed in one of the following ways: manually or with data binding. With the manual approach is selected then the dataPoints collection can be used to manually add new instances of type PieDataPoint which represent the data. The other option is to set a collection of data items through the setData method.

Returns:

the collection of data points used for the visualization of the data

See Also:

to provide the data through data binding

setData

public void setData(Iterable value)

Description copied from class: ChartSeries

Sets the items source of the series.

Overrides:

setData in class ChartSeries

Parameters:

value - The new items source of the series.

getValueBinding

public DataPointBinding getValueBinding()

Gets the DataPointBinding object that defines the way the value of a data point is calculated depending on the business object that it represents.

Returns:

the value binding definition

setValueBinding

public void setValueBinding(DataPointBinding value)

Sets a DataPointBinding object that defines the way the value of a data point will be calculated depending on the values of the business object that it will represent.

Parameters:

value - the value binding definition

setNameBinding

public void setNameBinding(DataPointBinding value)

getNameBinding

public DataPointBinding getNameBinding()

Gets a DataPointBinding which is used to obtain a name for the data points which will be displayed in the legend.

getSliceStyles

public List<SliceStyle> getSliceStyles()

Gets a List of SliceStyle objects that define how the different slices in a pie will be visualized.

Returns:

a collection of slice styles

See Also:

SliceStyle

setSliceStyles

public void setSliceStyles(List<SliceStyle> value)

Sets a List of SliceStyle objects that define how the different slices in a pie will be visualized.

Parameters:

value - a collection of slice styles

See Also:

SliceStyle

getRadiusFactor

public double getRadiusFactor()

Gets the value of the radius factor. RadPieChartView calculates the necessary radius in order to consume the whole available space. When this value is calculated, the radius factor is applied. The default value is 1.0. This means that the radius will not be changed. If the value is less than 1.0, the radius will be decreased, so the whole available space will not be taken. If the value is more than 1.0, the radius will be increased, so the chart will not entirely fit in the available space.

Returns:

the radius factor

setRadiusFactor

public void setRadiusFactor(double value)

Gets the value of the radius factor. RadPieChartView calculates the necessary radius in order to consume the whole available space. When this value is calculated, the radius factor is applied. The default value is 1.0. This means that the radius will not be changed. If the value is less than 1.0, the radius will be decreased, so the whole available space will not be taken. If the value is more than 1.0, the radius will be increased, so the chart will not entirely fit in the available space.

Parameters:

value - the radius factor, the value must be positive

getLabelFormat

public String getLabelFormat()

Gets the format that is applied to the percent value when creating labels for the data points. The default value is %d %%.

Overrides:

getLabelFormat in class ChartSeries

Returns:

the format of the labels

setLabelFormat

public void setLabelFormat(String value)

Sets a format that will be applied to the percent value when creating labels for the data points. The default value is %d %%.

Overrides:

setLabelFormat in class ChartSeries

Parameters:

value - the format of the labels

getLabelOffset

public double getLabelOffset()

Gets the offset in pixels that is applied to the labels relative to the arc of the data point. The default value is 10.0. The value is negative when the label is positioned out of the pie.

Returns:

the offset of the labels

setLabelOffset

public void setLabelOffset(double value)

Gets the offset in pixels that is applied to the labels relative to the arc of the data point. The default value is 10.0. If the value is negative, the label will be positioned out of the pie.

Parameters:

value - the offset of the labels

getSliceOffset

public double getSliceOffset()

Gets the offset in pixels that is applied to the slices relative to the center of the pie. The default value is 2.0. The value can be 0.0, if the slices will have no empty space among them. The value can be negative, if the slices are overlapping.

Returns:

the offset of the slices

setSliceOffset

public void setSliceOffset(double value)

Gets the offset in pixels that is applied to the slices relative to the center of the pie. The default value is 2.0. If the value is 0.0, the slices will have no empty space among them. If the value is negative, the slices be overlapping.

Parameters:

value - the offset of the slices

getAngleRange

public AngleRange getAngleRange()

Gets the AngleRange that is used to visualize the data points in this instance. The default value is a range which is starting at 0 and is 360 degrees large.

Returns:

the angle range used to visualize the data points

setAngleRange

public void setAngleRange(AngleRange value)

Sets the AngleRange that is used to visualize the data points in this instance. The default value is a range which is starting at 0 and is 360 degrees large.

model

public PieSeriesModel model()

Description copied from class: ChartSeries

Gets the series model for this instance.

Overrides:

model in class ChartSeries

Returns:

The ChartSeriesModel.

findClosestPoint

public DataPointInfo findClosestPoint(Point location)

Description copied from class: ChartSeries

Finds the closest DataPoint to the given location.

Overrides:

findClosestPoint in class ChartSeries

Parameters:

location - The location.

Returns:

The closest DataPoint to the given location.

getDataPointColor

public int getDataPointColor(int dataPointIndex)

hitTestDataPoint

public DataPoint hitTestDataPoint(PointF touchLocation)

Description copied from class: ChartSeries

Determines if the provided point argument is on a data point.

Overrides:

hitTestDataPoint in class ChartSeries

Parameters:

touchLocation - The point to test.

Returns:

The data point that contains the provided point.

getDisplayPercentage

public boolean getDisplayPercentage()

Gets a boolean value determining whether percentage is displayed in the slice label.

Returns:

true if percentage will be displayed, false otherwise.

setDisplayPercentage

public void setDisplayPercentage(boolean value)

Sets a boolean value determining whether percentage is displayed in the slice label.

Parameters:

value - true if percentage will be displayed, false otherwise.

setSelectedPointOffset

public void setSelectedPointOffset(double value)

getSelectedPointOffset

public double getSelectedPointOffset()

getPointLocation

public RadPoint getPointLocation(PieDataPoint point)