Common RenderableSeries Properties
All 2D Chart types in SciChart.js are derived from the BaseRenderableSeries type. This is a TypeScript class which is added to the sciChartSurface.renderableSeries collection and is rendered using our own proprietary WebAssembly / WebGL based rendering engine.
The common properties of the BaseRenderableSeries class are listed below.
Specific series types (chart types) are detailed in the following sections.
BaseRenderableSeries property | Description |
dataSeries | The DataSeries is the data-source for the RenderableSeries. Please see DataSeries API section for a complete walk-through of the DataSeries API |
drawNanAs | How to treat NAN (Not a number) values in the input dataSeries. See ELineDrawMode for a list of values. |
pointMarker | A PointMarker is used to draw an optional point-marker at each data-point. Applicable to some series types only. |
stroke | A Stroke for lines, outlines and edges of this RenderableSeries. Acceptable values include RGB format e.g. "#FF0000", RGBA format e.g. "#FF000077" and RGBA format e.g. "rgba(255,0,0,0.5)" |
strokeThickness | The Stroke Thickness for lines, outlines and edges of this RenderableSeries |
opacity | An Opacity factor of the Series that controls its semi-transparency level, where value 1 means the Series is opaque; 0 means transparent. |
xAxisId | The XAxisId of the series allows you to attach a series to a specific axis. If you only have single X and Y Axis you can leave this default. |
yAxisId | The YAxisId of the series allows you to attach a series to a specific axis. If you only have single X and Y Axis you can leave this default. |
isvisible | When true, the series is visible. To hide a series, set IsVisible = false. |
effect | An optional ShaderEffect for modifying the render output of a RenderableSeries. |
paletteProvider | The PaletteProvider API allows changing the color of a series on a per-point basis. For more details about the PaletteProvider API see the individual examples for Line Series, Column Series etc... |
See Also