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

The StackedMountainRenderableSeries allows creating JavaScript Stacked Mountain charts

description

Multiple StackedMountainRenderableSeries are required to create a stacked column 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 for creating a stacked mountain chart

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

Do not add the StackedMountainRenderableSeries directly to SciChartSurface.renderableSeries array, instead, use a StackedMountainCollection to group / stack the mountains.

Hierarchy

Implements

Index

Constructors

constructor

Properties

accumulatedVector

accumulatedVector: DoubleVector

accumulatedVectorAnimationValues

accumulatedVectorAnimationValues: DoubleVector

Protected getParentSurfaceFn

getParentSurfaceFn: () => SciChartSurface

Type declaration

hitTestProvider

hitTestProvider: IHitTestProvider

Readonly id

id: string = generateGuid()

Readonly isSpline

isSpline: boolean = false

Readonly isStacked

isStacked: boolean = true

Protected notifyParentPropertyChangedFn

notifyParentPropertyChangedFn: (propertyName: string) => void

Type declaration

    • (propertyName: string): void
    • Parameters

      • propertyName: string

      Returns void

Protected parentCollection

Readonly rolloverModifierProps

rolloverModifierProps: RolloverModifierRenderableSeriesProps = new RolloverModifierRenderableSeriesProps()

Readonly type

type: ESeriesType = ESeriesType.StackedMountainSeries

Protected webAssemblyContext

webAssemblyContext: TSciChart

Accessors

animation

dataSeries

drawNaNAs

drawingProviders

effect

fill

  • get fill(): string
  • set fill(fill: string): void
  • Gets or sets the fill brush of the mountain as an HTML color code

    Returns string

  • Gets or sets the fill brush of the mountain 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

isVisible

  • get isVisible(): boolean
  • set isVisible(value: boolean): void
  • When true, the series is visible and drawn

    inheritdoc

    Returns boolean

  • When true, the series is visible and drawn

    inheritdoc

    Parameters

    • value: 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

rolloverModifierProps1

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

xAxis

xAxisId

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

yAxis

yAxisId

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

Methods

Protected afterAnimationComplete

  • afterAnimationComplete(): void

applyTheme

Protected beforeAnimationStart

  • beforeAnimationStart(): void

checkIsOutOfDataRange

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

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

getBaseXValues

  • getBaseXValues(): number[]

getDataSeriesName

  • getDataSeriesName(): string

getDataSeriesValuesCount

  • getDataSeriesValuesCount(): number

getFillBrush

  • getFillBrush(): SCRTBrush
  • Gets the fill brush of the mountain as an HTML color code

    Returns SCRTBrush

getNativeXValues

  • getNativeXValues(): DoubleVector

getStrokePen

  • getStrokePen(): SCRTPen
  • Gets the stroke of the mountain as an HTML color code

    Returns SCRTPen

getXRange

getYRange

hasDataSeries

  • hasDataSeries(): boolean

hasDataSeriesValues

  • hasDataSeriesValues(): boolean

hasFillPaletteProvider

  • hasFillPaletteProvider(): boolean

hasPointMarkerPaletteProvider

  • hasPointMarkerPaletteProvider(): boolean

hasStrokePaletteProvider

  • hasStrokePaletteProvider(): boolean

invalidateParentCallback

  • invalidateParentCallback(): void

Protected newHitTestProvider

notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

Protected onAnimate

  • Internal method that runs on each animation tick

    Parameters

    • progress: number

      The current animation progress, a value from 0 to 1

    • animation: BaseAnimation

    Returns void

onAttach

onAttachToParentCollection

onDetach

  • onDetach(): void

onDetachFromParentCollection

  • onDetachFromParentCollection(): void

Generated using TypeDoc