Series (Sencha GXT 3.1.4)

java.lang.Object
- com.sencha.gxt.chart.client.chart.series.Series<M>

Type Parameters:
M - the data type of the series

All Implemented Interfaces:

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

Direct Known Subclasses:

MultipleColorSeries, ScatterSeries
```
public abstract class Series<M>
extends Object
implements SeriesHandler.HasSeriesHandlers<M>, SeriesSelectionEvent.HasSeriesSelectionHandlers<M>, SeriesItemOutEvent.HasSeriesItemOutHandlers<M>, SeriesItemOverEvent.HasSeriesItemOverHandlers<M>, SeriesItemUpEvent.HasSeriesItemUpHandlers<M>
```
Series is the abstract class containing the common logic to all chart series. This class implements the logic of handling mouse events, animating, hiding, showing all elements and returning the color of the series to be used as a legend item.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Series.LabelPosition
Enumeration used for labels positioned on the series.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Series.LabelPosition` Enumeration used for labels positioned on the series.

Constructor Summary

Constructors
Constructor and Description

Series()
Creates a series.

Constructors
Constructor and Description
`Series()` Creates a series.

Method Summary

Methods
Modifier and Type	Method and Description
`HandlerRegistration`	`addSeriesHandler(SeriesHandler<M> handler)` Adds a `SeriesHandler` handler for `SeriesSelectionEvent`, `SeriesItemOutEvent`, `SeriesItemOverEvent` and `SeriesItemUpEvent` events.
`HandlerRegistration`	`addSeriesItemOutHandler(SeriesItemOutEvent.SeriesItemOutHandler<M> handler)` Adds a `SeriesItemOutEvent.SeriesItemOutHandler` handler for `SeriesItemOutEvent` events.
`HandlerRegistration`	`addSeriesItemOverHandler(SeriesItemOverEvent.SeriesItemOverHandler<M> handler)` Adds a `SeriesItemOverEvent.SeriesItemOverHandler` handler for `SeriesItemOverEvent` events.
`HandlerRegistration`	`addSeriesItemUpHandler(SeriesItemUpEvent.SeriesItemUpHandler<M> handler)` Adds a `SeriesItemUpEvent.SeriesItemUpHandler` handler for `SeriesItemUpEvent` events.
`HandlerRegistration`	`addSeriesSelectionHandler(SeriesSelectionEvent.SeriesSelectionHandler<M> handler)` Adds a `SeriesSelectionEvent.SeriesSelectionHandler` handler for `SeriesSelectionEvent` events.
`void`	`calculateBBox(boolean gutter)` Calculates the bounding the box of the series and stores the result.
`void`	`clear()` Removes all the sprites of the series from the surface.
`abstract void`	`drawSeries()` Draws the series for the current chart.
`PreciseRectangle`	`getBBox()` Returns the bounding box of the series.
`Chart<M>`	`getChart()` Returns the chart that the series is attached.
`double[]`	`getGutters()` Returns the axis insets of the series.
`SeriesHighlighter`	`getHighlighter()` Return the `SeriesHighlighter` used by the series.
`SeriesLabelConfig<M>`	`getLabelConfig()` Returns the configuration for labels on the series.
`Map<Integer,String>`	`getLegendNames()` Returns the map of names used in the legend.
`List<String>`	`getLegendTitles()` Returns the list of titles used in the legend of the series.
`SeriesRenderer<M>`	`getRenderer()` Return the custom sprite renderer on the series.
`SeriesRenderer<M>`	`getShadowRenderer()` Return the custom shadow sprite renderer on the series.
`Color`	`getStroke()` Return the stroke color of the series.
`double`	`getStrokeWidth()` Return the stroke width of the series.
`ToolTip`	`getToolTip()` Return the generated tool tip from the tool tip config.
`SeriesToolTipConfig<M>`	`getToolTipConfig()` Returns the tooltip configuration.
`String`	`getValueProviderName(ValueProvider<? super M,? extends Number> provider, int index)` Attempts to get a simplified yet meaningful string from the given `ValueProvider`.
`ValueProvider<? super M,? extends Number>`	`getXField()` Returns the value provider for the x-axis of the series.
`abstract void`	`hide(int yFieldIndex)` Hides the given y field index from the series.
`void`	`hideToolTip()` Immediately hides the tool tip shown in the series.
`abstract void`	`highlight(int index)` Highlights the series at the given series index.
`abstract void`	`highlightAll(int index)` Highlights all of the items in the series.
`boolean`	`highlightedState()` Returns whether or not the series is actively highlighted.
`boolean`	`isHighlighting()` Returns whether or not the series uses highlighting.
`boolean`	`isShownInLegend()` Returns whether or not the series is shown in the legend.
`void`	`onMouseDown(PrecisePoint point, Event event)` Method used when the series is clicked.
`int`	`onMouseMove(PrecisePoint point, Event event)` Method used when the series is moused over.
`void`	`onMouseOut(PrecisePoint point, Event event)` Method used when the mouse leaves the series.
`void`	`onMouseUp(PrecisePoint point, Event event)` Method used when the series is clicked.
`void`	`removeToolTip()` Removes the components tooltip (if one exists).
`void`	`setChart(Chart<M> chart)` Sets the chart that the series is attached.
`void`	`setHighlighter(SeriesHighlighter highlighter)` Set the `SeriesHighlighter` used by the series.
`void`	`setHighlighting(boolean highlighting)` Sets whether or not the series uses highlighting.
`void`	`setLabelConfig(SeriesLabelConfig<M> labelConfig)` Sets the configuration for labels on the series.
`void`	`setRenderer(SeriesRenderer<M> renderer)` Sets a custom sprite renderer on the series.
`void`	`setShadowRenderer(SeriesRenderer<M> shadowRenderer)` Sets a custom shadow sprite renderer on the series.
`void`	`setShownInLegend(boolean showInLegend)` Sets whether or not the series is shown in the legend.
`void`	`setStroke(Color stroke)` Sets the stroke color of the series.
`void`	`setStrokeWidth(double strokeWidth)` Sets the stroke width of the series.
`void`	`setToolTipConfig(SeriesToolTipConfig<M> config)` Sets the tooltip configuration.
`void`	`setXField(ValueProvider<? super M,? extends Number> xField)` Sets the value provider for the x-axis of the series.
`abstract void`	`show(int yFieldIndex)` Shows the given y field index from the series.
`abstract void`	`unHighlight(int index)` Removes highlighting from the given series index.
`abstract void`	`unHighlightAll(int index)` UnHighlights all items in the series.
`abstract boolean`	`visibleInLegend(int index)` Returns whether or not the given series index is visible in legend.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Series
```
public Series()
```
    Creates a series.
- Method Detail
  - addSeriesHandler
```
public HandlerRegistration addSeriesHandler(SeriesHandler<M> handler)
```
    Description copied from interface: SeriesHandler.HasSeriesHandlers
    
    Adds a SeriesHandler handler for SeriesSelectionEvent, SeriesItemOutEvent, SeriesItemOverEvent and SeriesItemUpEvent events.
    
    Specified by:
    
    addSeriesHandler in interface SeriesHandler.HasSeriesHandlers<M>
    
    Parameters:
    handler - the handler
    
    Returns:
    the registration for the event
  - addSeriesItemOutHandler
```
public HandlerRegistration addSeriesItemOutHandler(SeriesItemOutEvent.SeriesItemOutHandler<M> handler)
```
    Description copied from interface: SeriesItemOutEvent.HasSeriesItemOutHandlers
    
    Adds a SeriesItemOutEvent.SeriesItemOutHandler handler for SeriesItemOutEvent events.
    
    Specified by:
    
    addSeriesItemOutHandler in interface SeriesItemOutEvent.HasSeriesItemOutHandlers<M>
    
    Parameters:
    handler - the handler
    
    Returns:
    the registration for the event
  - addSeriesItemOverHandler
```
public HandlerRegistration addSeriesItemOverHandler(SeriesItemOverEvent.SeriesItemOverHandler<M> handler)
```
    Description copied from interface: SeriesItemOverEvent.HasSeriesItemOverHandlers
    
    Adds a SeriesItemOverEvent.SeriesItemOverHandler handler for SeriesItemOverEvent events.
    
    Specified by:
    
    addSeriesItemOverHandler in interface SeriesItemOverEvent.HasSeriesItemOverHandlers<M>
    
    Parameters:
    handler - the handler
    
    Returns:
    the registration for the event
  - addSeriesSelectionHandler
```
public HandlerRegistration addSeriesSelectionHandler(SeriesSelectionEvent.SeriesSelectionHandler<M> handler)
```
    Description copied from interface: SeriesSelectionEvent.HasSeriesSelectionHandlers
    
    Adds a SeriesSelectionEvent.SeriesSelectionHandler handler for SeriesSelectionEvent events.
    
    Specified by:
    
    addSeriesSelectionHandler in interface SeriesSelectionEvent.HasSeriesSelectionHandlers<M>
    
    Parameters:
    handler - the handler
    
    Returns:
    the registration for the event
  - addSeriesItemUpHandler
```
public HandlerRegistration addSeriesItemUpHandler(SeriesItemUpEvent.SeriesItemUpHandler<M> handler)
```
    Description copied from interface: SeriesItemUpEvent.HasSeriesItemUpHandlers
    
    Adds a SeriesItemUpEvent.SeriesItemUpHandler handler for SeriesItemUpEvent events.
    
    Specified by:
    
    addSeriesItemUpHandler in interface SeriesItemUpEvent.HasSeriesItemUpHandlers<M>
    
    Parameters:
    handler - the handler
    
    Returns:
    the registration for the event
  - calculateBBox
```
public void calculateBBox(boolean gutter)
```
    Calculates the bounding the box of the series and stores the result. To get the result us getBBox().
    
    Parameters:
    gutter - true if to use the series gutter in the calculation
  - clear
```
public void clear()
```
    Removes all the sprites of the series from the surface.
  - drawSeries
```
public abstract void drawSeries()
```
    Draws the series for the current chart.
  - getBBox
```
public PreciseRectangle getBBox()
```
    Returns the bounding box of the series.
    
    Returns:
    the bounding box of the series
  - getChart
```
public Chart<M> getChart()
```
    Returns the chart that the series is attached.
    
    Returns:
    the chart that the series is attached
  - getGutters
```
public double[] getGutters()
```
    Returns the axis insets of the series.
    
    Returns:
    the axis insets of the series
  - getHighlighter
```
public SeriesHighlighter getHighlighter()
```
    Return the SeriesHighlighter used by the series.
    
    Returns:
    the series highlighter
  - getLabelConfig
```
public SeriesLabelConfig<M> getLabelConfig()
```
    Returns the configuration for labels on the series.
    
    Returns:
    the configuration for labels on the series
  - getLegendNames
```
public Map<Integer,String> getLegendNames()
```
    Returns the map of names used in the legend.
    
    Returns:
    the map of names used in the legend
  - getLegendTitles
```
public List<String> getLegendTitles()
```
    Returns the list of titles used in the legend of the series.
    
    Returns:
    the list of titles used in the legend of the series
  - getRenderer
```
public SeriesRenderer<M> getRenderer()
```
    Return the custom sprite renderer on the series.
    
    Returns:
    the custom sprite renderer on the series
  - getShadowRenderer
```
public SeriesRenderer<M> getShadowRenderer()
```
    Return the custom shadow sprite renderer on the series.
    
    Returns:
    the custom shadow sprite renderer on the series
  - getStroke
```
public Color getStroke()
```
    Return the stroke color of the series.
    
    Returns:
    the stroke color of the series
  - getStrokeWidth
```
public double getStrokeWidth()
```
    Return the stroke width of the series.
    
    Returns:
    the stroke width of the series
  - getToolTip
```
public ToolTip getToolTip()
```
    Return the generated tool tip from the tool tip config.
    
    Returns:
    the generated tool tip
  - getToolTipConfig
```
public SeriesToolTipConfig<M> getToolTipConfig()
```
    Returns the tooltip configuration.
    
    Returns:
    the tooltip configuration
  - getValueProviderName
```
public String getValueProviderName(ValueProvider<? super M,? extends Number> provider,
                          int index)
