com.sencha.gxt.chart.client.chart.series

Class PieSeries<M>

java.lang.Object

com.sencha.gxt.chart.client.chart.series.Series<M>

com.sencha.gxt.chart.client.chart.series.MultipleColorSeries<M>

com.sencha.gxt.chart.client.chart.series.AbstractPieSeries<M>

com.sencha.gxt.chart.client.chart.series.PieSeries<M>

Type Parameters:

M - data type used by this series

All Implemented Interfaces:

SeriesHandler.HasSeriesHandlers<M>, SeriesItemOutEvent.HasSeriesItemOutHandlers<M>, SeriesItemOverEvent.HasSeriesItemOverHandlers<M>, SeriesItemUpEvent.HasSeriesItemUpHandlers<M>, SeriesSelectionEvent.HasSeriesSelectionHandlers<M>

public class PieSeries<M>
extends AbstractPieSeries<M>

Creates a Pie Chart. A Pie Chart is a useful visualization technique to display quantitative information for different categories that also have a meaning as a whole. Here is an example pie configuration:

    PieSeries series = new PieSeries();
    series.setAngleField(dataAccess.data1());
    series.addColor(slice1);
    series.addColor(slice2);
    series.addColor(slice3);
    series.addColor(slice4);
    series.addColor(slice5);
    series.addColor(slice6);
    chart.addSeries(series);
 

First the series is created with its associated data type. Next the value provider field is set, which provides the value of the pie slices. A color is also added to represent each slice in the pie. Finally the series is added to the chart where it will be displayed.

Nested Class Summary

Nested classes/interfaces inherited from class com.sencha.gxt.chart.client.chart.series.Series

Series.LabelPosition

Field Summary

Fields inherited from class com.sencha.gxt.chart.client.chart.series.AbstractPieSeries

angleField, center, donut, margin, radius

Fields inherited from class com.sencha.gxt.chart.client.chart.series.MultipleColorSeries

colors

Fields inherited from class com.sencha.gxt.chart.client.chart.series.Series

bbox, chart, handlerManager, highlighter, highlighting, labelConfig, labels, lastHighlighted, legendNames, legendTitles, renderer, shadowAttributes, shadowed, shadowGroups, shadowRenderer, shownInLegend, sprites, stroke, strokeWidth, toolTip, toolTipConfig, xField

Constructor Summary

Constructors

Constructor and Description
PieSeries() Creates a pie series.

Method Summary

Modifier and Type	Method and Description
void	addLengthField(ValueProvider<? super M,? extends Number> lengthField) Adds a ValueProvider that represents the radius of a pie slice.
void	clear() Removes all the sprites of the series from the surface.
void	drawSeries() Draws the series for the current chart.
protected int	getIndex(PrecisePoint point) Returns the series index from the given point.
ArrayList<ValueProvider<? super M,? extends Number>>	getLengthFields() Returns the list of value providers that represent the radius of pie slices.
double	getPopOutMargin() Returns the margin that the slices pop out.
protected ValueProvider<? super M,? extends Number>	getValueProvider(int index) Returns the value at the given series index.
void	hide(int yFieldIndex) Hides the given y field index from the series.
void	highlight(int yFieldIndex) Highlights the series at the given series index.
void	highlightAll(int index) Highlights all of the items in the series.
int	onMouseMove(PrecisePoint point, Event event) Method used when the series is moused over.
void	setPopOutMargin(double popOutMargin) Sets the margin that the slices pop out.
void	show(int yFieldIndex) Shows the given y field index from the series.
void	unHighlight(int yFieldIndex) Removes highlighting from the given series index.
void	unHighlightAll(int index) UnHighlights all items in the series.
boolean	visibleInLegend(int index) Returns whether or not the given series index is visible in legend.

Methods inherited from class com.sencha.gxt.chart.client.chart.series.AbstractPieSeries

calculateSegment, createSegmentAnimator, getAngleField, getDonut, getLegendLabelProvider, getLegendTitles, getStoreIndex, setAngleField, setDonut, setLegendLabelProvider, setLegendValueProvider

Methods inherited from class com.sencha.gxt.chart.client.chart.series.MultipleColorSeries

addColor, addColor, getColor, getColors, removeColor, removeColor, setColor

Methods inherited from class com.sencha.gxt.chart.client.chart.series.Series

