updated API docs

docs/frontend_api/entities_attribute.js.html

@@ -26,7 +26,9 @@
     
     <section>
         <article>
-            <pre class="prettyprint source linenums"><code>class Attribute {
+            <pre class="prettyprint source linenums"><code>import promotedAttributeDefinitionParser from '../services/promoted_attribute_definition_parser.js';
+
+class Attribute {
     constructor(treeCache, row) {
         this.treeCache = treeCache;
 
@@ -47,29 +49,75 @@
         /** @param {int} position */
         this.position = row.position;
         /** @param {boolean} isInheritable */
-        this.isInheritable = row.isInheritable;
+        this.isInheritable = !!row.isInheritable;
     }
 
     /** @returns {NoteShort} */
-    async getNote() {
-        return await this.treeCache.getNote(this.noteId);
+    getNote() {
+        return this.treeCache.notes[this.noteId];
     }
 
-    get jsonValue() {
-        try {
-            return JSON.parse(this.value);
-        }
-        catch (e) {
-            return null;
-        }
+    get targetNoteId() { // alias
+        return this.type === 'relation' ? this.value : undefined;
+    }
+
+    get isAutoLink() {
+        return this.type === 'relation' &amp;&amp; ['internalLink', 'imageLink', 'relationMapLink', 'includeNoteLink'].includes(this.name);
     }
 
     get toString() {
         return `Attribute(attributeId=${this.attributeId}, type=${this.type}, name=${this.name}, value=${this.value})`;
     }
+
+    /**
+     * @return {boolean} - returns true if this attribute has the potential to influence the note in the argument.
+     *         That can happen in multiple ways:
+     *         1. attribute is owned by the note
+     *         2. attribute is owned by the template of the note
+     *         3. attribute is owned by some note's ancestor and is inheritable
+     */
+    isAffecting(affectedNote) {
+        if (!affectedNote) {
+            return false;
+        }
+
+        const attrNote = this.getNote();
+
+        if (!attrNote) {
+            // the note (owner of the attribute) is not even loaded into the cache so it should not affect anything else
+            return false;
+        }
+
+        const owningNotes = [affectedNote, ...affectedNote.getTemplateNotes()];
+
+        for (const owningNote of owningNotes) {
+            if (owningNote.noteId === attrNote.noteId) {
+                return true;
+            }
+        }
+
+        if (this.isInheritable) {
+            for (const owningNote of owningNotes) {
+                if (owningNote.hasAncestor(attrNote)) {
+                    return true;
+                }
+            }
+        }
+
+        return false;
+    }
+
+    isDefinition() {
+        return this.type === 'label' &amp;&amp; (this.name.startsWith('label:') || this.name.startsWith('relation:'));
+    }
+
+    getDefinition() {
+        return promotedAttributeDefinitionParser.parse(this.value);
+    }
 }
 
-export default Attribute;</code></pre>
+export default Attribute;
+</code></pre>
         </article>
     </section>
 
@@ -85,7 +133,7 @@ export default Attribute;</code></pre>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a>
 </footer>
 
 <script> prettyPrint(); </script>