java.lang.Object | ||
↳ | com.shinobicontrols.charts.Series<T extends com.shinobicontrols.charts.SeriesStyle> | |
↳ | com.shinobicontrols.charts.CartesianSeries<T extends com.shinobicontrols.charts.SeriesStyle> |
![]() |
Abstract base class for cartesian series. To display a cartesian series use an appropriate subclass.
Do not attempt to create your own direct subclasses of CartesianSeries, but if you have a need for advanced customization you should start from one of the concrete series.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Gets the user-set baseline value for this cartesian series.
| |||||||||||
Gets the orientation of the series.
| |||||||||||
This method is deprecated.
as of version 1.10.0, replaced by
getStackingToken()
| |||||||||||
Returns the current
StackingToken for this series. | |||||||||||
Returns whether a
Crosshair is displayed when the user performs a
tap-and-hold gesture. | |||||||||||
Whether or not the series is currently selected
| |||||||||||
Sets the baseline value for this cartesian series.
| |||||||||||
Sets whether a
Crosshair should be displayed when the user
performs a tap-and-hold gesture. | |||||||||||
Sets whether or not the series is selected, without requiring a user
gesture Note that this does not force an immediate chart redraw.
| |||||||||||
This method is deprecated.
as of version 1.10.0, replaced by
setStackingToken(StackingToken) with
token created by newCumulativeStackingToken()
| |||||||||||
Sets the
StackingToken for this series. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Gets the user-set 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.
Gets the orientation of the series.
This method is deprecated.
as of version 1.10.0, replaced by getStackingToken()
Gets the stack id for the series.
Series can be stacked on a chart, which means that their values are
offset and they are rendered on top of each other, with the first series
rendered at the bottom, offset from the baseline, with subsequent series
offset so that they begin at the top of the previous series. Each stacked
set in the chart is assigned an ID number representing the stack, and all
series in a stack have the same stack ID. A series' stack ID may be
null
, indicating that the series is not stacked.
Returns the current StackingToken
for this series.
The StackingToken
denotes the way in which, and the series with which, this series is
stacked.
StackingToken
for this seriesReturns whether a Crosshair
is displayed when the user performs a
tap-and-hold gesture. The crosshair consists of a tooltip and a circular
target centered on a data point in a series.
For LineSeries
, the tooltip will appear on the nearest series and
interpolate values between data points. For ColumnSeries
and
BarSeries
the crosshair will snap to the nearest column or bar.
Once a crosshair is visible it is locked to that current series. It will
ignore other series until it is dismissed and re-established on a
different series. To dismiss the crosshair the user performs a single tap
on the chart.
By default the crosshair is not enabled for this cartesian series.
Crosshair
is displayed when the user performs a
tap-and-hold gestureWhether or not the series is currently selected
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.
baseline | The baseline for this cartesian series |
---|
Sets whether a Crosshair
should be displayed when the user
performs a tap-and-hold gesture.
By default the crosshair is not enabled for this cartesian series.
Enabling the crosshair will prevent any parent views from receiving any swipe or pinch gestures
crosshairEnabled | whether a Crosshair should be displayed
when the user performs a tap-and-hold gesture |
---|
Sets whether or not the series is selected, without requiring a user gesture Note that this does not force an immediate chart redraw. If you require one, call it explicitly. Note also, that this method overrides the selection mode.
selected | Whether or not the series is to be selected |
---|
This method is deprecated.
as of version 1.10.0, replaced by setStackingToken(StackingToken)
with
token created by newCumulativeStackingToken()
Sets the stack id for the series.
Series can be stacked on a chart, which means that their values are offset and they are rendered on top of each other, with the first series rendered at the bottom, offset from the baseline, with subsequent series offset so that they begin at the top of the previous series. Each stacked set in the chart is assigned an ID number representing the stack, and all series in a stack have the same stack ID.
To add a series to a stacked set, you call the
setStackId(Integer)
method with the ID of the stacked set you
wish to add the series to.
A series' stack ID defaults to null
. This indicates that the
series is not stacked. The types of series that can be stacked are
BarSeries
, ColumnSeries
and LineSeries
.
Note that for LineSeries, all offsets must be either positive or negative otherwise you may find some strange visual effects around the crossing of the baseline. For BarSeries and ColumnSeries, all offsets must either be positive or negative at each data point. For example, two column series are stacked and have the following data points:
Note also that if your series are stacked, their values must be sorted - with respect to the xAxis in the case of a column series or line series of horizontal orientation, and with respect to the yAxis in the case of a bar series or line series of vertical orientation.
stackId | the stack id for this series |
---|
Sets the StackingToken
for this series.
The StackingToken
denotes the way in which, and the series with which, this series is
stacked.
If this series belongs to a ShinobiChart
, after setting the StackingToken
the
chart will be asked to redraw.
stackingToken | the StackingToken to set for this series |
---|