DashboardCoreAPI.html 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Interface: DashboardCoreAPI</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Interface: DashboardCoreAPI</h1>
  17. <section>
  18. <header>
  19. <h2>DashboardCoreAPI</h2>
  20. <div class="class-description">API class that is used to manage a dashboard.</div>
  21. </header>
  22. <article>
  23. <div class="container-overview">
  24. <dl class="details">
  25. </dl>
  26. </div>
  27. <h3 class="subsection-title">Methods</h3>
  28. <h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
  29. <div class="description">
  30. Destroys the dashboard.
  31. </div>
  32. <dl class="details">
  33. </dl>
  34. <h4 class="name" id="getFeature"><span class="type-signature"></span>getFeature<span class="signature">(name)</span><span class="type-signature"> &rarr; {object}</span></h4>
  35. <div class="description">
  36. Returns the feature with the specified feature name.
  37. </div>
  38. <h5>Parameters:</h5>
  39. <table class="params">
  40. <thead>
  41. <tr>
  42. <th>Name</th>
  43. <th>Type</th>
  44. <th class="last">Description</th>
  45. </tr>
  46. </thead>
  47. <tbody>
  48. <tr>
  49. <td class="name"><code>name</code></td>
  50. <td class="type">
  51. <span class="param-type">string</span>
  52. </td>
  53. <td class="description last">Unique name of the feature</td>
  54. </tr>
  55. </tbody>
  56. </table>
  57. <dl class="details">
  58. </dl>
  59. <h5>Returns:</h5>
  60. <div class="param-desc">
  61. Feature API object; undefined if not found
  62. </div>
  63. <dl>
  64. <dt>
  65. Type
  66. </dt>
  67. <dd>
  68. <span class="param-type">object</span>
  69. </dd>
  70. </dl>
  71. </article>
  72. </section>
  73. </div>
  74. <nav>
  75. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AppFactory.html">AppFactory</a></li></ul><h3>Interfaces</h3><ul><li><a href="CanvasAPI.html">CanvasAPI</a></li><li><a href="ContentAPI.html">ContentAPI</a></li><li><a href="ContentStoreAPI.html">ContentStoreAPI</a></li><li><a href="DashboardCoreAPI.html">DashboardCoreAPI</a></li><li><a href="DashboardPreferencesAPI.html">DashboardPreferencesAPI</a></li><li><a href="DashboardSettingsAPI.html">DashboardSettingsAPI</a></li><li><a href="PropertiesAPI.html">PropertiesAPI</a></li><li><a href="RendererAPI.html">RendererAPI</a></li><li><a href="SaveAPI.html">SaveAPI</a></li><li><a href="SerializerAPI.html">SerializerAPI</a></li><li><a href="StateAPI.html">StateAPI</a></li><li><a href="TransactionAPI.html">TransactionAPI</a></li><li><a href="UserProfileAPI.html">UserProfileAPI</a></li></ul>
  76. </nav>
  77. <br class="clear">
  78. <footer>
  79. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu May 05 2022 17:56:07 GMT+0000 (UTC)
  80. </footer>
  81. <script> prettyPrint(); </script>
  82. <script src="scripts/linenumber.js"> </script>
  83. </body>
  84. </html>