Class UiConfigRendererBase<TUiNode>`Abstract`

Type Parameters

TUiNode = any

Hierarchy

SimpleEventDispatcher<
    | "preFrame"
    | "preRender"
    | "postRender"
    | "postFrame">
- UiConfigRendererBase

Index

Constructors

`Protected`constructor

new UiConfigRendererBase<TUiNode>(container?, autoFrameEvents?, methods?): UiConfigRendererBase<TUiNode>
Type Parameters
- TUiNode = any
Parameters
- container: HTMLElement = document.body
- autoFrameEvents: boolean = true
- Optionalmethods: UiConfigMethods
Returns UiConfigRendererBase<TUiNode>
Overrides SimpleEventDispatcher<'preFrame'|'preRender'|'postRender'|'postFrame'>.constructor
- Defined in src/UiConfigRendererBase.ts:13

Properties

`Protected`_refreshQueue

_refreshQueue: Record<TUiRefreshModes, [UiObjectConfig<any, string, any>, number, undefined | string][]> = ...

`Protected` `Optional`_root

_root?: TUiNode

`Readonly`config

config: UiObjectConfig<any, "panel", any> = ...

`Readonly`methods

methods: UiConfigMethods

Methods

`Protected`_createUiContainer

_createUiContainer(): HTMLDivElement
Returns HTMLDivElement
- Defined in src/UiConfigRendererBase.ts:136

`Protected` `Abstract`_refreshUiConfigObject

_refreshUiConfigObject(config): void
Parameters
- config: UiObjectConfig<any, string, any>
Returns void
- Defined in src/UiConfigRendererBase.ts:134

addEventListener

addEventListener(type, listener): void
Adds a listener to an event type.
Parameters
- type:
      | "preRender"
      | "postRender"
      | "preFrame"
      | "postFrame"
  The type of event to listen to.
- listener: ((event: IEvent<
      | "preRender"
      | "postRender"
      | "preFrame"
      | "postFrame">) => void)
  The function that gets called when the event is fired.
  - - (event): void
    - Parameters
      event: IEvent<
          | "preRender"
          | "postRender"
          | "preFrame"
          | "postFrame">
      Returns void
Returns void
Inherited from SimpleEventDispatcher.addEventListener
- Defined in node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:43

addToRefreshQueue

addToRefreshQueue(mode, uiConfig, deep, delay): void
Parameters
- mode: TUiRefreshModes | "immediate"
- uiConfig: UiObjectConfig<any, string, any>
- deep: boolean
- delay: number
Returns void
- Defined in src/UiConfigRendererBase.ts:127

appendChild

appendChild(config?, params?): void
Parameters
- Optionalconfig: UiObjectConfig<any, string, any>
- Optionalparams: UiObjectConfig<any, string, any>
Returns void
- Defined in src/UiConfigRendererBase.ts:90

dispatchEvent

dispatchEvent(event): void
Fire an event type.
Parameters
- event: IEvent<
      | "preRender"
      | "postRender"
      | "preFrame"
      | "postFrame">
Returns void
Inherited from SimpleEventDispatcher.dispatchEvent
- Defined in node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:46

dispose

dispose(): void
Returns void
- Defined in src/UiConfigRendererBase.ts:81

disposeUiConfig

disposeUiConfig(config?, performDispose?): void
Disposes the UI associated with a config, doesn't makes change to the object or its parent.
Parameters
- Optionalconfig: UiObjectConfig<any, string, any>
- performDispose: boolean = true
Returns void
- Defined in src/UiConfigRendererBase.ts:117

hasEventListener

hasEventListener(type, listener): boolean
Checks if listener is added to an event type.
Parameters
- type:
      | "preRender"
      | "postRender"
      | "preFrame"
      | "postFrame"
  The type of event to listen to.
- listener: ((event: IEvent<
      | "preRender"
      | "postRender"
      | "preFrame"
      | "postFrame">) => void)
  The function that gets called when the event is fired.
  - - (event): void
    - Parameters
      event: IEvent<
          | "preRender"
          | "postRender"
          | "preFrame"
          | "postFrame">
      Returns void
Returns boolean
Inherited from SimpleEventDispatcher.hasEventListener
- Defined in node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:44

refreshQueue

refreshQueue(mode): void
Parameters
- mode: TUiRefreshModes
Returns void
- Defined in src/UiConfigRendererBase.ts:49

refreshRoot

refreshRoot(deep?, mode?, delay?): void
Parameters
- deep: boolean = true
- mode: TUiRefreshModes | "immediate" = 'postFrame'
- delay: number = 0
Returns void
- Defined in src/UiConfigRendererBase.ts:104

removeChild

removeChild(config): void
Parameters
- config: UiObjectConfig<any, string, any>
Returns void
- Defined in src/UiConfigRendererBase.ts:96

removeEventListener

removeEventListener(type, listener): void
Removes a listener from an event type.
Parameters
- type:
      | "preRender"
      | "postRender"
      | "preFrame"
      | "postFrame"
  The type of the listener that gets removed.
- listener: ((event: IEvent<
      | "preRender"
      | "postRender"
      | "preFrame"
      | "postFrame">) => void)
  The listener function that gets removed.
  - - (event): void
    - Parameters
      event: IEvent<
          | "preRender"
          | "postRender"
          | "preFrame"
          | "postFrame">
      Returns void
Returns void
Inherited from SimpleEventDispatcher.removeEventListener
- Defined in node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:45

`Abstract`renderUiConfig

renderUiConfig(uiConfig): void
Parameters
- uiConfig: UiObjectConfig<any, string, any>
Returns void
- Defined in src/UiConfigRendererBase.ts:108

Class UiConfigRendererBase<TUiNode>Abstract

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns UiConfigRendererBase<TUiNode>

Properties

Protected_refreshQueue

Protected Optional_root

Readonlyconfig

Readonlymethods

Methods

Protected_createUiContainer

Returns HTMLDivElement

Protected Abstract_refreshUiConfigObject

Parameters

Returns void

addEventListener

Parameters

Parameters

Returns void

Returns void

addToRefreshQueue

Parameters

Returns void

appendChild

Parameters

Returns void

dispatchEvent

Parameters

Returns void

dispose

Returns void

disposeUiConfig

Parameters

Returns void

hasEventListener

Parameters

Parameters

Returns void

Returns boolean

refreshQueue

Parameters

Returns void

refreshRoot

Parameters

Returns void

removeChild

Parameters

Returns void

removeEventListener

Parameters

Parameters

Returns void

Returns void

AbstractrenderUiConfig

Parameters

Returns void

Settings

On This Page

Class UiConfigRendererBase<TUiNode>`Abstract`

`Protected`constructor

`Protected`_refreshQueue

`Protected` `Optional`_root

`Readonly`config

`Readonly`methods

`Protected`_createUiContainer

`Protected` `Abstract`_refreshUiConfigObject

`Abstract`renderUiConfig