ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-14 13:18:15 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

[API] Fix event memberofs in TimeConductor

Browse Source
This commit is contained in:
Victor Woeltjen
2016-09-06 09:45:24 -07:00
parent 018bd022cc
commit 2a3a61da86
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/api/TimeConductor.js
View File

@ -86,7 +86,7 @@ define(['EventEmitter'], function (EventEmitter) {
* time conductor ticks, regularly updating the bounds from a timing * time conductor ticks, regularly updating the bounds from a timing
* source appropriate to the selected time system and mode of the time * source appropriate to the selected time system and mode of the time
* conductor. * conductor.
* @fires TimeConductor#follow * @fires module:openmct.TimeConductor~follow
* @param {boolean} followMode * @param {boolean} followMode
* @returns {boolean} * @returns {boolean}
* @memberof module:openmct.TimeConductor# * @memberof module:openmct.TimeConductor#
@ -97,7 +97,8 @@ define(['EventEmitter'], function (EventEmitter) {
this.followMode = followMode; this.followMode = followMode;
/** /**
* The TimeConductor has toggled into or out of follow mode. * The TimeConductor has toggled into or out of follow mode.
* @event module:openmct.TimeConductor~follow * @event follow
* @memberof module:openmct.TimeConductor~
* @property {boolean} followMode true if follow mode is * @property {boolean} followMode true if follow mode is
* enabled, otherwise false. * enabled, otherwise false.
*/ */
@ -119,7 +120,7 @@ define(['EventEmitter'], function (EventEmitter) {
* *
* @param {module:openmct.TimeConductorBounds~TimeConductorBounds} newBounds * @param {module:openmct.TimeConductorBounds~TimeConductorBounds} newBounds
* @throws {Error} Validation error * @throws {Error} Validation error
* @fires TimeConductor#bounds * @fires module:openmct.TimeConductor~bounds
* @returns {module:openmct.TimeConductorBounds~TimeConductorBounds} * @returns {module:openmct.TimeConductorBounds~TimeConductorBounds}
* @memberof module:openmct.TimeConductor# * @memberof module:openmct.TimeConductor#
* @method bounds * @method bounds
@ -130,7 +131,8 @@ define(['EventEmitter'], function (EventEmitter) {
this.boundsVal = newBounds; this.boundsVal = newBounds;
/** /**
* The start time, end time, or both have been updated. * The start time, end time, or both have been updated.
* @event module:openmct.TimeConductor~bounds * @event bounds
* @memberof module:openmct.TimeConductor~
* @property {TimeConductorBounds} bounds * @property {TimeConductorBounds} bounds
*/ */
this.emit('bounds', this.boundsVal); this.emit('bounds', this.boundsVal);
@ -176,7 +178,7 @@ define(['EventEmitter'], function (EventEmitter) {
* Get or set the Time of Interest. The Time of Interest is the temporal * Get or set the Time of Interest. The Time of Interest is the temporal
* focus of the current view. It can be manipulated by the user from the * focus of the current view. It can be manipulated by the user from the
* time conductor or from other views. * time conductor or from other views.
* @fires TimeConductor#timeOfInterest * @fires module:openmct.TimeConductor~timeOfInterest
* @param newTOI * @param newTOI
* @returns {number} the current time of interest * @returns {number} the current time of interest
* @memberof module:openmct.TimeConductor# * @memberof module:openmct.TimeConductor#
@ -187,7 +189,8 @@ define(['EventEmitter'], function (EventEmitter) {
this.toi = newTOI; this.toi = newTOI;
/** /**
* The Time of Interest has moved. * The Time of Interest has moved.
* @event module:openmctTimeConductor~timeOfInterest * @event timeOfInterest
* @memberof module:openmct.TimeConductor~
* @property {number} Current time of interest * @property {number} Current time of interest
*/ */
this.emit('timeOfInterest', this.toi); this.emit('timeOfInterest', this.toi);