-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi_ViewDefinition.js.html
99 lines (76 loc) · 3.61 KB
/
api_ViewDefinition.js.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: api/ViewDefinition.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: api/ViewDefinition.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>define(function () {
/**
* Defines a kind of view.
* @interface
*/
function ViewDefinition() {
}
/**
* Get metadata about this view, as may be used in the user interface
* to present options for this view.
* @param {*} object the object to be shown in this view
* @returns {mct.ViewMetadata} metadata about this view
*/
ViewDefinition.prototype.metadata = function (object) {
};
/**
* Instantiate a new view of this object. Callers of this method are
* responsible for calling `canView` before instantiating views in this
* manner.
*
* @param {*} object the object to be shown in this view
* @returns {mct.View} a view of this object
*/
ViewDefinition.prototype.view = function (object) {
};
/**
* Check if this view is capable of showing this object. Users of
* views should use this method before calling `show`.
*
* Subclasses should override this method to control the applicability
* of this view to other objects.
*
* @param {*} object the object to be shown in this view
* @returns {boolean} true if this view is applicable to this object
*/
ViewDefinition.prototype.canView = function (object) {
};
return ViewDefinition;
});
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-openmct.html">openmct</a></li></ul><h3>Classes</h3><ul><li><a href="module-openmct.MCT.html">MCT</a></li><li><a href="module-openmct.Type.html">Type</a></li></ul><h3>Events</h3><ul><li><a href="global.html#event:TimeConductor#boundsThestarttime,endtime,orbothhavebeenupdated">TimeConductor#bounds The start time, end time, or
both have been updated</a></li><li><a href="TimeConductor.html#event:timeOfInterestTheTimeofInteresthasmoved.">timeOfInterest The Time of Interest has moved.</a></li><li><a href="global.html#event:TimeConductor#followTheTimeConductorhastoggledintooroutoffollowmode.">TimeConductor#follow The TimeConductor has toggled
into or out of follow mode.</a></li><li><a href="global.html#event:TimeConductor#timeSystemThetimesystemusedbythetimeconductorhaschanged.AchangeinTimeSystemwillalwaysbefollowedbyaboundseventspecifyingnewquerybounds">TimeConductor#timeSystem The time system used by the time
conductor has changed. A change in Time System will always be
followed by a bounds event specifying new query bounds</a></li></ul><h3>Interfaces</h3><ul><li><a href="module-openmct.Selection.html">Selection</a></li><li><a href="module-openmct.TimeConductor.html">TimeConductor</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Sep 02 2016 15:10:29 GMT-0700 (PDT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>