mirror of
				https://github.com/zadam/trilium.git
				synced 2025-10-27 09:39:00 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			617 lines
		
	
	
		
			6.9 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			617 lines
		
	
	
		
			6.9 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
| <!DOCTYPE html>
 | |
| <html lang="en">
 | |
| <head>
 | |
|     <meta charset="utf-8">
 | |
|     <title>JSDoc: Global</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">Global</h1>
 | |
| 
 | |
|     
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| <section>
 | |
| 
 | |
| <header>
 | |
|     
 | |
|         <h2></h2>
 | |
|         
 | |
|     
 | |
| </header>
 | |
| 
 | |
| <article>
 | |
|     <div class="container-overview">
 | |
|     
 | |
|         
 | |
| 
 | |
|         
 | |
| 
 | |
| 
 | |
| <dl class="details">
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| </dl>
 | |
| 
 | |
| 
 | |
|         
 | |
|     
 | |
|     </div>
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
|         <h3 class="subsection-title">Methods</h3>
 | |
| 
 | |
|         
 | |
|             
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
|     <h4 class="name" id="decorateWidget"><span class="type-signature"></span>decorateWidget<span class="signature">()</span><span class="type-signature"></span></h4>
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
| 
 | |
| 
 | |
| <div class="description">
 | |
|     for overriding
 | |
| </div>
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| <dl class="details">
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
|     <dt class="tag-source">Source:</dt>
 | |
|     <dd class="tag-source"><ul class="dummy"><li>
 | |
|         <a href="widgets_collapsible_widget.js.html">widgets/collapsible_widget.js</a>, <a href="widgets_collapsible_widget.js.html#line93">line 93</a>
 | |
|     </li></ul></dd>
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| </dl>
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
|         
 | |
|             
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
|     <h4 class="name" id="doRenderBody"><span class="type-signature">(async) </span>doRenderBody<span class="signature">()</span><span class="type-signature"></span></h4>
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
| 
 | |
| 
 | |
| <div class="description">
 | |
|     for overriding
 | |
| </div>
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| <dl class="details">
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
|     <dt class="tag-source">Source:</dt>
 | |
|     <dd class="tag-source"><ul class="dummy"><li>
 | |
|         <a href="widgets_collapsible_widget.js.html">widgets/collapsible_widget.js</a>, <a href="widgets_collapsible_widget.js.html#line96">line 96</a>
 | |
|     </li></ul></dd>
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| </dl>
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
|         
 | |
|             
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
|     <h4 class="name" id="widgetCollapsedStateChangedEvent"><span class="type-signature"></span>widgetCollapsedStateChangedEvent<span class="signature">()</span><span class="type-signature"></span></h4>
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
| 
 | |
| 
 | |
| <div class="description">
 | |
|     This event is used to synchronize collapsed state of all the tab-cached widgets since they are all rendered
 | |
| separately but should behave uniformly for the user.
 | |
| </div>
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| <dl class="details">
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
|     <dt class="tag-source">Source:</dt>
 | |
|     <dd class="tag-source"><ul class="dummy"><li>
 | |
|         <a href="widgets_collapsible_widget.js.html">widgets/collapsible_widget.js</a>, <a href="widgets_collapsible_widget.js.html#line86">line 86</a>
 | |
|     </li></ul></dd>
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| </dl>
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
|         
 | |
|     
 | |
| 
 | |
|     
 | |
|         <h3 class="subsection-title">Type Definitions</h3>
 | |
| 
 | |
|         
 | |
|                 
 | |
| <h4 class="name" id="ToolbarButtonOptions">ToolbarButtonOptions</h4>
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
|     <h5>Type:</h5>
 | |
|     <ul>
 | |
|         <li>
 | |
|             
 | |
| <span class="param-type">Object</span>
 | |
| 
 | |
| 
 | |
|         </li>
 | |
|     </ul>
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
|     <h5 class="subsection-title">Properties:</h5>
 | |
| 
 | |
|     
 | |
| 
 | |
| <table class="props">
 | |
|     <thead>
 | |
|     <tr>
 | |
|         
 | |
|         <th>Name</th>
 | |
|         
 | |
| 
 | |
|         <th>Type</th>
 | |
| 
 | |
|         
 | |
|         <th>Attributes</th>
 | |
|         
 | |
| 
 | |
|         
 | |
| 
 | |
