Class: ClockViewModel

ClockViewModel

new ClockViewModel(clockopt)

A view model which exposes a Clock for user interfaces.
Parameters:
Name Type Attributes Description
clock Clock <optional>
 The clock object wrapped by this view model, if undefined a new instance will be created.
Source:
See:

Members

canAnimate :Boolean

Gets or sets whether the clock can animate. See Clock#canAnimate. This property is observable.
Type:
  • Boolean
Source:

clock :Clock

Gets the underlying Clock.
Type:
Source:

clockRange :ClockRange

Gets or sets the clock range setting. See Clock#clockRange. This property is observable.
Type:
  • ClockRange
Source:

clockStep :ClockStep

Gets or sets the clock step setting. See Clock#clockStep. This property is observable.
Type:
  • ClockStep
Source:

currentTime :JulianDate

Gets or sets the current time. See Clock#currentTime. This property is observable.
Type:
Source:

multiplier :Number

Gets or sets the clock multiplier. See Clock#multiplier. This property is observable.
Type:
  • Number
Source:

shouldAnimate :Boolean

Gets or sets whether the clock should animate. See Clock#shouldAnimate. This property is observable.
Type:
  • Boolean
Source:

startTime :JulianDate

Gets or sets the start time of the clock. See Clock#startTime. This property is observable.
Type:
Source:

stopTime :JulianDate

Gets or sets the stop time of the clock. See Clock#stopTime. This property is observable.
Type:
Source:

systemTime :JulianDate

Gets the current system time. This property is observable.
Type:
Source:

Methods

destroy()

Destroys the view model. Should be called to properly clean up the view model when it is no longer needed.
Source:

isDestroyed() → {Boolean}

Source:
Returns:
true if the object has been destroyed, false otherwise.
Type
Boolean

synchronize()

Updates the view model with the contents of the underlying clock. Can be called to force an update of the viewModel if the underlying clock has changed and Clock.tick has not yet been called.
Source: