mirror of
https://github.com/nasa/openmct.git
synced 2025-02-22 10:11:06 +00:00
[Time Conductor] Add JSDoc to plot
Add JSDoc to scripts/methods added to the Plot plug-in to support integration of custom formats for timestamps.
This commit is contained in:
parent
0ad22f6842
commit
0541f6edfa
@ -74,7 +74,8 @@ define(
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update axis options to reflect current metadata.
|
* Update axis options to reflect current metadata.
|
||||||
* @memberof platform/features/plot.PlotAxis
|
* @param {TelemetryMetadata[]} metadata objects describing
|
||||||
|
* applicable telemetry
|
||||||
*/
|
*/
|
||||||
PlotAxis.prototype.updateMetadata = function (metadatas) {
|
PlotAxis.prototype.updateMetadata = function (metadatas) {
|
||||||
var axisType = this.axisType,
|
var axisType = this.axisType,
|
||||||
@ -114,6 +115,12 @@ define(
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Change the domain/range selection for this axis. If the
|
||||||
|
* provided `key` is not recognized as an option, no change
|
||||||
|
* will occur.
|
||||||
|
* @param {string} key the identifier for the domain/range
|
||||||
|
*/
|
||||||
PlotAxis.prototype.chooseOption = function (key) {
|
PlotAxis.prototype.chooseOption = function (key) {
|
||||||
var self = this;
|
var self = this;
|
||||||
this.options.forEach(function (option) {
|
this.options.forEach(function (option) {
|
||||||
|
@ -26,14 +26,33 @@ define(
|
|||||||
function () {
|
function () {
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Wraps a `TelemetryFormatter` to provide formats for domain and
|
||||||
|
* range values; provides a single place to track domain/range
|
||||||
|
* formats within a plot, allowing other plot elements to simply
|
||||||
|
* request that values be formatted.
|
||||||
|
* @constructor
|
||||||
|
* @memberof platform/features/plot
|
||||||
|
* @implements {platform/telemetry.TelemetryFormatter}
|
||||||
|
* @param {TelemetryFormatter} telemetryFormatter the formatter
|
||||||
|
* to wrap.
|
||||||
|
*/
|
||||||
function PlotTelemetryFormatter(telemetryFormatter) {
|
function PlotTelemetryFormatter(telemetryFormatter) {
|
||||||
this.telemetryFormatter = telemetryFormatter;
|
this.telemetryFormatter = telemetryFormatter;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specify the format to use for domain values.
|
||||||
|
* @param {string} key the format's identifier
|
||||||
|
*/
|
||||||
PlotTelemetryFormatter.prototype.setDomainFormat = function (key) {
|
PlotTelemetryFormatter.prototype.setDomainFormat = function (key) {
|
||||||
this.domainFormat = key;
|
this.domainFormat = key;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Specify the format to use for range values.
|
||||||
|
* @param {string} key the format's identifier
|
||||||
|
*/
|
||||||
PlotTelemetryFormatter.prototype.setRangeFormat = function (key) {
|
PlotTelemetryFormatter.prototype.setRangeFormat = function (key) {
|
||||||
this.rangeFormat = key;
|
this.rangeFormat = key;
|
||||||
};
|
};
|
||||||
|
Loading…
x
Reference in New Issue
Block a user