Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StackedColumnCollection

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

A StackedColumnCollection allows grouping multiple StackedColumnRenderableSeries to create a JavaScript Stacked Column, 100 Stacked Column or Stacked Bar chart

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

This type implements IRenderableSeries but it is not a renderable series, instead it wraps multiple StackedColumnRenderableSeries to create a stacked column chart

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected accumulatedFinalAnimationValues0

accumulatedFinalAnimationValues0: SCRTDoubleVector

accumulatedValues0

accumulatedValues0: SCRTDoubleVector

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

Protected animationFSM

animationFSM: SeriesAnimationFiniteStateMachine

Readonly collectionChanged

collectionChanged: EventHandler<ObservableArrayChangedArgs>

Event handler which fires when the collection changes. See ObservableArrayChangedArgs for args

Protected dataLabelProviderProperty

dataLabelProviderProperty: BaseDataLabelProvider

enableDrawingOptimisations

enableDrawingOptimisations: boolean = true

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

Protected firstAnimationRender

firstAnimationRender: boolean = false

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

Protected isAccumulatedVectorDirty

isAccumulatedVectorDirty: boolean = true

Readonly isSpline

isSpline: false = false

Returns true if the series uses spline interpolation

Readonly isStacked

isStacked: true = true

Returns true if the series is a stacked series or not

Protected items

items: StackedColumnRenderableSeries[] = []

parentSurface

parentSurface: SciChartSurface

The parent SciChartSurface that this RenderableSeries is attached to

Readonly supportsResampling

supportsResampling: false = false

Returns true if the series supports resampling

Readonly type

type: StackedColumnCollection = ESeriesType.StackedColumnCollection

Protected webAssemblyContext

webAssemblyContext: TSciChart

The SciChart WebAssembly Context containing native methods and access to our WebGL2 WebAssembly Drawing Engine

Accessors

animation

  • Sets a start up animation class, a child class for {@link BaseAnimation}

    Parameters

    Returns void

Protected canDraw

  • get canDraw(): boolean

dataLabelProvider

dataPointWidth

  • get dataPointWidth(): number
  • set dataPointWidth(dataPointWidth: number): void

  • Gets or sets the Datapoint width, as a fraction of available space from 0.0 - 1.0

    Returns number

  • Gets or sets the Datapoint width, as a fraction of available space from 0.0 - 1.0

    Parameters

    • dataPointWidth: number

    Returns void

dataPointWidthMode

  • Gets or sets the mode which determines how dataPointWidth is interpreted. Available values are EDataPointWidthMode. Default Relative.

    Returns EDataPointWidthMode

  • Gets or sets the mode which determines how dataPointWidth is interpreted. Available values are EDataPointWidthMode. Default Relative.

    Parameters

    Returns void

dataSeries

drawNaNAs

drawingProviders

effect

  • effect property is not supported for BaseStackedCollection

    Returns ShaderEffect

  • effect property is not supported for BaseStackedCollection

    Parameters

    Returns void

hitTestProvider

hovered

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

isOneHundredPercent

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

  • Gets or sets 100% mode. When true, the stacked group becomes a 100% stacked chart

    Returns boolean

  • Gets or sets 100% mode. When true, the stacked group becomes a 100% stacked chart

    Parameters

    • value: boolean

    Returns void

isRunningAnimation

  • get isRunningAnimation(): 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

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

isVisibleChanged

opacity

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

  • opacity property is not supported for BaseStackedCollection

    Returns number

  • opacity property is not supported for BaseStackedCollection

    Parameters

    • value: number

    Returns void

paletteProvider

pointMarker

resamplingMode

resamplingPrecision

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

  • resamplingPrecision property is not supported for BaseStackedCollection

    Returns number

  • resamplingPrecision property is not supported for BaseStackedCollection

    Parameters

    • value: number

    Returns void

rolloverModifierProps

rolloverModifierProps1

selected

spacing

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

  • Gets the spacing between columns in pixels

    Returns number

  • Sets the spacing between columns in pixels

    Parameters

    • spacing: number

    Returns void

stroke

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

  • stroke property is not supported for BaseStackedCollection

    Returns string

  • stroke property is not supported for BaseStackedCollection

    Parameters

    • value: string

    Returns void

strokeThickness

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

  • strokeThickness property is not supported for BaseStackedCollection

    Returns number

  • strokeThickness property is not supported for BaseStackedCollection

    Parameters

    • value: number

    Returns void

