Options
All
  • Public
  • Public/Protected
  • All
Menu

A basic element of the interactive ecosystem. Each element has an unique identifier, an update function to be defined by the user, and the ability to add dependencies on other elements.

Hierarchy

Index

Constructors

constructor

  • Constructs the elements and adds it into the current controller.

    Returns BaseElement

Properties

update

update: function

The update function describes how this element should update itself

Type declaration

    • (): void
    • Returns void

Static controller

controller: Controller = new Controller()

The controller manages the dependencies between elements. Every element is added to this controller upon creation.

Static count

count: number = 0

This number uniquely identifes elements

Static disable

disable: boolean = false

Allows for the events attatched to elements to be disabled.

Accessors

id

id:

Returns the unique generated identifier associated with this element.

Methods

addDependency

  • Declares this element dependent on the provided element(s).

    Parameters

    Returns void

remove

  • remove(): void
  • Removes this element from the DOM and from the Element controller.

    Returns void

updateDependents

  • updateDependents(): void
  • Updates all of the elements that depend on this element.

    Returns void

Static clear

  • clear(disable?: boolean): void
  • Clears the static data structures holding elements and resets the count.

    Parameters

    • Default value disable: boolean = false

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc