2018-08-29 20:44:35 +02:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
2023-01-03 13:54:27 +01:00
< title > JSDoc: Class: FNote< / title >
2018-08-29 20:44:35 +02:00
< 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" >
2023-01-03 13:54:27 +01:00
< h1 class = "page-title" > Class: FNote< / h1 >
2018-08-29 20:44:35 +02:00
< section >
< header >
2023-01-03 13:54:27 +01:00
< h2 > < span class = "attribs" > < span class = "type-signature" > < / span > < / span > FNote< span class = "signature" > (froca, row)< / span > < span class = "type-signature" > < / span > < / h2 >
2018-08-29 20:44:35 +02:00
2023-08-21 04:17:16 -04:00
< div class = "class-description" > Note is the main node and concept in Trilium.< / div >
2018-08-29 20:44:35 +02:00
< / header >
< article >
< div class = "container-overview" >
2023-08-21 04:17:16 -04:00
< h2 > Constructor< / h2 >
2018-08-29 20:44:35 +02:00
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "FNote" > < span class = "type-signature" > < / span > new FNote< span class = "signature" > (froca, row)< / span > < span class = "type-signature" > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
2019-10-26 10:00:26 +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 >
2021-04-16 22:57:37 +02:00
< td class = "name" > < code > froca< / code > < / td >
2019-10-26 10:00:26 +02:00
< td class = "type" >
2021-04-16 22:57:37 +02:00
< span class = "param-type" > Froca< / span >
2019-10-26 10:00:26 +02:00
< / td >
< td class = "description last" > < / td >
< / tr >
< tr >
< td class = "name" > < code > row< / code > < / td >
< td class = "type" >
< span class = "param-type" > Object.< string, Object>< / span >
< / td >
< td class = "description last" > < / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.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 >
2019-08-20 21:40:47 +02:00
2018-08-29 20:44:35 +02:00
< / div >
< h3 class = "subsection-title" > Members< / h3 >
2023-06-29 20:54:58 +02:00
< h4 class = "name" id = "attachments" > < span class = "type-signature" > < / span > attachments< span class = "type-signature" > :Array.< < a href = "FAttachment.html" > FAttachment< / a > >|null< / span > < / h4 >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > Array.< < a href = "FAttachment.html" > FAttachment< / a > >< / span >
|
< span class = "param-type" > null< / span >
< / li >
< / ul >
< 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line75" > line 75< / a >
2023-06-29 20:54:58 +02:00
< / li > < / ul > < / dd >
< / dl >
2020-02-02 11:44:08 +01:00
< h4 class = "name" id = "attributes" > < span class = "type-signature" > < / span > attributes< span class = "type-signature" > :Array.< string>< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2020-02-02 11:44:08 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > Array.< string>< / span >
< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line58" > line 58< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-10-26 10:00:26 +02:00
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "childToBranch" > < span class = "type-signature" > < / span > childToBranch< span class = "type-signature" > :Object.< string, string>< / span > < / h4 >
2019-10-26 10:00:26 +02:00
< h5 > Type:< / h5 >
< ul >
< li >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Object.< string, string>< / span >
2019-10-26 10:00:26 +02:00
< / li >
< / ul >
< 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line72" > line 72< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-10-26 10:00:26 +02:00
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "children" > < span class = "type-signature" > < / span > children< span class = "type-signature" > :Array.< string>< / span > < / h4 >
2019-10-26 10:00:26 +02:00
< h5 > Type:< / h5 >
< ul >
< li >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Array.< string>< / span >
2019-10-26 10:00:26 +02:00
< / li >
< / ul >
< 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line66" > line 66< / a >
2023-07-27 23:22:08 +02:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "froca" > < span class = "type-signature" > < / span > froca< span class = "type-signature" > :Froca< / span > < / h4 >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > Froca< / span >
< / li >
< / ul >
< 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line55" > line 55< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-11-05 21:26:54 +01:00
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "isProtected" > < span class = "type-signature" > < / span > isProtected< span class = "type-signature" > :boolean< / span > < / h4 >
2019-11-23 22:56:35 +01:00
2021-11-10 21:30:54 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > boolean< / span >
< / li >
< / ul >
2019-11-23 22:56:35 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line86" > line 86< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-11-23 22:56:35 +01:00
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "mime" > < span class = "type-signature" > < / span > mime< span class = "type-signature" > :string< / span > < / h4 >
2019-11-05 21:26:54 +01:00
2021-11-10 21:30:54 +01:00
< div class = "description" >
content-type, e.g. "application/json"
< / div >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
2019-11-05 21:26:54 +01:00
2021-11-10 21:30:54 +01:00
< / li >
< / ul >
2019-11-05 21:26:54 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.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 >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "noteId" > < span class = "type-signature" > < / span > noteId< span class = "type-signature" > :string< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
< / 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 >
2024-12-11 18:31:29 +02:00
< a href = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line82" > line 82< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "parentToBranch" > < span class = "type-signature" > < / span > parentToBranch< span class = "type-signature" > :Object.< string, string>< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2020-02-02 11:44:08 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
2018-08-29 20:44:35 +02:00
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Object.< string, string>< / span >
2018-08-29 20:44:35 +02:00
2020-02-02 11:44:08 +01: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 >
2024-12-11 18:31:29 +02:00
< a href = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line69" > line 69< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-10-26 10:00:26 +02:00
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "parents" > < span class = "type-signature" > < / span > parents< span class = "type-signature" > :Array.< string>< / span > < / h4 >
2019-10-26 10:00:26 +02:00
< h5 > Type:< / h5 >
< ul >
< li >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Array.< string>< / span >
2019-10-26 10:00:26 +02:00
< / li >
< / ul >
< 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line64" > line 64< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-10-26 10:00:26 +02:00
< / dl >
2020-02-02 11:44:08 +01:00
< h4 class = "name" id = "targetRelations" > < span class = "type-signature" > < / span > targetRelations< span class = "type-signature" > :Array.< string>< / span > < / h4 >
2019-10-26 10:00:26 +02:00
< h5 > Type:< / h5 >
< ul >
< li >
2020-02-02 11:44:08 +01:00
< span class = "param-type" > Array.< string>< / span >
2019-10-26 10:00:26 +02:00
< / li >
< / ul >
< 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line61" > line 61< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-08-29 20:44:35 +02:00
< / dl >
2021-11-10 21:30:54 +01:00
< h4 class = "name" id = "title" > < span class = "type-signature" > < / span > title< span class = "type-signature" > :string< / span > < / h4 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01: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 >
2024-12-11 18:31:29 +02:00
< a href = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line84" > line 84< / 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 = "type" > < span class = "type-signature" > < / span > type< span class = "type-signature" > :< a href = "global.html#NoteType" > NoteType< / a > < / span > < / h4 >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< div class = "description" >
2023-08-21 04:17:16 -04:00
See {@see NoteType} for info on values.
2021-11-10 21:30:54 +01:00
< / div >
2018-08-29 20:44:35 +02:00
2021-11-10 21:30:54 +01:00
< h5 > Type:< / h5 >
< ul >
< li >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#NoteType" > NoteType< / a > < / span >
2021-11-10 21:30:54 +01: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 >
2024-12-11 18:31:29 +02:00
< a href = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line91" > line 91< / 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 >
2023-05-31 14:35:08 +02:00
< h4 class = "name" id = "getAllNotePaths" > < span class = "type-signature" > < / span > getAllNotePaths< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< Array.< string>>}< / span > < / h4 >
< div class = "description" >
Gives all possible note paths leading to this note. Paths containing search note are ignored (could form cycles)
< / div >
< 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line382" > line 382< / a >
2023-05-31 14:35:08 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
- array of notePaths (each represented by array of noteIds constituting the particular note path)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Array.< Array.< string>>< / span >
< / dd >
< / dl >
2023-06-29 20:54:58 +02:00
< h4 class = "name" id = "getAttachmentById" > < span class = "type-signature" > (async) < / span > getAttachmentById< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< < a href = "FAttachment.html" > FAttachment< / a > >}< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line269" > line 269< / a >
2023-06-29 20:54:58 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< < a href = "FAttachment.html" > FAttachment< / a > >< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getAttachments" > < span class = "type-signature" > (async) < / span > getAttachments< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "FAttachment.html" > FAttachment< / a > >>}< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line254" > line 254< / a >
2023-06-29 20:54:58 +02:00
< / li > < / ul > < / dd >
< / dl >
2023-09-25 23:11:24 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "FAttachment.html" > FAttachment< / a > >>< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getAttachmentsByRole" > < span class = "type-signature" > (async) < / span > getAttachmentsByRole< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "FAttachment.html" > FAttachment< / a > >>}< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line263" > line 263< / a >
2023-09-25 23:11:24 +02:00
< / li > < / ul > < / dd >
< / dl >
2023-06-29 20:54:58 +02:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< Array.< < a href = "FAttachment.html" > FAttachment< / a > >>< / span >
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getAttribute" > < span class = "type-signature" > < / span > getAttribute< span class = "signature" > (type, name)< / span > < span class = "type-signature" > → {< a href = "FAttribute.html" > FAttribute< / a > }< / span > < / h4 >
2018-12-22 22:28:49 +01:00
< h5 > Parameters:< / h5 >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< 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
2018-12-22 22:28:49 +01:00
< tr >
< td class = "name" > < code > type< / code > < / td >
< td class = "type" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#AttributeType" > AttributeType< / a > < / span >
2018-12-22 22:28:49 +01:00
< / td >
2023-05-31 14:35:08 +02:00
< td class = "description last" > attribute type (label, relation, etc.)< / td >
< / tr >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > attribute name< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line645" > line 645< / a >
2023-05-31 14:35:08 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2023-07-15 12:07:45 +02:00
attribute of the given type and name. If there are more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
2023-05-31 14:35:08 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "FAttribute.html" > FAttribute< / a > < / span >
< / dd >
< / dl >
< h4 class = "name" id = "getAttributeValue" > < span class = "type-signature" > < / span > getAttributeValue< span class = "signature" > (type, name)< / 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 > type< / code > < / td >
< td class = "type" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#AttributeType" > AttributeType< / a > < / span >
2023-05-31 14:35:08 +02:00
< / td >
< td class = "description last" > attribute type (label, relation, etc.)< / td >
< / tr >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > attribute name< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line667" > line 667< / a >
2023-05-31 14:35:08 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2023-06-29 20:54:58 +02:00
attribute value of the given type and name or null if no such attribute exists.
2023-05-31 14:35:08 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > string< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getAttributes" > < span class = "type-signature" > < / span > getAttributes< span class = "signature" > (type< span class = "signature-attributes" > opt< / span > , name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Array.< < a href = "FAttribute.html" > FAttribute< / a > >}< / span > < / h4 >
< 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 > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > (optional) attribute type to filter< / td >
2018-12-22 22:28:49 +01:00
< / tr >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2023-05-31 14:35:08 +02:00
< td class = "attributes" >
< optional>< br >
< / td >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2023-05-31 14:35:08 +02:00
< td class = "description last" > (optional) attribute name to filter< / td >
2018-12-22 22:28:49 +01:00
< / tr >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line316" > line 316< / 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 >
2018-12-22 22:28:49 +01:00
< div class = "param-desc" >
2023-05-31 14:35:08 +02:00
all note's attributes, including inherited ones
2018-12-22 22:28:49 +01:00
< / div >
2018-08-29 20:44:35 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2023-05-31 14:35:08 +02:00
< span class = "param-type" > Array.< < a href = "FAttribute.html" > FAttribute< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2023-05-31 14:35:08 +02:00
< h4 class = "name" id = "getBestNotePath" > < span class = "type-signature" > < / span > getBestNotePath< span class = "signature" > (hoistedNoteId< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Array.< string>}< / span > < / h4 >
2018-12-22 22:28:49 +01:00
2023-05-31 14:35:08 +02:00
< div class = "description" >
2023-06-29 20:54:58 +02:00
Returns the note path considered to be the "best"
2023-05-31 14:35:08 +02:00
< / div >
2018-12-22 22:28:49 +01:00
< h5 > Parameters:< / h5 >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2023-05-31 14:35:08 +02:00
< th > Attributes< / th >
2018-12-22 22:28:49 +01:00
2023-05-31 14:35:08 +02:00
< th > Default< / th >
2018-12-22 22:28:49 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2018-08-29 20:44:35 +02:00
2019-12-03 22:53:17 +01:00
< tr >
2023-05-31 14:35:08 +02:00
< td class = "name" > < code > hoistedNoteId< / code > < / td >
2019-12-03 22:53:17 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2023-05-31 14:35:08 +02:00
< td class = "attributes" >
< optional>< br >
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2023-05-31 14:35:08 +02:00
2018-08-29 20:44:35 +02:00
2023-05-31 14:35:08 +02:00
< / td >
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2023-05-31 14:35:08 +02:00
< td class = "default" >
'root'
< / td >
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2023-05-31 14:35:08 +02:00
< td class = "description last" > < / td >
2018-12-22 22:28:49 +01:00
< / tr >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line438" > line 438< / 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 >
2019-12-03 22:53:17 +01:00
< div class = "param-desc" >
2023-05-31 14:35:08 +02:00
array of noteIds constituting the particular note path
2019-12-03 22:53:17 +01:00
< / div >
2018-08-29 20:44:35 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2023-05-31 14:35:08 +02:00
< span class = "param-type" > Array.< string>< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2023-05-31 14:35:08 +02:00
< h4 class = "name" id = "getBestNotePathString" > < span class = "type-signature" > < / span > getBestNotePathString< span class = "signature" > (hoistedNoteId< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
2018-12-22 22:28:49 +01:00
2023-05-31 14:35:08 +02:00
< div class = "description" >
2023-06-29 20:54:58 +02:00
Returns the note path considered to be the "best"
2023-05-31 14:35:08 +02:00
< / div >
2018-12-22 22:28:49 +01:00
< h5 > Parameters:< / h5 >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-11-07 21:26:13 +01:00
< th > Attributes< / th >
2018-12-22 22:28:49 +01:00
2023-05-31 14:35:08 +02:00
< th > Default< / th >
2018-12-22 22:28:49 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< tr >
2023-05-31 14:35:08 +02:00
< td class = "name" > < code > hoistedNoteId< / code > < / td >
2018-12-22 22:28:49 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
2018-12-22 22:28:49 +01:00
2022-11-07 21:26:13 +01:00
< / td >
2018-12-22 22:28:49 +01:00
2022-11-07 21:26:13 +01:00
2023-05-31 14:35:08 +02:00
< td class = "default" >
2022-11-07 21:26:13 +01:00
2023-05-31 14:35:08 +02:00
'root'
2022-11-07 21:26:13 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2023-05-31 14:35:08 +02:00
< td class = "description last" > < / td >
2018-12-22 22:28:49 +01:00
< / tr >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line448" > line 448< / 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 >
2018-12-22 22:28:49 +01:00
< div class = "param-desc" >
2023-05-31 14:35:08 +02:00
serialized note path (e.g. 'root/a1h315/js725h')
2018-12-22 22:28:49 +01:00
< / div >
2018-08-29 20:44:35 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2023-05-31 14:35:08 +02:00
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2023-06-29 20:54:58 +02:00
< h4 class = "name" id = "getBlob" > < span class = "type-signature" > (async) < / span > getBlob< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< FBlob>}< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line892" > line 892< / a >
2023-06-29 20:54:58 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< FBlob>< / span >
< / dd >
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "getBranchIds" > < span class = "type-signature" > < / span > getBranchIds< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< string>}< / span > < / h4 >
2018-08-29 20:44:35 +02:00
< dl class = "details" >
2022-11-07 21:26:13 +01:00
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > use getParentBranchIds() instead< / li > < / ul > < / dd >
2022-01-05 20:31:21 +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 >
2024-12-11 18:31:29 +02:00
< a href = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line175" > line 175< / 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 >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Array.< string>< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getBranches" > < span class = "type-signature" > < / span > getBranches< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "FBranch.html" > FBranch< / a > >}< / span > < / h4 >
2020-03-08 11:41:42 +01:00
< dl class = "details" >
2022-11-07 21:26:13 +01:00
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > use getParentBranches() instead< / li > < / ul > < / dd >
2022-01-05 20:31:21 +01:00
2020-03-08 11:41:42 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line192" > line 192< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-03-08 11:41:42 +01:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Array.< < a href = "FBranch.html" > FBranch< / a > >< / span >
2020-03-08 11:41:42 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getChildBranches" > < span class = "type-signature" > < / span > getChildBranches< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "FBranch.html" > FBranch< / a > >}< / span > < / h4 >
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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line202" > line 202< / 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" > Array.< < a href = "FBranch.html" > FBranch< / a > >< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2018-12-22 22:28:49 +01:00
< h4 class = "name" id = "getChildNoteIds" > < span class = "type-signature" > < / span > getChildNoteIds< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< string>}< / span > < / h4 >
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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line244" > line 244< / 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 >
2018-12-22 22:28:49 +01:00
< span class = "param-type" > Array.< string>< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getChildNotes" > < span class = "type-signature" > (async) < / span > getChildNotes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "FNote.html" > FNote< / a > >>}< / span > < / h4 >
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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line249" > line 249< / 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.< Array.< < a href = "FNote.html" > FNote< / a > >>< / span >
2018-08-29 20:44:35 +02:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getLabel" > < span class = "type-signature" > < / span > getLabel< span class = "signature" > (name)< / span > < span class = "type-signature" > → {< a href = "FAttribute.html" > FAttribute< / a > }< / span > < / h4 >
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Parameters:< / h5 >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< 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
2018-12-22 22:28:49 +01:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< / td >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< td class = "description last" > label name< / td >
< / tr >
2018-08-29 20:44:35 +02:00
2018-12-22 22:28:49 +01:00
< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line721" > line 721< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
label if it exists, null otherwise
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "FAttribute.html" > FAttribute< / a > < / span >
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "getLabelValue" > < span class = "type-signature" > < / span > getLabelValue< span class = "signature" > (name)< / span > < span class = "type-signature" > → {string}< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2022-11-07 21:26:13 +01:00
< td class = "description last" > label name< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line745" > line 745< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
label value if label exists, null otherwise
2018-12-22 22:28:49 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > string< / span >
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getLabels" > < span class = "type-signature" > < / span > getLabels< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Array.< < a href = "FAttribute.html" > FAttribute< / a > >}< / span > < / h4 >
2018-12-22 22:28:49 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-11-07 21:26:13 +01:00
< th > Attributes< / th >
2018-12-22 22:28:49 +01:00
< 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 >
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
< / td >
2018-12-22 22:28:49 +01:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > label name to filter< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line531" > line 531< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
all note's labels (attributes with type label), including inherited ones
2018-12-22 22:28:49 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Array.< < a href = "FAttribute.html" > FAttribute< / a > >< / span >
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2023-09-06 23:05:03 +02:00
< h4 class = "name" id = "getMetadata" > < span class = "type-signature" > (async) < / span > getMetadata< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< {dateCreated: string, utcDateCreated: string, dateModified: string, utcDateModified: string}>}< / span > < / h4 >
< div class = "description" >
Provides note's date metadata.
< / div >
< 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line1008" > line 1008< / a >
2023-09-06 23:05:03 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Promise.< {dateCreated: string, utcDateCreated: string, dateModified: string, utcDateModified: string}>< / span >
< / dd >
< / dl >
2023-06-29 20:54:58 +02:00
< h4 class = "name" id = "getNoteComplement" > < span class = "type-signature" > (async) < / span > getNoteComplement< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< FBlob>}< / span > < / h4 >
2018-12-22 22:28:49 +01:00
< dl class = "details" >
2023-06-29 20:54:58 +02:00
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > use getBlob() instead< / li > < / ul > < / dd >
2018-12-22 22:28:49 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line887" > line 887< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-06-29 20:54:58 +02:00
< span class = "param-type" > Promise.< FBlob>< / span >
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2023-02-17 16:15:58 +01:00
< h4 class = "name" id = "getNotesToInheritAttributesFrom" > < span class = "type-signature" > < / span > getNotesToInheritAttributesFrom< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "FNote.html" > FNote< / a > >}< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line787" > line 787< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Array.< < a href = "FNote.html" > FNote< / a > >< / span >
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getOwnedAttribute" > < span class = "type-signature" > < / span > getOwnedAttribute< span class = "signature" > (type, name)< / span > < span class = "type-signature" > → {< a href = "FAttribute.html" > FAttribute< / a > }< / span > < / h4 >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< h5 > Parameters:< / h5 >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< th > Type< / th >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< tbody >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< tr >
< td class = "name" > < code > type< / code > < / td >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< td class = "type" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#AttributeType" > AttributeType< / a > < / span >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< / td >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< td class = "description last" > attribute type (label, relation, etc.)< / td >
< / tr >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< tr >
< td class = "name" > < code > name< / code > < / td >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< / td >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< td class = "description last" > attribute name< / td >
< / tr >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< / tbody >
< / table >
2018-12-22 22:28:49 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line634" > line 634< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
2020-02-02 11:44:08 +01:00
< div class = "param-desc" >
2023-07-15 12:07:45 +02:00
attribute of the given type and name. If there are more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
2020-02-02 11:44:08 +01:00
< / div >
2018-12-22 22:28:49 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "FAttribute.html" > FAttribute< / a > < / span >
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "getOwnedAttributeValue" > < span class = "type-signature" > < / span > getOwnedAttributeValue< span class = "signature" > (type, name)< / span > < span class = "type-signature" > → {string}< / 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 >
2020-02-02 11:44:08 +01:00
< td class = "name" > < code > type< / code > < / td >
2018-12-22 22:28:49 +01:00
< td class = "type" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#AttributeType" > AttributeType< / a > < / span >
2018-12-22 22:28:49 +01:00
< / td >
2020-02-02 11:44:08 +01:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > attribute type (label, relation, etc.)< / td >
2020-02-02 11:44:08 +01:00
< / tr >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2022-11-07 21:26:13 +01:00
< td class = "description last" > attribute name< / td >
2020-02-02 11:44:08 +01:00
< / tr >
2018-12-22 22:28:49 +01: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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line656" > line 656< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2023-06-29 20:54:58 +02:00
attribute value of the given type and name or null if no such attribute exists.
2018-12-22 22:28:49 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > string< / span >
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getOwnedAttributes" > < span class = "type-signature" > < / span > getOwnedAttributes< span class = "signature" > (type< span class = "signature-attributes" > opt< / span > , name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Array.< < a href = "FAttribute.html" > FAttribute< / a > >}< / span > < / h4 >
2018-12-22 22:28:49 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-11-07 21:26:13 +01:00
< th > Attributes< / th >
2018-12-22 22:28:49 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2020-02-02 11:44:08 +01:00
< td class = "name" > < code > type< / code > < / td >
2018-12-22 22:28:49 +01:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
2018-12-22 22:28:49 +01:00
2022-11-07 21:26:13 +01:00
< / td >
2020-02-02 11:44:08 +01:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > (optional) attribute type to filter< / td >
2020-02-02 11:44:08 +01:00
< / tr >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +01:00
< span class = "param-type" > string< / span >
< / td >
2018-12-22 22:28:49 +01:00
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
2018-12-22 22:28:49 +01:00
2022-11-07 21:26:13 +01:00
< / td >
2018-12-22 22:28:49 +01:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > (optional) attribute name to filter< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line303" > line 303< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
all note's attributes, including inherited ones
2018-12-22 22:28:49 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Array.< < a href = "FAttribute.html" > FAttribute< / a > >< / span >
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getOwnedLabel" > < span class = "type-signature" > < / span > getOwnedLabel< span class = "signature" > (name)< / span > < span class = "type-signature" > → {< a href = "FAttribute.html" > FAttribute< / a > }< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2020-02-02 11:44:08 +01:00
< td class = "description last" > label name< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line715" > line 715< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2020-02-02 11:44:08 +01:00
label if it exists, null otherwise
2018-12-22 22:28:49 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "FAttribute.html" > FAttribute< / a > < / span >
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "getOwnedLabelValue" > < span class = "type-signature" > < / span > getOwnedLabelValue< span class = "signature" > (name)< / span > < span class = "type-signature" > → {string}< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2020-02-02 11:44:08 +01:00
2018-12-22 22:28:49 +01:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > label name< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line739" > line 739< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
label value if label exists, null otherwise
2018-12-22 22:28:49 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > string< / span >
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getOwnedLabels" > < span class = "type-signature" > < / span > getOwnedLabels< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Array.< < a href = "FAttribute.html" > FAttribute< / a > >}< / span > < / h4 >
2019-08-20 21:40:47 +02:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-11-07 21:26:13 +01:00
< th > Attributes< / th >
2019-08-20 21:40:47 +02:00
< 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 >
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
2019-08-20 21:40:47 +02:00
2022-11-07 21:26:13 +01:00
< / td >
2019-08-20 21:40:47 +02:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > label name to filter< / td >
2019-08-20 21:40:47 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line523" > line 523< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-08-20 21:40:47 +02:00
< / dl >
< h5 > Returns:< / h5 >
2020-02-02 11:44:08 +01:00
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
all note's labels (attributes with type label), including inherited ones
2020-02-02 11:44:08 +01:00
< / div >
2019-08-20 21:40:47 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Array.< < a href = "FAttribute.html" > FAttribute< / a > >< / span >
2019-08-20 21:40:47 +02:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getOwnedRelation" > < span class = "type-signature" > < / span > getOwnedRelation< span class = "signature" > (name)< / span > < span class = "type-signature" > → {< a href = "FAttribute.html" > FAttribute< / a > }< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > relation name< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line727" > line 727< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2020-02-02 11:44:08 +01:00
relation if it exists, null otherwise
2018-12-22 22:28:49 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "FAttribute.html" > FAttribute< / a > < / span >
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "getOwnedRelationValue" > < span class = "type-signature" > < / span > getOwnedRelationValue< span class = "signature" > (name)< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
2019-08-20 21:40:47 +02:00
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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2022-11-07 21:26:13 +01:00
< td class = "description last" > relation name< / td >
2020-02-02 11:44:08 +01:00
< / tr >
< / tbody >
< / table >
2019-08-20 21:40:47 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line751" > line 751< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2019-08-20 21:40:47 +02:00
< / dl >
< h5 > Returns:< / h5 >
2020-02-02 11:44:08 +01:00
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
relation value if relation exists, null otherwise
2020-02-02 11:44:08 +01:00
< / div >
2019-08-20 21:40:47 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > string< / span >
2019-08-20 21:40:47 +02:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getOwnedRelations" > < span class = "type-signature" > < / span > getOwnedRelations< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Array.< < a href = "FAttribute.html" > FAttribute< / a > >}< / span > < / h4 >
2018-12-22 22:28:49 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-11-07 21:26:13 +01:00
< th > Attributes< / th >
2018-12-22 22:28:49 +01:00
< 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 >
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
< / td >
2018-12-22 22:28:49 +01:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > relation name to filter< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line597" > line 597< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
all note's relations (attributes with type relation), including inherited ones
2018-12-22 22:28:49 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Array.< < a href = "FAttribute.html" > FAttribute< / a > >< / span >
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "getParentBranchIds" > < span class = "type-signature" > < / span > getParentBranchIds< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< string>}< / span > < / h4 >
2022-01-05 20:31:21 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line167" > line 167< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-01-05 20:31:21 +01:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > Array.< string>< / span >
2022-01-05 20:31:21 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getParentBranches" > < span class = "type-signature" > < / span > getParentBranches< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "FBranch.html" > FBranch< / a > >}< / span > < / h4 >
2022-01-05 20:31:21 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line182" > line 182< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-01-05 20:31:21 +01:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Array.< < a href = "FBranch.html" > FBranch< / a > >< / span >
2022-01-05 20:31:21 +01:00
< / dd >
< / dl >
2020-02-02 11:44:08 +01:00
< h4 class = "name" id = "getParentNoteIds" > < span class = "type-signature" > < / span > getParentNoteIds< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< string>}< / span > < / h4 >
2018-12-22 22:28:49 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line210" > line 210< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2020-02-02 11:44:08 +01:00
< span class = "param-type" > Array.< string>< / span >
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getParentNotes" > < span class = "type-signature" > < / span > getParentNotes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "FNote.html" > FNote< / a > >}< / span > < / h4 >
2018-12-22 22:28:49 +01:00
2020-02-02 11:44:08 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line215" > line 215< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-02-02 11:44:08 +01:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Array.< < a href = "FNote.html" > FNote< / a > >< / span >
2020-02-02 11:44:08 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getRelation" > < span class = "type-signature" > < / span > getRelation< span class = "signature" > (name)< / span > < span class = "type-signature" > → {< a href = "FAttribute.html" > FAttribute< / a > }< / span > < / h4 >
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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > relation name< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line733" > line 733< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-02-02 11:44:08 +01:00
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
relation if it exists, null otherwise
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "FAttribute.html" > FAttribute< / a > < / span >
2020-02-02 11:44:08 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getRelationTarget" > < span class = "type-signature" > (async) < / span > getRelationTarget< span class = "signature" > (name)< / span > < span class = "type-signature" > → {Promise.< < a href = "FNote.html" > FNote< / a > >|null}< / span > < / h4 >
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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2022-11-07 21:26:13 +01:00
< td class = "description last" > < / td >
2020-02-02 11:44:08 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line763" > line 763< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-02-02 11:44:08 +01:00
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2022-11-07 21:26:13 +01:00
target note of the relation or null (if target is empty or note was not found)
2020-02-02 11:44:08 +01:00
< / div >
< 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 >
2022-11-07 21:26:13 +01:00
|
< span class = "param-type" > null< / span >
2020-02-02 11:44:08 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getRelationTargets" > < span class = "type-signature" > (async) < / span > getRelationTargets< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "FNote.html" > FNote< / a > >>}< / span > < / h4 >
2020-02-02 11:44:08 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-11-07 21:26:13 +01:00
< th > Attributes< / th >
2020-02-02 11:44:08 +01:00
< 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 >
2022-11-07 21:26:13 +01:00
< td class = "attributes" >
< optional>< br >
< / td >
2020-02-02 11:44:08 +01:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > relation name to filter< / td >
2020-02-02 11:44:08 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line773" > line 773< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-02-02 11:44:08 +01:00
< / dl >
< 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 >
2020-02-02 11:44:08 +01:00
< / dd >
< / dl >
2022-11-07 21:26:13 +01:00
< h4 class = "name" id = "getRelationValue" > < span class = "type-signature" > < / span > getRelationValue< span class = "signature" > (name)< / span > < span class = "type-signature" > → {string}< / span > < / h4 >
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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2020-09-30 22:48:30 +02:00
2022-11-07 21:26:13 +01:00
< td class = "description last" > relation name< / td >
2020-02-02 11:44:08 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line757" > line 757< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-02-02 11:44:08 +01:00
< / dl >
< h5 > Returns:< / h5 >
2022-11-07 21:26:13 +01:00
< div class = "param-desc" >
relation value if relation exists, null otherwise
< / div >
2020-02-02 11:44:08 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2022-11-07 21:26:13 +01:00
< span class = "param-type" > string< / span >
2020-02-02 11:44:08 +01:00
< / dd >
< / dl >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getRelations" > < span class = "type-signature" > < / span > getRelations< span class = "signature" > (name< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Array.< < a href = "FAttribute.html" > FAttribute< / a > >}< / span > < / h4 >
2020-02-02 11:44:08 +01:00
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2022-11-07 21:26:13 +01:00
< th > Attributes< / th >
2020-02-02 11:44:08 +01:00
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
2023-05-31 14:35:08 +02:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "description last" > relation name to filter< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line605" > line 605< / a >
2023-05-31 14:35:08 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
all note's relations (attributes with type relation), including inherited ones
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Array.< < a href = "FAttribute.html" > FAttribute< / a > >< / span >
< / dd >
< / dl >
< h4 class = "name" id = "getScriptEnv" > < span class = "type-signature" > < / span > getScriptEnv< span class = "signature" > ()< / span > < span class = "type-signature" > → {string|null}< / span > < / h4 >
2020-02-02 11:44:08 +01:00
2022-11-07 21:26:13 +01:00
2020-02-02 11:44:08 +01:00
2022-11-07 21:26:13 +01:00
2020-02-02 11:44:08 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line936" > line 936< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-02-02 11:44:08 +01:00
< / dl >
< h5 > Returns:< / h5 >
2020-09-30 22:48:30 +02:00
< div class = "param-desc" >
2023-05-31 14:35:08 +02:00
JS script environment - either "frontend" or "backend"
2020-09-30 22:48:30 +02:00
< / div >
2020-02-02 11:44:08 +01:00
< dl >
< dt >
Type
< / dt >
< dd >
2023-05-31 14:35:08 +02:00
< span class = "param-type" > string< / span >
|
< span class = "param-type" > null< / span >
2020-02-02 11:44:08 +01:00
< / dd >
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "getSortedNotePathRecords" > < span class = "type-signature" > < / span > getSortedNotePathRecords< span class = "signature" > (hoistedNoteId< span class = "signature-attributes" > opt< / span > )< / span > < span class = "type-signature" > → {Array.< < a href = "global.html#NotePathRecord" > NotePathRecord< / a > >}< / span > < / h4 >
2023-05-31 14:35:08 +02:00
< h5 > Parameters:< / h5 >
2021-09-30 12:26:13 +02:00
2023-05-31 14:35:08 +02: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 >
2021-09-30 12:26:13 +02:00
2023-05-31 14:35:08 +02:00
< tr >
< td class = "name" > < code > hoistedNoteId< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
2021-09-30 12:26:13 +02:00
2023-05-31 14:35:08 +02:00
< / td >
2021-09-30 12:26:13 +02:00
2023-05-31 14:35:08 +02:00
< td class = "attributes" >
< optional>< br >
2021-09-30 12:26:13 +02:00
2023-05-31 14:35:08 +02:00
2021-09-30 12:26:13 +02:00
2023-05-31 14:35:08 +02:00
< / td >
2021-09-30 12:26:13 +02:00
2023-05-31 14:35:08 +02:00
< td class = "default" >
'root'
< / td >
2021-09-30 12:26:13 +02:00
2023-05-31 14:35:08 +02:00
< td class = "description last" > < / td >
< / tr >
2021-09-30 12:26:13 +02:00
2023-05-31 14:35:08 +02:00
< / tbody >
< / table >
2021-09-30 12:26:13 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line404" > line 404< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-09-30 12:26:13 +02:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > Array.< < a href = "global.html#NotePathRecord" > NotePathRecord< / a > >< / span >
2021-09-30 12:26:13 +02:00
< / dd >
< / dl >
2023-06-29 20:54:58 +02:00
< h4 class = "name" id = "getTargetRelationSourceNotes" > < span class = "type-signature" > (async) < / span > getTargetRelationSourceNotes< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< Array.< < a href = "FNote.html" > FNote< / a > >>}< / span > < / h4 >
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
< div class = "description" >
Get relations which target this note
< / div >
< dl class = "details" >
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
2020-02-02 11:44:08 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line877" > line 877< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-09-30 22:48:30 +02:00
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
< / dl >
< h5 > Returns:< / h5 >
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
2020-02-02 11:44:08 +01:00
2023-06-29 20:54:58 +02:00
< span class = "param-type" > Promise.< Array.< < a href = "FNote.html" > FNote< / a > >>< / span >
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
< / dd >
< / dl >
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getTargetRelations" > < span class = "type-signature" > < / span > getTargetRelations< span class = "signature" > ()< / span > < span class = "type-signature" > → {Array.< < a href = "FAttribute.html" > FAttribute< / a > >}< / span > < / h4 >
2020-09-30 22:48:30 +02:00
2020-02-02 11:44:08 +01:00
2020-09-30 22:48:30 +02:00
< div class = "description" >
Get relations which target this note
< / div >
2020-02-02 11:44:08 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line867" > line 867< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-02-02 11:44:08 +01:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-02-17 16:15:58 +01:00
< span class = "param-type" > Array.< < a href = "FAttribute.html" > FAttribute< / a > >< / span >
2020-02-02 11:44:08 +01:00
< / dd >
< / dl >
2020-03-19 09:18:36 +01:00
< h4 class = "name" id = "hasAttribute" > < span class = "type-signature" > < / span > hasAttribute< span class = "signature" > (type, name)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
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 > type< / code > < / td >
< td class = "type" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#AttributeType" > AttributeType< / a > < / span >
2020-02-02 11:44:08 +01:00
< / td >
< td class = "description last" > attribute type (label, relation, etc.)< / td >
< / tr >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > attribute name< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line614" > line 614< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-02-02 11:44:08 +01:00
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if note has an attribute with given type and name (including inherited)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-03-19 09:18:36 +01:00
< span class = "param-type" > boolean< / span >
2020-02-02 11:44:08 +01:00
< / dd >
< / dl >
< h4 class = "name" id = "hasChildren" > < span class = "type-signature" > < / span > hasChildren< span class = "signature" > ()< / span > < span class = "type-signature" > → {boolean}< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line197" > line 197< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-02-02 11:44:08 +01:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
2020-03-19 09:18:36 +01:00
< h4 class = "name" id = "hasLabel" > < span class = "type-signature" > < / span > hasLabel< span class = "signature" > (name)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > label name< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line683" > line 683< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-02-02 11:44:08 +01:00
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if label exists (including inherited)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-03-19 09:18:36 +01:00
< span class = "param-type" > boolean< / span >
2020-02-02 11:44:08 +01:00
< / dd >
< / dl >
< h4 class = "name" id = "hasOwnedAttribute" > < span class = "type-signature" > < / span > hasOwnedAttribute< span class = "signature" > (type, name)< / span > < span class = "type-signature" > → {boolean}< / 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 > type< / code > < / td >
< td class = "type" >
2023-08-21 04:17:16 -04:00
< span class = "param-type" > < a href = "global.html#AttributeType" > AttributeType< / a > < / span >
2020-02-02 11:44:08 +01:00
< / td >
< td class = "description last" > attribute type (label, relation, etc.)< / td >
< / tr >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > attribute name< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line625" > line 625< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-02-02 11:44:08 +01:00
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if note has an attribute with given type and name (including inherited)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< h4 class = "name" id = "hasOwnedLabel" > < span class = "type-signature" > < / span > hasOwnedLabel< span class = "signature" > (name)< / span > < span class = "type-signature" > → {boolean}< / span > < / h4 >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
2018-12-22 22:28:49 +01:00
< 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" > label name< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line677" > line 677< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2020-02-02 11:44:08 +01:00
true if label exists (excluding inherited)
2018-12-22 22:28:49 +01:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-02-02 11:44:08 +01:00
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< h4 class = "name" id = "hasOwnedRelation" > < span class = "type-signature" > < / span > hasOwnedRelation< span class = "signature" > (name)< / span > < span class = "type-signature" > → {boolean}< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > relation name< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line703" > line 703< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2020-02-02 11:44:08 +01:00
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if relation exists (excluding inherited)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2020-03-19 09:18:36 +01:00
< h4 class = "name" id = "hasRelation" > < span class = "type-signature" > < / span > hasRelation< span class = "signature" > (name)< / span > < span class = "type-signature" > → {boolean}< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > relation name< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line709" > line 709< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if relation exists (including inherited)
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2020-03-19 09:18:36 +01:00
< span class = "param-type" > boolean< / span >
2018-12-22 22:28:49 +01:00
< / dd >
< / dl >
2020-02-02 11:44:08 +01:00
< h4 class = "name" id = "invalidateAttributeCache" > < span class = "type-signature" > < / span > invalidateAttributeCache< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2018-12-22 22:28:49 +01:00
< dl class = "details" >
2021-11-10 21:30:54 +01:00
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > NOOP< / li > < / ul > < / dd >
2018-12-22 22:28:49 +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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line860" > line 860< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
< / dl >
< h4 class = "name" id = "isHiddenCompletely" > < span class = "type-signature" > < / span > isHiddenCompletely< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2024-12-11 18:31:29 +02:00
< a href = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line457" > line 457< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-09-30 12:26:13 +02:00
< / dl >
2023-02-17 16:15:58 +01:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
boolean - true if there's no non-hidden path, note is not cloned to the visible tree
< / div >
2021-09-30 12:26:13 +02:00
< h4 class = "name" id = "isHtml" > < span class = "type-signature" > < / span > isHtml< span class = "signature" > ()< / span > < span class = "type-signature" > → {boolean}< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line931" > line 931< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-09-30 12:26:13 +02:00
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
true if this note is HTML
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< h4 class = "name" id = "isJavaScript" > < span class = "type-signature" > < / span > isJavaScript< span class = "signature" > ()< / span > < span class = "type-signature" > → {boolean}< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line923" > line 923< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2018-12-22 22:28:49 +01:00
< / dl >
2021-09-30 12:26:13 +02:00
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2023-02-17 16:15:58 +01:00
true if this note is JavaScript (code or file)
2021-09-30 12:26:13 +02:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
2018-12-22 22:28:49 +01:00
2019-08-20 21:40:47 +02:00
2018-12-22 22:28:49 +01:00
< h4 class = "name" id = "isJson" > < span class = "type-signature" > < / span > isJson< span class = "signature" > ()< / span > < span class = "type-signature" > → {boolean}< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line141" > line 141< / a >
2023-05-31 14:35:08 +02:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< h4 class = "name" id = "isLabelTruthy" > < span class = "type-signature" > < / span > isLabelTruthy< span class = "signature" > (name)< / span > < span class = "type-signature" > → {boolean}< / 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 > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > label name< / 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 = "entities_fnote.js.html" > entities/fnote.js< / a > , < a href = "entities_fnote.js.html#line689" > line 689< / 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 >
2023-05-31 14:35:08 +02:00
< div class = "param-desc" >
true if label exists (including inherited) and does not have "false" value.
< / div >
2018-08-29 20:44:35 +02:00
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > boolean< / span >
< / dd >
< / dl >
< / 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 >
