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

Defines the base class for Renderable Series Animations in SciChart's High Performance Real-time JavaScript Charts

remarks

An Animation defines the animation that should take place on the start up e.g. as a Wave, Sweep, Fade animation etc...

Hierarchy

Implements

Index

Constructors

Protected constructor

Properties

dataSeries

dataSeries: IDataSeries

The IDataSeries to be used for the animation

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

Styles of the IRenderableSeries to be animated

Readonly Abstract type

Returns the type of the animation. See EAnimationType for a list of values

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

  • Updates properties of IRenderableSeries

    Parameters

    • renderableSeries: IRenderableSeries

      The renderable series to be animated

    • initialStyles: BaseAnimationStyle

      The initial styles

    • animationProgress: number

      The animation progress, should be between 0 and 1

    Returns void

Generated using TypeDoc