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" >
2023-09-06 09:25:00 +02:00
< 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 >
2023-02-17 16:15:58 +01:00
< / 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 >
2023-09-25 23:11:24 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line37" > line 37< / 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
< / div >
< h3 class = "subsection-title" > Members< / h3 >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "$container" > < span class = "type-signature" > < / span > $container< span class = "type-signature" > :jQuery< / span > < / h4 >
2019-10-06 21:35:26 +02:00
2023-08-21 04:17:16 -04:00
< div class = "description" >
Container of all the rendered script content
< / div >
2019-10-06 21:35:26 +02:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2019-10-06 21:35:26 +02:00
< span class = "param-type" > jQuery< / span >
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
2019-10-06 21:35:26 +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-25 23:11:24 +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 >
2020-04-07 19:19:20 +02:00
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "BasicWidget" > < span class = "type-signature" > < / span > BasicWidget< span class = "type-signature" > :< a href = "BasicWidget.html" > BasicWidget< / a > < / span > < / h4 >
2020-04-07 19:19:20 +02:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2020-04-07 19:19:20 +02:00
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "BasicWidget.html" > BasicWidget< / a > < / span >
2020-04-07 19:19:20 +02:00
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
2020-04-07 19:19:20 +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-10-07 20:57:53 +03:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line77" > line 77< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "NoteContextAwareWidget" > < span class = "type-signature" > < / span > NoteContextAwareWidget< span class = "type-signature" > :< a href = "NoteContextAwareWidget.html" > NoteContextAwareWidget< / a > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "NoteContextAwareWidget.html" > NoteContextAwareWidget< / a > < / span >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
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-10-07 20:57:53 +03:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line74" > line 74< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2023-01-03 14:31:46 +01:00
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "RightPanelWidget" > < span class = "type-signature" > < / span > RightPanelWidget< span class = "type-signature" > :< a href = "RightPanelWidget.html" > RightPanelWidget< / a > < / span > < / h4 >
2023-01-03 14:31:46 +01:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2023-01-03 14:31:46 +01:00
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "RightPanelWidget.html" > RightPanelWidget< / a > < / span >
2023-01-03 14:31:46 +01:00
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
2023-01-03 14:31:46 +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-10-07 20:57:53 +03:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line71" > line 71< / 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 >
2024-12-11 18:31:29 +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-07-27 23:22:08 +02:00
< / li > < / ul > < / dd >
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "currentNote" > < span class = "type-signature" > < / span > currentNote< span class = "type-signature" > :< a href = "FNote.html" > FNote< / a > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< div class = "description" >
2023-10-07 20:57:53 +03:00
Note where the script is currently executing, i.e. the note where the currently executing source code is written.
2023-08-21 04:17:16 -04:00
< / div >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "FNote.html" > FNote< / a > < / span >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
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-25 23:11:24 +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 >
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "dayjs" > < span class = "type-signature" > < / span > dayjs< span class = "type-signature" > :dayjs< / span > < / h4 >
2023-02-17 16:15:58 +01:00
2023-08-21 04:17:16 -04:00
< div class = "description" >
2023-09-06 09:25:00 +02:00
day.js library for date manipulation.
See < a href = "https://day.js.org" > https://day.js.org< / a > for documentation
2023-08-21 04:17:16 -04:00
< / div >
2023-02-17 16:15:58 +01:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2023-02-17 16:15:58 +01:00
< span class = "param-type" > dayjs< / span >
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
2023-02-17 16:15:58 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-10-07 20:57:53 +03:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line68" > line 68< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-04-07 19:19:20 +02:00
2023-08-21 04:17:16 -04:00
< dt class = "tag-see" > See:< / dt >
< dd class = "tag-see" >
< ul >
< li > < a href = "https://day.js.org" > https://day.js.org< / a > < / li >
< / ul >
< / dd >
2020-04-07 19:19:20 +02:00
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "originEntity" > < span class = "type-signature" > < / span > originEntity< span class = "type-signature" > :object|null< / span > < / h4 >
2020-04-07 19:19:20 +02:00
2023-08-21 04:17:16 -04:00
< div class = "description" >
2023-10-07 20:57:53 +03:00
Entity whose event triggered this execution.
2023-08-21 04:17:16 -04:00
< / div >
2020-04-07 19:19:20 +02:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2020-04-07 19:19:20 +02:00
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
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
2020-04-07 19:19:20 +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-10-07 20:57:53 +03:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line60" > line 60< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-04-07 19:19:20 +02:00
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "startNote" > < span class = "type-signature" > < / span > startNote< span class = "type-signature" > :< a href = "FNote.html" > FNote< / a > < / span > < / h4 >
2020-04-07 19:19:20 +02:00
2023-08-21 04:17:16 -04:00
< div class = "description" >
2023-10-07 20:57:53 +03:00
Note where the script started executing, i.e., the (event) entrypoint of the current script execution.
2023-08-21 04:17:16 -04:00
< / div >
2020-04-07 19:19:20 +02:00
2023-08-21 04:17:16 -04:00
< h5 > Type:< / h5 >
< ul >
< li >
2020-04-07 19:19:20 +02:00
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "FNote.html" > FNote< / a > < / span >
2020-04-07 19:19:20 +02:00
2023-08-21 04:17:16 -04:00
< / li >
< / ul >
2020-04-07 19:19:20 +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-25 23:11:24 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line48" > line 48< / a >
2023-02-17 16:15:58 +01:00
< / 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-10-07 20:57:53 +03:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line96" > line 96< / 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-10-07 20:57:53 +03:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line86" > line 86< / 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
2023-08-21 04:17:16 -04:00
< td class = "description last" >
< h6 > Properties< / h6 >
2023-01-03 14:31:46 +01:00
2023-08-21 04:17:16 -04:00
< table class = "params" >
2023-01-03 14:31:46 +01:00
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > title< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
2023-08-21 04:17:16 -04:00
< td class = "description last" > < / td >
2023-01-03 14:31:46 +01:00
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > action< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > function< / span >
2023-01-03 14:31:46 +01:00
< / td >
< td class = "attributes" >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
2023-08-21 04:17:16 -04:00
< td class = "description last" > callback handling the click on the button< / td >
2023-01-03 14:31:46 +01:00
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > id< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
2023-09-06 09:25:00 +02:00
< 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 >
2023-01-03 14:31:46 +01:00
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > icon< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > string< / span >
2023-01-03 14:31:46 +01:00
< / td >
< td class = "attributes" >
2023-08-21 04:17:16 -04:00
< optional>< br >
2023-01-03 14:31:46 +01:00
< / td >
2023-08-21 04:17:16 -04:00
< td class = "description last" > name of the boxicon to be used (e.g. "time" for "bx-time" icon)< / td >
2023-01-03 14:31:46 +01:00
< / tr >
< tr >
2023-08-21 04:17:16 -04:00
< td class = "name" > < code > shortcut< / code > < / td >
2023-01-03 14:31:46 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2023-08-21 04:17:16 -04:00
2023-01-03 14:31:46 +01:00
< / td >
< td class = "description last" > keyboard shortcut for the button, e.g. "alt+t"< / td >
< / tr >
< / tbody >
< / table >
2023-08-21 04:17:16 -04:00
< / td >
< / tr >
< / tbody >
< / table >
2023-01-03 14:31:46 +01:00
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2023-09-06 09:25:00 +02: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-10-07 20:57:53 +03:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line156" > line 156< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line415" > line 415< / 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 >
2023-09-06 09:25:00 +02:00
< 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line581" > line 581< / 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:25:00 +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 >
2023-08-21 04:17:16 -04:00
< 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 >
2023-09-06 09:25:00 +02:00
< / td >
< td class = "default" >
< / td >
< td class = "description last" > custom link tile with note's title as default< / td >
< / tr >
< tr >
< td class = "name" > < code > title=< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
2018-08-29 20:44:35 +02:00
< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line404" > line 404< / 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:25:00 +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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line318" > line 318< / 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" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#int" > int< / a > < / span >
2023-06-29 20:54:58 +02:00
< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line625" > line 625< / 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" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#int" > int< / a > < / span >
2023-07-15 12:07:45 +02:00
< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line617" > line 617< / 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 >
2023-09-13 09:01:55 +02:00
< h4 class = "name" id = "getActiveContext" > < span class = "type-signature" > < / span > getActiveContext< span class = "signature" > ()< / span > < span class = "type-signature" > → {NoteContext}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line427" > line 427< / a >
2023-09-13 09:01:55 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
- returns active context (split)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > NoteContext< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line461" > line 461< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line421" > line 421< / 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-09-13 09:01:55 +02:00
active note (loaded into center pane)
2022-06-02 17:25:58 +02:00
< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line476" > line 476< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line453" > line 453< / 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
2023-09-13 09:01:55 +02:00
< h4 class = "name" id = "getActiveMainContext" > < span class = "type-signature" > < / span > getActiveMainContext< span class = "signature" > ()< / span > < span class = "type-signature" > → {NoteContext}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line433" > line 433< / a >
2023-09-13 09:01:55 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
- returns active main context (first split in a tab, represents the tab as a whole)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > NoteContext< / span >
< / dd >
< / dl >
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" >
2023-09-06 09:25:00 +02:00
Get access to the widget handling note detail. Methods like `getWidgetType()` and `getTypeWidget()` to get to the
implementation of actual widget type.
2023-02-17 16:15:58 +01:00
< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line470" > line 470< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line485" > line 485< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line529" > line 529< / 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" >
2023-09-06 09:25:00 +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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line311" > line 311< / 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-09-13 09:01:55 +02:00
< h4 class = "name" id = "getMainNoteContexts" > < span class = "type-signature" > < / span > getMainNoteContexts< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< NoteContext>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line445" > line 445< / a >
2023-09-13 09:01:55 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
- returns all main contexts representing tabs
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Array.< NoteContext>< / span >
< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line547" > line 547< / 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-09-06 09:25:00 +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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line281" > line 281< / 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-09-13 09:01:55 +02:00
< h4 class = "name" id = "getNoteContexts" > < span class = "type-signature" > < / span > getNoteContexts< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< NoteContext>}< / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line439" > line 439< / a >
2023-09-13 09:01:55 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
- returns all note contexts (splits) in all tabs
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Array.< NoteContext>< / span >
< / dd >
< / dl >
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-09-06 09:25:00 +02:00
Returns list of notes. If note is missing from the 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. 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line294" > line 294< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line520" > line 520< / 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 >
2025-04-01 14:46:35 +02:00
< h4 class = "name" id = "getWeekFirstDayNote" > < span class = "type-signature" > < / span > getWeekFirstDayNote< 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line538" > line 538< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line556" > line 556< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line636" > line 636< / 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-10-07 20:57:53 +03:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line129" > line 129< / 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-10-07 20:57:53 +03:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line111" > line 111< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line325" > line 325< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line500" > line 500< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line510" > line 510< / 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-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#int" > int< / a > < / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line610" > line 610< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line601" > line 601< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line302" > line 302< / 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
2023-10-31 22:26:56 +01:00
< h4 class = "name" id = "runAsyncOnBackendWithManualTransactionHandling" > < span class = "type-signature" > < / span > runAsyncOnBackendWithManualTransactionHandling< span class = "signature" > (func, params)< / span > < span class = "type-signature" > → {Promise.< *>}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2023-09-06 09:25:00 +02:00
Executes given anonymous function on the backend.
Internally this serializes the anonymous function into string and sends it to backend via AJAX.
2023-10-31 22:26:56 +01:00
This function is meant for advanced needs where an async function is necessary.
In this case, the automatic request-scoped transaction management is not applied,
and you need to manually define transaction via api.transactional().
If you have a synchronous function, please use api.runOnBackend().
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 >
2023-10-31 22:26:56 +01:00
< td class = "name" > < code > func< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
2023-10-31 22:26:56 +01:00
< span class = "param-type" > function< / span >
2023-08-21 04:17:16 -04:00
|
2023-10-31 22:26:56 +01:00
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > (synchronous) function 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 >
< td class = "description last" > list of parameters to the anonymous function to be sent to backend< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line240" > line 240< / a >
2023-10-31 22:26:56 +01:00
< / li > < / ul > < / dd >
< / dl >
< 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 >
< h4 class = "name" id = "runOnBackend" > < span class = "type-signature" > < / span > runOnBackend< span class = "signature" > (func, params)< / span > < span class = "type-signature" > → {Promise.< *>}< / span > < / h4 >
< div class = "description" >
Executes given anonymous function on the backend.
Internally this serializes the anonymous function into string and sends it to backend via AJAX.
Please make sure that the supplied function is synchronous. Only sync functions will work correctly
with transaction management. If you really know what you're doing, you can call api.runAsyncOnBackendWithManualTransactionHandling()
< / 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 > func< / code > < / td >
< td class = "type" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > function< / span >
2023-10-31 22:26:56 +01:00
|
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
< / td >
2023-10-31 22:26:56 +01:00
< td class = "description last" > (synchronous) function to be executed on the backend< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< tr >
< td class = "name" > < code > params< / code > < / td >
< td class = "type" >
2023-10-31 22:26:56 +01:00
< span class = "param-type" > Array.< ?>< / span >
2018-08-29 20:44:35 +02:00
< / 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-10-31 22:26:56 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line218" > line 218< / 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 >
2023-10-31 22:26:56 +01:00
< span class = "param-type" > Promise.< *>< / span >
2018-08-29 20:44:35 +02:00
< / 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" >
2023-09-06 09:25:00 +02:00
This is a powerful search method - you can search by attributes and their values, e.g.:
2024-12-11 18:31:29 +02:00
"#dateModified =* MONTH AND #log". See full documentation for all options at: https://triliumnext.github.io/Docs/Wiki/search.html
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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line268" > line 268< / 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" >
2023-09-06 09:25:00 +02:00
This is a powerful search method - you can search by attributes and their values, e.g.:
2024-12-11 18:31:29 +02:00
"#dateModified =* MONTH AND #log". See full documentation for all options at: https://triliumnext.github.io/Docs/Wiki/search.html
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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line256" > line 256< / 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" >
2024-12-11 18:31:29 +02:00
Hoist note in the current tab. See https://triliumnext.github.io/Docs/Wiki/note-hoisting.html
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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line565" > line 565< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line492" > line 492< / 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
2023-09-25 23:11:24 +02:00
< h4 class = "name" id = "showConfirmDialog" > < span class = "type-signature" > < / span > showConfirmDialog< span class = "signature" > (message)< / span > < span class = "type-signature" > → {Promise.< boolean>}< / span > < / h4 >
< div class = "description" >
Show confirm dialog to the user.
< / 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line359" > line 359< / a >
2023-09-25 23:11:24 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
promise resolving to true if the user confirmed
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< boolean>< / span >
< / dd >
< / dl >
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-09-25 23:11:24 +02:00
Show an error toast 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line341" > line 341< / 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
2023-09-25 23:11:24 +02:00
< h4 class = "name" id = "showInfoDialog" > < span class = "type-signature" > < / span > showInfoDialog< span class = "signature" > (message)< / span > < span class = "type-signature" > → {Promise}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2023-09-25 23:11:24 +02:00
Show an info dialog 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line350" > line 350< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2023-09-25 23:11:24 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise< / span >
< / dd >
< / dl >
< 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" >
Show an info toast message to the user.
< / 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line333" > line 333< / a >
2023-09-25 23:11:24 +02:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "showPromptDialog" > < span class = "type-signature" > < / span > showPromptDialog< span class = "signature" > (props)< / span > < span class = "type-signature" > → {Promise.< string>}< / span > < / h4 >
< div class = "description" >
Show prompt dialog to the user.
< / 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 > props< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
< td class = "description last" >
< h6 > Properties< / h6 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > title< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > message< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > defaultValue< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line371" > line 371< / a >
2023-09-25 23:11:24 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
promise resolving to the answer provided by the user
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< string>< / span >
< / dd >
< / dl >
2018-08-29 20:44:35 +02:00
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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line380" > line 380< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line389" > line 389< / 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-09-06 09:25:00 +02:00
Trilium runs in a backend and frontend process, when something is changed on the backend from a script,
frontend will get asynchronously synchronized.
This method returns a promise which resolves once all the backend -> frontend synchronization is finished.
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 >
2024-12-11 18:31:29 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line593" > line 593< / 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-09-25 23:11:24 +02:00
< 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 >
2018-08-29 20:44:35 +02:00
< / nav >
< br class = "clear" >
< footer >
2024-12-15 10:44:40 +02:00
Documentation generated by < a href = "https://github.com/jsdoc/jsdoc" > JSDoc 4.0.4< / a >
2018-08-29 20:44:35 +02:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
