Creates an instance of the StackedColumnRenderableSeries
The SciChart WebAssembly Context containing native methods and access to our WebGL2 WebAssembly Drawing Engine
Optional parameters of type IStackedColumnRenderableSeriesOptions to configure the series
the accumulated values which are used to draw each column/band for BaseStackedRenderableSeries
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 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.
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 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.
drawingProviders property is not supported for StackedColumnRenderableSeries instead set on the StackedColumnCollection
drawingProviders property is not supported for StackedColumnRenderableSeries, instead set on the StackedColumnCollection
effect property is not supported for StackedColumnRenderableSeries, instead set on the StackedColumnCollection
effect property is not supported for StackedColumnRenderableSeries, instead set on the StackedColumnCollection
Readonly. When true, resampling modes are enabled for faster drawing performance.
Gets or sets the Fill of the column chart as an HTML color code
Gets or sets the Fill of the column chart as an HTML color code
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 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 the Stacked Group ID
Gets or sets the Stacked Group ID
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
Returns true if the series supports resampling
Gets the bound XAxis for this BaseRenderableSeries.
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 BaseRenderableSeries.
yAxisId property is not supported for BaseStackedRenderableSeries, instead set on the StackedColumnCollection or StackedMountainCollection
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
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
getBaseXValues() is not supported for BaseStackedRenderableSeries
Called internally - gets the column width in pixels
The current XAxis CoordinateCalculatorBase
getCurrentRenderPassData method is not supported for BaseStackedRenderableSeries
Returns the associated IDataSeries.dataSeriesName
Returns IDataSeries.count for the linked dataSeries
Gets the fill brush of the column as an HTML color code
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
Get a SeiesInfo object for this series based on the given hitTest
Gets the stroke of the column as an HTML color code
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
hasFillPaletteProvider() is not supported for BaseStackedRenderableSeries
hasPointMarkerPaletteProvider() is not supported for BaseStackedRenderableSeries
hasStrokePaletteProvider() is not supported for BaseStackedRenderableSeries
Used internally to check if resampling is needed for the renderable series
Is called for each render
onAttach() is not supported for BaseStackedRenderableSeries
Called internally when the StackedColumnRenderableSeries is attached to a parent StackedColumnCollection
the parent BaseStackedCollection
function to get the parent SciChartSurface
function to notify property has changed
function to get the column width
onDetach() is not supported for BaseStackedRenderableSeries
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
toPointSeries method is not supported for BaseStackedRenderableSeries
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
The StackedColumnRenderableSeries allows creating JavaScript Stacked Column charts, and 100% Stacked Column Charts
Multiple StackedColumnRenderableSeries are required to create a stacked column chart type in SciChart. These are grouped with a StackedColumnCollection, which implements IRenderableSeries and may be added directly to a SciChartSurface.renderableSeries collection.
Code sample below for stacking above and below (vertical stacking)
const stackedColumn0 = new StackedColumnRenderableSeries(wasmContext); stackedColumn0.stackedGroupId = "group one"; // Same group ID means stack vertically const stackedColumn1 = new StackedColumnRenderableSeries(wasmContext); stackedColumn1.stackedGroupId = "group one"; // Same group ID means stack vertically const stackedColumn2 = new StackedColumnRenderableSeries(wasmContext); stackedColumn2.stackedGroupId = "group one"; // Same group ID means stack vertically const stackedColumnCollection = new StackedColumnCollection(wasmContext); stackedColumnCollection.add(stackedColumn0, stackedColumn1, stackedColumn2); sciChartSurface.renderableSeries.add(stackedColumnCollection);Code sample below for stacking side by side (horizontal stacking)
const stackedColumn0 = new StackedColumnRenderableSeries(wasmContext); stackedColumn0.stackedGroupId = "group one"; // Different group ID means stack horizontally const stackedColumn1 = new StackedColumnRenderableSeries(wasmContext); stackedColumn1.stackedGroupId = "group two"; // Different group ID means stack horizontally const stackedColumn2 = new StackedColumnRenderableSeries(wasmContext); stackedColumn2.stackedGroupId = "group three"; // Different group ID means stack horizontally const stackedColumnCollection = new StackedColumnCollection(wasmContext); stackedColumnCollection.add(stackedColumn0, stackedColumn1, stackedColumn2); sciChartSurface.renderableSeries.add(stackedColumnCollection);Do not add the StackedColumnRenderableSeries directly to SciChartSurface.renderableSeries array, instead, use a StackedColumnCollection to group / stack the columns.