global.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Global</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">Global</h1>
  17. <section>
  18. <header>
  19. <h2></h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <dl class="details">
  24. </dl>
  25. </div>
  26. <h3 class="subsection-title">Methods</h3>
  27. <h4 class="name" id="doRenderBody"><span class="type-signature">(async) </span>doRenderBody<span class="signature">()</span><span class="type-signature"></span></h4>
  28. <div class="description">
  29. for overriding
  30. </div>
  31. <dl class="details">
  32. <dt class="tag-source">Source:</dt>
  33. <dd class="tag-source"><ul class="dummy"><li>
  34. <a href="widgets_collapsible_widget.js.html">widgets/collapsible_widget.js</a>, <a href="widgets_collapsible_widget.js.html#line34">line 34</a>
  35. </li></ul></dd>
  36. </dl>
  37. <h3 class="subsection-title">Type Definitions</h3>
  38. <h4 class="name" id="ToolbarButtonOptions">ToolbarButtonOptions</h4>
  39. <h5>Type:</h5>
  40. <ul>
  41. <li>
  42. <span class="param-type">Object</span>
  43. </li>
  44. </ul>
  45. <h5 class="subsection-title">Properties:</h5>
  46. <table class="props">
  47. <thead>
  48. <tr>
  49. <th>Name</th>
  50. <th>Type</th>
  51. <th>Attributes</th>
  52. <th class="last">Description</th>
  53. </tr>
  54. </thead>
  55. <tbody>
  56. <tr>
  57. <td class="name"><code>title</code></td>
  58. <td class="type">
  59. <span class="param-type">string</span>
  60. </td>
  61. <td class="attributes">
  62. </td>
  63. <td class="description last"></td>
  64. </tr>
  65. <tr>
  66. <td class="name"><code>icon</code></td>
  67. <td class="type">
  68. <span class="param-type">string</span>
  69. </td>
  70. <td class="attributes">
  71. &lt;optional><br>
  72. </td>
  73. <td class="description last">name of the boxicon to be used (e.g. "time" for "bx-time" icon)</td>
  74. </tr>
  75. <tr>
  76. <td class="name"><code>action</code></td>
  77. <td class="type">
  78. <span class="param-type">function</span>
  79. </td>
  80. <td class="attributes">
  81. </td>
  82. <td class="description last">callback handling the click on the button</td>
  83. </tr>
  84. <tr>
  85. <td class="name"><code>shortcut</code></td>
  86. <td class="type">
  87. <span class="param-type">string</span>
  88. </td>
  89. <td class="attributes">
  90. &lt;optional><br>
  91. </td>
  92. <td class="description last">keyboard shortcut for the button, e.g. "alt+t"</td>
  93. </tr>
  94. </tbody>
  95. </table>
  96. <dl class="details">
  97. <dt class="tag-source">Source:</dt>
  98. <dd class="tag-source"><ul class="dummy"><li>
  99. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line104">line 104</a>
  100. </li></ul></dd>
  101. </dl>
  102. </article>
  103. </section>
  104. </div>
  105. <nav>
  106. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
  107. </nav>
  108. <br class="clear">
  109. <footer>
  110. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a>
  111. </footer>
  112. <script> prettyPrint(); </script>
  113. <script src="scripts/linenumber.js"> </script>
  114. </body>
  115. </html>