2018-08-29 20:44:35 +02:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > JSDoc: Class: FrontendScriptApi< / 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" > Class: FrontendScriptApi< / h1 >
< section >
< header >
2023-02-17 16:15:58 +01:00
< h2 > < span class = "attribs" > < span class = "type-signature" > < / span > < / span > FrontendScriptApi< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h2 >
2018-08-29 20:44:35 +02:00
< / header >
< article >
< div class = "container-overview" >
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "FrontendScriptApi" > < span class = "type-signature" > < / span > new FrontendScriptApi< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
2023-02-17 16:15:58 +01:00
< div class = "description" >
< p > This is the main frontend API interface for scripts. All the properties and methods are published in the "api" object
available in the JS frontend notes. You can use e.g. < code > api.showMessage(api.startNote.title);< / code > < / p >
< / div >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< 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#line24" > line 24< / a >
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< / div >
< h3 class = "subsection-title" > Members< / h3 >
2019-10-06 21:35:26 +02:00
< h4 class = "name" id = "$container" > < span class = "type-signature" > < / span > $container< span class = "type-signature" > < / span > < / h4 >
< 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 > container< / code > < / td >
< td class = "type" >
< span class = "param-type" > jQuery< / span >
< / td >
< td class = "description last" > of all the rendered script content< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< 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#line26" > line 26< / a >
< / li > < / ul > < / dd >
2020-04-07 19:19:20 +02:00
< / dl >
< h4 class = "name" id = "BasicWidget" > < span class = "type-signature" > < / span > BasicWidget< span class = "type-signature" > < / span > < / h4 >
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "type" >
< span class = "param-type" > BasicWidget< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line45" > line 45< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "NoteContextAwareWidget" > < span class = "type-signature" > < / span > NoteContextAwareWidget< span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "type" >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > NoteContextAwareWidget< / span >
2018-08-29 20:44:35 +02:00
< / td >
2022-11-07 21:26:13 +01:00
< td class = "description last" > < / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line42" > line 42< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2023-01-03 14:31:46 +01:00
< / dl >
< h4 class = "name" id = "RightPanelWidget" > < span class = "type-signature" > < / span > RightPanelWidget< span class = "type-signature" > < / span > < / h4 >
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "type" >
< span class = "param-type" > RightPanelWidget< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line39" > line 39< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-12-29 21:15:34 +01:00
< / dl >
2023-07-27 23:22:08 +02:00
< h4 class = "name" id = "createNoteLink" > < span class = "type-signature" > < / span > createNoteLink< span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > - use api.createLink() instead< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line309" > line 309< / a >
2023-07-27 23:22:08 +02:00
< / li > < / ul > < / dd >
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "currentNote" > < span class = "type-signature" > < / span > currentNote< span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
< 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 > note< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
2023-06-29 20:54:58 +02:00
< td class = "description last" > where the script is currently executing< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< 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#line31" > line 31< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "dayjs" > < span class = "type-signature" > < / span > dayjs< span class = "type-signature" > < / span > < / h4 >
< 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 > day.js< / code > < / td >
< td class = "type" >
< span class = "param-type" > dayjs< / span >
< / td >
< td class = "description last" > library for date manipulation. See < a href = "https://day.js.org" > https://day.js.org< / a > for documentation< / 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#line36" > line 36< / a >
< / li > < / ul > < / dd >
2020-04-07 19:19:20 +02:00
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "originEntity" > < span class = "type-signature" > < / span > originEntity< span class = "type-signature" > < / span > < / h4 >
2020-04-07 19:19:20 +02:00
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
2022-11-07 21:26:13 +01:00
< th > Name< / th >
2020-04-07 19:19:20 +02:00
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2022-11-07 21:26:13 +01:00
< td class = "name" > < code > entity< / code > < / td >
2020-04-07 19:19:20 +02:00
< td class = "type" >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > object< / span >
|
< span class = "param-type" > null< / span >
2020-04-07 19:19:20 +02:00
< / td >
2022-11-07 21:26:13 +01:00
< td class = "description last" > whose event triggered this execution< / td >
2020-04-07 19:19:20 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< 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#line33" > line 33< / a >
< / li > < / ul > < / dd >
2020-04-07 19:19:20 +02:00
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "startNote" > < span class = "type-signature" > < / span > startNote< span class = "type-signature" > < / span > < / h4 >
2020-04-07 19:19:20 +02:00
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
2022-11-07 21:26:13 +01:00
< th > Name< / th >
2020-04-07 19:19:20 +02:00
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2022-11-07 21:26:13 +01:00
< td class = "name" > < code > note< / code > < / td >
2020-04-07 19:19:20 +02:00
< td class = "type" >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > object< / span >
2020-04-07 19:19:20 +02:00
< / td >
2023-06-29 20:54:58 +02:00
< td class = "description last" > where the script started executing< / td >
2020-04-07 19:19:20 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< 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#line29" > line 29< / a >
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< h4 class = "name" id = "activateNewNote" > < span class = "type-signature" > < / span > activateNewNote< span class = "signature" > (notePath)< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
2020-01-04 21:53:49 +01:00
Activates newly created note. Compared to this.activateNote() also makes sure that frontend has been fully synced.
2018-08-29 20:44:35 +02:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > notePath< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > (or noteId)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line64" > line 64< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "activateNote" > < span class = "type-signature" > < / span > activateNote< span class = "signature" > (notePath)< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
Activates note in the tree and in the note detail.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > notePath< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > (or noteId)< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line54" > line 54< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
< / dd >
< / dl >
2022-12-17 21:46:51 +01:00
< h4 class = "name" id = "addButtonToToolbar" > < span class = "type-signature" > < / span > addButtonToToolbar< span class = "signature" > (opts)< / span > < span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
2022-12-17 21:46:51 +01:00
< div class = "description" >
Adds a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2018-08-29 20:44:35 +02:00
2022-12-17 21:46:51 +01:00
< tr >
< td class = "name" > < code > opts< / code > < / td >
2018-08-29 20:44:35 +02:00
2022-12-17 21:46:51 +01:00
< td class = "type" >
2023-01-03 14:31:46 +01:00
< span class = "param-type" > object< / span >
2018-08-29 20:44:35 +02:00
2022-12-17 21:46:51 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2022-12-17 21:46:51 +01:00
2018-08-29 20:44:35 +02:00
2022-12-17 21:46:51 +01:00
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
2018-08-29 20:44:35 +02:00
2023-01-03 14:31:46 +01:00
< 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 > opts.id< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > id of the button, used to identify the old instances of this button to be replaced
ID is optional because of BC, but not specifying it is deprecated. ID can be alphanumeric only.< / td >
< / tr >
< tr >
< td class = "name" > < code > opts.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 > opts.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 > opts.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 > opts.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 >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2022-12-22 14:59:20 +01:00
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > you can now create/modify launchers in the top-left Menu -> Configure Launchbar
for special needs there's also backend API's createOrUpdateLauncher()< / li > < / ul > < / dd >
2022-11-30 16:57:51 +01:00
2018-08-29 20:44:35 +02:00
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line124" > line 124< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2022-06-02 17:25:58 +02:00
< h4 class = "name" id = "addTextToActiveContextEditor" > < span class = "type-signature" > < / span > addTextToActiveContextEditor< span class = "signature" > (text)< / span > < span class = "type-signature" > < / span > < / h4 >
< div class = "description" >
Adds given text to the editor cursor
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > text< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > this must be clear text, HTML is not supported.< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line317" > line 317< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-06-02 17:25:58 +02:00
< / dl >
2020-01-10 20:10:17 +01:00
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "bindGlobalShortcut" > < span class = "type-signature" > < / span > bindGlobalShortcut< span class = "signature" > (keyboardShortcut, handler, namespace< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
2020-01-10 20:10:17 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2023-02-17 16:15:58 +01:00
< th > Attributes< / th >
2020-01-10 20:10:17 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2023-02-17 16:15:58 +01:00
< td class = "name" > < code > keyboardShortcut< / code > < / td >
2020-01-10 20:10:17 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2023-02-17 16:15:58 +01:00
< td class = "attributes" >
2020-01-10 20:10:17 +01:00
2023-02-17 16:15:58 +01:00
< / td >
2020-01-10 20:10:17 +01:00
2023-02-17 16:15:58 +01:00
< td class = "description last" > e.g. "ctrl+shift+a"< / td >
< / tr >
< tr >
< td class = "name" > < code > handler< / code > < / td >
< td class = "type" >
< span class = "param-type" > function< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > namespace< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > specify namespace of the handler for the cases where call for bind may be repeated.
If a handler with this ID exists, it's replaced by the new handler.< / td >
2020-01-10 20:10:17 +01:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line459" > line 459< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-01-10 20:10:17 +01:00
< / dl >
2023-02-17 16:15:58 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
< / dd >
< / dl >
2020-01-10 20:10:17 +01:00
2019-11-05 21:26:54 +01:00
2023-09-06 09:20:32 +02:00
< h4 class = "name" id = "createLink" > < span class = "type-signature" > < / span > createLink< span class = "signature" > (notePath, params< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {jQuery}< / span > < / h4 >
2019-11-05 21:26:54 +01:00
2023-02-17 16:15:58 +01:00
< div class = "description" >
2023-06-29 20:54:58 +02:00
Create a note link (jQuery object) for given note.
2023-02-17 16:15:58 +01:00
< / div >
2019-11-05 21:26:54 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-12-14 23:51:28 +01:00
< th > Attributes< / th >
2019-11-05 21:26:54 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2023-02-17 16:15:58 +01:00
< td class = "name" > < code > notePath< / code > < / td >
2019-11-05 21:26:54 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2022-12-14 23:51:28 +01:00
< td class = "attributes" >
< / td >
2019-11-05 21:26:54 +01:00
2023-02-17 16:15:58 +01:00
< td class = "description last" > (or noteId)< / td >
2019-11-05 21:26:54 +01:00
< / tr >
< tr >
2023-02-17 16:15:58 +01:00
< td class = "name" > < code > params< / code > < / td >
2019-11-05 21:26:54 +01:00
< td class = "type" >
2023-02-17 16:15:58 +01:00
< span class = "param-type" > object< / span >
2019-11-05 21:26:54 +01:00
< / td >
2022-12-14 23:51:28 +01:00
< td class = "attributes" >
2023-02-17 16:15:58 +01:00
< optional>< br >
2022-12-14 23:51:28 +01:00
< / td >
2019-11-05 21:26:54 +01:00
2023-02-17 16:15:58 +01:00
< td class = "description last" >
< h6 > Properties< / h6 >
2021-02-17 23:55:51 +01:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > showTooltip< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
true
< / td >
< td class = "description last" > enable/disable tooltip on the link< / td >
< / tr >
< tr >
< td class = "name" > < code > showNotePath< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > show also whole note's path as part of the link< / td >
< / tr >
2022-01-05 20:31:21 +01:00
< tr >
< td class = "name" > < code > showNoteIcon< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > show also note icon before the title< / td >
< / tr >
2021-02-17 23:55:51 +01:00
< tr >
< td class = "name" > < code > title=< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
2022-11-12 20:40:40 +01:00
< td class = "default" >
< / td >
2018-08-29 20:44:35 +02:00
2021-02-17 23:55:51 +01:00
< td class = "description last" > custom link tile with note's title as default< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
2022-11-12 20:40:40 +01:00
< / td >
< / tr >
< / tbody >
< / table >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line306" > line 306< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2023-09-06 09:20:32 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
- jQuery element with the link (wrapped in < span > )
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > jQuery< / span >
< / dd >
< / dl >
2018-08-29 20:44:35 +02:00
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h4 class = "name" id = "formatDateISO" > < span class = "type-signature" > < / span > formatDateISO< span class = "signature" > (date)< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > date< / code > < / td >
< td class = "type" >
< span class = "param-type" > Date< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line251" > line 251< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
date in YYYY-MM-DD format
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
2023-06-29 20:54:58 +02:00
< h4 class = "name" id = "formatNoteSize" > < span class = "type-signature" > < / span > formatNoteSize< span class = "signature" > (size)< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > size< / code > < / td >
< td class = "type" >
< span class = "param-type" > int< / span >
< / td >
< td class = "description last" > in bytes< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-07-15 12:07:45 +02:00
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > - use api.formatSize()< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line503" > line 503< / a >
2023-07-15 12:07:45 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
formatted string
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
< h4 class = "name" id = "formatSize" > < span class = "type-signature" > < / span > formatSize< span class = "signature" > (size)< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > size< / code > < / td >
< td class = "type" >
< span class = "param-type" > int< / span >
< / td >
< td class = "description last" > in bytes< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-06-29 20:54:58 +02:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line495" > line 495< / a >
2023-06-29 20:54:58 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
formatted string
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
2022-06-02 17:25:58 +02:00
< h4 class = "name" id = "getActiveContextCodeEditor" > < span class = "type-signature" > < / span > getActiveContextCodeEditor< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< CodeMirror>}< / span > < / h4 >
2022-05-03 23:25:28 +02:00
< div class = "description" >
2022-06-02 17:25:58 +02:00
See https://codemirror.net/doc/manual.html#api
2022-05-03 23:25:28 +02:00
< / div >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line339" > line 339< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-05-03 23:25:28 +02:00
< / dl >
< h5 > Returns:< / h5 >
2022-06-02 17:25:58 +02:00
< div class = "param-desc" >
instance of CodeMirror
< / div >
2022-05-03 23:25:28 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2022-06-02 17:25:58 +02:00
< span class = "param-type" > Promise.< CodeMirror>< / span >
2022-05-03 23:25:28 +02:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getActiveContextNote" > < span class = "type-signature" > < / span > getActiveContextNote< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "FNote.html" > FNote< / a > }< / span > < / h4 >
2022-06-02 17:25:58 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line323" > line 323< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-06-02 17:25:58 +02:00
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
active note (loaded into right pane)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "FNote.html" > FNote< / a > < / span >
2022-06-02 17:25:58 +02:00
< / dd >
< / dl >
< h4 class = "name" id = "getActiveContextNotePath" > < span class = "type-signature" > < / span > getActiveContextNotePath< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< (string|null)>}< / span > < / h4 >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line354" > line 354< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-06-02 17:25:58 +02:00
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2023-06-29 20:54:58 +02:00
returns a note path of active note or null if there isn't active note
2022-06-02 17:25:58 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2023-02-17 16:15:58 +01:00
< span class = "param-type" > Promise.< (string|null)>< / span >
2020-01-10 20:10:17 +01:00
2023-02-17 16:15:58 +01:00
< / dd >
< / dl >
2020-01-10 20:10:17 +01:00
2023-02-17 16:15:58 +01:00
2020-01-10 20:10:17 +01:00
2020-02-02 11:44:08 +01:00
2023-02-17 16:15:58 +01:00
2020-02-02 11:44:08 +01:00
2023-02-17 16:15:58 +01:00
2020-02-02 11:44:08 +01:00
2023-02-17 16:15:58 +01:00
2023-06-29 20:54:58 +02:00
< h4 class = "name" id = "getActiveContextTextEditor" > < span class = "type-signature" > < / span > getActiveContextTextEditor< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< BalloonEditor>}< / span > < / h4 >
2023-02-17 16:15:58 +01:00
2020-02-02 11:44:08 +01:00
2023-02-17 16:15:58 +01:00
2020-02-02 11:44:08 +01:00
2023-02-17 16:15:58 +01:00
< div class = "description" >
2023-06-29 20:54:58 +02:00
See https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editor-Editor.html for documentation on the returned instance.
2023-02-17 16:15:58 +01:00
< / div >
2020-02-02 11:44:08 +01:00
2022-05-03 23:25:28 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line331" > line 331< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-05-03 23:25:28 +02:00
< / dl >
2023-02-17 16:15:58 +01:00
< h5 > Returns:< / h5 >
2022-05-03 23:25:28 +02:00
2023-02-17 16:15:58 +01:00
< div class = "param-desc" >
instance of CKEditor
< / div >
2022-05-03 23:25:28 +02:00
2023-02-17 16:15:58 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2022-05-03 23:25:28 +02:00
2023-06-29 20:54:58 +02:00
< span class = "param-type" > Promise.< BalloonEditor>< / span >
2022-05-03 23:25:28 +02:00
2023-02-17 16:15:58 +01:00
< / dd >
< / dl >
2022-05-03 23:25:28 +02:00
2023-02-17 16:15:58 +01:00
2022-05-03 23:25:28 +02:00
2023-02-17 16:15:58 +01:00
2022-05-03 23:25:28 +02:00
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "getActiveNoteDetailWidget" > < span class = "type-signature" > < / span > getActiveNoteDetailWidget< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< NoteDetailWidget>}< / span > < / h4 >
2022-05-03 23:25:28 +02:00
2023-02-17 16:15:58 +01:00
2022-05-03 23:25:28 +02:00
2023-02-17 16:15:58 +01:00
< div class = "description" >
Get access to the widget handling note detail. Methods like `getWidgetType()` and `getTypeWidget()` to get to the
implementation of actual widget type.
< / div >
2022-05-03 23:25:28 +02:00
2020-02-02 11:44:08 +01:00
2020-01-10 20:10:17 +01:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line348" > line 348< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-01-10 20:10:17 +01:00
< / dl >
2022-05-03 23:25:28 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-02-17 16:15:58 +01:00
< span class = "param-type" > Promise.< NoteDetailWidget>< / span >
2022-05-03 23:25:28 +02:00
< / dd >
< / dl >
2020-01-10 20:10:17 +01:00
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "getComponentByEl" > < span class = "type-signature" > < / span > getComponentByEl< span class = "signature" > (el)< / span > < span class = "type-signature" > → {Component}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2023-06-29 20:54:58 +02:00
Returns component which owns the given DOM element (the nearest parent component in DOM tree)
2022-01-10 19:54:38 +01:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2023-02-17 16:15:58 +01:00
< td class = "name" > < code > el< / code > < / td >
2022-01-10 19:54:38 +01:00
< td class = "type" >
2023-02-17 16:15:58 +01:00
< span class = "param-type" > Element< / span >
2022-01-10 19:54:38 +01:00
< / td >
2023-02-17 16:15:58 +01:00
< td class = "description last" > DOM element< / td >
2022-01-10 19:54:38 +01:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line363" > line 363< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-01-10 19:54:38 +01:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-02-17 16:15:58 +01:00
< span class = "param-type" > Component< / span >
2022-01-10 19:54:38 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getDayNote" > < span class = "type-signature" > < / span > getDayNote< span class = "signature" > (date)< / span > < span class = "type-signature" > → {Promise.< < a href = "FNote.html" > FNote< / a > >}< / span > < / h4 >
2022-01-10 19:54:38 +01:00
< div class = "description" >
Returns day note for a given date. If it doesn't exist, it is automatically created.
2018-08-29 20:44:35 +02:00
< / div >
2019-04-14 12:24:48 +02:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > date< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > e.g. "2019-04-29"< / td >
< / tr >
< / tbody >
< / table >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line407" > line 407< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Promise.< < a href = "FNote.html" > FNote< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2019-04-14 12:24:48 +02:00
< h4 class = "name" id = "getInstanceName" > < span class = "type-signature" > < / span > getInstanceName< span class = "signature" > ()< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
2019-02-20 22:24:51 +01:00
< div class = "description" >
2019-04-14 12:24:48 +02:00
Instance name identifies particular Trilium instance. It can be useful for scripts
if some action needs to happen on only one specific instance.
2019-02-20 22:24:51 +01:00
< / div >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line244" > line 244< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-02-20 22:24:51 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2019-02-20 22:24:51 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2019-04-14 12:24:48 +02:00
< span class = "param-type" > string< / span >
2019-02-20 22:24:51 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getMonthNote" > < span class = "type-signature" > < / span > getMonthNote< span class = "signature" > (month)< / span > < span class = "type-signature" > → {Promise.< < a href = "FNote.html" > FNote< / a > >}< / span > < / h4 >
2018-09-03 16:05:28 +02:00
2019-04-14 12:24:48 +02:00
< div class = "description" >
Returns month-note. If it doesn't exist, it is automatically created.
< / div >
2018-09-03 16:05:28 +02:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2019-04-14 12:24:48 +02:00
< td class = "name" > < code > month< / code > < / td >
2018-09-03 16:05:28 +02:00
< td class = "type" >
2019-04-14 12:24:48 +02:00
< span class = "param-type" > string< / span >
2018-09-03 16:05:28 +02:00
< / td >
2019-04-14 12:24:48 +02:00
< td class = "description last" > e.g. "2019-04"< / td >
2018-09-03 16:05:28 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line425" > line 425< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-09-03 16:05:28 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2019-04-14 12:24:48 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Promise.< < a href = "FNote.html" > FNote< / a > >< / span >
2019-04-14 12:24:48 +02:00
< / dd >
< / dl >
2018-09-03 16:05:28 +02:00
2018-08-29 20:44:35 +02:00
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getNote" > < span class = "type-signature" > < / span > getNote< span class = "signature" > (noteId)< / span > < span class = "type-signature" > → {Promise.< < a href = "FNote.html" > FNote< / a > >}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2019-04-14 12:24:48 +02:00
< div class = "description" >
2023-06-29 20:54:58 +02:00
Returns note by given noteId. If note is missing from the cache, it's loaded.
2019-04-14 12:24:48 +02:00
*
< / div >
2018-08-29 20:44:35 +02:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2019-04-14 12:24:48 +02:00
< td class = "name" > < code > noteId< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line214" > line 214< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Promise.< < a href = "FNote.html" > FNote< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2019-02-20 22:24:51 +01:00
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getNotes" > < span class = "type-signature" > < / span > getNotes< span class = "signature" > (noteIds, silentNotFoundError< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "FNote.html" > FNote< / a > >>}< / span > < / h4 >
2019-02-20 22:24:51 +01:00
2019-04-14 12:24:48 +02:00
< div class = "description" >
2023-06-29 20:54:58 +02:00
Returns list of notes. If note is missing from the cache, it's loaded.
2019-02-20 22:24:51 +01:00
2019-04-14 12:24:48 +02:00
This is often used to bulk-fill the cache with notes which would have to be picked one by one
2023-06-29 20:54:58 +02:00
otherwise (by e.g. createLink())
2019-04-14 12:24:48 +02:00
< / div >
2019-02-20 22:24:51 +01:00
2019-04-14 12:24:48 +02:00
< h5 > Parameters:< / h5 >
2019-02-20 22:24:51 +01:00
2019-04-14 12:24:48 +02:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
2019-02-20 22:24:51 +01:00
2019-04-14 12:24:48 +02:00
< th > Type< / th >
2019-02-20 22:24:51 +01:00
2019-04-14 12:24:48 +02:00
< th > Attributes< / th >
2019-02-20 22:24:51 +01:00
2019-04-14 12:24:48 +02:00
2019-02-20 22:24:51 +01:00
2019-04-14 12:24:48 +02:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2019-02-20 22:24:51 +01:00
2019-04-14 12:24:48 +02:00
< tbody >
2019-02-20 22:24:51 +01:00
2019-04-14 12:24:48 +02:00
< tr >
< td class = "name" > < code > noteIds< / code > < / td >
< td class = "type" >
< span class = "param-type" > Array.< string>< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > silentNotFoundError< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > don't report error if the note is not found< / td >
< / tr >
< / tbody >
< / table >
2019-02-20 22:24:51 +01:00
2019-04-14 12:24:48 +02:00
< dl class = "details" >
2019-02-20 22:24:51 +01:00
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line227" > line 227< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-02-20 22:24:51 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2019-04-14 12:24:48 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Promise.< Array.< < a href = "FNote.html" > FNote< / a > >>< / span >
2019-04-14 12:24:48 +02:00
< / dd >
< / dl >
2019-02-20 22:24:51 +01:00
2018-08-29 20:44:35 +02:00
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getTodayNote" > < span class = "type-signature" > < / span > getTodayNote< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< < a href = "FNote.html" > FNote< / a > >}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2019-04-14 12:24:48 +02:00
Returns date-note for today. If it doesn't exist, it is automatically created.
2018-08-29 20:44:35 +02:00
< / div >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line398" > line 398< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2021-11-10 21:30:54 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Promise.< < a href = "FNote.html" > FNote< / a > >< / span >
2021-11-10 21:30:54 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getWeekNote" > < span class = "type-signature" > < / span > getWeekNote< span class = "signature" > (date)< / span > < span class = "type-signature" > → {Promise.< < a href = "FNote.html" > FNote< / a > >}< / span > < / h4 >
2021-11-10 21:30:54 +01:00
< div class = "description" >
2022-01-10 19:54:38 +01:00
Returns day note for the first date of the week of the given date. If it doesn't exist, it is automatically created.
2021-11-10 21:30:54 +01:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > date< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > e.g. "2019-04-29"< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line416" > line 416< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01:00
< / dl >
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Promise.< < a href = "FNote.html" > FNote< / a > >< / span >
2019-04-14 12:24:48 +02:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getYearNote" > < span class = "type-signature" > < / span > getYearNote< span class = "signature" > (year)< / span > < span class = "type-signature" > → {Promise.< < a href = "FNote.html" > FNote< / a > >}< / span > < / h4 >
2019-04-14 12:24:48 +02:00
< div class = "description" >
Returns year-note. If it doesn't exist, it is automatically created.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > year< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > e.g. "2019"< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line434" > line 434< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-04-14 12:24:48 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2019-04-14 12:24:48 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Promise.< < a href = "FNote.html" > FNote< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2022-10-26 16:52:00 +02:00
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "log" > < span class = "type-signature" > < / span > log< span class = "signature" > (message)< / span > < span class = "type-signature" > → {void}< / span > < / h4 >
2022-10-26 16:52:00 +02:00
< div class = "description" >
Log given message to the log pane in UI
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > message< / code > < / td >
< td class = "type" >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line514" > line 514< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-10-26 16:52:00 +02:00
< / dl >
2023-02-17 16:15:58 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > void< / span >
< / dd >
< / dl >
2022-10-26 16:52:00 +02:00
2018-08-29 20:44:35 +02:00
2019-04-14 12:24:48 +02:00
2022-06-02 17:36:30 +02:00
< h4 class = "name" id = "openSplitWithNote" > < span class = "type-signature" > < / span > openSplitWithNote< span class = "signature" > (notePath, activate)< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
Open a note in a new split.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > notePath< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > (or noteId)< / td >
< / tr >
< tr >
< td class = "name" > < code > activate< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > set to true to activate the new split, false to stay on the current split< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line97" > line 97< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-06-02 17:36:30 +02:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
< / dd >
< / dl >
2021-02-17 23:55:51 +01:00
< h4 class = "name" id = "openTabWithNote" > < span class = "type-signature" > < / span > openTabWithNote< span class = "signature" > (notePath, activate)< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
< div class = "description" >
Open a note in a new tab.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > notePath< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > (or noteId)< / td >
< / tr >
< tr >
< td class = "name" > < code > activate< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > set to true to activate the new tab, false to stay on the current tab< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line79" > line 79< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-02-17 23:55:51 +01:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
< / dd >
< / dl >
2020-03-08 11:41:42 +01:00
< h4 class = "name" id = "parseDate" > < span class = "type-signature" > < / span > parseDate< span class = "signature" > (str)< / span > < span class = "type-signature" > → {Date}< / span > < / h4 >
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > str< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
2019-04-14 12:24:48 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line258" > line 258< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-04-14 12:24:48 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2019-04-14 12:24:48 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2020-03-08 11:41:42 +01:00
parsed object
2019-04-14 12:24:48 +02:00
< / div >
< dl >
< dt >
2023-02-17 16:15:58 +01:00
Type
< / dt >
< dd >
< span class = "param-type" > Date< / span >
2020-03-08 11:41:42 +01:00
2023-02-17 16:15:58 +01:00
< / dd >
< / dl >
2020-03-08 11:41:42 +01:00
2023-02-17 16:15:58 +01:00
2020-03-08 11:41:42 +01:00
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "protectNote" > < span class = "type-signature" > < / span > protectNote< span class = "signature" > (noteId, protect)< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
2019-04-14 12:24:48 +02:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-03-08 11:41:42 +01:00
< td class = "name" > < code > noteId< / code > < / td >
2019-04-14 12:24:48 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
2020-03-08 11:41:42 +01:00
< tr >
< td class = "name" > < code > protect< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > true to protect note, false to unprotect< / td >
< / tr >
2019-04-14 12:24:48 +02:00
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line378" > line 378< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-04-14 12:24:48 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2023-02-17 16:15:58 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
< / dd >
< / dl >
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "protectSubTree" > < span class = "type-signature" > < / span > protectSubTree< span class = "signature" > (noteId, protect)< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
2020-03-08 11:41:42 +01:00
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
< h5 > Parameters:< / h5 >
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
< tr >
< td class = "name" > < code > noteId< / code > < / td >
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
< / td >
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
< td class = "description last" > < / td >
< / tr >
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
< tr >
< td class = "name" > < code > protect< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > true to protect subtree, false to unprotect< / td >
< / tr >
< / tbody >
< / table >
2019-04-14 12:24:48 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line388" > line 388< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-04-07 22:01:52 +02:00
< / dl >
2023-02-17 16:15:58 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
< / dd >
< / dl >
2021-04-07 22:01:52 +02:00
< h4 class = "name" id = "randomString" > < span class = "type-signature" > < / span > randomString< span class = "signature" > (length)< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
< div class = "description" >
Return randomly generated string of given length. This random string generation is NOT cryptographically secure.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > length< / code > < / td >
< td class = "type" >
2023-07-15 12:07:45 +02:00
< span class = "param-type" > int< / span >
2021-04-07 22:01:52 +02:00
< / td >
< td class = "description last" > of the string< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line488" > line 488< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-09-30 22:48:30 +02:00
< / dl >
2021-04-07 22:01:52 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
random string
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
2020-09-30 22:48:30 +02:00
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "refreshIncludedNote" > < span class = "type-signature" > < / span > refreshIncludedNote< span class = "signature" > (includedNoteId)< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
2020-09-30 22:48:30 +02:00
< div class = "description" >
This will refresh all currently opened notes which have included note specified in the parameter
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > includedNoteId< / code > < / td >
< td class = "type" >
< / td >
< td class = "description last" > noteId of the included note< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line479" > line 479< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-11-10 19:34:15 +01:00
< / dl >
2023-02-17 16:15:58 +01:00
< h5 > Returns:< / h5 >
2019-11-10 19:34:15 +01:00
2019-04-14 12:24:48 +02:00
2023-02-17 16:15:58 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
2019-04-14 12:24:48 +02:00
2023-02-17 16:15:58 +01:00
< / dd >
2019-04-14 12:24:48 +02:00
< / dl >
2023-02-17 16:15:58 +01:00
2019-04-14 12:24:48 +02:00
2019-10-26 10:00:26 +02:00
< h4 class = "name" id = "reloadNotes" > < span class = "type-signature" > < / span > reloadNotes< span class = "signature" > (noteIds)< / span > < span class = "type-signature" > < / span > < / h4 >
2019-04-14 12:24:48 +02:00
2019-11-05 21:26:54 +01:00
< div class = "description" >
Update frontend tree (note) cache from the backend.
< / div >
2019-04-14 12:24:48 +02:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2019-10-26 10:00:26 +02:00
< td class = "name" > < code > noteIds< / code > < / td >
2019-04-14 12:24:48 +02:00
< td class = "type" >
2019-10-26 10:00:26 +02:00
< span class = "param-type" > Array.< string>< / span >
2019-04-14 12:24:48 +02:00
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line235" > line 235< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-04-14 12:24:48 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2019-04-14 12:24:48 +02:00
2018-08-29 20:44:35 +02:00
2020-01-01 22:03:27 +01:00
< h4 class = "name" id = "runOnBackend" > < span class = "type-signature" > < / span > runOnBackend< span class = "signature" > (script, params)< / span > < span class = "type-signature" > → {Promise.< *>}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2020-01-01 22:03:27 +01:00
Executes given anonymous function on the backend.
2018-08-29 20:44:35 +02:00
Internally this serializes the anonymous function into string and sends it to backend via AJAX.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > script< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > script to be executed on the backend< / td >
< / tr >
< tr >
< td class = "name" > < code > params< / code > < / td >
< td class = "type" >
< span class = "param-type" > Array.< ?>< / span >
< / td >
2023-02-17 16:15:58 +01:00
< td class = "description last" > list of parameters to the anonymous function to be sent to backend< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line157" > line 157< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
return value of the executed function on the backend
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< *>< / span >
< / dd >
< / dl >
2018-10-07 16:27:12 +02:00
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "searchForNote" > < span class = "type-signature" > < / span > searchForNote< span class = "signature" > (searchString)< / span > < span class = "type-signature" > → {Promise.< (< a href = "FNote.html" > FNote< / a > |null)>}< / span > < / h4 >
2019-04-22 22:52:09 +02:00
< div class = "description" >
This is a powerful search method - you can search by attributes and their values, e.g.:
2020-09-30 22:48:30 +02:00
"#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search
2019-04-22 22:52:09 +02:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > searchString< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line201" > line 201< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-04-22 22:52:09 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2019-04-22 22:52:09 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Promise.< (< a href = "FNote.html" > FNote< / a > |null)>< / span >
2019-04-22 22:52:09 +02:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "searchForNotes" > < span class = "type-signature" > < / span > searchForNotes< span class = "signature" > (searchString)< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "FNote.html" > FNote< / a > >>}< / span > < / h4 >
2019-04-22 22:52:09 +02:00
< div class = "description" >
This is a powerful search method - you can search by attributes and their values, e.g.:
2020-09-30 22:48:30 +02:00
"#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search
2019-04-22 22:52:09 +02:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > searchString< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line189" > line 189< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-04-22 22:52:09 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2019-04-22 22:52:09 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Promise.< Array.< < a href = "FNote.html" > FNote< / a > >>< / span >
2019-04-22 22:52:09 +02:00
< / dd >
< / dl >
2018-12-22 22:28:49 +01:00
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "setHoistedNoteId" > < span class = "type-signature" > < / span > setHoistedNoteId< span class = "signature" > (noteId)< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
2019-10-21 21:22:53 +02:00
< div class = "description" >
2021-02-17 23:55:51 +01:00
Hoist note in the current tab. See https://github.com/zadam/trilium/wiki/Note-hoisting
2019-10-21 21:22:53 +02:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > noteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > set hoisted note. 'root' will effectively unhoist< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line443" > line 443< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-10-21 21:22:53 +02:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-02-17 16:15:58 +01:00
< span class = "param-type" > Promise.< void>< / span >
2019-10-21 21:22:53 +02:00
< / dd >
< / dl >
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "setupElementTooltip" > < span class = "type-signature" > < / span > setupElementTooltip< span class = "signature" > ($el)< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
2018-12-22 22:28:49 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > $el< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
2023-02-17 16:15:58 +01:00
< td class = "description last" > jquery object on which to set up the tooltip< / td >
2018-12-22 22:28:49 +01:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line370" > line 370< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-10-07 16:27:12 +02:00
< / dl >
2023-02-17 16:15:58 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
< / dd >
< / dl >
2018-10-07 16:27:12 +02:00
2019-08-20 21:40:47 +02:00
2018-10-07 16:27:12 +02:00
2018-08-29 20:44:35 +02:00
< h4 class = "name" id = "showError" > < span class = "type-signature" > < / span > showError< span class = "signature" > (message)< / span > < span class = "type-signature" > < / span > < / h4 >
< div class = "description" >
2023-06-29 20:54:58 +02:00
Show an error message to the user.
2018-08-29 20:44:35 +02:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > message< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line274" > line 274< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h4 class = "name" id = "showMessage" > < span class = "type-signature" > < / span > showMessage< span class = "signature" > (message)< / span > < span class = "type-signature" > < / span > < / h4 >
< div class = "description" >
2023-06-29 20:54:58 +02:00
Show an info message to the user.
2018-08-29 20:44:35 +02:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > message< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line266" > line 266< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2019-08-20 21:40:47 +02:00
2022-05-13 22:33:57 +02:00
< h4 class = "name" id = "triggerCommand" > < span class = "type-signature" > < / span > triggerCommand< span class = "signature" > (name, data)< / span > < span class = "type-signature" > < / span > < / h4 >
< div class = "description" >
2023-06-29 20:54:58 +02:00
Trigger command. This is a very low-level API which should be avoided if possible.
2022-05-13 22:33:57 +02:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > data< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line283" > line 283< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-05-13 22:33:57 +02:00
< / dl >
< h4 class = "name" id = "triggerEvent" > < span class = "type-signature" > < / span > triggerEvent< span class = "signature" > (name, data)< / span > < span class = "type-signature" > < / span > < / h4 >
< div class = "description" >
2023-06-29 20:54:58 +02:00
Trigger event. This is a very low-level API which should be avoided if possible.
2022-05-13 22:33:57 +02:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > data< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-05-31 14:35:08 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line292" > line 292< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-05-13 22:33:57 +02:00
< / dl >
2019-12-10 23:04:18 +01:00
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "waitUntilSynced" > < span class = "type-signature" > < / span > waitUntilSynced< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< void>}< / span > < / h4 >
2019-12-10 23:04:18 +01:00
2020-01-01 22:03:27 +01:00
< div class = "description" >
2023-06-29 20:54:58 +02:00
Trilium runs in a backend and frontend process, when something is changed on the backend from a script,
2020-01-01 22:03:27 +01:00
frontend will get asynchronously synchronized.
This method returns a promise which resolves once all the backend -> frontend synchronization is finished.
2023-06-29 20:54:58 +02:00
Typical use case is when a new note has been created, we should wait until it is synced into frontend and only then activate it.
2020-01-01 22:03:27 +01:00
< / div >
2019-12-10 23:04:18 +01:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-09-06 09:20:32 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line471" > line 471< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-12-10 23:04:18 +01:00
< / dl >
2023-02-17 16:15:58 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< void>< / span >
< / dd >
< / dl >
2019-12-10 23:04:18 +01:00
2018-08-29 20:44:35 +02:00
< / article >
< / section >
< / div >
< nav >
2023-06-29 20:54:58 +02:00
< h2 > < a href = "index.html" > Home< / a > < / h2 > < h3 > Classes< / h3 > < ul > < 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 > < / ul >
2018-08-29 20:44:35 +02:00
< / nav >
< br class = "clear" >
< footer >
2023-05-31 14:35:08 +02:00
Documentation generated by < a href = "https://github.com/jsdoc/jsdoc" > JSDoc 4.0.2< / a >
2018-08-29 20:44:35 +02:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
