com.telerik.widget.chart.visualization.common

Class ChartSeries

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

All Implemented Interfaces:

DataBindingListener, ChartSeriesModel.DataPointsChangedListener, ChartElementPresenter, ChartSeries, PaletteChangedListener

Direct Known Subclasses:

PieSeries, PointTemplateSeries

public abstract class ChartSeries
extends ChartElementPresenter
implements ChartSeries, DataBindingListener, ChartSeriesModel.DataPointsChangedListener

Base class for all chart series.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SERIES_Z_INDEX

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangedListener(PropertyChangedListener listener)
ChartSeriesDataSource	dataSource() Gets the ChartSeriesDataSource for this series.
DataPointInfo	findClosestPoint(Point location) Finds the closest DataPoint to the given location.
boolean	getClipToPlotArea() Gets a value that determines if the chart will clip its children to fit inside the plot area.
Iterable	getData() Gets the items source of the series.
double	getDistanceToPoint(Point dataPointLocation, Point tapLocation) Returns the distance between a data point and a tap location.
boolean	getIsSelected()
boolean	getIsVisibleInLegend() Gets a boolean value determining whether the current PointTemplateSeries instance will be visible in the Chart legend.
int	getLabelFillColor() Gets the label fill color.
Typeface	getLabelFont() Gets the label font.
int	getLabelFontStyle() Gets the current label font style.
String	getLabelFormat() Gets the format in which the labels' text will be rendered.
float	getLabelMargin() Gets the label margin.
BaseLabelRenderer	getLabelRenderer() Gets the ChartLabelRenderer responsible for drawing the labels.
float	getLabelSize() Gets the label text size.
int	getLabelStrokeColor() Gets tje label stroke color.
int	getLabelTextColor() Gets the color of the label text.
Function<Object,String>	getLabelValueToStringConverter() Gets the converter used for converting the value of a label to text value.
RadSize	getPlotAreaSize() Gets the plot area size.
SeriesSelectionMode	getSelectionMode()
boolean	getShowLabels() Gets a value that determines whether the series labels should be shown.
boolean	hitTest(PointF touchLocation) Determines if the series contains the provided point.
DataPoint	hitTestDataPoint(PointF touchLocation) Determines if the provided point argument is on a data point.
ChartSeriesModel	model() Gets the series model for this instance.
void	onBoundItemPropertyChanged(DataPointBindingEntry entry, PropertyChangeEvent event) Called when a change was made to an item that it currently bound.
void	onDataBindingComplete() Called after binding data source items.
void	onDataPointIsSelectedChanged(DataPoint point) Occurs when a DataPoint owned by the series has its IsSelected property changed.
void	onPointAdded(int index, DataPoint point)
void	onPointRemoved(int index, DataPoint point)
void	postRender(Canvas canvas) Used as second layer for rendering the current presenter instance onto the passed canvas object.
void	removePropertyChangedListener(PropertyChangedListener listener)
void	render(Canvas canvas) Used to render the current presenter instance onto the passed canvas object.
void	setClipToPlotArea(boolean value) Sets a value that determines if the chart will clip its children to fit inside the plot area.
void	setData(Iterable value) Sets the items source of the series.
void	setIsSelected(boolean value)
void	setIsVisibleInLegend(boolean value) Sets a boolean value determining whether the current PointTemplateSeries instance will be visible in the Chart legend.
void	setLabelFillColor(int color) Sets the current label fill color.
void	setLabelFont(Typeface value) Sets the label font.
void	setLabelFontStyle(int value) Sets the current label font style.
void	setLabelFormat(String value) Sets the format in which the labels' text will be rendered.
void	setLabelMargin(float value) Sets the current label margin.
void	setLabelPadding(float left, float top, float right, float bottom) Sets the padding for the labels in the series.
void	setLabelRenderer(BaseLabelRenderer value) Sets a ChartLabelRenderer object that will be responsible for drawing the series labels.
void	setLabelSize(float value) Sets the label text size.
void	setLabelStrokeColor(int color) Sets the current label stroke color.
void	setLabelTextColor(int value) Sets the color of the label text.
void	setLabelValueToStringConverter(Function<Object,String> converter) Sets the converter used to convert label value to string value.
void	setSelectionMode(SeriesSelectionMode value)
void	setShowLabels(boolean value) Sets the value that determines whether the series labels should be shown.

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

