public class

BandSeries

extends CartesianSeries<T extends SeriesStyle>
java.lang.Object
   ↳ com.shinobicontrols.charts.Series<T extends com.shinobicontrols.charts.SeriesStyle>
     ↳ com.shinobicontrols.charts.CartesianSeries<T extends com.shinobicontrols.charts.SeriesStyle>
       ↳ com.shinobicontrols.charts.BandSeries

Class Overview

Displays a band series on the chart. Band series are visualized as two line series, one for the High values and one for the Low, with an area fill between the lines. The color of this fill depends on the relationship between the lines, for example it may be green if the High value is greater than the Low value, and red if the opposite is true.

BandSeries expects data points implementing MultiValueData, and MultiValueDataPoint implements this interface.

Band series do not stack, and the setStackId(Integer) method has no effect. Similarly, baselines are not applicable to BandSeries and the setBaseline(Object) method has no effect.

Band series are a Premium-only feature. In the Standard edition, attempting to add instances of the series to a chart will result in an java.lang.UnsupportedOperationException being thrown

Summary

[Expand]
Inherited Constants
From class com.shinobicontrols.charts.Series
Public Constructors
BandSeries()
Default constructor
BandSeries(Series.Orientation orientation)
Constructor with orientation
Public Methods
SeriesStyleProvider<BandSeriesStyle> createDefaultSeriesStyleProvider()
BandSeries does not currently make use of the SeriesStyleProvider.
void setBaseline(Object baseline)
Sets the baseline value for this cartesian series.
void setStackingToken(StackingToken stackingToken)
Sets the StackingToken for this BandSeries.
[Expand]
Inherited Methods
From class com.shinobicontrols.charts.CartesianSeries
From class com.shinobicontrols.charts.Series
From class java.lang.Object

Public Constructors

public BandSeries ()

Default constructor

public BandSeries (Series.Orientation orientation)

Constructor with orientation

Parameters
orientation The orientation of the series

Public Methods

public SeriesStyleProvider<BandSeriesStyle> createDefaultSeriesStyleProvider ()

BandSeries does not currently make use of the SeriesStyleProvider. As such this method returns null.

Returns

public void setBaseline (Object baseline)

Sets the baseline value for this cartesian series. This is on the X or Y-axis depending on the orientation of the series. For example, the Y-axis for LineSeries and ColumnSeries, the X-axis for BarSeries).

Certain styling options for a series are based on the baseline and thus the baseline value will affect the visual appearance of a series. For example, for a LineSeries, in its LineSeriesStyle object you can set the area color above and below the baseline.

If no baseline has been explicitly set this method will return null. In this case, for Bar and ColumnSeries, the baseline value that will be used internally will be zero. For LineSeries it will be the minimum of the axis' default range.

Financial series (BandSeries, OHLCSeries and CandlestickSeries) ignore any baseline value set on them.

Parameters
baseline The baseline for this cartesian series

public void setStackingToken (StackingToken stackingToken)

Sets the StackingToken for this BandSeries. The token denotes the way in which, and the series with which, this series is stacked.

By default BandSeries are overlaid on top each other, and this will be the case whether they are given the same overlapping StackingToken instance or individual, different StackingToken instances.

BandSeries cannot be stacked cumulatively. Attempting to set a cumulative StackingToken on a BandSeries will be ignored.

A series' StackingToken cannot be null; attempting to set a null token will result in an IllegalArgumentException being thrown.

If this series belongs to a ShinobiChart, after setting the StackingToken the chart will be asked to redraw.

Parameters
stackingToken the StackingToken to set for this BandSeries