```
    Attempts to get a simplified yet meaningful string from the given ValueProvider.
    
    Parameters:
    provider - the value provider
    index - the index to be used if no path
    
    Returns:
    the name
  - getXField
```
public ValueProvider<? super M,? extends Number> getXField()
```
    Returns the value provider for the x-axis of the series.
    
    Returns:
    the value provider for the x-axis of the series
  - hide
```
public abstract void hide(int yFieldIndex)
```
    Hides the given y field index from the series.
    
    Parameters:
    yFieldIndex - the index of the y field
  - hideToolTip
```
public void hideToolTip()
```
    Immediately hides the tool tip shown in the series.
  - highlight
```
public abstract void highlight(int index)
```
    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.
    
    Parameters:
    index - the series index to be highlighted
  - highlightAll
```
public abstract void highlightAll(int index)
```
    Highlights all of the items in the series.
    
    Parameters:
    index - the index of the series
  - highlightedState
```
public boolean highlightedState()
```
    Returns whether or not the series is actively highlighted.
    
    Returns:
    true if highlighted
  - isHighlighting
```
public boolean isHighlighting()
```
    Returns whether or not the series uses highlighting.
    
    Returns:
    whether or not the series uses highlighting
  - isShownInLegend
```
public boolean isShownInLegend()
```
    Returns whether or not the series is shown in the legend.
    
    Returns:
    true if the series is shown in the legend
  - onMouseDown
```
public void onMouseDown(PrecisePoint point,
               Event event)
