added jsdocs generated pages

2025-10-31 02:16:05 +01:00 · 2018-08-29 20:44:35 +02:00
parent 1ece9b71ec
commit 7c3d46d22a
91 changed files with 45360 additions and 19 deletions
--- a/docs/frontend_api/services_frontend_script_api.js.html
+++ b/docs/frontend_api/services_frontend_script_api.js.html
@@ -0,0 +1,246 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: services/frontend_script_api.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: services/frontend_script_api.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import treeService from './tree.js';
+import server from './server.js';
+import utils from './utils.js';
+import infoService from './info.js';
+import linkService from './link.js';
+import treeCache from './tree_cache.js';
+
+/**
+ * This is the main frontend API interface for scripts. It's published in the local "api" object.
+ *
+ * @constructor
+ * @hideconstructor
+ */
+function FrontendScriptApi(startNote, currentNote, originEntity = null) {
+    const $pluginButtons = $("#plugin-buttons");
+
+    /** @property {object} note where script started executing */
+    this.startNote = startNote;
+    /** @property {object} note where script is currently executing */
+    this.currentNote = currentNote;
+    /** @property {object|null} entity whose event triggered this execution */
+    this.originEntity = originEntity;
+
+    /**
+     * Activates note in the tree and in the note detail.
+     *
+     * @method
+     * @param {string} notePath (or noteId)
+     * @returns {Promise&lt;void>}
+     */
+    this.activateNote = treeService.activateNote;
+
+    /**
+     * Activates newly created note. Compared to this.activateNote() also refreshes tree.
+     *
+     * @param {string} notePath (or noteId)
+     * @return {Promise&lt;void>}
+     */
+    this.activateNewNote = async notePath => {
+        await treeService.reload();
+
+        await treeService.activateNote(notePath, true);
+    };
+
+    /**
+     * @typedef {Object} ToolbarButtonOptions
+     * @property {string} title
+     * @property {string} [icon] - name of the jQuery UI icon to be used (e.g. "clock" for "ui-icon-clock" icon)
+     * @property {function} action - callback handling the click on the button
+     * @property {string} [shortcut] - keyboard shortcut for the button, e.g. "alt+t"
+     */
+
+    /**
+     * Adds new button the the plugin area.
+     *
+     * @param {ToolbarButtonOptions} opts
+     */
+    this.addButtonToToolbar = opts => {
+        const buttonId = "toolbar-button-" + opts.title.replace(/[^a-zA-Z0-9]/g, "-");
+
+        const icon = $("&lt;span>")
+            .addClass("ui-icon ui-icon-" + opts.icon);
+
+        const button = $('&lt;button>')
+            .addClass("btn btn-xs")
+            .click(opts.action)
+            .append(icon)
+            .append($("&lt;span>").text(opts.title));
+
+        button.attr('id', buttonId);
+
+        if ($("#" + buttonId).replaceWith(button).length === 0) {
+            $pluginButtons.append(button);
+        }
+
+        if (opts.shortcut) {
+            $(document).bind('keydown', opts.shortcut, opts.action);
+
+            button.attr("title", "Shortcut " + opts.shortcut);
+        }
+    };
+
+    function prepareParams(params) {
+        if (!params) {
+            return params;
+        }
+
+        return params.map(p => {
+            if (typeof p === "function") {
+                return "!@#Function: " + p.toString();
+            }
+            else {
+                return p;
+            }
+        });
+    }
+
+    /**
+     * Executes given anonymous function on the server.
+     * Internally this serializes the anonymous function into string and sends it to backend via AJAX.
+     *
+     * @param {string} script - script to be executed on the backend
+     * @param {Array.&lt;?>} params - list of parameters to the anonymous function to be send to backend
+     * @return {Promise&lt;*>} return value of the executed function on the backend
+     */
+    this.runOnServer = async (script, params = []) => {
+        if (typeof script === "function") {
+            script = script.toString();
+        }
+
+        const ret = await server.post('script/exec', {
+            script: script,
+            params: prepareParams(params),
+            startNoteId: startNote.noteId,
+            currentNoteId: currentNote.noteId,
+            originEntityName: "notes", // currently there's no other entity on frontend which can trigger event
+            originEntityId: originEntity ? originEntity.noteId : null
+        });
+
+        if (ret.success) {
+            return ret.executionResult;
+        }
+        else {
+            throw new Error("server error: " + ret.error);
+        }
+    };
+
+    /**
+     * Returns list of notes. If note is missing from cache, it's loaded.
+     *
+     * This is often used to bulk-fill the cache with notes which would have to be picked one by one
+     * otherwise (by e.g. createNoteLink())
+     *
+     * @param {string[]} noteIds
+     * @param {boolean} [silentNotFoundError] - don't report error if the note is not found
+     * @return {Promise&lt;NoteShort[]>}
+     */
+    this.getNotes = async (noteIds, silentNotFoundError = false) => await treeCache.getNotes(noteIds, silentNotFoundError);
+
+    /**
+     * Instance name identifies particular Trilium instance. It can be useful for scripts
+     * if some action needs to happen on only one specific instance.
+     *
+     * @return {string}
+     */
+    this.getInstanceName = () => window.glob.instanceName;
+
+    /**
+     * @method
+     * @param {Date} date
+     * @returns {string} date in YYYY-MM-DD format
+     */
+    this.formatDateISO = utils.formatDateISO;
+
+    /**
+     * @method
+     * @param {string} str
+     * @returns {Date} parsed object
+     */
+    this.parseDate = utils.parseDate;
+
+    /**
+     * Show info message to the user.
+     *
+     * @method
+     * @param {string} message
+     */
+    this.showMessage = infoService.showMessage;
+
+    /**
+     * Show error message to the user.
+     *
+     * @method
+     * @param {string} message
+     */
+    this.showError = infoService.showError;
+
+    /**
+     * Refresh tree
+     *
+     * @method
+     * @returns {Promise&lt;void>}
+     */
+    this.refreshTree = treeService.reload;
+
+    /**
+     * Create note link (jQuery object) for given note.
+     *
+     * @method
+     * @param {string} notePath (or noteId)
+     * @param {string} [noteTitle] - if not present we'll use note title
+     */
+    this.createNoteLink = linkService.createNoteLink;
+}
+
+export default FrontendScriptApi;</code></pre>
+        </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="NoteFull.html">NoteFull</a></li><li><a href="NoteShort.html">NoteShort</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.5.5</a> on Wed Aug 29 2018 20:44:07 GMT+0200 (CEST)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>