module

meteoJS/timeline/navigationButtons

Source: timeline/NavigationButtons.js

Child class

NavigationButtons([options])

Abstract types

buttonDefinition
findTimeBy
options

Event

click:button

Class

Abstract types

inner

buttonDefinition  Object

Parameters

Name Type Optional Description

buttonClass

(string or undefined)

Yes

Class.

methodName

("first", "last", "prev", "next", "nextAllEnabled", "prevAllEnabled", "add", or "sub")

 

Method to execute on timeline, when button is clicked.

timeAmount

integer

Yes

Required when methodName is "add" or "sub."

timeKey

string

Yes

Required when methodName is "add" or "sub."

text

string

Yes

Text for button.

title

string

Yes

Title for button.
inner

findTimeBy  ("exact", "nearest", "before", or "later")

Determines how the time is chosen, when a button for time navigation is clicked. On "exact" the time in the timeline is only changed if the time exists. In all other cases the time will be changed and a suitable timestamp is chosen.

inner

options  Object

Options for constructor.

Parameters

Name Type Optional Description

timeline

module:meteoJS/timeline.Timeline

 

Timeline object.

findTimeBy

module:meteoJS/timeline/navigationButtons~findTimeBy

 

Determines how the time is chosen, when a button is clicked.

buttonClass

(string or undefined)

 

Default button class.

Event

click:button  module:meteoJS/timeline/navigationButtons~buttonDefinition

Properties

Name Type Optional Description

isTimeChanged

boolean

 

Time changed.

button

external:HTMLElement

 

Button.

methodName

("first", "last", "prev", "next", "nextAllEnabled", "prevAllEnabled", "add", or "sub")

 

Method executed on timeline.

timeAmount

integer

Yes

Passed if methodName is "add" or "sub."

timeKey

string

Yes

Passed if methodName is "add" or "sub."