Module: meteoJS/timeline/animation

Child class

Animation(options)

Methods

insertFrequencyButtonGroup(node, options)
insertFrequencyInput(node, options)

insertFrequencyRange(node, options)
insertRestartPauseButtonGroup(node, options)

insertRestartPauseInput(node, options)
insertRestartPauseRange(node, options)

Abstract type

options

Events

change:imageFrequency
change:restartPause

end:animation
restart:animation

start:animation
stop:animation

Class

Animation

Methods

static

insertFrequencyButtonGroup(node, options) → external:jQuery

Insert an button-group to change frequency.

import { insertFrequencyButtonGroup } from 'meteojs/timeline/Animation';

Parameters

Name Type Optional Description

node

external:jQuery

Node to insert the button-group.

options

Object

Options for the button-group.

Values in options have the following properties:

Name	Type	Optional	Description
animation	module:meteoJS/timeline/animation.Animation		Animation object.
frequencies	Array of number		Frequencies to select.
btnGroupClass	(string or undefined)	Yes	Class added to the button-group node. Defaults to `'btn-group'`.
btnClass	(string or undefined)	Yes	Class added to each button. Defaults to `'btn btn-primary'`.
suffix	string	Yes	Suffix text for each button after frequency. Defaults to `'fps'`.

Returns: external:jQuery Button-group node.

static

insertFrequencyInput(node, options) → external:jQuery

Insert an input-group to change frequency.

import { insertFrequencyInput } from 'meteojs/timeline/Animation';

Parameters

Name Type Optional Description

node

external:jQuery

Node to insert input-group.

options

Object

Options for input-group.

Values in options have the following properties:

Name Type Optional Description

animation

module:meteoJS/timeline/animation.Animation

Animation object.

suffix

string

Yes

Suffix text for input-group.

Defaults to 'fps'.

Returns: external:jQuery Input-group node.

static

insertFrequencyRange(node, options) → external:jQuery

Insert an input-range to change frequency.

import { insertFrequencyRange } from 'meteojs/timeline/Animation';

Parameters

Name Type Optional Description

node

external:jQuery

Node to insert input-range.

options

Object

Options for input-range.

Values in options have the following properties:

Name	Type	Optional	Description
animation	module:meteoJS/timeline/animation.Animation		Animation object.
frequencies	Array of number		Frequencies to select.

Returns: external:jQuery Input-range node.

static

insertRestartPauseButtonGroup(node, options) → external:jQuery

Insert an button-group to change restart pause.

import { insertRestartPauseButtonGroup } from 'meteojs/timeline/Animation';

Parameters

Name Type Optional Description

node

external:jQuery

Node to insert the button-group.

options

Object

Options for the button-group.

Values in options have the following properties:

Name	Type	Optional	Description
animation	module:meteoJS/timeline/animation.Animation		Animation object.
pauses	Array of number		Restart pauses to select.
btnGroupClass	(string or undefined)	Yes	Class added to the button-group node. Defaults to `'btn-group'`.
btnClass	(string or undefined)	Yes	Class added to each button. Defaults to `'btn btn-primary'`.
suffix	string	Yes	Suffix in each button after duration text. Defaults to `'s'`.

Returns: external:jQuery Button-group node.

static

insertRestartPauseInput(node, options) → external:jQuery

Insert an input-group to change restart pause.

import { insertRestartPauseInput } from 'meteojs/timeline/Animation';

Parameters

Name Type Optional Description

node

external:jQuery

Node to insert input-group.

options

Object

Options for input-group.

Values in options have the following properties:

Name Type Optional Description

animation

module:meteoJS/timeline/animation.Animation

Animation object.

suffix

string

Yes

Suffix text for input-group.

Defaults to 's'.

Returns: external:jQuery Input-group node.

static

insertRestartPauseRange(node, options) → external:jQuery

Insert an input-range to change restart pause.

import { insertRestartPauseRange } from 'meteojs/timeline/Animation';

Parameters

Name Type Optional Description

node

external:jQuery

Node to insert input-range.

options

Object

Options for input-range.

Values in options have the following properties:

Name	Type	Optional	Description
animation	module:meteoJS/timeline/animation.Animation		Animation object.
pauses	Array of number		Restart pauses to select.

Returns: external:jQuery Input-range node.

Abstract type

inner

options Object

Options for animation constructor.

Parameters

Name	Type	Optional	Description
timeline	module:meteoJS/timeline.Timeline		Timeline to animate.
restartPause	number	Yes	Time in seconds to pause before the animation restart. Defaults to `1.8`.
imagePeriod	number	Yes	Time in seconds between animation of two images. Ignored, if imageFrequency is specified. Defaults to `0.2`.
imageFrequency	(number or undefined)	Yes	Time of images during one second.
enabledStepsOnly	boolean	Yes	Use only enabled times. Defaults to `true`.
allEnabledStepsOnly	boolean	Yes	Use only times that are enabled by all sets of time. Defaults to `false`.

Events

change:imageFrequency

Event triggered when imageFrequency/imagePeriod is changed.

change:restartPause

Event triggered when restartPause is changed.

end:animation

Event on reaching last timestamp.

restart:animation

Event triggered immediatly before restart of animation.

start:animation

Event on animation start.

stop:animation

Event on animation stop.