Creates an instance of the PolarLineRenderableSeries
The SciChart WebAssembly Context containing native methods and access to our WebGL2 WebAssembly Drawing Engine
optional parameters of type IPolarStackedMountainRenderableSeriesOptions applied when constructing the series type
the accumulated values which are used to draw each column/band for BaseStackedRenderableSeries
The bottom edge of each column band, used when StackedColumnCollection.separatePositiveNegativeStacks is true to correctly stack positive values upward and negative values downward from the zero line independently.
The declared column slots this series consumes and their bindings. See ColumnBindings.
A hovered EventHandler. This event fires whenever the Series is hovered or unhovered by a mouse or pointer.
A unique 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 collection of other series.
Returns true if the series is a stacked series or not
An isVisible changed EventHandler. This event fires whenever the Series isVisible changes.
Gets or sets RolloverModifierRenderableSeriesProps for RolloverModifier tooltips Is being used for Y1 tooltips for FastBandRenderableSeries
A selected EventHandler. This event fires whenever the Series is selected or deselected.
Optional hook supplying the explicit set of data/storage row indices to render this pass, carried onto RenderPassData.visibleIndices. Returns undefined (the default) to use the normal contiguous visible-index window. Set by views whose on-screen rows are non-contiguous in storage (e.g. a grid after a sort/filter), so label/marker generation can process only the visible rows instead of the whole data set. Evaluated once per series per render pass.
Sets a start up animation class, a child class for SeriesAnimation
If true, the drawing will be clipped to the visibleRange of the associated Y Axis. This is only really relevant if you are using Stacked Y Axes and do not want the series to be drawn outside that axis range
If true, the drawing will be clipped to the visibleRange of the associated Y Axis. This is only really relevant if you are using Stacked Y Axes and do not want the series to be drawn outside that axis range
Gets or sets options to use a custom texture brush
Gets or sets options to use a custom texture brush
Gets or sets the BaseDataLabelProvider used for creating and drawing per-point text
Gets or sets the BaseDataLabelProvider used for creating and drawing per-point text
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 a list of Series Drawing Providers, which perform specific drawing operations in the series
Gets a list of Series Drawing Providers, which perform specific drawing operations in the series
Gets an optional ShaderEffect for modifying the render output of this IRenderableSeries
Sets an optional ShaderEffect for modifying the render output of this IRenderableSeries
Readonly. When true, resampling modes are enabled for faster drawing performance.
Gets or sets the fill brush of the mountain as an HTML color code
Gets or sets the fill brush of the mountain as an HTML color code
Gets or sets the fill for the region below the zero line as a gradient brush
Gets or sets the fill for the region below the zero line as a gradient brush
Gets or sets the fill color for the region below the zero line as an HTML Color code
Gets or sets the fill color for the region below the zero line as an HTML Color code
Gets or sets whether the Series is hovered by a mouse or pointer device. Setting programmatically will trigger hovered logic
Gets or sets whether the Series is hovered by a mouse or pointer device. Setting programmatically will trigger hovered logic
gets if the animation is currently running
gets if a data animation is currently running
Gets or sets whether the Series is selected. Setting programmatically will trigger selection logic
Gets or sets whether the Series is selected. Setting programmatically will trigger selection logic
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.
The parent SciChartSurface that this RenderableSeries is attached to
set parentSurface property is not supported for BaseStackedRenderableSeries
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
resamplingMode property is not supported for BaseStackedRenderableSeries
resamplingMode property is not supported for BaseStackedRenderableSeries
resamplingPrecision property is not supported for BaseStackedRenderableSeries
resamplingPrecision property is not supported for BaseStackedRenderableSeries
Gets or sets series name
Gets or sets series name
A Stroke for lines, outlines and edges of this RenderableSeries
A Stroke for lines, outlines and edges of this RenderableSeries
The StrokeDashArray defines the stroke or dash pattern for the Y0 line. Accepts an array of values, e.g. [2,2] will have a line of length 2 and a gap of length 2.
The StrokeDashArray defines the stroke or dash pattern for the Y0 line. Accepts an array of values, e.g. [2,2] will have a line of length 2 and a gap of length 2.
The Stroke Thickness for lines, outlines and edges of this RenderableSeries
The Stroke Thickness for lines, outlines and edges of this RenderableSeries
Gets or sets the stroke color the Y1 values in the data-series. See associated XyyDataSeries for further information
Gets or sets the stroke color the Y1 values in the data-series. See associated XyyDataSeries for further information
The strokeY1DashArray defines the stroke or dash pattern for the Y1 line. Accepts an array of values, e.g. [2,2] will have a line of length 2 and a gap of length 2.
The strokeY1DashArray defines the stroke or dash pattern for the Y1 line. Accepts an array of values, e.g. [2,2] will have a line of length 2 and a gap of length 2.
The stroke thickness for the Y1 (lower) line. Defaults to the same as the main strokeThickness.
The stroke thickness for the Y1 (lower) line. Defaults to the same as the main strokeThickness.
Returns true if the series supports resampling
Whether this series type can be resampled when its dataSeries contains NaN values. Series which resample each of their values in a separate pass can end up with mismatched outputs, as NaNs do not necessarily fall into the same buckets for every value.
Gets the bound XAxis for this IRenderableSeries.
xAxisId property is not supported for BaseStackedRenderableSeries, instead set on the StackedColumnCollection or StackedMountainCollection
xAxisId property is not supported for BaseStackedRenderableSeries, instead set on the StackedColumnCollection or StackedMountainCollection
Gets the bound YAxis for this IRenderableSeries.
Gets the bound YAxis Id. Returns this series' own yAxisId if set, otherwise the parent StackedColumnCollection's yAxisId. The base setter throws — only StackedColumnRenderableSeries supports setting a per-series yAxisId.
yAxisId property is not supported for BaseStackedRenderableSeries, instead set on the StackedColumnCollection or StackedMountainCollection
Determines whether the y range for this series should consider only the visible data (the default), or include the drawn points just outside the visible range
Determines whether the y range for this series should consider only the visible data (the default), or include the drawn points just outside the visible range
Replace this to do custom adjustments to the auto color for a particular property
Runs after the animation is complete
Applies yArrayFilter to an XyN point series so its primary yValues is the selected array. Handles both the resampled (sub-series) and wrapped (non-resampled) paths.
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
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
Add the animation into the queue
Returns current of final animation accumulated values. Is used for visible range calculation with animation
Flag to return final animation accumulated values
getBaseXValues() is not supported for BaseStackedRenderableSeries
Gets the RenderPassData instance used for this render pass
Returns the associated IDataSeries.dataSeriesName
Returns IDataSeries.count for the linked dataSeries
Returns the indices range of data points in xRange of the associated IDataSeries
The X-Axis Range currently in view
If True the renderable series uses CategoryAxis
Returns the IDataSeries.getNativeXValues for the associated dataSeries
Returns the IDataSeries.getNativeYValues for the associated dataSeries
The render layer grouping within which the series will be draw. Defaults to EDefaultRenderLayer.SeriesLayer (5)
Get a SeiesInfo object for this series based on the given hitTest
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
Returns true if the BaseRenderableSeries has an IPointMarkerPaletteProvider
Returns true if the BaseRenderableSeries has an IStrokePaletteProvider
Used internally to check if resampling is needed for the renderable series
Is called for each render
Called when the BaseRenderableSeries is attached to a parent SciChartSurface
the SciChartSurface that this series has been attached to
Called internally when the StackedMountainRenderableSeries is attached to a parent StackedMountainCollection
the parent BaseStackedCollection
function to get the parent SciChartSurface
function to notify property has changed
Called when the BaseRenderableSeries is detached from a SciChartSurface
Called when the BaseStackedRenderableSeries is detached from its parent BaseStackedCollection
Called when the Dpi changes in the browser. This could be due to user zooming the browser, or changing DPI settings in Windows, or moving the browser containing SciChart to another monitor
The TDpiChangedEventArgs containing info about the Dpi Changed event
adds palette colors
Resolve colors marked AUTO_COLOR using the theme's strokePalette and fillPalette To do custom adjustments to the resolved colors, override the adjustAutoColor method
Cancel all previous animations and run the current one
Sets initial and end animation vectors
Sets the RenderPassData instance used for this render pass
The render layer grouping within which the series will be draw. Defaults to EDefaultRenderLayer.SeriesLayer (5)
Returns a dataset for drawing on the viewport
The resampling parameters
Internal method that runs on each animation tick
The current animation progress, a value from 0 to 1
The animation finite state machine
Runs renderdataTransform to set transformedRenderPassData, usually for use with ranging.
Generated using TypeDoc
Defines a polar stacked mountain-series or polar stacked mountain chart type in the SciChart's High Performance Real-time JavaScript Charts, which needs to be paired within a Collection to function correctly.
📚 Docs: https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/polar-stacked-mountain-renderable-series/