Class: NoteShort

NoteShort(froca, row)

FIXME: since there's no "full note" anymore we can rename this to Note This note's representation is used in note tree and is kept in Froca.

Constructor

new NoteShort(froca, row)

Parameters:
Name Type Description
froca Froca
row Object.<string, Object>
Source:

Members

attributes :Array.<string>

Type:
  • Array.<string>
Source:

children :Array.<string>

Type:
  • Array.<string>
Source:

childToBranch :Object.<string, string>

Type:
  • Object.<string, string>
Source:

isProtected :boolean

Type:
  • boolean
Source:

mime :string

content-type, e.g. "application/json"
Type:
  • string
Source:

noteId :string

Type:
  • string
Source:

parents :Array.<string>

Type:
  • Array.<string>
Source:

parentToBranch :Object.<string, string>

Type:
  • Object.<string, string>
Source:

targetRelations :Array.<string>

Type:
  • Array.<string>
Source:

title :string

Type:
  • string
Source:

type :string

one of 'text', 'code', 'file' or 'render'
Type:
  • string
Source:

Methods

getAttribute(type, name) → {Attribute}

Parameters:
Name Type Description
type string attribute type (label, relation, etc.)
name string attribute name
Source:
Returns:
attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
Type
Attribute

getAttributes(typeopt, nameopt) → {Array.<Attribute>}

Parameters:
Name Type Attributes Description
type string <optional>
 (optional) attribute type to filter
name string <optional>
 (optional) attribute name to filter
Source:
Returns:
all note's attributes, including inherited ones
Type
Array.<Attribute>

getAttributeValue(type, name) → {string}

Parameters:
Name Type Description
type string attribute type (label, relation, etc.)
name string attribute name
Source:
Returns:
attribute value of given type and name or null if no such attribute exists.
Type
string

getBranches() → {Array.<Branch>}

Source:
Returns:
Type
Array.<Branch>

getBranchIds() → {Array.<string>}

Source:
Returns:
Type
Array.<string>

getChildBranches() → {Array.<Branch>}

Source:
Returns:
Type
Array.<Branch>

getChildNoteIds() → {Array.<string>}

Source:
Returns:
Type
Array.<string>

(async) getChildNotes() → {Promise.<Array.<NoteShort>>}

Source:
Returns:
Type
Promise.<Array.<NoteShort>>

getLabel(name) → {Attribute}

Parameters:
Name Type Description
name string label name
Source:
Returns:
label if it exists, null otherwise
Type
Attribute

getLabels(nameopt) → {Array.<Attribute>}

Parameters:
Name Type Attributes Description
name string <optional>
 label name to filter
Source:
Returns:
all note's labels (attributes with type label), including inherited ones
Type
Array.<Attribute>

getLabelValue(name) → {string}

Parameters:
Name Type Description
name string label name
Source:
Returns:
label value if label exists, null otherwise
Type
string

(async) getNoteComplement() → {Promise.<NoteComplement>}

Return note complement which is most importantly note's content
Source:
Returns:
Type
Promise.<NoteComplement>

getOwnedAttribute(type, name) → {Attribute}

Parameters:
Name Type Description
type string attribute type (label, relation, etc.)
name string attribute name
Source:
Returns:
attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
Type
Attribute

getOwnedAttributes(typeopt, nameopt) → {Array.<Attribute>}

Parameters:
Name Type Attributes Description
type string <optional>
 (optional) attribute type to filter
name string <optional>
 (optional) attribute name to filter
Source:
Returns:
all note's attributes, including inherited ones
Type
Array.<Attribute>

getOwnedAttributeValue(type, name) → {string}

Parameters:
Name Type Description
type string attribute type (label, relation, etc.)
name string attribute name
Source:
Returns:
attribute value of given type and name or null if no such attribute exists.
Type
string

getOwnedLabel(name) → {Attribute}

Parameters:
Name Type Description
name string label name
Source:
Returns:
label if it exists, null otherwise
Type
Attribute

getOwnedLabels(nameopt) → {Array.<Attribute>}

Parameters:
Name Type Attributes Description
name string <optional>
 label name to filter
