Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

constructor

Properties

dataSeries

dataSeries: OhlcDataSeries
inheritdoc

delay

delay: number = 0

The animation delay

duration

duration: number = 3000

The animation duration

ease

ease: TEasingFn = easing.linear

Sets the animation easing function

isComplete

isComplete: true

isFadeEffectAnimation

isFadeEffectAnimation: boolean = false

Enables fade effect animation

isOnStartAnimation

isOnStartAnimation: boolean = false

Enables the animation for the effects like Wave, Sweep etc.

styles

inheritdoc

Readonly type

type: Style = EAnimationType.Style
inheritdoc

Accessors

isDataSeriesAnimation

  • get isDataSeriesAnimation(): boolean
  • Return flag if it is dataSeries animation

    Returns boolean

isStyleAnimation

  • get isStyleAnimation(): boolean
  • Return flag if it is styles animation

    Returns boolean

Methods

calculateAnimationValues

  • calculateAnimationValues(wasmContext: TSciChart, originalValues: SCRTDoubleVector, animationValues: SCRTDoubleVector, progress: number, noZeroLine?: boolean): void
  • Runs on start up animation to update animation vectors

    Parameters

    • wasmContext: TSciChart
    • originalValues: SCRTDoubleVector

      original values

    • animationValues: SCRTDoubleVector

      calculated values used for the animation

    • progress: number

      Current animation progress

    • Default value noZeroLine: boolean = false

      Sets zeroLine = 0, is used for XyzDataSeries

    Returns void

calculateDataSeriesAnimationValues

  • calculateDataSeriesAnimationValues(wasmContext: TSciChart, initialValues: SCRTDoubleVector, finalValues: SCRTDoubleVector, interpolatedValues: SCRTDoubleVector, progress: number): void
  • Runs for data animation to update animation vectors

    Parameters

    • wasmContext: TSciChart
    • initialValues: SCRTDoubleVector

      The initial vector

    • finalValues: SCRTDoubleVector

      The final vector

    • interpolatedValues: SCRTDoubleVector

      The vector which will be updated with interpolated values

    • progress: number

      Current animation progress

    Returns void

getSeriesStyle

toJSON

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

    Returns { options: {}; type: EAnimationType }

updateSeriesProperties

Generated using TypeDoc