```
    Method used when the series is clicked.
    
    Parameters:
    point - the point clicked
  - onMouseMove
```
public int onMouseMove(PrecisePoint point,
              Event event)
```
    Method used when the series is moused over.
    
    Parameters:
    point - the point moused over
    
    Returns:
    the index of the moused over item
  - onMouseOut
```
public void onMouseOut(PrecisePoint point,
              Event event)
```
    Method used when the mouse leaves the series.
    
    Parameters:
    point - the point left
  - onMouseUp
```
public void onMouseUp(PrecisePoint point,
             Event event)
```
    Method used when the series is clicked.
    
    Parameters:
    point - the point clicked
  - removeToolTip
```
public void removeToolTip()
```
    Removes the components tooltip (if one exists).
  - setChart
```
public void setChart(Chart<M> chart)
```
    Sets the chart that the series is attached.
    
    Parameters:
    chart - the chart that the series is attached
  - setHighlighter
```
public void setHighlighter(SeriesHighlighter highlighter)
```
    Set the SeriesHighlighter used by the series.
    
    Parameters:
    highlighter - the series highlighter
  - setHighlighting
```
public void setHighlighting(boolean highlighting)
```
    Sets whether or not the series uses highlighting.
    
    Parameters:
    highlighting - whether or not the series uses highlighting
  - setLabelConfig
```
public void setLabelConfig(SeriesLabelConfig<M> labelConfig)
```
    Sets the configuration for labels on the series.
    
    Parameters:
    labelConfig - the label configuration
  - setRenderer
```
public void setRenderer(SeriesRenderer<M> renderer)
```
    Sets a custom sprite renderer on the series.
    
    Parameters:
    renderer - the renderer
  - setShadowRenderer
```
public void setShadowRenderer(SeriesRenderer<M> shadowRenderer)
```
    Sets a custom shadow sprite renderer on the series.
    
    Parameters:
    shadowRenderer - the renderer
  - setShownInLegend
```
public void setShownInLegend(boolean showInLegend)
```
    Sets whether or not the series is shown in the legend.
    
    Parameters:
    showInLegend - true if the series is shown in the legend
  - setStroke
```
public void setStroke(Color stroke)
```
    Sets the stroke color of the series.
    
    Parameters:
    stroke - the stroke color of the series
  - setStrokeWidth
```
public void setStrokeWidth(double strokeWidth)
```
    Sets the stroke width of the series.
    
    Parameters:
    strokeWidth - the stroke width of the series
  - setToolTipConfig
```
public void setToolTipConfig(SeriesToolTipConfig<M> config)
```
    Sets the tooltip configuration.
    
    Parameters:
    config - the tooltip configuration
  - setXField
```
public void setXField(ValueProvider<? super M,? extends Number> xField)
```
    Sets the value provider for the x-axis of the series.
    
    Parameters:
    xField - the value provider for the x-axis of the series
  - show
```
public abstract void show(int yFieldIndex)
```
    Shows the given y field index from the series.
    
    Parameters:
    yFieldIndex - the index of the y field
  - unHighlight
```
public abstract void unHighlight(int index)
```
    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.
    
    Parameters:
    index - the index to have its highlighting removed
  - unHighlightAll
```
public abstract void unHighlightAll(int index)
```
    UnHighlights all items in the series.
    
    Parameters:
    index - the index of the series
  - visibleInLegend
```
public abstract boolean visibleInLegend(int index)
```
    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.
    
    Parameters:
    index - the series index to determine visible
    
    Returns:
    whether or not it is visible

Class Series<M>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Series

Method Detail

addSeriesHandler

addSeriesItemOutHandler

addSeriesItemOverHandler

addSeriesSelectionHandler

addSeriesItemUpHandler

calculateBBox

clear

drawSeries

getBBox

getChart

getGutters

getHighlighter

getLabelConfig

getLegendNames

getLegendTitles

getRenderer

getShadowRenderer

getStroke

getStrokeWidth

getToolTip

getToolTipConfig

getValueProviderName

getXField

hide

hideToolTip

highlight

highlightAll

highlightedState

isHighlighting

isShownInLegend

onMouseDown

onMouseMove

onMouseOut

onMouseUp

removeToolTip

setChart

setHighlighter

setHighlighting

setLabelConfig

setRenderer

setShadowRenderer

setShownInLegend

setStroke

setStrokeWidth

setToolTipConfig

setXField

show

unHighlight

unHighlightAll

visibleInLegend