xAxis

xAxisId

  • get xAxisId(): string
  • set xAxisId(id: string): void
  • inheritdoc

    Returns string

  • inheritdoc

    Parameters

    • id: string

    Returns void

yAxis

yAxisId

  • get yAxisId(): string
  • set yAxisId(id: string): void
  • inheritdoc

    Returns string

  • inheritdoc

    Parameters

    • id: string

    Returns 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

zeroLineY

  • get zeroLineY(): number
  • set zeroLineY(zeroLineY: number): void

  • Gets or sets the Zero-line Y, the Y-value where the mountain crosses zero and inverts. Default is 0

    Returns number

  • Gets or sets the Zero-line Y, the Y-value where the mountain crosses zero and inverts. Default is 0

    Parameters

    • zeroLineY: number

    Returns void

Methods

add

adjustAutoColor

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

Protected afterAnimationComplete

  • afterAnimationComplete(): void

applyTheme

asArray

  • asArray(): T[]

  • Returns the backing array. Do not modify this collection. Use add or remove instead.

    Returns T[]

Protected beforeAnimationStart

  • beforeAnimationStart(): void

checkIsOutOfDataRange

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

clear

  • clear(callDeleteOnChildren?: boolean): void

  • Clears the array. Raises the collectionChanged event to subscribers

    Parameters

    • Default value callDeleteOnChildren: boolean = false

      When true, if the items in the array implement the IDeletable interface, the delete() function will be called. Defaults to false for backward compatibility

    Returns void

contains

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

get

getBaseXValues

  • getBaseXValues(): number[]

getById

getColumnWidth

  • Called internally - gets the column width in pixels

    Parameters

    Returns number

getCurrentRenderPassData

getDataSeriesName

  • getDataSeriesName(): string

getDataSeriesValuesCount

  • getDataSeriesValuesCount(): number

Protected getFirstSeries

  • getFirstSeries(): T

  • Gets the first series in the collection, else undefined

    Returns T

getIndicesRange

getNativeXValues

  • getNativeXValues(): SCRTDoubleVector

Protected getParentSurface

getSeriesInfo

getVisibleSeries

  • getVisibleSeries(): T[]

getXRange

getYRange

hasDataSeries

  • hasDataSeries(): boolean

hasDataSeriesValues

  • hasDataSeriesValues(): boolean

hasFillPaletteProvider

  • hasFillPaletteProvider(): boolean

hasPointMarkerPaletteProvider

  • hasPointMarkerPaletteProvider(): boolean

hasStrokePaletteProvider

  • hasStrokePaletteProvider(): boolean

insert

Protected invalidateParent

  • invalidateParent(): void

Protected isAllDataSeriesSet

  • isAllDataSeriesSet(): boolean

Protected isEnoughDataToDraw

  • isEnoughDataToDraw(): boolean

notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

onAnimate

  • onAnimate(timeElapsed: number): void

onAttach

onDetach

  • onDetach(): void

onDpiChanged

Optional pushPalettedColors

remove

  • Removes an item by value. Raises the collectionChanged event to subscribers

    Parameters

    • item: StackedColumnRenderableSeries

      The item to remove

    • Default value callDeleteOnChildren: boolean = false

      When true, if the items in the array implement the IDeletable interface, the delete() function will be called. Defaults to false for backward compatibility

    Returns void

removeAt

  • removeAt(index: number, callDeleteOnChildren?: boolean): void

  • Removes an item at the specified index. Raises the collectionChanged event to subscribers

    Parameters

    • index: number

      The item to remove

    • Default value callDeleteOnChildren: boolean = false

      When true, if the items in the array implement the IDeletable interface, the delete() function will be called. Defaults to false for backward compatibility

    Returns void

resolveAutoColors

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

runAnimation

set

setAccumulatedValuesDirty

  • setAccumulatedValuesDirty(): void

size

  • size(): number

  • gets the number of elements in the array

    Returns number

toJSON

  • Convert the object to a definition that can be serialized to JSON, or used directly with the builder api

    Parameters

    • Default value excludeData: boolean = false

      if set true, data values will not be included in the json.

    Returns TSeriesDefinition

toPointSeries

updateAccumulatedVectors

  • updateAccumulatedVectors(): void

Protected updateAnimationProperties

Protected updateHitTestProviders

Generated using TypeDoc