| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  | <!DOCTYPE html> | 
					
						
							|  |  |  | <html lang="en"> | 
					
						
							|  |  |  | <head> | 
					
						
							|  |  |  |     <meta charset="utf-8"> | 
					
						
							|  |  |  |     <title>JSDoc: Source: entities/attribute.js</title> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     <script src="scripts/prettify/prettify.js"> </script> | 
					
						
							|  |  |  |     <script src="scripts/prettify/lang-css.js"> </script> | 
					
						
							|  |  |  |     <!--[if lt IE 9]>
 | 
					
						
							|  |  |  |       <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> | 
					
						
							|  |  |  |     <![endif]--> | 
					
						
							|  |  |  |     <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> | 
					
						
							|  |  |  |     <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> | 
					
						
							|  |  |  | </head> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <body> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <div id="main"> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     <h1 class="page-title">Source: entities/attribute.js</h1> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |      | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |      | 
					
						
							|  |  |  |     <section> | 
					
						
							|  |  |  |         <article> | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  |             <pre class="prettyprint source linenums"><code>import promotedAttributeDefinitionParser from '../services/promoted_attribute_definition_parser.js'; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | class Attribute { | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |     constructor(treeCache, row) { | 
					
						
							|  |  |  |         this.treeCache = treeCache; | 
					
						
							| 
									
										
										
										
											2020-02-02 11:44:08 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  |         this.update(row); | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     update(row) { | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |         /** @param {string} attributeId */ | 
					
						
							|  |  |  |         this.attributeId = row.attributeId; | 
					
						
							|  |  |  |         /** @param {string} noteId */ | 
					
						
							|  |  |  |         this.noteId = row.noteId; | 
					
						
							|  |  |  |         /** @param {string} type */ | 
					
						
							|  |  |  |         this.type = row.type; | 
					
						
							|  |  |  |         /** @param {string} name */ | 
					
						
							|  |  |  |         this.name = row.name; | 
					
						
							|  |  |  |         /** @param {string} value */ | 
					
						
							|  |  |  |         this.value = row.value; | 
					
						
							|  |  |  |         /** @param {int} position */ | 
					
						
							|  |  |  |         this.position = row.position; | 
					
						
							|  |  |  |         /** @param {boolean} isInheritable */ | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  |         this.isInheritable = !!row.isInheritable; | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     /** @returns {NoteShort} */ | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  |     getNote() { | 
					
						
							|  |  |  |         return this.treeCache.notes[this.noteId]; | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  |     get targetNoteId() { // alias | 
					
						
							|  |  |  |         return this.type === 'relation' ? this.value : undefined; | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     get isAutoLink() { | 
					
						
							|  |  |  |         return this.type === 'relation' && ['internalLink', 'imageLink', 'relationMapLink', 'includeNoteLink'].includes(this.name); | 
					
						
							| 
									
										
										
										
											2020-04-07 19:19:20 +02:00
										 |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |     get toString() { | 
					
						
							| 
									
										
										
										
											2020-02-02 11:44:08 +01:00
										 |  |  |         return `Attribute(attributeId=${this.attributeId}, type=${this.type}, name=${this.name}, value=${this.value})`; | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |     } | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  |     /** | 
					
						
							|  |  |  |      * @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' && (this.name.startsWith('label:') || this.name.startsWith('relation:')); | 
					
						
							|  |  |  |     } | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     getDefinition() { | 
					
						
							|  |  |  |         return promotedAttributeDefinitionParser.parse(this.value); | 
					
						
							|  |  |  |     } | 
					
						
							| 
									
										
										
										
											2019-02-20 22:24:51 +01:00
										 |  |  | } | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  | export default Attribute; | 
					
						
							|  |  |  | </code></pre> | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  |         </article> | 
					
						
							|  |  |  |     </section> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | </div> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <nav> | 
					
						
							| 
									
										
										
										
											2020-04-21 23:14:55 +02:00
										 |  |  |     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#decorateWidget">decorateWidget</a></li><li><a href="global.html#doRenderBody">doRenderBody</a></li><li><a href="global.html#widgetCollapsedStateChangedEvent">widgetCollapsedStateChangedEvent</a></li></ul> | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  | </nav> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <br class="clear"> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <footer> | 
					
						
							| 
									
										
										
										
											2020-09-30 22:48:30 +02:00
										 |  |  |     Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> | 
					
						
							| 
									
										
										
										
											2018-12-22 22:28:49 +01:00
										 |  |  | </footer> | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | <script> prettyPrint(); </script> | 
					
						
							|  |  |  | <script src="scripts/linenumber.js"> </script> | 
					
						
							|  |  |  | </body> | 
					
						
							|  |  |  | </html> |