Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UIComponent

Base class for all UI components.

This class should be inherited.

Hierarchy

Index

Properties

Methods

Properties

eventQueue

eventQueue: EmitterEvent[]

uiComponent

uiComponent: Element

The underlying HTML element.

Methods

destroy

  • destroy(): void

  • Destroys the UI component.

    Returns void

emit

  • emit(evtName: String, ...args: any): void

  • Fires an event.

    Parameters

    • evtName: String

      The event name to fire.

    • Rest ...args: any

      The arguments to pass.

    Returns void

getElement

  • getElement(): Element

  • Returns the element for this UI component.

    Returns Element

getSize

  • getSize(): { height: Number; w: Number }

  • Returns the size of the component.

    Returns { height: Number; w: Number }

    • height: Number
    • w: Number

init

  • init(): void

  • Optional initialization code.

    Returns void

on

  • on(evtName: String, callback: Function): void

  • Listens for an event.

    Parameters

    • evtName: String

      The event name to listen for.

    • callback: Function

      The callback to assign.

    Returns void

once

  • once(evtName: String, callback: Function): void

  • Listens for an event once.

    Parameters

    • evtName: String

      The event name to listen for.

    • callback: Function

      The callback to assign.

    Returns void

setSize

  • setSize(w: string | number, h: string | number): void

  • Sets the size of the component.

    Parameters

    • w: string | number

      CSS prefixed width.

    • h: string | number

      CSS prefixed height.

    Returns void

Generated using TypeDoc