ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-22 17:08:57 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

[JSDoc] Add annotations

Browse Source 
Bulk-add JSDoc annotations, WTD-1482.
This commit is contained in:
Victor Woeltjen
2015-08-07 11:44:54 -07:00
parent 14f97eae9c
commit c08a460d30
239 changed files with 939 additions and 185 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
platform/features/plot/src/elements/PlotPreparer.js
View File

@ -36,6 +36,7 @@ define(
* preparing them to be rendered. It creates a WebGL-plottable
* Float32Array for each trace, and tracks the boundaries of the
* data sets (since this is convenient to do during the same pass).
* @memberof platform/features/plot
* @constructor
* @param {Telemetry[]} datas telemetry data objects
* @param {string} domain the key to use when looking up domain values
@ -92,6 +93,7 @@ define(
* data sets. This is given as a two-element array where the
* first element is domain, and second is range.
* @returns {number[]} the dimensions which bound this data set
* @memberof platform/features/plot.PlotPreparer#
*/
getDimensions: function () {
return [max[0] - min[0], max[1] - min[1]];
@ -102,6 +104,7 @@ define(
* first element is domain, and second is range.
* The domain value here is not adjusted by the domain offset.
* @returns {number[]} the origin of this data set's boundary
* @memberof platform/features/plot.PlotPreparer#
*/
getOrigin: function () {
return min;
@ -112,6 +115,7 @@ define(
* preparer, in order to minimize loss-of-precision due to
* conversion to the 32-bit float format needed by WebGL.
* @returns {number} the domain offset
* @memberof platform/features/plot.PlotPreparer#
*/
getDomainOffset: function () {
return domainOffset;
@ -132,6 +136,7 @@ define(
* cause aliasing artifacts (particularly for timestamps)
*
* @returns {Float32Array[]} the buffers for these traces
* @memberof platform/features/plot.PlotPreparer#
*/
getBuffers: function () {
return buffers;
@ -142,4 +147,4 @@ define(
return PlotPreparer;
}
);
);