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

Defines Animations that can be applied directly to a SciChartSurface in SciChart's High Performance Real-time JavaScript Charts

remarks

When creating the animation, use the options to specify what to update

Type parameters

  • T

Hierarchy

  • GenericAnimation

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

delay

delay: number = 0

The animation delay

duration

duration: number = 1000

The animation duration

ease

ease: TEasingFn = easing.linear

Sets the animation easing function

from

from: T

The initial state of the animation parameter

Readonly id

id: string

onAnimate

onAnimate: (from: T, to: T, progress: number) => void

The function that is called each frame. Update the target of the animation here. progress is between 0 and 1.

Type declaration

    • (from: T, to: T, progress: number): void
    • Parameters

      • from: T
      • to: T
      • progress: number

      Returns void

onCompleted

onCompleted: () => void

The function that is called after the animation has finished.

Type declaration

    • (): void
    • Returns void

to

to: T

The final state of the animation parameter

Accessors

isComplete

  • get isComplete(): boolean
  • Returns boolean

Methods

cancel

  • cancel(): void
  • Cancel the animation. onCompleted will not be called

    Returns void

reset

  • reset(): void
  • Reset the animation to its initial state. If reset while running or onCompleted, the animation will remain in the list and run again.

    Returns void

update

  • update(timeElapsed: number): void
  • Advance the animation according to the time elapsed since the last frame

    Parameters

    • timeElapsed: number

    Returns void

Generated using TypeDoc