2021-11-10 21:30:54 +01:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
2023-01-03 13:54:27 +01:00
< title > JSDoc: Class: FAttribute< / title >
2021-11-10 21:30:54 +01: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: FAttribute< / h1 >
2021-11-10 21:30:54 +01:00
< section >
< header >
2023-01-03 13:54:27 +01:00
< h2 > < span class = "attribs" > < span class = "type-signature" > < / span > < / span > FAttribute< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h2 >
2021-11-10 21:30:54 +01:00
2023-08-21 04:17:16 -04:00
< div class = "class-description" > Attribute is an abstract concept which has two real uses - label (key - value pair)
and relation (representing named relationship between source and target note)< / div >
2021-11-10 21:30:54 +01:00
< / header >
< article >
< div class = "container-overview" >
< h2 > Constructor< / h2 >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "FAttribute" > < span class = "type-signature" > < / span > new FAttribute< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
2021-11-10 21:30: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 >
2023-08-21 04:17:16 -04:00
< a href = "entities_fattribute.js.html" > entities/fattribute.js< / a > , < a href = "entities_fattribute.js.html#line12" > line 12< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01:00
< / dl >
< / div >
< h3 class = "subsection-title" > Members< / h3 >
< h4 class = "name" id = "attributeId" > < span class = "type-signature" > < / span > attributeId< span class = "type-signature" > :string< / span > < / h4 >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
< / 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 >
2023-08-21 04:17:16 -04:00
< a href = "entities_fattribute.js.html" > entities/fattribute.js< / a > , < a href = "entities_fattribute.js.html#line22" > line 22< / 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 >
2023-08-21 04:17:16 -04:00
< a href = "entities_fattribute.js.html" > entities/fattribute.js< / a > , < a href = "entities_fattribute.js.html#line15" > line 15< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01:00
< / dl >
< h4 class = "name" id = "isInheritable" > < span class = "type-signature" > < / span > isInheritable< span class = "type-signature" > :boolean< / span > < / h4 >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > boolean< / span >
< / 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 >
2023-08-21 04:17:16 -04:00
< a href = "entities_fattribute.js.html" > entities/fattribute.js< / a > , < a href = "entities_fattribute.js.html#line34" > line 34< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01:00
< / dl >
< h4 class = "name" id = "name" > < span class = "type-signature" > < / span > name< span class = "type-signature" > :string< / span > < / h4 >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
< / 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 >
2023-08-21 04:17:16 -04:00
< a href = "entities_fattribute.js.html" > entities/fattribute.js< / a > , < a href = "entities_fattribute.js.html#line28" > line 28< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01:00
< / dl >
< h4 class = "name" id = "noteId" > < span class = "type-signature" > < / span > noteId< span class = "type-signature" > :string< / span > < / h4 >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
< / 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 >
2023-08-21 04:17:16 -04:00
< a href = "entities_fattribute.js.html" > entities/fattribute.js< / a > , < a href = "entities_fattribute.js.html#line24" > line 24< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01:00
< / dl >
2023-08-21 04:17:16 -04:00
< h4 class = "name" id = "position" > < span class = "type-signature" > < / span > position< span class = "type-signature" > :< a href = "global.html#int" > int< / a > < / span > < / h4 >
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#int" > int< / a > < / span >
2021-11-10 21:30:54 +01: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 >
2023-08-21 04:17:16 -04:00
< a href = "entities_fattribute.js.html" > entities/fattribute.js< / a > , < a href = "entities_fattribute.js.html#line32" > line 32< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01: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#AttributeType" > AttributeType< / a > < / span > < / h4 >
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#AttributeType" > AttributeType< / a > < / span >
2021-11-10 21:30:54 +01: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 >
2023-08-21 04:17:16 -04:00
< a href = "entities_fattribute.js.html" > entities/fattribute.js< / a > , < a href = "entities_fattribute.js.html#line26" > line 26< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01:00
< / dl >
< h4 class = "name" id = "value" > < span class = "type-signature" > < / span > value< span class = "type-signature" > :string< / span > < / h4 >
< h5 > Type:< / h5 >
< ul >
< li >
< span class = "param-type" > string< / span >
< / 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 >
2023-08-21 04:17:16 -04:00
< a href = "entities_fattribute.js.html" > entities/fattribute.js< / a > , < a href = "entities_fattribute.js.html#line30" > line 30< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01:00
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getNote" > < span class = "type-signature" > < / span > getNote< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "FNote.html" > FNote< / a > }< / span > < / h4 >
2021-11-10 21:30: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 >
2023-08-21 04:17:16 -04:00
< a href = "entities_fattribute.js.html" > entities/fattribute.js< / a > , < a href = "entities_fattribute.js.html#line38" > line 38< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2021-11-10 21:30:54 +01:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > < a href = "FNote.html" > FNote< / a > < / span >
2021-11-10 21:30:54 +01:00
< / dd >
< / dl >
2022-07-11 23:15:16 +02:00
2023-01-03 13:54:27 +01:00
< h4 class = "name" id = "getTargetNote" > < span class = "type-signature" > (async) < / span > getTargetNote< span class = "signature" > ()< / span > < span class = "type-signature" > → {Promise.< < a href = "FNote.html" > FNote< / a > >}< / span > < / h4 >
2022-07-11 23:15:16 +02:00
< dl class = "details" >
2023-02-17 16:15:58 +01:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2023-08-21 04:17:16 -04:00
< a href = "entities_fattribute.js.html" > entities/fattribute.js< / a > , < a href = "entities_fattribute.js.html#line43" > line 43< / a >
2023-02-17 16:15:58 +01:00
< / li > < / ul > < / dd >
2022-07-11 23:15:16 +02:00
< / dl >
< h5 > Returns:< / h5 >
< dl >
< dt >
Type
< / dt >
< dd >
2023-01-03 13:54:27 +01:00
< span class = "param-type" > Promise.< < a href = "FNote.html" > FNote< / a > >< / span >
2022-07-11 23:15:16 +02:00
< / dd >
< / dl >
2021-11-10 21:30:54 +01:00
< / article >
< / section >
< / div >
< nav >
2023-08-21 04:17:16 -04: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 > < / ul >
2021-11-10 21:30:54 +01:00
< / nav >
< br class = "clear" >
< footer >
2023-05-31 14:35:08 +02:00
Documentation generated by < a href = "https://github.com/jsdoc/jsdoc" > JSDoc 4.0.2< / a >
2021-11-10 21:30:54 +01:00
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
