com.sencha.gxt.chart.client.chart.series
Class ScatterSeries<M>

java.lang.Object
  extended by com.sencha.gxt.chart.client.chart.series.Series<M>
      extended by com.sencha.gxt.chart.client.chart.series.ScatterSeries<M>
Type Parameters:
M - the data type used by this series
All Implemented Interfaces:
SeriesHandler.HasSeriesHandlers, SeriesItemOutEvent.HasSeriesItemOutHandlers, SeriesItemOverEvent.HasSeriesItemOverHandlers, SeriesSelectionEvent.HasSeriesSelectionHandlers
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.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.sencha.gxt.chart.client.chart.series.Series
Series.LabelPosition
 
Constructor Summary
ScatterSeries()
          Creates a scatter Series.
 
Method Summary
 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.
 ValueProvider<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 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 setYField(ValueProvider<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 index.
 void unHighlightAll(int index)
          UnHighlights all items in the series.
 boolean visibleInLegend(int index)
          Returns whether or not the given index is visible in legend.
 
Methods inherited from class com.sencha.gxt.chart.client.chart.series.Series
addSeriesHandler, addSeriesItemOutHandler, addSeriesItemOverHandler, addSeriesSelectionHandler, calculateBBox, delete, getBBox, getChart, getGutters, getHighlighter, getLabelConfig, getLegendNames, getLegendTitles, getRenderer, getStroke, getStrokeWidth, getToolTip, getToolTipConfig, getXField, getYAxisPosition, highlightedState, isHighlighting, isShownInLegend, onMouseDown, onMouseMove, onMouseOut, removeToolTip, setChart, setHighlighter, setHighlighting, setLabelConfig, setRenderer, setShownInLegend, setStroke, setStrokeWidth, setToolTipConfig, setXField, setYAxisPosition
 
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

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

getYField

public ValueProvider<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 index.

Specified by:
highlight in class Series<M>
Parameters:
yFieldIndex - the 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

setYField

public void setYField(ValueProvider<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 index.

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 index is visible in legend.

Specified by:
visibleInLegend in class Series<M>
Parameters:
index - the index to determine visible
Returns:
whether or not it is visible


Copyright © 2011. All Rights Reserved.