David Tsay
bbb271a678
clarify value hints ( #2673 )
...
remove confusing comments regarding domain - input and range - output
2020-05-15 14:48:25 -07:00
Shefali Joshi
7db4ac8ff6
Fixes API link. ( #2618 )
2020-01-08 12:38:12 -08:00
Andrew Henry
f86b8cce16
Merge branch 'topic-core-refactor' into tcr-master
2019-12-06 14:37:18 -08:00
Shefali Joshi
55327a0150
[refactor-doc] Updates the API doc for new API usage. ( #2553 )
...
* [refactor-doc] Updates the API doc to new API usage.
2019-12-06 09:40:24 -08:00
MarvinJWendt
b36d1ca2bc
Grammar fixes
...
Sources:
to experiment: https://en.oxforddictionaries.com/definition/experiment
2018-11-24 02:43:25 +01:00
Andrew Henry
e9643ad07f
Added brief readmes for all plugins. ( #2184 )
2018-10-03 18:55:27 -07:00
Andrew Henry
3246480f82
Indicators api ( #1837 )
...
* [API] Added Indicators API
* [Indicators] Converted Follow Indicator to new Indicators API
* [Indicators] Converted URL Indicator to new Indicators API
* [Indicators] Changes to some legacy indicators for compatibility with new Indicators API
* [Indicators] Addressed code review items from https://github.com/nasa/openmct/pull/1837
* Updated tests for URL Indicator
* Adding Indicator API spec
* Address linting issues
* Switched to direct DOM manipulation rather than template compilation to avoid an unnecessary extra holder element
* Updated documentation to reflect changes to API
* Indicators api styling (#2076 )
Updated styling for Indicators
* Update API TOC
* Fix color of items w-mct-example areas of Style Guide
Fixes #1837
* Status class refactoring and cleanups
Fixes #1837
- Significant cleanups and name refactoring to allow more
concise selector definitions, with changes in js, html and scss files;
- Updates in Style Guide > Status page, with some content
reorganization and clarification;
* Corrected out of date API
* de-zeptoed Indicator API test spec
* Remove promise from URLIndicator
* Separated legacy indicators support
* Updated Indicator specs to Jasmine 3
* Fixed checkstyle and lint issues
* Moved legacy indicators support to adapter folder
* Various fixes for Indicators
Fixes #1837
- Added SASS constants for Indicator colors;
- Removed commented code;
- Removed unused indicator classes from _messages.scss
- Fixed missing s-status-on class;
* Significant revisions to Style Guide Indicators content
Fixes #1837
- Better documentation including recommendations;
- Better and more concrete examples;
* Style Guide example tweaks
Fixes #1837
* Refinement to Style Guide Status and Limits content
Fixes #1837
- More detail and clarification on Status and Limits;
* Cleanup code
Fixes #1837
- Remove commented styles;
- Line return refinements;
2018-07-16 15:21:38 -07:00
Pete Richards
241d75e393
Summary widget telemetry provider ( #1943 )
...
* Summary Widgets produce telemetry
Adds a summary widget telemetry provider and metadata provider to
the summary widget plugin. Supports subscribing to realtime
summary widget evaluations without needing the summary widget UI.
Fixes https://github.com/nasa/openmct/issues/1893
* Use metadata to determine telemetry types
Update summary widgets to use metadata to determine telemetry types.
fixes https://github.com/nasa/openmct/issues/1801
fixes https://github.com/nasa/openmct/issues/1883
* shared evaluators, more telemetry values
Share summary widget evaluators to reduce number of times a object
needs to be loaded when dealing with multiple queries.
Fixes https://github.com/nasa/openmct/issues/1893
* Separate view for editing
fixes https://github.com/nasa/openmct/issues/1827
* Update summary widget tests
* Workaround incorrect telemetry capability application
In the case where an object support telemetry but does not support
the specific type of telemetry request i.e. a summary widget has
request for lad but not for historical, an error will be thrown.
* use makeKeyString
use makeKeyString when storing configuration of objects in summary
widgets. Otherwise, namespace information would not be properly
tracked. Fixes https://github.com/nasa/openmct/issues/1949
* [Tests] coverage for EvaluatorPool
Add tests for EvaluatorPool and fix a bug where the same evaluator
was returned for different objects.
* Add copyright headers
* Update metadata provider registration
* attach title to a element
* Only evaluate realtime when all data available
* Prevent update after destroy
* Don't error when no telemetry exists
* Don't mutate on view destroy
Improper removal of listeners was triggering a mutation on view
destroy, which happens after the initial persist call to server
that occurs when saving. This mutation occurs after the edit
transaction has been closed, which would result in an immediate
persist call. This can cause a race condition when the first
persist call has not completed, which causes a 409 conflict and
a persistence error.
Fix #1827
* Spec for telemetryProvider
* update on time system change
Summary Widgets now resubscribe and requery for data when time
system changes, in order to ensure they're showing the correct
data to the user.
* link to telemetry request details
* rename variables, update jsdoc
Addresses comments in https://github.com/nasa/openmct/pull/1943
2018-04-20 15:46:09 -07:00
Pete Richards
8db75bf41e
[API] Support dynamic telemetry metadata ( #1941 )
...
* [API] Support dynamic telemetry metadata
Add support for dynamic telemetry metadata via custom telemetry
metadata providers.
The metadata provider API should be considered unstable in it's
current invocation.
* Perform deprecation checking at runtime
* SWG uses telemetry metadata provider
* Don't throw with no matched metadata provider
* Update API docs
* Add license header
* Combine metadata providers with general telemetry providers
* Replace `TelemetryAPI.canProvideTelemetry` with
`TelemetryAPI.isTelemetryObject`.
* CanProvideTelemetry is deprecated
* Change SWG inputs to numberfield
2018-03-21 14:18:08 -07:00
Even Stensberg
91b150c064
icon -> cssClass
2017-11-24 10:04:59 -08:00
Even Stensberg
9506d309b0
[TEST] Add Unit Test for URLIndicator
...
Adds the first test for the URLIndicator.
[DOCS] fix docs api indenting
fix linting
fix linting
fix docs
2017-11-24 10:04:59 -08:00
Even Stensberg
c9bd60f50e
[BUILD] Adds URLIndicator along with documentation
...
Adds URLIndicator to the build, testable adding
`openmct.install(new openmct.plugins.URLIndicatorPlugin({
url: 'http://localhost:8080/ ',
icon: 'check',
interval: 15000,
label: 'Localhost'
}))`
to the openmct file. Also added Documentation about the plugin.
2017-11-24 10:04:59 -08:00
Victor Woeltjen
4b86439b8a
[Documentation] Fix typo
...
Omitting checklist; changes to documentation only
2017-08-29 09:43:08 -07:00
Victor Woeltjen
95188f6ce6
[Documentation] Document image hint
2017-05-31 15:57:20 -07:00
Pete Richards
749a2ba088
[Docs] Update Time API docs
...
Update time API docs to accurately reflect usage of the time API.
2017-05-16 14:56:56 -07:00
Pete Richards
a9067892f4
[Docs] Update format docs
...
Remove examples of format implementations. The docs stated
incorrectly that UTCTimeFormat used the additional parameters
for the format method when it did not actually use those
parameters.
With our current landscape of telemetry providers, parse can
frequently be called on an already parsed value, so added
documentation to highlight the importance of an idempotent
parse method.
Cleanup related to change of file locations in:
https://github.com/nasa/openmct/issues/1574
2017-05-10 17:47:14 -07:00
Pete Richards
258020624c
Merge pull request #1571 from nasa/standardize-type-name
...
[Types] label -> name
2017-05-10 14:51:25 -07:00
Pete Richards
c674627ebd
[Docs] x/y -> domain/range
...
Update docs to reference domain and range. Also added additional
documentation for the Telemetry API based on a previous draft of
the docs.
https://github.com/nasa/openmct/issues/1546
2017-05-09 18:36:37 -07:00
Pete Richards
c5161887e2
[Types] label -> name
...
Change label to name, log a warning to console if a typeDef
is registered with a label.
Fixes https://github.com/nasa/openmct/issues/1568 .
2017-05-09 17:55:15 -07:00
Henry
37c9c6dfaf
[Time Conductor] Made corrections to Time API documentation. Added a key field to the NumberFormat so that it can be used with the new format registration mechanism
2017-05-01 11:27:00 -07:00
Henry
0981e99256
[Time API] Updated API documentation to include new Time API options.
2017-04-30 23:21:48 -07:00
Henry
af622599a5
[Docs] Updated API docs to reflect V1 public API
...
Cleaned up docs. Addresses #1473
2017-03-28 12:03:00 -07:00
Andrew Henry
7e8e861468
Merge pull request #1372 from nasa/api-review-followup-1122
...
[API] Address review followup items
2017-01-18 21:42:22 -08:00
Victor Woeltjen
d522d105ad
[Plugins] Document plugins
2017-01-13 11:57:00 -08:00
Victor Woeltjen
381f3d9b69
[API] Document default composition provider
...
https://github.com/nasa/openmct/issues/1122#issuecomment-252115292
Fixes #1122
2016-12-23 16:40:21 -08:00
Victor Woeltjen
1666c42f78
[Plugins] Document plugins
2016-12-23 13:05:34 -08:00
Victor Woeltjen
9a0fcc045c
[API] Simplify type registration
...
https://github.com/nasa/openmct/pull/1302#discussion_r85417042
2016-10-27 15:30:34 -07:00
Victor Woeltjen
833bad067e
[API] Add creatable property to example
2016-10-27 12:16:57 -07:00
Victor Woeltjen
64ff463200
Revert "Revert "Async root registration""
2016-10-19 14:55:07 -07:00
Victor Woeltjen
4eca80a770
Revert "Async root registration"
2016-10-18 10:48:26 -07:00
Pete Richards
6ec858b237
[Docs] Update root registration in README.
...
https://github.com/nasa/openmct/issues/1251
2016-10-14 12:38:52 -07:00
Victor Woeltjen
b0e842863d
Squashed commit of the following:
...
commit 6b5528a4fc2af993b0bcc762d58b5a219c9348d9f8819ee5b0fa90f8819ee946ce6c6385c3ef0264d864044b1b627d5b6f13f5215b2c0e9aeedd7d8d264208e28018c13b1fe931912b66a4dc874ae72b66a4d60470c810b85dc874ae7afd34e07b9c27c0c5fc5c07aeb62976c9eed102492976c9e70354d2b00e67061f9d6deb1de9d182a7810150d0d71c0999b512774ae03c3e1defee89537b9ac3e7fbf2178e2b430094fea3f77f79abe849f43bb6e03d8f3c3d910e0956811adcbcc5a4e2ca27b6a51887bb04d9db4a7c3bfae0a6471fe7453b0d0526627b43e35179a359634be5653bd8dd9928b5f1f9855511965304fb742d649d386a47df095b0012ca48c134e07b938d230230aa94901846e6c104b8326900aed01d3a93f41fa93f41f1c3#1124 .
commit aed01d3a2309c73ef5f8b1b6080161cb93da5e15d0e7eb29a95e9e6099b06bd1af5c033f20c1bb9491214f26231fde82e6730ae0abcfc36fe1e775e0d4d9f9c4670cb1ec93666ab27302f6dfc5021e119e3a3529e0434ea5487a987d98b45ecc7b987d98b47e53974bd69aed8d331d61f446ed8d331cd37ce9bd97439d94d61f446002763f7dd021cad255ce833b4239fbd915ef89f455c9a0a469f6f926bd9762d79392aeaa9a5bda4917407550e6f48b44b44e388dfa8df28a9e19296b14106632c21c235032a571db41f6e64fe83e0da521c411f8fbe34ce952846cfdab4a614f152f55652fc46c42e57675bf956c3d0a44c48338e4c3412e8a4e1cfac4b90a64e9f5157341ed9d03e2631bdcfd773a7c0c24fdcba665583b1ed7821f1be517f3ea5e3dcadfa4fd97f4df73238745ecc7bb2ba3c3f997cf1ae3ce57d0616e2b4d770e7d812db7c074f29a0792118d353eb111eeff078042e84911631c4b5ddac6baf2dc1f4db7e12d45b1799c695e5761c889bc97cf26d438c4b83b7589d56f30c15a7279c5d8575d53ab83a34565e45b365950daa6cb60800c913e649567176d1df573b8c6bc4ca10e531338f025411cc6833c30a7a47a36d6851d0f0d635a129de73d0cf634a412702d7acf6469a500bf4482e5b009e8aafd0731ecc9705a5f2c7cc4a1262c02904a60817ce9bd969a8cafd2da7e6264ab7bccd0186264ab75f37a5cad2b4dc5027a5cad20ec4de069b39370abd5c1f92a3a61da86018bd022cc4739b36bc3c9b1035a6d676832847560c179eac3a20e8d69b51abcb248fea8151f5f22cdf21f3763341bceb4e20470a02272e3dc26c13096c3d1cac22af778145d5743eeb33af06f714bdcd592bd1035b5f62541ce33ced4bccfe37510dbabf27c41014dbd796f2bebbcc32c76d0ff2ec6690a1e0fb3611d1d4f36a7d90f96fbdd62e05fb57fe4185cdcab0850ccad5aaa6a23df9454ab5b1d3754b309f26b56#1110 and #1111
commit b4dc50295c02aa08a382dde3#1131 from nasa/open1094
Resolve synchronization issues with MutableObject
commit 382dde300ab1b8df402aa08a02aa08a3efc95d9c7d73c505#1121 from nasa/api-containment
[API] Containment
commit c95d9c79561147f3a2463e4d#1107 from nasa/api-type-forms
[API] Handle forms with a "properties" region
commit fd97f4db41b1b8df4d873228a838021dba551fc620f3b57ddd58787c44362a45893602a94ab44431cc9efdff31bd3c6665fb10e90519c0d341a8be978c439d81099c88b7ce1d6e664003e370d804fc4906c184821eb76be3d2e58934ba96f73fb4ce7819#1126 by an EventEmitter.
commit 2463e4d59fd73c505bea831ecc59d91de26d3c5d11409ce50993872ce0748861644f2dd4948f771b0656a298295a0b8295a0bed10656a298dafe2ce91d5014f30b248962d90a811487682607a57bf265b4781d31fe8d02https://github.com/nasa/openmct/pull/999#issuecomment-236045158
commit bfdbc71e401147f3aa47#1097 )
* Include all bundles in artifact
change bundle registry such that all bundles are immediately registered,
but must be specifically enabled. A default registry class enables bundles
that make sense for demonstration purposes.
Added methods to the registry to allow enabling and disabling of bundles
without having to load additional files.
* support alternate asset/worker paths
Change the gulp glob for assets to copy over a more minimal
set of files-- only css, fonts, and images. Results in a
smaller distributable archive.
Update stylesheet loader to use a constant for the assets path.
This can be customized at run time via MCT.setAssetPath() to
allow MCT to be hosted in various locations.
Update worker loader to support loading workers from blobs to
support packaging as standalone file.
* Load templates via requirejs
* [gulp] lazy-require where reasonable
Require things right before starting tasks to reduce gulp start up time.
* document setAssetPath
commit 719f9f45e8#1096 )
commit 95ef70a24c#1070 )
* [API] Allow selection
* [API] Keep in sync using model
* [API] Add selection as EventEmitter
* [API] Use selection from ToDo tutorial
* [API] Restore selection functionality
commit d5aa998b4c#1068 )
* [Objects] util for equality checking
Add a method for checking object equality, useful for other services.
* [Composition] Draft Composition API
Draft composition API. Composition collections provide an observable
for watching and mutating the composition of an object.
Composition providers implement the loading and modification of composition.
The default composition provider uses the composition attribute of
domain objects, while allowing other providers to implement their
own loading and mutation behavior.
* add todo about event listener bindings
* [Type] Add form property for defining form fields
* [tutorial] Add Composition tutorial
* provider doesn't have to implement events, load returns array of children
* use new composition in old api
* correct key name
* Override instantiate to provide model ids
Override instantiate in public API adapter to prevent making changes to
platform code. Instantiate now passes the id of the domain object with the
model so that capabilities can convert to a new-style domain object and use
that to detect functionality.
* Implement mutation capability with decorator
Implementation mutation capability override with decorator to adapter code
outside of platform. Capability override ensures that models are kept in
sync even though they are no longer shared objects.
* override composition cleanly
Override composition capability without making changes inside platform.
* cleanup after temporary collections
* remove unused try/catch
commit 7890fcae69#1079 )
* [API] use new-style objects consistently
* rewrite todo tutorial in test-api.html
* [API] Add API doc, update object API
* [Tutorials] Rename tutorials, remove old
* Fix Links
* updates
* initial
* hope this works
* Object Utils always return new objects instead of mutating existing objects
* keep domain object model in-sync when listening
Keep the domain object model in sync with the latest version when
listening for mutation events.
* Remove old-style plugins
* Update views to use new API
* Tidy Code
* Update API Docs
* Add Plugin API and Example
commit 18843cee48#1072 )
* [API] Allow selection
* [API] Keep in sync using model
* [API] Add selection as EventEmitter
* [API] Use selection from ToDo tutorial
* [API] Add appliesTo-style method
* [API] Remove destroy method, simplify show
* [View] Return a no-op
* [API] Use new applies-to checking
* [API] Rename TodoView to TodoRenderer
* [API] Rewire views
* [API] Wire up so that things work
* [API] Begin adding container
...to attempt to give views something to listen to for destroy-like
events
* [API] Begin using regions...
* [API] Begin working through Region stuff
* [API] Revise Region API
...for similarity with Marionette,
https://github.com/nasa/openmct/pull/1072#issuecomment-230902986
* [API] Begin separating View, ViewDefinition
* [API] Finish separating View/ViewDefinition
* [API] Update MCTView
...to reflect updates to Region/View/ViewDefinition APIs
* [API] Simplify View API
...merging closely-related populate/show methods, and restoring
compatibility with todo tutorial
* [API] Wire in from todo tutorial plugin
* [API] Switch back to region constants
* [API] Update method signature, add JSDoc
* [API] Update variable name
* [API] Remove unnecessary separate regions file
* [API] Relocate Region; not external api
* [API] Revert changes to api.js
...as these ended up becoming entirely superficial
commit 1879c122c7#1074 )
* [API] Allow selection
* [API] Keep in sync using model
* [API] Add selection as EventEmitter
* [API] Use selection from ToDo tutorial
* Object events prototype
* Added examples
* Transitional API
* Modified todo list code to work with new setters
* [API] Removed emitting of events on container when property changes value to remove ambiguity. Listeners must be listening to the same path used in the setter to catch changes
commit d7ddb96c4e#1078 )
* [Bundle] load filter with requirejs
* [Build] Use almond, wrap in UMD
Use almond for built version of application and wrap in UMD so that
it supports requirejs, commonjs, and basic browser loading.
* [Main] Can choose where to load app
MCT.run allows you to specify a dom element to load application
within. If element is not specified, will use body.
* [MCT] set class on injected div
Set class on injected div so extra markup is not required.
* [Build] Re-enable optimize
* Add minimal bootstrap example
commit bccd018d97b55668426d47a543b5b656fa#1062 from nasa/tc-redux
[Time Conductor] V2 Public API
commit 5b656faa9d8d2c489fa94366b0870d#933
commit 47a543beb706f87c1c944080#1067 from nasa/api-css
[API] Remove stylesheet from example
commit 06f87c147214a56eac9c41cd#1029 from nasa/api-toolbar-add-only
[API Prototype] Add toolbar
commit c9c41cdcc8370b51514a56ea14a56ea17ed51e6bfb2e7db7#1028 from nasa/api-view
[API Prototype] Support imperative view registration
commit b2e7db71cc96316ded51e6bfd51e6bfd925de7a96d475d76#1030 from nasa/api-tutorial/objects
Api tutorial/objects
commit d475d767d5a63e053399370b515c234a50f325cbdbe6a4efc113920d8802b6a8c514aae4a4704baabe0029e59a9cb273ef0aeec9b1cf4c1f96e84542c289a27305c94408079096316de6e42240a87ddcd891affe4821a618d1ce580a4e509a833f5de7a96ccc9c4e17b09a833f#1010 from nasa/api-type-proto
[API Prototype] Type registration
commit 09a833f524c4fec1a9c4e17b580a4e52b54ca2f519c4e17b9c4e17bfabd3e5d95d6bc70793ac2da6ef1d34234ca2f51d5e86ac80ddbd0525ba6b0ba79e958ffc03cb0ccb577205faa6bb136f2ae785a07e2fb8e555b531bdeb7ece5897e8a29c7a6eabc4fec1af6aa6996df3df0c660238f2b73b824e551954d986287aa034ce23385dc5d298
2016-09-30 17:31:33 -07:00
David Tsay
Shefali Joshi
Andrew Henry
MarvinJWendt
Andrew Henry
Pete Richards
Even Stensberg
Victor Woeltjen
Pete Richards