Layers methods

These methods are available for all layers. For layer-specific methods, refer to the layer documentation.

Get the time of the first TimeFrame (always the begining of the animation) as a UNIX timestamp in seconds. If the frame container is empty, returns Infinity

Returns

Number: Start date as a UNIX timestamp in seconds

Example

getAnimationStartDate ()

Get the start date of the animated sequence

Returns

Date: Start date

Example

Weather wind and temperature layer

getAnimationEnd ()

Get the end time of the animation as a UNIX timestamp in seconds. If the frame container is empty, returns Infinity

Returns

Number: End date as a UNIX timestamp in seconds

Example

getAnimationEndDate ()

Get the end date of the animated sequence

Returns

Date: End date

Example

Weather wind and temperature layer

getAnimationTime ()

Get the current time of the animation as a UNIX timestamp in seconds.

Returns

Number: Animation current time as a UNIX timestamp in seconds

Example

getAnimationTimeDate ()

Get the current time of the animated sequence

Returns

Date: Animation current time

Example

Weather wind and temperature layer

setAnimationTime (time)

Change the visualization to a specific time. Does not stop animation.

Parameters

time (number) : The animation time, as a UNIX timestamp in seconds

Emits: animationTimeSet

Example

Weather wind and temperature layer

setOpacity (opacity)

Changes the global opacity of the layer

Parameters

opacity (number) : opacity value 0 - 1. Default 1

Example

animate (timePerSecond)

Changes the speed of the animation. 0 to stop. The speed is in number of real world milliseconds per animation second. Example: if timePerSecond is set to 10*1000, then the animation will run 10x of real world speed.

Parameters

timePerSecond (number) : The speed of real world milliseconds per animation second.

Emits: playAnimation is timePerSecond is greater than 0

Emits: pauseAnimation is timePerSecond is 0

Example

animateByFactor (factor)

Animate by a factor of real life speed. 0 to stop. Exampe, if factor is 10, then the animation will play at 10 times the real life speed.

Parameters

factor (number) : real life speed factor.

Emits: playAnimation is factor greater than 0

Emits: pauseAnimation is factor is 0

Example