Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StackedColumnRenderableSeries

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github
summary

The StackedColumnRenderableSeries allows creating JavaScript Stacked Column charts, and 100% Stacked Column Charts

description

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);
remarks

Do not add the StackedColumnRenderableSeries directly to SciChartSurface.renderableSeries array, instead, use a StackedColumnCollection to group / stack the columns.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected accumulatedFinalAnimationValues

accumulatedFinalAnimationValues: SCRTDoubleVector

accumulatedValues

accumulatedValues: SCRTDoubleVector

the accumulated values which are used to draw each column/band for BaseStackedRenderableSeries

Protected animationFSM

animationFSM: SeriesAnimationFiniteStateMachine

Protected animationQueue

animationQueue: SeriesAnimation[] = []

Protected currentRenderPassData

currentRenderPassData: RenderPassData

Protected dataLabelProviderProperty

dataLabelProviderProperty: BaseDataLabelProvider

Protected dataSeriesProperty

dataSeriesProperty: IDataSeries

Protected getParentSurfaceFn

getParentSurfaceFn: () => SciChartSurface

Type declaration

hitTestProvider

hitTestProvider: IHitTestProvider

hovered

hovered: EventHandler<SeriesHoveredArgs> = new EventHandler<SeriesHoveredArgs>()

A hovered EventHandler. This event fires whenever the Series is hovered or unhovered by a mouse or pointer.

remarks

See EventHandler for how to subscribe

Readonly id

id: string = generateGuid()

A unique Id for the IRenderableSeries

invalidateParentCallback

invalidateParentCallback: () => void

A callback which tells the parent SciChartSurface that it must be redrawn, e.g. when a property changes

Type declaration

    • (): void

    • Returns void

Readonly isStacked

isStacked: boolean = true

Returns true if the series is a stacked series or not

isVisibleChanged

isVisibleChanged: EventHandler<SeriesVisibleChangedArgs> = new EventHandler<SeriesVisibleChangedArgs>()

An isVisible changed EventHandler. This event fires whenever the Series isVisible changes.

remarks

See EventHandler for how to subscribe

Protected notifyParentPropertyChangedFn

notifyParentPropertyChangedFn: (propertyName: string) => void

Type declaration

    • (propertyName: string): void

    • Parameters

      • propertyName: string

      Returns void

Protected opacityProperty

opacityProperty: number = 1

Protected paletteProviderProperty

paletteProviderProperty: IPaletteProvider = DefaultPaletteProvider.createEmpty()

Protected parentCollection

parentCollection: BaseStackedCollection<BaseStackedRenderableSeries>

Protected pointSeries

pointSeries: XyPointSeriesResampled

Protected renderDataTransformProperty

renderDataTransformProperty: IRenderDataTransform

Protected resamplerHelper

resamplerHelper: ExtremeResamplerHelper

Readonly rolloverModifierProps

rolloverModifierProps: RolloverModifierRenderableSeriesProps = new RolloverModifierRenderableSeriesProps(this)

Readonly rolloverModifierProps1

rolloverModifierProps1: RolloverModifierRenderableSeriesProps = new RolloverModifierRenderableSeriesProps(this, true)

Gets or sets RolloverModifierRenderableSeriesProps for RolloverModifier tooltips Is being used for Y1 tooltips for FastBandRenderableSeries

selected

selected: EventHandler<SeriesSelectedArgs> = new EventHandler<SeriesSelectedArgs>()

A selected EventHandler. This event fires whenever the Series is selected or deselected.

remarks

See EventHandler for how to subscribe

Readonly type

type: StackedColumnSeries = ESeriesType.StackedColumnSeries

Protected typeMap

typeMap: Map<string, string> = new Map<string, string>()

Protected webAssemblyContext

webAssemblyContext: TSciChart

Accessors

animation

clipToYRange

  • get clipToYRange(): boolean
  • set clipToYRange(value: boolean): void

  • 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

    Returns boolean

  • 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

    Parameters

    • value: boolean

    Returns void

dataLabelProvider

dataSeries

drawNaNAs

drawingProviders

effect

enableDrawingOptimisations

  • get enableDrawingOptimisations(): boolean

  • Readonly. When true, resampling modes are enabled for faster drawing performance.

    inheritdoc

    Returns boolean

fill

  • get fill(): string
  • set fill(fill: string): void

  • Gets or sets the Fill of the column chart as an HTML color code

    Returns string

  • Gets or sets the Fill of the column chart as an HTML color code

    Parameters

    • fill: string

    Returns void

isDigitalLine

  • get isDigitalLine(): boolean
  • set isDigitalLine(isDigitalLine: boolean): void

  • When true, if this series draws a line, the line will be a digital (step) line

    inheritdoc

    Returns boolean

  • When true, if this series draws a line, the line will be a digital (step) line

    inheritdoc

    Parameters

    • isDigitalLine: boolean

    Returns void

isHovered

  • get isHovered(): boolean
  • set isHovered(isHovered: boolean): void

  • Gets or sets whether the Series is hovered by a mouse or pointer device. Setting programmatically will trigger hovered logic

    inheritdoc

    Returns boolean

  • Gets or sets whether the Series is hovered by a mouse or pointer device. Setting programmatically will trigger hovered logic

    inheritdoc

    Parameters

    • isHovered: boolean

    Returns void

isRunningAnimation

  • get isRunningAnimation(): boolean

isRunningDataAnimation

  • get isRunningDataAnimation(): boolean