addSeriesHandler, addSeriesItemOutHandler, addSeriesItemOverHandler, addSeriesItemUpHandler, addSeriesSelectionHandler, calculateBBox, ensureHandlers, getBBox, getChart, getGutters, getHighlighter, getLabelConfig, getLegendNames, getPointFromCommand, getRenderer, getShadowRenderer, getStroke, getStrokeWidth, getToolTip, getToolTipConfig, getValueProviderName, getXField, hideShadows, hideToolTip, highlightedState, isHighlighting, isShownInLegend, onMouseDown, onMouseOut, onMouseUp, removeToolTip, setChart, setHighlighter, setHighlighting, setLabelConfig, setLabelContrast, setLabelText, setRenderer, setShadowRenderer, setShownInLegend, setStroke, setStrokeWidth, setToolTipConfig, setXField

Methods inherited from class java.lang.Object

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

Constructor Detail

PieSeries

public PieSeries()

Creates a pie series.

Method Detail

addLengthField

public void addLengthField(ValueProvider<? super M,? extends Number> lengthField)

Adds a ValueProvider that represents the radius of a pie slice.

Parameters:

lengthField - the value provider

clear

public void clear()

Description copied from class: Series

Removes all the sprites of the series from the surface.

Overrides:

clear in class Series<M>

drawSeries

public void drawSeries()

Description copied from class: Series

Draws the series for the current chart.

Specified by:

drawSeries in class Series<M>

getLengthFields

public ArrayList<ValueProvider<? super M,? extends Number>> getLengthFields()

Returns the list of value providers that represent the radius of pie slices.

Returns:

the list

getPopOutMargin

public double getPopOutMargin()

Returns the margin that the slices pop out.

Returns:

the margin that the slices pop out

hide

public void hide(int yFieldIndex)

Description copied from class: Series

Hides the given y field index from the series.

Specified by:

hide in class Series<M>

Parameters:

yFieldIndex - the index of the y field

highlight

public void highlight(int yFieldIndex)

Description copied from class: Series

Highlights the series at the given series index. The series index represents the index of an item in the series. For example a bar in a bar series.

Specified by:

highlight in class Series<M>

Parameters:

yFieldIndex - the series index to be highlighted

highlightAll

public void highlightAll(int index)

Description copied from class: Series

Highlights all of the items in the series.

Specified by:

highlightAll in class Series<M>

Parameters:

index - the index of the series

onMouseMove

public int onMouseMove(PrecisePoint point,
                       Event event)

Description copied from class: Series

Method used when the series is moused over.

Overrides:

onMouseMove in class Series<M>

Parameters:

point - the point moused over

Returns:

the index of the moused over item

setPopOutMargin

public void setPopOutMargin(double popOutMargin)

Sets the margin that the slices pop out.

Parameters:

popOutMargin - the margin that the slices pop out

show

public void show(int yFieldIndex)

Description copied from class: Series

Shows the given y field index from the series.

Specified by:

show in class Series<M>

Parameters:

yFieldIndex - the index of the y field

unHighlight

public void unHighlight(int yFieldIndex)

Description copied from class: Series

Removes highlighting from the given series index. The series index represents the index of an item in the series. For example a bar in a bar series.

Specified by:

unHighlight in class Series<M>

Parameters:

yFieldIndex - the index to have its highlighting removed

unHighlightAll

public void unHighlightAll(int index)

Description copied from class: Series

UnHighlights all items in the series.

Specified by:

unHighlightAll in class Series<M>

Parameters:

index - the index of the series

visibleInLegend

public boolean visibleInLegend(int index)

Description copied from class: Series

Returns whether or not the given series index is visible in legend. The series index represents the index of an item in the series. For example a bar in a bar series.

Specified by:

visibleInLegend in class Series<M>

Parameters:

index - the series index to determine visible

Returns:

whether or not it is visible

getIndex

protected int getIndex(PrecisePoint point)

Description copied from class: Series

Returns the series index from the given point. The series index represents the index of an item in the series. For example a bar in a bar series.

Specified by:

getIndex in class Series<M>

Parameters:

point - the point get the series index

Returns:

the series index

getValueProvider

protected ValueProvider<? super M,? extends Number> getValueProvider(int index)

Description copied from class: Series

Returns the value at the given series index. The series index represents the index of an item in the series. For example a bar in a bar series.

Specified by:

getValueProvider in class Series<M>

Parameters:

index - the series index

Returns:

the value