SERIES_Z_INDEX

public static final int SERIES_Z_INDEX

See Also:

Constant Field Values

Method Detail

addPropertyChangedListener

public void addPropertyChangedListener(PropertyChangedListener listener)

removePropertyChangedListener

public void removePropertyChangedListener(PropertyChangedListener listener)

setSelectionMode

public void setSelectionMode(SeriesSelectionMode value)

getSelectionMode

public SeriesSelectionMode getSelectionMode()

getIsSelected

public boolean getIsSelected()

setIsSelected

public void setIsSelected(boolean value)

setLabelPadding

public void setLabelPadding(float left,
                            float top,
                            float right,
                            float bottom)

Sets the padding for the labels in the series.

Parameters:

left - the left padding.

top - the top padding.

right - the right padding.

bottom - the bottom padding.

getLabelRenderer

public BaseLabelRenderer getLabelRenderer()

Gets the ChartLabelRenderer responsible for drawing the labels.

Returns:

A ChartLabelRenderer instance.

setLabelRenderer

public void setLabelRenderer(BaseLabelRenderer value)

Sets a ChartLabelRenderer object that will be responsible for drawing the series labels.

Parameters:

value - A the new series ChartLabelRenderer. If null is passed, the default renderer will be used.

getIsVisibleInLegend

public boolean getIsVisibleInLegend()

Gets a boolean value determining whether the current PointTemplateSeries instance will be visible in the Chart legend.

Returns:

true if the series is shown in the legend, otherwise false.

setIsVisibleInLegend

public void setIsVisibleInLegend(boolean value)

Sets a boolean value determining whether the current PointTemplateSeries instance will be visible in the Chart legend.

Parameters:

value - true if the series is shown in the legend, otherwise false.

hitTest

public boolean hitTest(PointF touchLocation)

Determines if the series contains the provided point.

Parameters:

touchLocation - The point to test.

Returns:

True if the series contains the point argument and false otherwise.

hitTestDataPoint

public DataPoint hitTestDataPoint(PointF touchLocation)

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

Parameters:

touchLocation - The point to test.

Returns:

The data point that contains the provided point.

getLabelFormat

public String getLabelFormat()

Gets the format in which the labels' text will be rendered.

Returns:

the current format.

setLabelFormat

public void setLabelFormat(String value)

Sets the format in which the labels' text will be rendered.

Parameters:

value - the new format.

getLabelValueToStringConverter

public Function<Object,String> getLabelValueToStringConverter()

Gets the converter used for converting the value of a label to text value.

Returns:

the current label value converter.

setLabelValueToStringConverter

public void setLabelValueToStringConverter(Function<Object,String> converter)

Sets the converter used to convert label value to string value.

Parameters:

converter - the new converter.

getLabelFont

public Typeface getLabelFont()

Gets the label font.

Returns:

the current label font.

setLabelFont

public void setLabelFont(Typeface value)

Sets the label font.

Parameters:

value - the new label font.

getLabelFontStyle

public int getLabelFontStyle()

Gets the current label font style.

Returns:

the current label font style.

setLabelFontStyle

public void setLabelFontStyle(int value)

Sets the current label font style.

Parameters:

value - the new label font style.

getLabelTextColor

public int getLabelTextColor()

Gets the color of the label text.

Returns:

the current text color.

setLabelTextColor

public void setLabelTextColor(int value)

Sets the color of the label text.

Parameters:

value - the new color.

getLabelFillColor

public int getLabelFillColor()

Gets the label fill color.

Returns:

the current fill color.

setLabelFillColor

public void setLabelFillColor(int color)

Sets the current label fill color.

Parameters:

color - the new color.

getLabelStrokeColor

public int getLabelStrokeColor()

Gets tje label stroke color.

Returns:

the current label stroke color.