isSelected

  • get isSelected(): boolean
  • set isSelected(isSelected: boolean): void

  • Gets or sets whether the Series is selected. Setting programmatically will trigger selection logic

    inheritdoc

    Returns boolean

  • Gets or sets whether the Series is selected. Setting programmatically will trigger selection logic

    inheritdoc

    Parameters

    • isSelected: boolean

    Returns void

isSpline

  • get isSpline(): boolean

  • Returns true if the series uses spline interpolation

    inheritdoc

    Returns boolean

isVisible

  • get isVisible(): boolean
  • set isVisible(isVisible: boolean): void

  • When true, the series is visible and drawn

    inheritdoc

    Returns boolean

  • When true, the series is visible and drawn

    inheritdoc

    Parameters

    • isVisible: boolean

    Returns void

opacity

  • get opacity(): number
  • set opacity(value: number): void

  • An Opacity factor of the Series that controls its semi-transparency level, where value 1 means the Series is opaque; 0 - transparent.

    inheritdoc

    Returns number

  • An Opacity factor of the Series that controls its semi-transparency level, where value 1 means the Series is opaque; 0 - transparent.

    inheritdoc

    Parameters

    • value: number

    Returns void

paletteProvider

parentSurface

pointMarker

  • A Point Marker which is used to draw an optional point-marker at each data-point. Applicable to some series types only

    inheritdoc

    Returns IPointMarker | undefined

  • A Point Marker which is used to draw an optional point-marker at each data-point. Applicable to some series types only

    inheritdoc

    Parameters

    Returns void

renderDataTransform

resamplingMode

resamplingPrecision

  • get resamplingPrecision(): number
  • set resamplingPrecision(value: number): void

spacing

  • get spacing(): number
  • set spacing(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

stackedGroupId

  • get stackedGroupId(): string
  • set stackedGroupId(value: string): void

stroke

  • get stroke(): string
  • set stroke(htmlColorCode: string): void

  • A Stroke for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Returns string

  • A Stroke for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Parameters

    • htmlColorCode: string

    Returns void

strokeThickness

  • get strokeThickness(): number
  • set strokeThickness(value: number): void

  • The Stroke Thickness for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Returns number

  • The Stroke Thickness for lines, outlines and edges of this RenderableSeries

    inheritdoc

    Parameters

    • value: number

    Returns void

supportsResampling

  • get supportsResampling(): boolean

xAxis

xAxisId

  • get xAxisId(): string
  • set xAxisId(value: string): void

yAxis

yAxisId

  • get yAxisId(): string
  • set yAxisId(value: string): void

yRangeMode

  • 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

    inheritdoc

    Returns EYRangeMode

  • 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

    Parameters

    Returns void

Methods

adjustAutoColor

  • adjustAutoColor(propertyName: string, color: string): string

Protected afterAnimationComplete

  • afterAnimationComplete(): void

applyTheme

Protected beforeAnimationStart

  • beforeAnimationStart(): void

checkIsOutOfDataRange

  • checkIsOutOfDataRange(xValue: number, yValue: number): boolean

Protected dataSeriesDataChanged

  • dataSeriesDataChanged(): void

delete

  • delete(): void

  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

draw

enqueueAnimation

getBaseXValues

  • getBaseXValues(): number[]

  • getBaseXValues() is not supported for BaseStackedRenderableSeries

    Returns number[]

getColumnWidth

  • Called internally - gets the column width in pixels

    Parameters

    Returns number

getCurrentRenderPassData

getDataPointWidth

getDataSeriesName

  • getDataSeriesName(): string

getDataSeriesValuesCount

  • getDataSeriesValuesCount(): number

getFillBrush

  • getFillBrush(): SCRTBrush

  • Gets the fill brush of the column as an HTML color code

    Returns SCRTBrush

getGroupIndex

  • getGroupIndex(): number

  • Returns number

getGroupsCount

  • getGroupsCount(): number

  • Returns number

getIndicesRange

getNativeXValues

  • getNativeXValues(): SCRTDoubleVector

getNativeYValues

  • getNativeYValues(): SCRTDoubleVector

getSeriesInfo

getStrokePen

  • getStrokePen(): SCRTPen

  • Gets the stroke of the column as an HTML color code

    Returns SCRTPen

getXRange

getYRange

hasDataSeries

  • hasDataSeries(): boolean

hasDataSeriesValues

  • hasDataSeriesValues(): boolean

hasFillPaletteProvider

  • hasFillPaletteProvider(): boolean

hasPointMarkerPaletteProvider

  • hasPointMarkerPaletteProvider(): boolean

hasStrokePaletteProvider

  • hasStrokePaletteProvider(): boolean

Protected needsResampling

Protected newHitTestProvider

notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

onAnimate

  • onAnimate(): void

onAttach

onAttachToParentCollection

onDetach

  • onDetach(): void

onDetachFromParentCollection

  • onDetachFromParentCollection(): void

onDpiChanged

pushPalettedColors

resolveAutoColors

  • resolveAutoColors(index: number, maxSeries: number, theme: IThemeProvider): void

runAnimation

Protected setAnimationVectors

setGroupIndex

  • setGroupIndex(value: number): void

  • Parameters

    • value: number

    Returns void

setGroupsCount

  • setGroupsCount(value: number): void

  • Parameters

    • value: number

    Returns void

Protected setPaletteProvider

toJSON

toPointSeries

Protected updateAnimationProperties

Protected valueChanged

  • valueChanged(oldValue: any, newValue: any): boolean

  • Parameters

    • oldValue: any
    • newValue: any

    Returns boolean

Generated using TypeDoc