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

Class ScatterSeries<M>

java.lang.Object

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

com.sencha.gxt.chart.client.chart.series.ScatterSeries<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>

Direct Known Subclasses:

LineSeries, RadarSeries

public class ScatterSeries<M>
extends Series<M>

Creates a Scatter Chart. The scatter plot is useful when trying to display more than two variables in the same visualization. These variables can be mapped into x, y coordinates and also to an element's radius/size, color, etc. Here is an example scatter configuration:

    ScatterSeries series = new ScatterSeries();
    series.setYAxisPosition(Position.LEFT);
    series.setYField(dataAccess.data1());
    Sprite marker = Primitives.cross(0, 0, 8);
    marker.setFill(RGB.GREEN);
    series.setMarkerConfig(marker);
    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 field is set, which provides the value of each point. A sprite is added that determines the representation of each point in the scatter. 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
ScatterSeries() Creates a scatter Series.

Method Summary

Methods

Modifier and Type	Method and Description
void	calculateBounds()
void	drawSeries() Draws the series for the current chart.
Sprite	getMarkerConfig() Returns the marker configuration.
double	getSelectionTolerance() Returns the selection tolerance of markers.
String	getTitle() Returns the series title used in the legend.
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() Returns the ValueProvider used 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.
void	setLegendTitle(String title) Set the series title used in the legend.
void	setMarkerConfig(Sprite markerConfig) Sets the marker configuration.
void	setSelectionTolerance(double selectionTolerance) Sets the selection tolerance of markers.
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	setYField(ValueProvider<? super M,? extends Number> yField) Sets the ValueProvider used for the y axis of 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.Series

addSeriesHandler, addSeriesItemOutHandler, addSeriesItemOverHandler, addSeriesItemUpHandler, addSeriesSelectionHandler, calculateBBox, clear, getBBox, getChart, getGutters, getHighlighter, getLabelConfig, getLegendNames, getLegendTitles, 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

ScatterSeries

public ScatterSeries()

Creates a scatter Series.

Method Detail

calculateBounds

public void calculateBounds()

drawSeries

public void drawSeries()

Description copied from class: Series

Draws the series for the current chart.

Specified by:

drawSeries in class Series<M>

getMarkerConfig

public Sprite getMarkerConfig()

Returns the marker configuration.

Returns:

the marker configuration

getSelectionTolerance

public double getSelectionTolerance()

Returns the selection tolerance of markers.

Returns:

the selection tolerance of markers

getTitle

public String getTitle()

Returns the series title used in the legend.

Returns:

the series title used in the legend

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()

Returns the ValueProvider used for the y axis of the series.

Returns:

the value provider used 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

setLegendTitle

public void setLegendTitle(String title)

Set the series title used in the legend.

Parameters:

title - the series title used in the legend

setMarkerConfig

public void setMarkerConfig(Sprite markerConfig)

Sets the marker configuration.

Parameters:

markerConfig - the marker configuration

setSelectionTolerance

public void setSelectionTolerance(double selectionTolerance)

Sets the selection tolerance of markers.

Parameters:

selectionTolerance - the selection tolerance of markers

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

setYField

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

Sets the ValueProvider used for the y axis of the series.

Parameters:

yField - the value provider

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