From 92118d353e9c57b608e12c34fa8ae747dec0021f Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Wed, 7 Sep 2016 11:24:01 -0700 Subject: [PATCH] [API] Add Time Conductor example --- API.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/API.md b/API.md index 48ca7515d2..52072979c7 100644 --- a/API.md +++ b/API.md @@ -142,6 +142,19 @@ openmct.composition(myObject).load().then(function (childObjects) { }); ``` +### Synchronizing with the Time Conductor + +Views which wish to remain synchronized with the state of Open MCT's +time conductor should utilize +[`openmct.conductor`]{@link module:openmct.TimeConductor}: + +``` +openmct.conductor.on('bounds', function (newBounds) { + requestTelemetry(newBounds.start, newBounds.end).then(displayTelemetry); +}); +``` + + ## Plugins While you can register new features with Open MCT directly, it is generally