Module: meteoJS/timeline/visualisation

Child class

static

Format a Date-object via the Moment.js library.

import { makeTimeTextCallbackFunction } from 'meteojs/timeline/Visualisation';

Name	Type	Optional	Description
moment	external:momentjs		Moment.js object.

Returns: module:meteoJS/timeline/visualisation~timeTextCallbackFunction Callback.

inner

Options for Visualisation.

Name	Type	Optional	Description
timeline	module:meteoJS/timeline.Timeline	Yes	Timeline object.
node	external:jQuery	Yes	Node.
animation	module:meteoJS/timeline/animation.Animation	Yes	Animation object. If specified, the animation will be stopped on user interaction with the visualisation object.
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`.
textInvalid	string	Yes	Output string, if time of timeline is invalid. Defaults to `'-'`.
getTimeText	module:meteoJS/timeline/visualisation~timeTextCallbackFunction	Yes	Returns a textual representation of a time according to a passed format.
outputTimezone	string	Yes	'local' for browser local timezone.

inner

Returns a textual representation of a time according to a passed format.

This function could be used to convert Date-objects to a readable time with external libraries. One such implementation is given by module:meteoJS/timeline/visualisation.makeTimeTextCallbackFunction.

Name	Type	Optional	Description
time	Date		A valid datetime.
format	string		Format string.