From a3c3f997cff1cae0718c06012b0dc53cefea7d2d Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Wed, 7 Sep 2016 13:25:05 -0700 Subject: [PATCH] [API] Move down TC example ...to come after telemetry usage example --- API.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/API.md b/API.md index 5ce628889e..24083e1cf6 100644 --- a/API.md +++ b/API.md @@ -203,18 +203,6 @@ 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); -}); -``` - ### Support Common Gestures Custom views may also want to support common gestures using the @@ -247,6 +235,24 @@ openmct.objects.observe(myDomainObject, "name", function (newName) { }); ``` +### Using Telemetry + +Very often in Open MCT, you wish to work with telemetry data (for instance, +to display it in a custom visualization.) + + +### 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