[Plot] Add JSDoc for stack plots

Add JSDoc for new classes introduced (and revised interfaces
exposed by existing classes) to support stacked plots,
WTD-625.
This commit is contained in:
Victor Woeltjen
2014-12-12 14:37:06 -08:00
parent 80852177c7
commit b1158ce230
6 changed files with 239 additions and 30 deletions

View File

@ -7,31 +7,16 @@ define(
[
"./elements/PlotPreparer",
"./elements/PlotPalette",
"./elements/PlotPanZoomStack",
"./elements/PlotPosition",
"./elements/PlotTickGenerator",
"./elements/PlotFormatter",
"./elements/PlotAxis",
"./modes/PlotModeOptions"
],
function (
PlotPreparer,
PlotPalette,
PlotPanZoomStack,
PlotPosition,
PlotTickGenerator,
PlotFormatter,
PlotAxis,
PlotModeOptions
) {
function (PlotPreparer, PlotPalette, PlotAxis, PlotModeOptions) {
"use strict";
var AXIS_DEFAULTS = [
{ "name": "Time" },
{ "name": "Value" }
],
DOMAIN_TICKS = 5,
RANGE_TICKS = 7;
];
/**
* The PlotController is responsible for any computation/logic
@ -90,10 +75,14 @@ define(
modeOptions.getModeHandler().plotTelemetry(prepared);
}
// Trigger an update of a specific subplot;
// used in a loop to update all subplots.
function updateSubplot(subplot) {
subplot.update();
}
// Set up available modes (stacked/overlaid), based on the
// set of telemetry objects in this plot view.
function setupModes(telemetryObjects) {
modeOptions = new PlotModeOptions(telemetryObjects || []);
}