[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:
Victor Woeltjen
2015-10-28 08:47:04 -07:00
parent 0ad22f6842
commit 0541f6edfa
2 changed files with 27 additions and 1 deletions

View File

@ -26,14 +26,33 @@ define(
function () {
'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) {
this.telemetryFormatter = telemetryFormatter;
}
/**
* Specify the format to use for domain values.
* @param {string} key the format's identifier
*/
PlotTelemetryFormatter.prototype.setDomainFormat = function (key) {
this.domainFormat = key;
};
/**
* Specify the format to use for range values.
* @param {string} key the format's identifier
*/
PlotTelemetryFormatter.prototype.setRangeFormat = function (key) {
this.rangeFormat = key;
};