API Docs for: 0.0.0
Show:

Element Class

Defined in: library\elements\element.js:38
Module: Elements

Constructor

Element

(
  • session
  • description
)

Defined in library\elements\element.js:38

Parameters:

  • session Object
  • description Object

Properties

active

Boolean

Defined in library\elements\element.js:118

Indicates if the element should be considered active.

This does NOT affect it's availability for querying or graph linking, this is simply an extension of the status.

An example would be taking a server offline for maintenance.

See for making an element unavailable to searches and linking.

created

Number

Defined in library\elements\element.js:163

creater

String

Defined in library\elements\element.js:156

description

String

Defined in library\elements\element.js:83

Markdown style string describing the element.

distress

Number

Defined in library\elements\element.js:97

fields

Object

Defined in library\elements\element.js:149

id

String

Defined in library\elements\element.js:69

modified

Number

Defined in library\elements\element.js:177

modifier

String

Defined in library\elements\element.js:170

name

String

Defined in library\elements\element.js:76

removed

Boolean

Defined in library\elements\element.js:133

When true, this element is no longer used when calculating support/dependency trees or event propagation, but it will still appear in searches and show in exploratory graphs and searches.

status

Number

Defined in library\elements\element.js:90

subtype

String

Defined in library\elements\element.js:111

type

String

Defined in library\elements\element.js:104