SciChart Android 2D Charts API > 2D Chart Types > Renderable Series APIs > Common RenderableSeries Features
Common RenderableSeries Features

All 2D series types in SciChart Android implement the IRenderableSeries interface. These are called RenderableSeries and are visual representation of X,Y data. Please refer to the What is a RenderableSeries article for the complete list of all the series types available out of the box in SciChart.

Common RenderableSeries APIs

One of the main features of RenderableSeries API is its extensibility. New series types can be created via the Custom RenderableSeries API. The list of other features shared by all the series types can be found below:

IRenderableSeries Features

Description

getDataSeries()setDataSeries() A DataSeries is the data-source for a RenderableSeries. Please see the DataSeries API section for a complete walkthrough of the DataSeries API.
getIsVisible()setIsVisible() Allows to hide or show a series.
getIsSelected()setIsSelected() A series can be made Selected to be drawn on the top of other RenderableSeries. Also, the series can alter its appearance in response to changes in the selection state. Please refer to the SeriesSelectionModifier article for more details.
getPointMarker()setPointMarker() This feature lets you set an optional marker on data points, e.g. Ellipse, Square, Triangle or a custom shape. Its usage is described minutely in the PointMarker API article.
getResamplingMode()setResamplingMode() Allows to choose a particular ResamplingMode for a series, which specifies a way to reduce the DataSeries for drawing. For more details, see the Data Resampling article.
getPaletteProvider()setPaletteProvider() The PaletteProvider API allows changing the color of a series on a per-point basis. Please see the PaletteProvider API article for more information.
getStrokeStyle()setStrokeStyle() Allows to assign an PenStyle object to determine how the series' outline should be drawn. Please refer to the Styling and Theming section for more details.
getSeriesInfoProvider()setSeriesInfoProvider() Allows to customize the result of inspection of a series by Chart Modifiers. Also can be used to specify how modifiers tooltips have to appear for this series. Please refer to the Cursors and Tooltips section for more info.
getSelectedSeriesStyle()setSelectedSeriesStyle() Allows to change the appearance of a series when its selection status changes. Please refer to the SeriesSelectionModifier article to learn more about this.
getXAxisId()setXAxisId() In case of multi axis, allows to attach a series to a specific X axis.
getYAxisId()setYAxisId() In case of multi axis, allows to attach a series to a specific Y axis.

 

IRenderableSeries Event Listeners

Description

addIsSelectedChangeListener() / removeIsSelectedChangeListener() Allows to attach a listener to a series which will be called when it becomes selected/deselected. This can occur when the setIsSelected() method is called. See the RenderableSeriesChangeListener interface.
addIsVisibleChangeListener()removeIsVisibleChangeListener() Allows to attach a listener to a series which will be called when its visibility changes. This can occur when the setIsVisible() method is called. See the RenderableSeriesChangeListener interface.

 

BaseRenderableSeries Features

Description

getZeroLineY()setZeroLineY() Specifies the minimum Y value which is considered as an up value. Any part of a series which contains values that are above this value will be drawn upwards. Any part of the series with values below it will be drawn downwards.
getDrawNaNAs()setDrawNaNAs() Specifies how data points with NaN Y values are rendered within a given series type. In SciChart, Double.NaN or Float.NaN is treated as a special value which designates an empty point. It is rendered as a gap within a series. For some chart types, though, the ends of the gap can be connected with a line. See the next paragraph for more details.

For more comprehensive walkthrough into any feature, please find a corresponding article in the list below. To learn more about the specifics of any series type, please refer to articles on that series type. The list of the series types available out of the box can be found in the What is a RenderableSeries article.

Adding a Gap onto a RenderableSeries

There is a special value reserved for this purpose in SciChart, Double.NaN or Float.NaN. If the Y value of a data point is equal to the NaN value, a series will render an empty space at this place, equal to the width of a single series bar:

 

Some chart types, such as FastLineRenderableSeries or FastMountainRenderableSeries, allow to configure how gaps appear on a series via the setDrawNaNAs() method. Please see the LineDrawMode enumeration for more info.

See Also