Child class

Class

Abstract types

inner

optionKeyboardNavigation  Object

Keyboard navigation options.

Parameters

Name Type Optional Description

enabled

boolean

Yes

Enable Keyboard Navigation.

Defaults to false.

first

module:meteoJS/timeline~optionPressedKeys

Yes

Keyboard event to execute first(). Default: Home.

Defaults to 36.

last

module:meteoJS/timeline~optionPressedKeys

Yes

Keyboard event to execute last(). Default: End.

Defaults to 35.

prev

module:meteoJS/timeline~optionPressedKeys

Yes

Keyboard event to execute prev(). Default: Arrow left.

Defaults to 37.

next

module:meteoJS/timeline~optionPressedKeys

Yes

Keyboard event to execute next(). Default: Arrow right.

Defaults to 39.

prevAllEnabledTime

module:meteoJS/timeline~optionPressedKeys

Yes

Keyboard event to execute prevAllEnabledTime(). Default: Arrow left + Ctrl.

Defaults to [37, 'ctrl'].

nextAllEnabledTime

module:meteoJS/timeline~optionPressedKeys

Yes

Keyboard event to execute nextAllEnabledTime(). Default: Arrow right + Ctrl.

Defaults to [39, 'ctrl'].

add

Object with module:meteoJS/timeline~optionPressedKeys properties

Yes

Keyboard event to execute add(). The keys are combined with an amount integer and a timeKey (definition analog to the add() function). Defaults: ArrowRight plus 3h:Ctrl+Shift, 6h:Shift, 12h:Alt+Shift, 24h:Alt

sub

Object with module:meteoJS/timeline~optionPressedKeys properties

Yes

Keyboard event to execute sub(). The keys are combined with an amount integer and a timeKey (definition analog to the add() function). Defaults: ArrowLeft plus 3h:Ctrl+Shift, 6h:Shift, 12h:Alt+Shift, 24h:Alt

inner

optionPressedKeys  (module:meteoJS/timeline~specialKeyIdentifier or Array of module:meteoJS/timeline~specialKeyIdentifier)

Definition of pressed keys with optional special keys.

inner

options  Object

Options for timeline constructor.

Parameters

Name Type Optional Description

maxTimeGap

(number or undefined)

Yes

Maximum of time period (in seconds) between two timestamps. If this option is specified, than e.g. the method getTimes() could return more timestamps than defined by setTimesBySetID.

keyboardNavigation

module:meteoJS/timeline~optionKeyboardNavigation

Yes

Keyboard navigation options.

inner

specialKeyIdentifier  ("ctrl", "alt", "shift", "meta", or Number)

Special key identifier.

Events

change:enabledTimes

Listener
module:meteoJS/timeline/visualisation.Visualisation

change:time

Property

Name Type Optional Description

oldDate

Date

 

Time before change.

Listener
module:meteoJS/timeline/visualisation.Visualisation

change:times

Listener
module:meteoJS/timeline/visualisation.Visualisation