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

Class AreaSeries<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.AreaSeries<M>

Type Parameters:

M - the 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 AreaSeries<M>
extends MultipleColorSeries<M>

Creates a Stacked Area Chart. The stacked area chart is useful when displaying multiple aggregated layers of information. Here is an example area configuration:

    AreaSeries series = new AreaSeries();
    series.setYAxisPosition(Position.LEFT);
    series.addYField(dataAccess.data1());
    series.addYField(dataAccess.data2());
    series.addYField(dataAccess.data3());
    series.addYField(dataAccess.data4());
    series.addYField(dataAccess.data5());
    series.addYField(dataAccess.data6());
    series.addYField(dataAccess.data7());
    series.addColor(new RGB(148, 174, 10));
    series.addColor(new RGB(17, 95, 166));
    series.addColor(new RGB(166, 17, 32));
    series.addColor(new RGB(255, 136, 9));
    series.addColor(new RGB(255, 209, 62));
    series.addColor(new RGB(166, 17, 135));
    series.addColor(new RGB(36, 173, 154));
    chart.addSeries(series);
 

First the series is created with its associated data type. The y-axis position is set to tell the series the scale of the displayed axis. Otherwise the series will use its own internal scale. Next the value provider fields are added, which represent each layer of the area. A color is also added to represent each field in the area. 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

Constructor Summary

Constructors

Constructor and Description
AreaSeries() Creates an area Series.

Method Summary

Methods

Modifier and Type	Method and Description
void	addYField(int index, ValueProvider<? super M,? extends Number> yField) Adds a data field for the y axis of the series.
void	addYField(ValueProvider<? super M,? extends Number> yField) Adds a data field for the y axis of the series.
void	drawSeries() Draws the series for the current chart.
Set<Integer>	getExcluded() Returns the fields that have been hidden from the series using hide(int).
PathSprite	getHighlightLineConfig() Returns the configuration sprite for the highlighting line.
ArrayList<String>	getLegendTitles() Returns the list of titles used in the legend of the series.
Chart.Position	getXAxisPosition() Returns the x axis position of the series.
Chart.Position	getYAxisPosition() Returns the y axis position of the series.
ValueProvider<? super M,? extends Number>	getYField(int index) Returns the value provider for the y-axis of the series at the given index.
List<ValueProvider<? super M,? extends Number>>	getYFields() Returns the list of value providers for the y-axis of the series.
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.
ValueProvider<? super M,? extends Number>	removeYField(int index) Removes a data field for the y axis of the series.
boolean	removeYField(ValueProvider<? super M,? extends Number> yField) Removes a data field for the y axis of the series.
void	setHighlightLineConfig(PathSprite highlightLineConfig) Sets the configuration sprite for the highlighting line.
void	setLegendTitles(List<String> legendTitles) Sets the list of labels used by the legend.
void	setXAxisPosition(Chart.Position xAxisPosition) Sets the position of the x axis on the chart to be used by the series.
void	setYAxisPosition(Chart.Position yAxisPosition) Sets the position of the y axis on the chart to be used by the series.
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.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, clear, getBBox, getChart, getGutters, getHighlighter, getLabelConfig, getLegendNames, getRenderer, getShadowRenderer, getStroke, getStrokeWidth, getToolTip, getToolTipConfig, getValueProviderName, getXField, hideToolTip, highlightedState, isHighlighting, isShownInLegend, onMouseDown, onMouseMove, onMouseOut, onMouseUp, removeToolTip, setChart, setHighlighter, setHighlighting, setLabelConfig, setRenderer, setShadowRenderer, setShownInLegend, setStroke, setStrokeWidth, setToolTipConfig, setXField

Methods inherited from class java.lang.Object

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

Constructor Detail

AreaSeries

public AreaSeries()

Creates an area Series.

Method Detail

addYField

public void addYField(int index,
             ValueProvider<? super M,? extends Number> yField)

Adds a data field for the y axis of the series.

Parameters:

index - the index to have the yField inserted

yField - the value provider for the data on the y axis

addYField

public void addYField(ValueProvider<? super M,? extends Number> yField)

Adds a data field for the y axis of the series.

Parameters:

yField - the value provider for the data on the y axis

drawSeries

public void drawSeries()

Description copied from class: Series

Draws the series for the current chart.

Specified by:

drawSeries in class Series<M>

getExcluded

public Set<Integer> getExcluded()

Returns the fields that have been hidden from the series using hide(int).

Returns:

the fields that have been hidden from the series

getHighlightLineConfig

public PathSprite getHighlightLineConfig()

Returns the configuration sprite for the highlighting line.

Returns:

the configuration sprite for the highlighting line

getLegendTitles

public ArrayList<String> getLegendTitles()

Description copied from class: Series

Returns the list of titles used in the legend of the series.

Overrides:

getLegendTitles in class Series<M>

Returns:

the list of titles used in the legend of the series

getXAxisPosition

public Chart.Position getXAxisPosition()

Returns the x axis position of the series.

Returns:

the x axis position of the series

getYAxisPosition

public Chart.Position getYAxisPosition()

Returns the y axis position of the series.

Returns:

the y axis position of the series

getYField

public ValueProvider<? super M,? extends Number> getYField(int index)

Returns the value provider for the y-axis of the series at the given index.

Parameters:

index - the index of the value provider

Returns:

the value provider for the y-axis of the series at the given index

getYFields

public List<ValueProvider<? super M,? extends Number>> getYFields()

Returns the list of value providers for the y-axis of the series.

Returns:

the list of value providers for the y-axis of the series

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

removeYField

public ValueProvider<? super M,? extends Number> removeYField(int index)

Removes a data field for the y axis of the series.

Parameters:

index - the index of the data field to remove

Returns:

the removed field

removeYField

public boolean removeYField(ValueProvider<? super M,? extends Number> yField)

Removes a data field for the y axis of the series.

Parameters:

yField - the value provider for the data on the y axis

Returns:

whether or not the field was successfully removed

setHighlightLineConfig

public void setHighlightLineConfig(PathSprite highlightLineConfig)

Sets the configuration sprite for the highlighting line.

Parameters:

highlightLineConfig - the configuration sprite for the highlighting line

setLegendTitles

public void setLegendTitles(List<String> legendTitles)

Sets the list of labels used by the legend.

Parameters:

legendTitles - the list of labels

setXAxisPosition

public void setXAxisPosition(Chart.Position xAxisPosition)

Sets the position of the x axis on the chart to be used by the series.

Parameters:

xAxisPosition - the position of the x axis on the chart to be used by the series

setYAxisPosition

public void setYAxisPosition(Chart.Position yAxisPosition)

Sets the position of the y axis on the chart to be used by the series.

Parameters:

yAxisPosition - the position of the y axis on the chart to be used by the series

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