LineSeries (GXT 4.0.1)

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

Type Parameters:

M - the data type used by the series

All Implemented Interfaces:

SeriesHandler.HasSeriesHandlers<M>, SeriesItemOutEvent.HasSeriesItemOutHandlers<M>, SeriesItemOverEvent.HasSeriesItemOverHandlers<M>, SeriesItemUpEvent.HasSeriesItemUpHandlers<M>, SeriesSelectionEvent.HasSeriesSelectionHandlers<M>
```
public class LineSeries<M>
extends ScatterSeries<M>
```
Creates a Line Chart. A Line Chart is a useful visualization technique to display quantitative information for different categories or other real values (as opposed to the BarSeries), that can show some progression (or regression) in the data set.

Here is an example line configuration:
```
 LineSeries<Data> series = new LineSeries<Data>();
 series.setYAxisPosition(Position.LEFT);
 series.setYField(dataAccess.data1());
 series.setStroke(new RGB(194,0,36));
 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 on the line. The stroke is set to represent the color of the line. 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.ScatterSeries
  coordinates, hidden, markerConfig, max, min, scale, selectionTolerance, xAxisPosition, yAxisPosition, yField
- Fields inherited from class com.sencha.gxt.chart.client.chart.series.Series
  bbox, chart, handlerManager, highlighter, highlighting, labelConfig, labels, lastDisplayedTooltipIndex, lastHighlighted, legendNames, legendTitles, renderer, shadowAttributes, shadowed, shadowGroups, shadowRenderer, shownInLegend, sprites, stroke, strokeWidth, toolTip, toolTipConfig, xField

Constructor Summary

Constructors
Constructor and Description

LineSeries()
Creates a line Series.

Constructors
Constructor and Description
`LineSeries()` Creates a line `Series`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all the sprites of the series from the surface.
`protected void`	`drawLabels()` Draws the labels on the series.
`void`	`drawSeries()` Draws the series for the current chart.
`Color`	`getFill()` Returns the fill color of the line.
`SeriesRenderer<M>`	`getFillRenderer()` Returns the `SeriesRenderer` used on the fill sprite.
`protected int`	`getIndex(PrecisePoint point)` Returns the series index from the given point.
`SeriesHighlighter`	`getLineHighlighter()`
`SeriesRenderer<M>`	`getLineRenderer()` Returns the `SeriesRenderer` used on the line sprite.
`double`	`getMarkerIndex()` Returns the marker index of the series.
`int`	`getSegments()` Returns the number of segments of the smoothed line.
`protected int`	`getStoreIndex(int index)` Returns the appropriate index on the store for the given series index.
`void`	`hide(int yFieldIndex)` Hides the given y field index from the series.
`protected void`	`hideShadows()`
`void`	`highlight(int yFieldIndex)` Highlights the series at the given series index.
`void`	`highlightAll(int index)` Highlights all of the items in the series.
`boolean`	`isGapless()` Returns whether the line is drawn over gaps in field.
`boolean`	`isShowMarkers()` Returns whether or not markers are shown.
`boolean`	`isSmooth()` Returns whether or not the line is smoothed or straight.
`int`	`onMouseMove(PrecisePoint point, Event event)` Method used when the series is moused over.
`void`	`setFill(Color fill)` Sets the fill color of the line.
`void`	`setFillRenderer(SeriesRenderer<M> fillRenderer)` Sets the `SeriesRenderer` used on the fill sprite.
`void`	`setGapless(boolean gapless)` Sets whether the line is drawn over gaps in field.
`void`	`setLineHighlighter(SeriesHighlighter lineHighlighter)`
`void`	`setLineRenderer(SeriesRenderer<M> lineRenderer)` Sets the `SeriesRenderer` used on the line sprite
`void`	`setMarkerIndex(double markerIndex)` Sets the marker index.
`void`	`setSegments(int segments)` Sets the number of segments of the smoothed line.
`void`	`setShowMarkers(boolean showMarkers)` Sets whether or not to show markers.
`void`	`setSmooth(boolean smooth)` Sets whether or not the line is smoothed or straight.
`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.ScatterSeries
calculateBounds, drawMarkers, drawShadows, getMarkerConfig, getSelectionTolerance, getTitle, getValueProvider, getXAxisPosition, getYAxisPosition, getYField, setLegendTitle, setMarkerConfig, setSelectionTolerance, setXAxisPosition, setYAxisPosition, setYField, shrink

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

- Constructor Detail
  - LineSeries
```
public LineSeries()
```
    Creates a line Series.
- Method Detail
  - 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.
    
    Overrides:
    
    drawSeries in class ScatterSeries<M>
  - getFill
```
public Color getFill()
```
    Returns the fill color of the line.
    
    Returns:
    
    the fill color of the line
  - getFillRenderer
```
public SeriesRenderer<M> getFillRenderer()
```
    Returns the SeriesRenderer used on the fill sprite.
    
    Returns:
    
    the series renderer used on the fill sprite
  - getLineHighlighter
```
public SeriesHighlighter getLineHighlighter()
```
  - getLineRenderer
