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

[Plot] Add clarifying comments

Browse Source 
Add clarifying comments to PlotLine, added to simplify merging
of real-time with historical data, WTD-806.
This commit is contained in:
Victor Woeltjen
2015-04-17 14:04:46 -07:00
parent 7370b1a87f
commit 9f390de213
1 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
platform/features/plot/src/elements/PlotLine.js
View File

@ -45,9 +45,11 @@ define(
} }
return { return {
getLineBuffer: function () { /**
return buffer; * Add a point to this plot line.
}, * @param {number} domainValue the domain value
* @param {number} rangeValue the range value
*/
addPoint: function (domainValue, rangeValue) { addPoint: function (domainValue, rangeValue) {
var index = buffer.findInsertionIndex(domainValue); var index = buffer.findInsertionIndex(domainValue);
if (index > -1) { if (index > -1) {
@ -60,6 +62,14 @@ define(
} }
} }
}, },
/**
* Add a series of telemetry data to this plot line.
* @param {TelemetrySeries} series the data series
* @param {string} [domain] the key indicating which domain
* to use when looking up data from this series
* @param {string} [range] the key indicating which range
* to use when looking up data from this series
*/
addSeries: function (series, domain, range) { addSeries: function (series, domain, range) {
// Should try to add via insertion if a // Should try to add via insertion if a
// clear insertion point is available; // clear insertion point is available;