StockChartX Web & Mobile

Class: Animation

StockChartX. Animation

new Animation(config)

Represents basic animation.
Parameters:
Name Type Argument Description
config object <optional>
 The configuration object
Properties
Name Type Argument Default Description
context Object <optional>
 'This' context.
recurring boolean <optional>
 true The flag that indicates whether this is a recurring animation.
callback StockChartX.Animation~AnimationFrameCallback <optional>
 The animation frame callback.

Members

callback :Animation~AnimationFrameCallback

The animation frame callback.
Type:
  • Animation~AnimationFrameCallback

context :Object

'This' context object.
Type:
  • Object

handleAnimationFrame

Handles next animation frame. For internal use only. It is called by AnimationController.

recurring :boolean

The flag that indicates whether this is a recurring animation.
Type:
  • boolean

<readonly> started :boolean

The flag that indicates whether animation is started.
Type:
  • boolean

stop

Stops animation.
See:

Methods

start()

Starts animation.
See:
Returns:
True if animation was started, false otherwise.
Type
boolean

Type Definitions

AnimationFrameCallback()

The callback to handle next animation frame.