meteoJS/timeline/animation/togglebutton

animation

module:meteoJS/timeline/animation.Animation

Animation object.

node

external:HTMLElement

Node to append the button and the dropdown menu (if menu set to true). If this is a 'button' element, this will be the animation button and no menu is added.

startedContent

(string, external:HTMLElement, or undefined)

Yes

Content or text of button node if animation is running. Default ist the Bootstrap pause-fill Icon.

startedClass

(string or undefined)

Yes

Classed added to button node if animation is running.

stoppedContent

(string, external:HTMLElement, or undefined)

Yes

Content of button node if animation is stopped. Default ist the Bootstrap play-fill Icon.

stoppedClass

(string or undefined)

Yes

Classed added to button node if animation is running.

classButton

(string or undefined)

Yes

Classed added to button node.

menu

boolean

Yes

Add dropdown menu for animation setup to the button. Ignored, if node is a button element.

Defaults to true.

menuImageFrequency

boolean

Yes

Show frequency configuration in the dropdown menu.

Defaults to true.

imageFrequencyCaption

string

Yes

Label text for the frequency configuration in the dropdown menu.

Defaults to 'Frequency'.

menuFrequencies

(undefined or Array of integer)

Yes

Array of frequencies for the range slider. If undefined the slider will be hidden.

menuRestartPause

boolean

Yes

Show restart pause configuration in the dropdown menu.

Defaults to true.

restartPauseCaption

string

Yes

Label text for the restart pause configuration in the dropdown menu.

Defaults to 'Restart pause'.