Creates an instance of the BaseRenderableSeries
The {@link TSciChart | SciChart WebAssembly Context} containing native methods and access to our WebGL2 WebAssembly Drawing Engine
optional parameters of type IBaseRenderableSeriesOptions applied when constructing the series type
Gets a list of Series Drawing Providers, which perform specific drawing operations in the series
Gets the current IHitTestProvider, used to call methods IHitTestProvider.hitTest, IHitTestProvider.getNearestPoint2D and IHitTestProvider.getNearestHorizontalPoint and provide info about the series data-points at mouse or touch locations
A unique, auto-generated Id for the IRenderableSeries
A callback which tells the parent SciChartSurface that it must be redrawn, e.g. when a property changes
Returns true if the series is a stacked series or not
The parent SciChartSurface that this RenderableSeries is attached to
Gets or sets RolloverModifierRenderableSeriesProps for RolloverModifier tooltips
Gets or sets RolloverModifierRenderableSeriesProps for RolloverModifier tooltips Is being used for Y1 tooltips for FastBandRenderableSeries
Returns the type of the series. See ESeriesType for a list of values
Y vector with animation values
Gets a start up animation class, a child class for BaseAnimation
Sets a start up animation class, a child class for BaseAnimation
The DataSeries which provides a datasource for this IRenderableSeries to draw
The DataSeries which provides a datasource for this IRenderableSeries to draw
How to treat NAN (Not a number) values in the input dataSeries. See ELineDrawMode for a list of values.
How to treat NAN (Not a number) values in the input dataSeries. See ELineDrawMode for a list of values.
Gets an optional ShaderEffect for modifying the render output of this IRenderableSeries
Sets an optional ShaderEffect for modifying the render output of this IRenderableSeries
When true, if this series draws a line, the line will be a digital (step) line
When true, if this series draws a line, the line will be a digital (step) line
gets if the animation is currently running
Returns true if the series uses spline interpolation
When true, the series is visible and drawn
When true, the series is visible and drawn
An Opacity factor of the Series that controls its semi-transparency level, where value 1 means the Series is opaque; 0 - transparent.
An Opacity factor of the Series that controls its semi-transparency level, where value 1 means the Series is opaque; 0 - transparent.
An optional IPaletteProvider which is used to provide per data-point coloring or paletting.
An optional IPaletteProvider which is used to provide per data-point coloring or paletting.
A Point Marker which is used to draw an optional point-marker at each data-point. Applicable to some series types only
A Point Marker which is used to draw an optional point-marker at each data-point. Applicable to some series types only
A Stroke for lines, outlines and edges of this RenderableSeries
A Stroke for lines, outlines and edges of this RenderableSeries
The Stroke Thickness for lines, outlines and edges of this RenderableSeries
The Stroke Thickness for lines, outlines and edges of this RenderableSeries
Gets the bound XAxis for this BaseRenderableSeries.
Gets the bound YAxis for this BaseRenderableSeries.
Runs after the animation is complete
Starts an animation for IRenderableSeries
Runs before the animation starts
Checks is the point is out of the data range. For sorted data only. Is used to hide tooltips for RolloverModifier
The X value of the point
The Y value of the point
Is being called when the data for the underlying DataSeries changes
Deletes native (WebAssembly) memory used by this type, after which it cannot be used.
Called when the BaseRenderableSeries must be drawn
The {@link WebGL2RenderingContext} with methods for drawing on the WebGL Canvas via our WebAssembly Rendering Engine
The RenderPassData containing data about the current rendering pass
Returns the IDataSeries.getNativeXValues as a JavaScript array for the primary / base series in the SciChartSurface
Returns the associated IDataSeries.dataSeriesName
Returns IDataSeries.count for the linked dataSeries
Returns the IDataSeries.getNativeXValues for the associated dataSeries
Returns the IDataSeries.getNativeYValues for the associated dataSeries
Gets the X-Range of the series. Override in derived classes to provide series specific implementations
Gets the Y-Range of the series for the current X-Range. Override in derived classes to provide series specific implementations
The AxisCore.visibleRange for the current bound XAxis
Whether the current bound XAxis is a Category axis
Returns true if the BaseRenderableSeries has a dataSeries
Returns true if the BaseRenderableSeries has a dataSeries and IDataSeries.hasValues is true
Returns true if the BaseRenderableSeries has an {@ IFillPaletteProvider }
Returns true if the BaseRenderableSeries has an {@ IPointMarkerPaletteProvider}
Returns true if the BaseRenderableSeries has an IStrokePaletteProvider
Factory function to create a Hit Test Provider; a class which performs hit-test and checks mouse-over and nearest point.
Internal method that runs on each animation tick
The current animation progress, a value from 0 to 1
Called when the BaseRenderableSeries is attached to a parent SciChartSurface
the SciChartSurface that this series has been attached to
Called when the BaseRenderableSeries is detached from a SciChartSurface
adds palette colors
Generated using TypeDoc
Defines the base class to a Render Series (or Chart Type) in SciChart's High Performance Real-time JavaScript Charts
A RenderableSeries defines how data should be rendered. e.g. as a Line Chart, Mountain Chart, Candlestick Chart etc... This is independent from the DataSeries which stores the data to render
See derived types of BaseDataSeries to find out what data-series are available. See derived types of IRenderableSeries to find out what 2D JavaScript Chart types are available.