```
public SeriesRenderer<M> getLineRenderer()
```
    Returns the SeriesRenderer used on the line sprite.
    
    Returns:
    
    the series renderer used on the line sprite
  - getMarkerIndex
```
public double getMarkerIndex()
```
    Returns the marker index of the series. Determines the number of markers to animate to simulate progression.
    
    Returns:
    
    the marker index of the series
  - getSegments
```
public int getSegments()
```
    Returns the number of segments of the smoothed line.
    
    Returns:
    
    the number of segments of the smoothed line
  - hide
```
public void hide(int yFieldIndex)
```
    Description copied from class: Series
    
    Hides the given y field index from the series.
    
    Overrides:
    
    hide in class ScatterSeries<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.
    
    Overrides:
    
    highlight in class ScatterSeries<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.
    
    Overrides:
    
    highlightAll in class ScatterSeries<M>
    
    Parameters:
    
    index - the index of the series
  - isGapless
```
public boolean isGapless()
```
    Returns whether the line is drawn over gaps in field.
    
    Returns:
    
    whether the line is drawn over gaps in field
  - isShowMarkers
```
public boolean isShowMarkers()
```
    Returns whether or not markers are shown.
    
    Returns:
    
    whether or not markers are shown
  - isSmooth
```
public boolean isSmooth()
```
    Returns whether or not the line is smoothed or straight.
    
    Returns:
    
    true if smooth
  - 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
    
    event - the event being handled
    
    Returns:
    
    the index of the moused over item
  - setFill
```
public void setFill(Color fill)
```
    Sets the fill color of the line. If none the fill will not be drawn.
    
    Parameters:
    
    fill - the color of the fill
  - setFillRenderer
```
public void setFillRenderer(SeriesRenderer<M> fillRenderer)
```
    Sets the SeriesRenderer used on the fill sprite.
    
    Parameters:
    
    fillRenderer - the series renderer used on the fill sprite
  - setGapless
```
public void setGapless(boolean gapless)
```
    Sets whether the line is drawn over gaps in field. Gaps do not work with setFill(Color).
    
    Parameters:
    
    gapless - whether the line is drawn over gaps in field
  - setLineHighlighter
```
public void setLineHighlighter(SeriesHighlighter lineHighlighter)
```
  - setLineRenderer
```
public void setLineRenderer(SeriesRenderer<M> lineRenderer)
```
    Sets the SeriesRenderer used on the line sprite
    
    Parameters:
    
    lineRenderer - the series renderer used on the line sprite
  - setMarkerIndex
```
public void setMarkerIndex(double markerIndex)
```
    Sets the marker index. Determines the number of markers to animate to simulate progression.
    
    Parameters:
    
    markerIndex - the marker index
  - setSegments
```
public void setSegments(int segments)
```
    Sets the number of segments of the smoothed line. Smooth line enabled using setSmooth(boolean).
    
    Parameters:
    
    segments - the number of segments of the smoothed line
  - setShowMarkers
```
public void setShowMarkers(boolean showMarkers)
```
    Sets whether or not to show markers.
    
    Parameters:
    
    showMarkers - whether or not to show markers
  - setSmooth
```
public void setSmooth(boolean smooth)
```
    Sets whether or not the line is smoothed or straight.
    
    Parameters:
    
    smooth - true if smooth
  - show
```
public void show(int yFieldIndex)
```
    Description copied from class: Series
    
    Shows the given y field index from the series.
    
    Overrides:
    
    show in class ScatterSeries<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.
    
    Overrides:
    
    unHighlight in class ScatterSeries<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.
    
    Overrides:
    
    unHighlightAll in class ScatterSeries<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.
    
    Overrides:
    
    visibleInLegend in class ScatterSeries<M>
    
    Parameters:
    
    index - the series index to determine visible
    
    Returns:
    
    whether or not it is visible
  - drawLabels
```
protected void drawLabels()
```
    Draws the labels on the series.
    
    Overrides:
    
    drawLabels in class ScatterSeries<M>
  - 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.
    
    Overrides:
    
    getIndex in class ScatterSeries<M>
    
    Parameters:
    
    point - the point get the series index
    
    Returns:
    
    the series index
  - getStoreIndex
```
protected int getStoreIndex(int index)
```
    Description copied from class: Series
    
    Returns the appropriate index on the store for the given series index. The series index represents the index of an item in the series. For example a bar in a bar series.
    
    Overrides:
    
    getStoreIndex in class ScatterSeries<M>
    
    Parameters:
    
    index - the series index
    
    Returns:
    
    the store index
  - hideShadows
```
protected void hideShadows()
```
    Overrides:
    
    hideShadows in class Series<M>

Class LineSeries<M>

Nested Class Summary

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

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

LineSeries

Method Detail

clear

drawSeries

getFill

getFillRenderer

getLineHighlighter

getLineRenderer

getMarkerIndex

getSegments

hide

highlight

highlightAll

isGapless

isShowMarkers

isSmooth

onMouseMove

setFill

setFillRenderer

setGapless

setLineHighlighter

setLineRenderer

setMarkerIndex

setSegments

setShowMarkers

setSmooth

show

unHighlight

unHighlightAll

visibleInLegend

drawLabels

getIndex

getStoreIndex

hideShadows