setLabelStrokeColor

public void setLabelStrokeColor(int color)

Sets the current label stroke color.

Parameters:

color - the new color.

getLabelSize

public float getLabelSize()

Gets the label text size.

Returns:

the current label text size.

setLabelSize

public void setLabelSize(float value)

Sets the label text size.

Parameters:

value - the new label text size.

getLabelMargin

public float getLabelMargin()

Gets the label margin.

Returns:

the current label margin.

setLabelMargin

public void setLabelMargin(float value)

Sets the current label margin.

Parameters:

value - the new label margin.

getShowLabels

public boolean getShowLabels()

Gets a value that determines whether the series labels should be shown.

Returns:

true it the series labels should be shown andfalse otherwise.

setShowLabels

public void setShowLabels(boolean value)

Sets the value that determines whether the series labels should be shown.

Parameters:

value - true it the series labels should be shown and false otherwise.

getData

public Iterable getData()

Gets the items source of the series.

Returns:

The items source of the series.

setData

public void setData(Iterable value)

Sets the items source of the series.

Parameters:

value - The new items source of the series.

getClipToPlotArea

public boolean getClipToPlotArea()

Gets a value that determines if the chart will clip its children to fit inside the plot area.

Returns:

true to clip children to the plot area or false otherwise.

setClipToPlotArea

public void setClipToPlotArea(boolean value)

Sets a value that determines if the chart will clip its children to fit inside the plot area.

Parameters:

value - true to clip children to the plot area or false otherwise.

getPlotAreaSize

public RadSize getPlotAreaSize()

Gets the plot area size.

Returns:

The plot area size.

See Also:

RadSize

onDataBindingComplete

public void onDataBindingComplete()

Description copied from interface: DataBindingListener

Called after binding data source items.

Specified by:

onDataBindingComplete in interface DataBindingListener

onBoundItemPropertyChanged

public void onBoundItemPropertyChanged(DataPointBindingEntry entry,
                                       PropertyChangeEvent event)

Description copied from interface: DataBindingListener

Called when a change was made to an item that it currently bound.

Specified by:

onBoundItemPropertyChanged in interface DataBindingListener

Parameters:

entry - the item that was changed.

event - the info about the change that was made.

onDataPointIsSelectedChanged

public void onDataPointIsSelectedChanged(DataPoint point)

Description copied from interface: ChartSeries

Occurs when a DataPoint owned by the series has its IsSelected property changed.

Specified by:

onDataPointIsSelectedChanged in interface ChartSeries

findClosestPoint

public DataPointInfo findClosestPoint(Point location)

Finds the closest DataPoint to the given location.

Parameters:

location - The location.

Returns:

The closest DataPoint to the given location.

model

public ChartSeriesModel model()

Gets the series model for this instance.

Returns:

The ChartSeriesModel.

onPointAdded

public void onPointAdded(int index,
                         DataPoint point)

Specified by:

onPointAdded in interface ChartSeriesModel.DataPointsChangedListener

onPointRemoved

public void onPointRemoved(int index,
                           DataPoint point)

Specified by:

onPointRemoved in interface ChartSeriesModel.DataPointsChangedListener

getDistanceToPoint

public double getDistanceToPoint(Point dataPointLocation,
                                 Point tapLocation)

Returns the distance between a data point and a tap location.

Parameters:

dataPointLocation - the data point.

tapLocation - the tap location.

Returns:

the distance.

dataSource

public ChartSeriesDataSource dataSource()

Gets the ChartSeriesDataSource for this series.

Returns:

The ChartSeriesDataSource for this series.

render

public void render(Canvas canvas)

Description copied from class: PresenterBase

Used to render the current presenter instance onto the passed canvas object.

Overrides:

render in class PresenterBase

Parameters:

canvas - the canvas onto which the presenter is to be rendered.

postRender

public void postRender(Canvas canvas)

Description copied from class: PresenterBase

Used as second layer for rendering the current presenter instance onto the passed canvas object.

Overrides:

postRender in class PresenterBase

Parameters:

canvas - the canvas onto which the presenter is to be rendered.