API Docs for: 0.0.0
Show:

Set Class

Defined in: library\space\set.js:12
Module: Elements

Represents the set of links that connect elements. Various collections serve different purposes for how they connect and can inherit from one another.

Constructor

Set

(
  • session
  • description
)

Defined in library\space\set.js:12

Parameters:

  • session Object
  • description Object

Methods

checkAccess

(
  • session
)
Boolean

Defined in library\space\set.js:196

Parameters:

Returns:

Boolean:

emit

(
  • session
  • key
  • data
  • origin
)

Defined in library\space\set.js:158

Parameters:

  • session Session
  • key String

    Identifier for the event to emit, a key prefix of "ext-" indicating external origin is required and added automatically if omitted.

  • data Object
  • origin String

Throws:

Error:

On access denial

propagating

(
  • id
  • event
)

Defined in library\space\set.js:186

Parameters:

  • id String

    The Element causing the event emission from this set.

  • event Event

    The Event that is propagating.

Properties

created

Number

Defined in library\elements\page.js:74

creater

String

Defined in library\elements\page.js:67

description

String

Defined in library\elements\page.js:46

Markdown style string describing the purpose of the set.

fields

Object

Defined in library\elements\page.js:53

Custom fields to use to tag the set for informational purposes.

id

String

Defined in library\elements\page.js:25

id

String

Defined in library\space\set.js:23

modified

Number

Defined in library\elements\page.js:88

modifier

String

Defined in library\elements\page.js:81

name

String

Defined in library\elements\page.js:32

private

Boolean

Defined in library\elements\page.js:39

When true, edges in this page are considered limited to the page and not the master list.

touched

Array | String

Defined in library\elements\page.js:60

Array of page IDs that should be considered a subgroup of this page.