123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907 |
- <!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">Members</h3>
-
-
- <h4 class="name" id="api"><span class="type-signature"></span>api<span class="type-signature"> :<a href="FrontendScriptApi.html">FrontendScriptApi</a></span></h4>
- <div class="description">
- An instance of the frontend api available globally.
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type"><a href="FrontendScriptApi.html">FrontendScriptApi</a></span>
- </li>
- </ul>
- <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#line25">line 25</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
-
- <h3 class="subsection-title">Methods</h3>
-
-
-
-
- <h4 class="name" id="getJsonContent"><span class="type-signature"></span>getJsonContent<span class="signature">()</span><span class="type-signature"> → {*}</span></h4>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="entities_fblob.js.html">entities/fblob.js</a>, <a href="entities_fblob.js.html#line22">line 22</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Throws:</h5>
-
- <div class="param-desc">
-
- Error in case of invalid JSON
-
- </div>
-
- <h5>Returns:</h5>
-
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">*</span>
- </dd>
- </dl>
-
-
-
-
-
- <h4 class="name" id="getJsonContentSafely"><span class="type-signature"></span>getJsonContentSafely<span class="signature">()</span><span class="type-signature"> → {*|null}</span></h4>
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="entities_fblob.js.html">entities/fblob.js</a>, <a href="entities_fblob.js.html#line31">line 31</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- valid object or null if the content cannot be parsed as JSON
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">*</span>
- |
- <span class="param-type">null</span>
- </dd>
- </dl>
-
-
-
-
- <h3 class="subsection-title">Type Definitions</h3>
-
-
- <h4 class="name" id="AttributeType">AttributeType</h4>
- <div class="description">
- There are currently only two types of attributes, labels or relations.
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">"label"</span>
- |
- <span class="param-type">"relation"</span>
- </li>
- </ul>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line3">line 3</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="NotePathRecord">NotePathRecord</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 class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>isArchived</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>isInHoistedSubTree</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>isSearch</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>notePath</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Array.<string></span>
-
- </td>
-
-
- <td class="description last"></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>isHidden</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
-
- <td class="description last"></td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line35">line 35</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="NoteType">NoteType</h4>
- <div class="description">
- There are many different Note types, some of which are entirely opaque to the
- end user. Those types should be used only for checking against, they are
- not for direct use.
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">"file"</span>
- |
- <span class="param-type">"image"</span>
- |
- <span class="param-type">"search"</span>
- |
- <span class="param-type">"noteMap"</span>
- |
- <span class="param-type">"launcher"</span>
- |
- <span class="param-type">"doc"</span>
- |
- <span class="param-type">"contentWidget"</span>
- |
- <span class="param-type">"text"</span>
- |
- <span class="param-type">"relationMap"</span>
- |
- <span class="param-type">"render"</span>
- |
- <span class="param-type">"canvas"</span>
- |
- <span class="param-type">"mermaid"</span>
- |
- <span class="param-type">"book"</span>
- |
- <span class="param-type">"webView"</span>
- |
- <span class="param-type">"code"</span>
- </li>
- </ul>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="entities_fnote.js.html">entities/fnote.js</a>, <a href="entities_fnote.js.html#line28">line 28</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="int">int</h4>
- <div class="description">
- A whole number
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">number</span>
- </li>
- </ul>
- <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#line20">line 20</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
-
- </article>
- </section>
- </div>
- <nav>
- <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BasicWidget.html">BasicWidget</a></li><li><a href="FAttachment.html">FAttachment</a></li><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteContextAwareWidget.html">NoteContextAwareWidget</a></li><li><a href="RightPanelWidget.html">RightPanelWidget</a></li></ul><h3>Global</h3><ul><li><a href="global.html#api">api</a></li><li><a href="global.html#getJsonContent">getJsonContent</a></li><li><a href="global.html#getJsonContentSafely">getJsonContentSafely</a></li></ul>
- </nav>
- <br class="clear">
- <footer>
- Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
- </footer>
- <script> prettyPrint(); </script>
- <script src="scripts/linenumber.js"> </script>
- </body>
- </html>
|