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 >
< h2 > < span class = "attribs" > < span class = "type-signature" > < / span > < / span > FrontendScriptApi< / h2 >
< / header >
< article >
< div class = "container-overview" >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-04-07 22:01:52 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line23" > line 23< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< / div >
< h3 class = "subsection-title" > Members< / h3 >
2019-10-06 21:35:26 +02:00
< h4 class = "name" id = "$container" > < span class = "type-signature" > < / span > $container< span class = "type-signature" > < / span > < / h4 >
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > container< / code > < / td >
< td class = "type" >
< span class = "param-type" > jQuery< / span >
< / td >
< td class = "description last" > of all the rendered script content< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-04-07 22:01:52 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line27" > line 27< / a >
2020-04-07 19:19:20 +02:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "BasicWidget" > < span class = "type-signature" > < / span > BasicWidget< span class = "type-signature" > < / span > < / h4 >
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "type" >
< span class = "param-type" > BasicWidget< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line61" > line 61< / a >
2019-10-06 21:35:26 +02:00
< / li > < / ul > < / dd >
< / dl >
2020-03-08 11:41:42 +01:00
< h4 class = "name" id = "CollapsibleWidget" > < span class = "type-signature" > < / span > CollapsibleWidget< span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "type" >
2020-03-08 11:41:42 +01:00
< span class = "param-type" > CollapsibleWidget< / span >
2018-08-29 20:44:35 +02:00
< / td >
2020-03-08 11:41:42 +01:00
< td class = "description last" > < / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-04-07 22:01:52 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line40" > line 40< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2020-03-08 11:41:42 +01:00
< h4 class = "name" id = "currentNote" > < span class = "type-signature" > < / span > currentNote< span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-03-08 11:41:42 +01:00
< td class = "name" > < code > note< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
2020-03-08 11:41:42 +01:00
< td class = "description last" > where script is currently executing< / td >
2018-08-29 20:44:35 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-04-07 22:01:52 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line32" > line 32< / a >
2019-08-20 21:40:47 +02:00
< / li > < / ul > < / dd >
< / dl >
2021-09-30 12:26:13 +02:00
< h4 class = "name" id = "NoteContextAwareWidget" > < span class = "type-signature" > < / span > NoteContextAwareWidget< span class = "type-signature" > < / span > < / h4 >
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "type" >
< span class = "param-type" > NoteContextAwareWidget< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line49" > line 49< / a >
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "NoteContextCachingWidget" > < span class = "type-signature" > < / span > NoteContextCachingWidget< span class = "type-signature" > < / span > < / h4 >
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "type" >
< span class = "param-type" > NoteContextAwareWidget< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line58" > line 58< / a >
< / li > < / ul > < / dd >
< / dl >
2020-03-08 11:41:42 +01:00
< h4 class = "name" id = "originEntity" > < span class = "type-signature" > < / span > originEntity< span class = "type-signature" > < / span > < / h4 >
2019-08-20 21:40:47 +02:00
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
2020-03-08 11:41:42 +01:00
< th > Name< / th >
2019-08-20 21:40:47 +02:00
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-03-08 11:41:42 +01:00
< td class = "name" > < code > entity< / code > < / td >
2019-08-20 21:40:47 +02:00
< td class = "type" >
2020-03-08 11:41:42 +01:00
< span class = "param-type" > object< / span >
|
< span class = "param-type" > null< / span >
2019-08-20 21:40:47 +02:00
< / td >
2020-03-08 11:41:42 +01:00
< td class = "description last" > whose event triggered this execution< / td >
2019-08-20 21:40:47 +02:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-04-07 22:01:52 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line34" > line 34< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "startNote" > < span class = "type-signature" > < / span > startNote< span class = "type-signature" > < / span > < / h4 >
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > note< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
< td class = "description last" > where script started executing< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-04-07 22:01:52 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line30" > line 30< / a >
2020-04-07 19:19:20 +02:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "TabAwareWidget" > < span class = "type-signature" > < / span > TabAwareWidget< span class = "type-signature" > < / span > < / h4 >
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "type" >
2021-09-30 12:26:13 +02:00
< span class = "param-type" > NoteContextAwareWidget< / span >
2020-04-07 19:19:20 +02:00
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2021-09-30 12:26:13 +02:00
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > use NoteContextAwareWidget instead< / li > < / ul > < / dd >
2020-04-07 19:19:20 +02:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line46" > line 46< / a >
2020-04-07 19:19:20 +02:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "TabCachingWidget" > < span class = "type-signature" > < / span > TabCachingWidget< span class = "type-signature" > < / span > < / h4 >
< h5 class = "subsection-title" > Properties:< / h5 >
< table class = "props" >
< thead >
< tr >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "type" >
2021-09-30 12:26:13 +02:00
< span class = "param-type" > NoteContextCachingWidget< / span >
2020-04-07 19:19:20 +02:00
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
2021-09-30 12:26:13 +02:00
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > use NoteContextCachingWidget instead< / li > < / ul > < / dd >
2020-04-07 19:19:20 +02:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line55" > line 55< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line80" > line 80< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line70" > line 70< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / 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 = "addButtonToToolbar" > < span class = "type-signature" > < / span > addButtonToToolbar< span class = "signature" > (opts)< / span > < span class = "type-signature" > < / span > < / h4 >
< div class = "description" >
Adds new button the the plugin area.
< / 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 > opts< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "global.html#ToolbarButtonOptions" > ToolbarButtonOptions< / a > < / 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 >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line117" > line 117< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2020-01-10 20:10:17 +01:00
< h4 class = "name" id = "addTextToActiveTabEditor" > < span class = "type-signature" > < / span > addTextToActiveTabEditor< 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 >
2020-02-02 11:44:08 +01:00
< td class = "description last" > this must be clear text, HTML is not supported.< / td >
2020-01-10 20:10:17 +01:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-05 20:31:21 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line327" > line 327< / a >
2020-01-10 20:10:17 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-11-05 21:26:54 +01:00
< h4 class = "name" id = "bindGlobalShortcut" > < span class = "type-signature" > < / span > bindGlobalShortcut< span class = "signature" > (keyboardShortcut, handler)< / span > < span class = "type-signature" > < / 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 > keyboardShortcut< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< 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 = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-10 19:54:38 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line457" > line 457< / a >
2019-11-05 21:26:54 +01:00
< / li > < / ul > < / dd >
< / dl >
2018-08-29 20:44:35 +02:00
2021-02-17 23:55:51 +01:00
< h4 class = "name" id = "createNoteLink" > < span class = "type-signature" > < / span > createNoteLink< span class = "signature" > (notePath, params< span class = "signature-attributes" > opt< / span > , title=< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
Create note link (jQuery object) for given note.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Attributes< / 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 = "attributes" >
< / td >
< td class = "description last" > (or noteId)< / td >
< / tr >
< tr >
2021-02-17 23:55:51 +01:00
< td class = "name" > < code > params< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" >
< h6 > Properties< / h6 >
< 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
< / tbody >
< / table >
< / td >
< / tr >
< tr >
< td class = "name" > < code > title=< / code > < / td >
2018-08-29 20:44:35 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
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 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-05 20:31:21 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line319" > line 319< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line277" > line 277< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / 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 >
2020-02-02 11:44:08 +01:00
< h4 class = "name" id = "getActiveTabNote" > < span class = "type-signature" > < / span > getActiveTabNote< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "NoteShort.html" > NoteShort< / a > }< / span > < / h4 >
2018-10-07 16:27:12 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-05 20:31:21 +01: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 >
2018-10-07 16:27:12 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-10-07 16:27:12 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2019-03-12 21:52:19 +01:00
active note (loaded into right pane)
2018-10-07 16:27:12 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-02-02 11:44:08 +01:00
< span class = "param-type" > < a href = "NoteShort.html" > NoteShort< / a > < / span >
2018-10-07 16:27:12 +02:00
< / dd >
< / dl >
2019-10-20 12:29:34 +02:00
< h4 class = "name" id = "getActiveTabNotePath" > < span class = "type-signature" > < / span > getActiveTabNotePath< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< (string|null)>}< / span > < / h4 >
2018-09-03 16:05:28 +02:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-05 20:31:21 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line347" > line 347< / a >
2018-09-03 16:05:28 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-09-03 16:05:28 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2019-05-21 21:47:28 +02:00
returns note path of active note or null if there isn't active note
2018-09-03 16:05:28 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2019-05-21 21:47:28 +02:00
< span class = "param-type" > Promise.< (string|null)>< / span >
2018-09-03 16:05:28 +02:00
< / dd >
< / dl >
2020-02-02 11:44:08 +01:00
< h4 class = "name" id = "getActiveTabTextEditor" > < span class = "type-signature" > < / span > getActiveTabTextEditor< span class = "signature" > (callback)< / span > < span class = "type-signature" > < / span > < / h4 >
2020-01-10 20:10:17 +01:00
< div class = "description" >
See https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editor-Editor.html for a documentation on the returned instance.
< / div >
2020-02-02 11:44:08 +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 > callback< / code > < / td >
< td class = "type" >
< / td >
< td class = "description last" > method receiving "textEditor" instance< / td >
< / tr >
< / tbody >
< / table >
2020-01-10 20:10:17 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-05 20:31:21 +01: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 >
2020-01-10 20:10:17 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-04-14 12:24:48 +02:00
< h4 class = "name" id = "getDateNote" > < span class = "type-signature" > < / span > getDateNote< span class = "signature" > (date)< / span > < span class = "type-signature" > → {Promise.< < a href = "NoteShort.html" > NoteShort< / a > >}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2022-01-10 19:54:38 +01:00
Returns day note for a given date. 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 > 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" >
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > use getDayNote instead< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line399" > line 399< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< < a href = "NoteShort.html" > NoteShort< / a > >< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getDayNote" > < span class = "type-signature" > < / span > getDayNote< span class = "signature" > (date)< / span > < span class = "type-signature" > → {Promise.< < a href = "NoteShort.html" > NoteShort< / a > >}< / span > < / h4 >
< 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-10 19:54:38 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line408" > line 408< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / 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 >
2019-04-14 12:24:48 +02:00
< span class = "param-type" > Promise.< < a href = "NoteShort.html" > NoteShort< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2019-04-14 12:24:48 +02:00
< h4 class = "name" id = "getInstanceName" > < span class = "type-signature" > < / span > getInstanceName< span class = "signature" > ()< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
2019-02-20 22:24:51 +01:00
< div class = "description" >
2019-04-14 12:24:48 +02:00
Instance name identifies particular Trilium instance. It can be useful for scripts
if some action needs to happen on only one specific instance.
2019-02-20 22:24:51 +01:00
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line270" > line 270< / a >
2019-02-20 22:24:51 +01:00
< / li > < / ul > < / dd >
< / 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 >
2019-04-14 12:24:48 +02:00
< h4 class = "name" id = "getMonthNote" > < span class = "type-signature" > < / span > getMonthNote< span class = "signature" > (month)< / span > < span class = "type-signature" > → {Promise.< < a href = "NoteShort.html" > NoteShort< / 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-10 19:54:38 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line426" > line 426< / a >
2018-09-03 16:05:28 +02:00
< / li > < / ul > < / dd >
< / 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 >
< span class = "param-type" > Promise.< < a href = "NoteShort.html" > NoteShort< / a > >< / span >
< / dd >
< / dl >
2018-09-03 16:05:28 +02:00
2018-08-29 20:44:35 +02:00
2019-04-14 12:24:48 +02:00
< h4 class = "name" id = "getNote" > < span class = "type-signature" > < / span > getNote< span class = "signature" > (noteId)< / span > < span class = "type-signature" > → {Promise.< < a href = "NoteShort.html" > NoteShort< / a > >}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2019-04-14 12:24:48 +02:00
< div class = "description" >
Returns note by given noteId. If note is missing from cache, it's loaded.
*
< / 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line242" > line 242< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / 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 >
2019-04-14 12:24:48 +02:00
< span class = "param-type" > Promise.< < a href = "NoteShort.html" > NoteShort< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2019-02-20 22:24:51 +01:00
2019-04-14 12:24:48 +02: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 = "NoteShort.html" > NoteShort< / a > >>}< / span > < / h4 >
2019-02-20 22:24:51 +01:00
2019-04-14 12:24:48 +02:00
< div class = "description" >
Returns list of notes. If note is missing from cache, it's loaded.
2019-02-20 22:24:51 +01:00
2019-04-14 12:24:48 +02:00
This is often used to bulk-fill the cache with notes which would have to be picked one by one
otherwise (by e.g. createNoteLink())
< / 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
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line254" > line 254< / a >
2019-02-20 22:24:51 +01:00
< / li > < / ul > < / dd >
< / 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 >
< span class = "param-type" > Promise.< Array.< < a href = "NoteShort.html" > NoteShort< / a > >>< / span >
< / dd >
< / dl >
2019-02-20 22:24:51 +01:00
2018-08-29 20:44:35 +02:00
2019-04-14 12:24:48 +02:00
< h4 class = "name" id = "getTodayNote" > < span class = "type-signature" > < / span > getTodayNote< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< < a href = "NoteShort.html" > NoteShort< / 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-05 20:31:21 +01: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 >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / 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 >
< span class = "param-type" > Promise.< < a href = "NoteShort.html" > NoteShort< / a > >< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getWeekNote" > < span class = "type-signature" > < / span > getWeekNote< span class = "signature" > (date)< / span > < span class = "type-signature" > → {Promise.< < a href = "NoteShort.html" > NoteShort< / a > >}< / span > < / h4 >
< 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-10 19:54:38 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line417" > line 417< / a >
2021-11-10 21:30:54 +01:00
< / li > < / ul > < / dd >
< / dl >
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2019-04-14 12:24:48 +02:00
< span class = "param-type" > Promise.< < a href = "NoteShort.html" > NoteShort< / a > >< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getYearNote" > < span class = "type-signature" > < / span > getYearNote< span class = "signature" > (year)< / span > < span class = "type-signature" > → {Promise.< < a href = "NoteShort.html" > NoteShort< / a > >}< / span > < / h4 >
< 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-10 19:54:38 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line435" > line 435< / a >
2019-04-14 12:24:48 +02:00
< / li > < / ul > < / dd >
< / 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 >
< span class = "param-type" > Promise.< < a href = "NoteShort.html" > NoteShort< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2019-04-14 12:24:48 +02:00
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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line94" > line 94< / a >
2021-02-17 23:55:51 +01:00
< / li > < / ul > < / dd >
< / 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line284" > line 284< / a >
2019-04-14 12:24:48 +02:00
< / li > < / ul > < / dd >
< / 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 >
Type
< / dt >
< dd >
2020-03-08 11:41:42 +01:00
< span class = "param-type" > Date< / span >
2019-04-14 12:24:48 +02:00
< / dd >
< / dl >
2020-03-08 11:41:42 +01:00
< h4 class = "name" id = "protectActiveNote" > < span class = "type-signature" > < / span > protectActiveNote< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > use protectNote and protectSubtree instead< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-05 20:31:21 +01: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 >
2020-03-08 11:41:42 +01:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "protectNote" > < span class = "type-signature" > < / span > protectNote< span class = "signature" > (noteId, protect)< / span > < span class = "type-signature" > < / 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-05 20:31:21 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line370" > line 370< / a >
2019-04-14 12:24:48 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02: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
2019-04-14 12:24:48 +02:00
2020-03-08 11:41:42 +01:00
< h4 class = "name" id = "protectSubTree" > < span class = "type-signature" > < / span > protectSubTree< span class = "signature" > (noteId, protect)< / span > < span class = "type-signature" > < / span > < / h4 >
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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-05 20:31:21 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line379" > line 379< / a >
2021-04-07 22:01:52 +02:00
< / li > < / ul > < / dd >
< / dl >
< 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" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > of the string< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-10 19:54:38 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line484" > line 484< / a >
2020-09-30 22:48:30 +02:00
< / li > < / ul > < / dd >
< / 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
< h4 class = "name" id = "refreshIncludedNote" > < span class = "type-signature" > < / span > refreshIncludedNote< span class = "signature" > (includedNoteId)< / span > < span class = "type-signature" > < / span > < / h4 >
< 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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-10 19:54:38 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line475" > line 475< / a >
2019-11-10 19:34:15 +01:00
< / li > < / ul > < / dd >
< / dl >
2019-04-14 12:24:48 +02:00
2020-04-07 19:19:20 +02:00
< h4 class = "name" id = "refreshTree" > < span class = "type-signature" > < / span > refreshTree< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2019-04-14 12:24:48 +02:00
< dl class = "details" >
2020-04-07 19:19:20 +02:00
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > - this is now no-op since all the changes should be gracefully handled per widget< / li > < / ul > < / dd >
2019-04-14 12:24:48 +02:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line306" > line 306< / a >
2019-04-14 12:24:48 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02: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" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line262" > line 262< / a >
2019-04-14 12:24:48 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2019-04-14 12:24:48 +02:00
2018-08-29 20:44:35 +02:00
2020-01-01 22:03:27 +01:00
< h4 class = "name" id = "runOnBackend" > < span class = "type-signature" > < / span > runOnBackend< span class = "signature" > (script, params)< / span > < span class = "type-signature" > → {Promise.< *>}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< div class = "description" >
2020-01-01 22:03:27 +01:00
Executes given anonymous function on the backend.
2018-08-29 20:44:35 +02:00
Internally this serializes the anonymous function into string and sends it to backend via AJAX.
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > script< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > script to be executed on the backend< / td >
< / tr >
< tr >
< td class = "name" > < code > params< / code > < / td >
< td class = "type" >
< span class = "param-type" > Array.< ?>< / span >
< / td >
< td class = "description last" > list of parameters to the anonymous function to be send to backend< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line180" > line 180< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
return value of the executed function on the backend
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< *>< / span >
< / dd >
< / dl >
2020-01-01 22:03:27 +01:00
< h4 class = "name" id = "runOnServer" > < span class = "type-signature" > < / span > runOnServer< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > new name of this API call is runOnBackend so use that< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line208" > line 208< / a >
2020-01-01 22:03:27 +01:00
< / li > < / ul > < / dd >
< / dl >
2018-08-29 20:44:35 +02:00
2018-10-07 16:27:12 +02:00
2019-04-22 22:52:09 +02:00
< h4 class = "name" id = "searchForNote" > < span class = "type-signature" > < / span > searchForNote< span class = "signature" > (searchString)< / span > < span class = "type-signature" > → {Promise.< (< a href = "NoteShort.html" > NoteShort< / a > |null)>}< / span > < / h4 >
< div class = "description" >
This is a powerful search method - you can search by attributes and their values, e.g.:
2020-09-30 22:48:30 +02:00
"#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search
2019-04-22 22:52:09 +02:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > searchString< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line230" > line 230< / a >
2019-04-22 22:52:09 +02:00
< / li > < / ul > < / dd >
< / 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 >
< span class = "param-type" > Promise.< (< a href = "NoteShort.html" > NoteShort< / a > |null)>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "searchForNotes" > < span class = "type-signature" > < / span > searchForNotes< span class = "signature" > (searchString)< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "NoteShort.html" > NoteShort< / a > >>}< / span > < / h4 >
< div class = "description" >
This is a powerful search method - you can search by attributes and their values, e.g.:
2020-09-30 22:48:30 +02:00
"#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search
2019-04-22 22:52:09 +02:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > searchString< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2021-09-30 12:26:13 +02: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 >
2019-04-22 22:52:09 +02:00
< / li > < / ul > < / dd >
< / 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 >
< span class = "param-type" > Promise.< Array.< < a href = "NoteShort.html" > NoteShort< / a > >>< / span >
< / dd >
< / dl >
2018-12-22 22:28:49 +01:00
2019-10-21 21:22:53 +02:00
< h4 class = "name" id = "setHoistedNoteId" > < span class = "type-signature" > < / span > setHoistedNoteId< span class = "signature" > (noteId)< / span > < span class = "type-signature" > → {Promise}< / span > < / h4 >
< div class = "description" >
2021-02-17 23:55:51 +01:00
Hoist note in the current tab. See https://github.com/zadam/trilium/wiki/Note-hoisting
2019-10-21 21:22:53 +02:00
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > noteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > set hoisted note. 'root' will effectively unhoist< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-10 19:54:38 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line444" > line 444< / a >
2019-10-21 21:22:53 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise< / span >
< / dd >
< / dl >
2018-12-22 22:28:49 +01:00
< h4 class = "name" id = "setupElementTooltip" > < span class = "type-signature" > < / span > setupElementTooltip< span class = "signature" > ($el)< / span > < span class = "type-signature" > < / 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 > $el< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
< td class = "description last" > jquery object on which to setup the tooltip< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-05 20:31:21 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line353" > line 353< / a >
2018-10-07 16:27:12 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-10-07 16:27:12 +02:00
2018-08-29 20:44:35 +02:00
< h4 class = "name" id = "showError" > < span class = "type-signature" > < / span > showError< span class = "signature" > (message)< / span > < span class = "type-signature" > < / span > < / h4 >
< div class = "description" >
Show error 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 >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line300" > line 300< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< h4 class = "name" id = "showMessage" > < span class = "type-signature" > < / span > showMessage< span class = "signature" > (message)< / span > < span class = "type-signature" > < / span > < / h4 >
< div class = "description" >
Show info 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 >
2021-09-30 12:26:13 +02:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line292" > line 292< / a >
2018-08-29 20:44:35 +02:00
< / li > < / ul > < / dd >
< / dl >
2019-08-20 21:40:47 +02:00
2019-12-10 23:04:18 +01:00
< h4 class = "name" id = "waitUntilSynced" > < span class = "type-signature" > < / span > waitUntilSynced< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2020-01-01 22:03:27 +01:00
< div class = "description" >
Trilium runs in backend and frontend process, when something is changed on the backend from 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 new note has been created, we should wait until it is synced into frontend and only then activate it.
< / div >
2019-12-10 23:04:18 +01:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2022-01-10 19:54:38 +01:00
< a href = "services_frontend_script_api.js.html" > services/frontend_script_api.js< / a > , < a href = "services_frontend_script_api.js.html#line468" > line 468< / a >
2019-12-10 23:04:18 +01:00
< / li > < / ul > < / dd >
< / dl >
2018-08-29 20:44:35 +02:00
< / article >
< / section >
< / div >
< nav >
2021-11-10 21:30:54 +01:00
< h2 > < a href = "index.html" > Home< / a > < / h2 > < h3 > Classes< / h3 > < ul > < li > < a href = "Attribute.html" > Attribute< / a > < / li > < li > < a href = "Branch.html" > Branch< / a > < / li > < li > < a href = "FrontendScriptApi.html" > FrontendScriptApi< / a > < / li > < li > < a href = "NoteComplement.html" > NoteComplement< / a > < / li > < li > < a href = "NoteShort.html" > NoteShort< / a > < / li > < / ul > < h3 > Global< / h3 > < ul > < li > < a href = "global.html#doRenderBody" > doRenderBody< / a > < / li > < / ul >
2018-08-29 20:44:35 +02:00
< / nav >
< br class = "clear" >
< footer >
2021-09-30 12:26:13 +02:00
Documentation generated by < a href = "https://github.com/jsdoc/jsdoc" > JSDoc 3.6.7< / a >
2018-08-29 20:44:35 +02:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
