class static

text.Text

Source: timeline/visualisation/Text.js:22

Show current selected time of a timeline as text.

import Text from 'meteojs/timeline/visualisation/Text';

Methods

attachEventListener(obj, listener, func[, thisArg])
emptyNode()
getOutputTimezone()
getTimelineTimes()

onChangeTime()
onChangeTimes()
onInitNode(isListenersDefined)
setNode(node)

setOutputTimezone(outputTimezone)
timeToText(time, format)

new Text(options)

Parameter

Name	Type	Optional	Description
options			Options.

Extends: module:meteoJS/timeline/visualisation.Visualisation

Methods

protected

attachEventListener(obj, listener, func[, thisArg])

Attach an event listener on an object. Object could be a jQuery-object or an object using module:meteoJS/events.

Parameters

Name	Optional	Description
obj		Object to put the event listener on.
listener		Event listener key.
func		Function to be executed when event is triggered.
thisArg	Yes	This in the function func when event triggered.

Inherited from: module:meteoJS/timeline/visualisation.Visualisation#attachEventListener

protected

emptyNode()

Called to empty the output node. Mainly if the output is muted. Prerequisite: this.options.node must be defined.

Inherited from: module:meteoJS/timeline/visualisation.Visualisation#emptyNode

public

getOutputTimezone() → (string or undefined)

Gets current value of output timezone.

Inherited from: module:meteoJS/timeline/visualisation.Visualisation#getOutputTimezone
Returns: Output timezone.

protected

getTimelineTimes() → Array of Date

Returns the times to display. This could be either all times in the timeline or only the enabled times or the all enabled times. The user of the visualisation object select this by the options.

Inherited from: module:meteoJS/timeline/visualisation.Visualisation#getTimelineTimes
Returns: Times.

protected

onChangeTime()

Called if the timeline triggers the module:meteoJS/timeline#change:time event. Prerequisite: this.options.node must be defined.

Inherited from: module:meteoJS/timeline/visualisation.Visualisation#onChangeTime

abstract protected

onChangeTimes()

Called if the timeline triggers the module:meteoJS/timeline#change:times or module:meteoJS/timeline#change:enabledTimes event. Prerequisite: this.options.node must be defined.

Inherited from: module:meteoJS/timeline/visualisation.Visualisation#onChangeTimes

abstract protected

onInitNode(isListenersDefined)

Called once an output node is set. Prerequisite: this.options.node must be defined.

Parameter

Name	Type	Optional	Description
isListenersDefined			True if the event listeners are already set.

Inherited from: module:meteoJS/timeline/visualisation.Visualisation#onInitNode

public

setNode(node) → module:meteoJS/timeline/visualisation.Visualisation

Sets jQuery-Node for output.

Parameter

Name	Type	Optional	Description
node			Node, undefined to mute the output.

Inherited from: module:meteoJS/timeline/visualisation.Visualisation#setNode
Returns: This.

public

setOutputTimezone(outputTimezone) → module:meteoJS/timeline/visualisation.Visualisation

Sets output timezone, undefined for UTC.

Parameter

Name	Type	Optional	Description
outputTimezone			Timezone for datetime output.

Inherited from: module:meteoJS/timeline/visualisation.Visualisation#setOutputTimezone
Returns: This.

protected

timeToText(time, format) → string

Converts a Date-object to a string.

Parameters

Name	Type	Optional	Description
time			Time.
format			Format string, passed to the .

Inherited from: module:meteoJS/timeline/visualisation.Visualisation#timeToText
Returns: String.