|         <th class="last">Description</th>
 | |
|     </tr>
 | |
|     </thead>
 | |
| 
 | |
|     <tbody>
 | |
|     
 | |
| 
 | |
|         <tr>
 | |
|             
 | |
|                 <td class="name"><code>title</code></td>
 | |
|             
 | |
| 
 | |
|             <td class="type">
 | |
|             
 | |
|                 
 | |
| <span class="param-type">string</span>
 | |
| 
 | |
| 
 | |
|             
 | |
|             </td>
 | |
| 
 | |
|             
 | |
|                 <td class="attributes">
 | |
|                 
 | |
| 
 | |
|                 
 | |
|                 </td>
 | |
|             
 | |
| 
 | |
|             
 | |
| 
 | |
|             <td class="description last"></td>
 | |
|         </tr>
 | |
| 
 | |
|     
 | |
| 
 | |
|         <tr>
 | |
|             
 | |
|                 <td class="name"><code>icon</code></td>
 | |
|             
 | |
| 
 | |
|             <td class="type">
 | |
|             
 | |
|                 
 | |
| <span class="param-type">string</span>
 | |
| 
 | |
| 
 | |
|             
 | |
|             </td>
 | |
| 
 | |
|             
 | |
|                 <td class="attributes">
 | |
|                 
 | |
|                     <optional><br>
 | |
|                 
 | |
| 
 | |
|                 
 | |
|                 </td>
 | |
|             
 | |
| 
 | |
|             
 | |
| 
 | |
|             <td class="description last">name of the boxicon to be used (e.g. "time" for "bx-time" icon)</td>
 | |
|         </tr>
 | |
| 
 | |
|     
 | |
| 
 | |
|         <tr>
 | |
|             
 | |
|                 <td class="name"><code>action</code></td>
 | |
|             
 | |
| 
 | |
|             <td class="type">
 | |
|             
 | |
|                 
 | |
| <span class="param-type">function</span>
 | |
| 
 | |
| 
 | |
|             
 | |
|             </td>
 | |
| 
 | |
|             
 | |
|                 <td class="attributes">
 | |
|                 
 | |
| 
 | |
|                 
 | |
|                 </td>
 | |
|             
 | |
| 
 | |
|             
 | |
| 
 | |
|             <td class="description last">callback handling the click on the button</td>
 | |
|         </tr>
 | |
| 
 | |
|     
 | |
| 
 | |
|         <tr>
 | |
|             
 | |
|                 <td class="name"><code>shortcut</code></td>
 | |
|             
 | |
| 
 | |
|             <td class="type">
 | |
|             
 | |
|                 
 | |
| <span class="param-type">string</span>
 | |
| 
 | |
| 
 | |
|             
 | |
|             </td>
 | |
| 
 | |
|             
 | |
|                 <td class="attributes">
 | |
|                 
 | |
|                     <optional><br>
 | |
|                 
 | |
| 
 | |
|                 
 | |
|                 </td>
 | |
|             
 | |
| 
 | |
|             
 | |
| 
 | |
|             <td class="description last">keyboard shortcut for the button, e.g. "alt+t"</td>
 | |
|         </tr>
 | |
| 
 | |
|     
 | |
|     </tbody>
 | |
| </table>
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| <dl class="details">
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
|     <dt class="tag-source">Source:</dt>
 | |
|     <dd class="tag-source"><ul class="dummy"><li>
 | |
|         <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line76">line 76</a>
 | |
|     </li></ul></dd>
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| 
 | |
|     
 | |
| </dl>
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
|             
 | |
|     
 | |
| 
 | |
|     
 | |
| </article>
 | |
| 
 | |
| </section>
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| </div>
 | |
| 
 | |
| <nav>
 | |
|     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><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#decorateWidget">decorateWidget</a></li><li><a href="global.html#doRenderBody">doRenderBody</a></li><li><a href="global.html#widgetCollapsedStateChangedEvent">widgetCollapsedStateChangedEvent</a></li></ul>
 | |
| </nav>
 | |
| 
 | |
| <br class="clear">
 | |
| 
 | |
| <footer>
 | |
|     Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a>
 | |
| </footer>
 | |
| 
 | |
| <script> prettyPrint(); </script>
 | |
| <script src="scripts/linenumber.js"> </script>
 | |
| </body>
 | |
| </html> | 