Source:
Returns:
all note's labels (attributes with type label), including inherited ones
Type
Array.<Attribute>

getOwnedLabelValue(name) → {string}

Parameters:
Name Type Description
name string label name
Source:
Returns:
label value if label exists, null otherwise
Type
string

getOwnedRelation(name) → {Attribute}

Parameters:
Name Type Description
name string relation name
Source:
Returns:
relation if it exists, null otherwise
Type
Attribute

getOwnedRelations(nameopt) → {Array.<Attribute>}

Parameters:
Name Type Attributes Description
name string <optional>
 relation name to filter
Source:
Returns:
all note's relations (attributes with type relation), including inherited ones
Type
Array.<Attribute>

getOwnedRelationValue(name) → {string}

Parameters:
Name Type Description
name string relation name
Source:
Returns:
relation value if relation exists, null otherwise
Type
string

getParentNoteIds() → {Array.<string>}

Source:
Returns:
Type
Array.<string>

getParentNotes() → {Array.<NoteShort>}

Source:
Returns:
Type
Array.<NoteShort>

getRelation(name) → {Attribute}

Parameters:
Name Type Description
name string relation name
Source:
Returns:
relation if it exists, null otherwise
Type
Attribute

getRelations(nameopt) → {Array.<Attribute>}

Parameters:
Name Type Attributes Description
name string <optional>
 relation name to filter
Source:
Returns:
all note's relations (attributes with type relation), including inherited ones
Type
Array.<Attribute>

(async) getRelationTarget(name) → {Promise.<NoteShort>|null}

Parameters:
Name Type Description
name string
Source:
Returns:
target note of the relation or null (if target is empty or note was not found)
Type
Promise.<NoteShort> | null

(async) getRelationTargets(nameopt) → {Promise.<Array.<NoteShort>>}

Parameters:
Name Type Attributes Description
name string <optional>
 relation name to filter
Source:
Returns:
Type
Promise.<Array.<NoteShort>>

getRelationValue(name) → {string}

Parameters:
Name Type Description
name string relation name
Source:
Returns:
relation value if relation exists, null otherwise
Type
string

getScriptEnv() → {string|null}

Source:
Returns:
JS script environment - either "frontend" or "backend"
Type
string | null

getTargetRelations() → {Array.<Attribute>}

Get relations which target this note
Source:
Returns:
Type
Array.<Attribute>

(async) getTargetRelationSourceNotes() → {Array.<NoteShort>}

Get relations which target this note
Source:
Returns:
Type
Array.<NoteShort>

getTemplateNotes() → {Array.<NoteShort>}

Source:
Returns:
Type
Array.<NoteShort>

hasAttribute(type, name) → {boolean}

Parameters:
Name Type Description
type string attribute type (label, relation, etc.)
name string attribute name
Source:
Returns:
true if note has an attribute with given type and name (including inherited)
Type
boolean

hasChildren() → {boolean}

Source:
Returns:
Type
boolean

hasLabel(name) → {boolean}

Parameters:
Name Type Description
name string label name
Source:
Returns:
true if label exists (including inherited)
Type
boolean

hasOwnedAttribute(type, name) → {boolean}

Parameters:
Name Type Description
type string attribute type (label, relation, etc.)
name string attribute name
Source:
Returns:
true if note has an attribute with given type and name (including inherited)
Type
boolean

hasOwnedLabel(name) → {boolean}

Parameters:
Name Type Description
name string label name
Source:
Returns:
true if label exists (excluding inherited)
Type
boolean

hasOwnedRelation(name) → {boolean}

Parameters:
Name Type Description
name string relation name
Source:
Returns:
true if relation exists (excluding inherited)
Type
boolean

hasRelation(name) → {boolean}

Parameters:
Name Type Description
name string relation name
Source:
Returns:
true if relation exists (including inherited)
Type
boolean

invalidateAttributeCache()

Deprecated:
  • NOOP
Source:

isHtml() → {boolean}

Source:
Returns:
true if this note is HTML
Type
boolean

isJavaScript() → {boolean}

Source:
Returns:
true if this note is JavaScript (code or attachment)
Type
boolean

isJson() → {boolean}

Source:
Returns:
Type
boolean