Options
All
  • Public
  • Public/Protected
  • All
Menu
summary

A StackedMountainCollection allows grouping multiple StackedMountainRenderableSeries to create a JavaScript Stacked Mountain chart, or 100% Stacked Mountain chart

description

Multiple StackedMountainRenderableSeries are required to create a stacked mountain chart type in SciChart. These are grouped with a StackedMountainCollection, which implements IRenderableSeries and may be added directly to a SciChartSurface.renderableSeries collection.

Code sample below:

const stackedMountain0 = new StackedMountainRenderableSeries(wasmContext);
// .. configure mountain 1, including set dataSeries
const stackedMountain1 = new StackedMountainRenderableSeries(wasmContext);
// .. configure mountain 2, including set dataSeries
const stackedMountain2 = new StackedMountainRenderableSeries(wasmContext);
// .. configure mountain 3, including set dataSeries
const stackedMountainCollection = new StackedMountainCollection(wasmContext);
stackedMountainCollection.add(stackedMountain0, stackedMountain1, stackedMountain2);

sciChartSurface.renderableSeries.add(stackedMountainCollection);
remarks

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

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected accumulatedVector0

accumulatedVector0: DoubleVector

Protected accumulatedVectorAnimationValues0

accumulatedVectorAnimationValues0: DoubleVector

Protected animationToken

animationToken: AnimationToken

Readonly collectionChanged

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

Readonly id

id: string = generateGuid()

invalidateParentCallback

invalidateParentCallback: () => void

Type declaration

    • (): void
    • Returns void

Protected isAccumulatedVectorDirty

isAccumulatedVectorDirty: boolean = true

Readonly isSpline

isSpline: false = false

Readonly isStacked

isStacked: true = true

parentSurface

parentSurface: SciChartSurface

Readonly type

type: VerticallyStackedMountainCollection = ESeriesType.VerticallyStackedMountainCollection

Protected webAssemblyContext

webAssemblyContext: TSciChart

The {@link TSciChart | SciChart WebAssembly Context} containing native methods and access to our WebGL2 WebAssembly Drawing Engine

Accessors

animation

dataSeries

  • dataSeries property is not supported for BaseStackedCollection

    Returns IDataSeries

  • dataSeries property is not supported for BaseStackedCollection

    Parameters

    Returns void

drawNaNAs

drawingProviders

effect

  • effect property is not supported for BaseStackedCollection

    Returns ShaderEffect

  • effect property is not supported for BaseStackedCollection

    Parameters

    Returns void

hitTestProvider

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

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

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
  • opacity property is not supported for BaseStackedCollection

    Returns number

  • opacity property is not supported for BaseStackedCollection

    Parameters

    • value: number

    Returns void

paletteProvider

pointMarker

rolloverModifierProps

rolloverModifierProps1

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

Methods

add

Protected afterAnimationComplete

  • afterAnimationComplete(): void

animate

  • animate(): void

applyTheme

asArray

  • asArray(): T[]
  • Converts to a javascript array

    Returns T[]

Protected beforeAnimationStart

  • beforeAnimationStart(): void

checkIsOutOfDataRange

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

clear

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

get

getBaseXValues

  • getBaseXValues(): number[]

getDataSeriesName

  • getDataSeriesName(): string

getDataSeriesValuesCount

  • getDataSeriesValuesCount(): number

Protected getFirstSeries

  • getFirstSeries(): T
  • Gets the first series in the collection, else undefined

    Returns T

getNativeXValues

  • getNativeXValues(): DoubleVector

Protected getParentSurface

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

notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

Protected onAnimate

  • onAnimate(progress: number): void
  • Internal method that runs on each animation tick

    Parameters

    • progress: number

      The current animation progress, a value from 0 to 1

    Returns void

onAttach

onDetach

  • onDetach(): void

remove

removeAt

  • removeAt(index: number): void
  • Removes an item at the specified index. Raises the collectionChanged event to subscribers

    Parameters

    • index: number

    Returns void

set

size

  • size(): number
  • gets the number of elements in the array

    Returns number

updateAccumulatedVectors

  • updateAccumulatedVectors(): void

Generated using TypeDoc