Class UI

Hierarchy

UiConfigRendererBlueprint
- UI

Index

Constructors

constructor

new UI(container?: HTMLElement, __namedParameters?: {
autoPostFrame: undefined | boolean;
}): UI
Parameters
- container: HTMLElement = document.body
- __namedParameters: {
  autoPostFrame: undefined | boolean;
  } = {}
  - autoPostFrame: undefined | boolean
Returns UI
Inherited from UiConfigRendererBlueprint.constructor
- Defined in src/UiConfigRendererBlueprint.tsx:14

Properties

THREE

THREE: undefined | THREE = ...

`Protected` _refreshQueue

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

`Protected` `Optional` _root

_root?: Root

`Readonly` config

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

`Readonly` methods

methods: UiConfigMethods

Methods

`Protected` _createUiContainer

_createUiContainer(): HTMLDivElement
Returns HTMLDivElement
Inherited from UiConfigRendererBlueprint._createUiContainer
- Defined in src/UiConfigRendererBlueprint.tsx:20

`Protected` _refreshUiConfigObject

_refreshUiConfigObject(config: UiObjectConfig<any, string, any>): void
Parameters
- config: UiObjectConfig<any, string, any>
Returns void
Inherited from UiConfigRendererBlueprint._refreshUiConfigObject
- Defined in src/UiConfigRendererBlueprint.tsx:57

addEventListener

addEventListener(type: "preRender" | "postRender" | "preFrame" | "postFrame", listener: ((event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">) => void)): void
Parameters
- type: "preRender" | "postRender" | "preFrame" | "postFrame"
- listener: ((event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">) => void)
  - - (event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">): void
    - Parameters
      
      event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">
      
      Returns void
Returns void
Inherited from UiConfigRendererBlueprint.addEventListener
- Defined in node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:43

addToRefreshQueue

addToRefreshQueue(mode: TUiRefreshModes | "immediate", uiConfig: UiObjectConfig<any, string, any>, deep: boolean, delay: number): void
Parameters
- mode: TUiRefreshModes | "immediate"
- uiConfig: UiObjectConfig<any, string, any>
- deep: boolean
- delay: number
Returns void
Inherited from UiConfigRendererBlueprint.addToRefreshQueue
- Defined in node_modules/uiconfig.js/dist/UiConfigRendererBase.d.ts:24

appendChild

appendChild(config?: UiObjectConfig<any, string, any>, params?: UiObjectConfig<any, string, any>): void
Parameters
- Optional config: UiObjectConfig<any, string, any>
- Optional params: UiObjectConfig<any, string, any>
Returns void
Inherited from UiConfigRendererBlueprint.appendChild
- Defined in node_modules/uiconfig.js/dist/UiConfigRendererBase.d.ts:13

dispatchEvent

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

dispose

dispose(): void
Returns void
Inherited from UiConfigRendererBlueprint.dispose
- Defined in src/UiConfigRendererBlueprint.tsx:68

disposeUiConfig

disposeUiConfig(config?: UiObjectConfig<any, string, any>, performDispose?: boolean): void
Disposes the UI associated with a config, doesn't makes change to the object or its parent.
Parameters
- Optional config: UiObjectConfig<any, string, any>
- Optional performDispose: boolean
Returns void
Inherited from UiConfigRendererBlueprint.disposeUiConfig
- Defined in node_modules/uiconfig.js/dist/UiConfigRendererBase.d.ts:23

hasEventListener

hasEventListener(type: "preRender" | "postRender" | "preFrame" | "postFrame", listener: ((event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">) => void)): boolean
Parameters
- type: "preRender" | "postRender" | "preFrame" | "postFrame"
- listener: ((event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">) => void)
  - - (event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">): void
    - Parameters
      
      event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">
      
      Returns void
Returns boolean
Inherited from UiConfigRendererBlueprint.hasEventListener
- Defined in node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:44

refreshQueue

refreshQueue(mode: TUiRefreshModes): void
Parameters
- mode: TUiRefreshModes
Returns void
Inherited from UiConfigRendererBlueprint.refreshQueue
- Defined in node_modules/uiconfig.js/dist/UiConfigRendererBase.d.ts:10

refreshRoot

refreshRoot(deep?: boolean, mode?: TUiRefreshModes | "immediate", delay?: number): void
Parameters
- Optional deep: boolean
- Optional mode: TUiRefreshModes | "immediate"
- Optional delay: number
Returns void
Inherited from UiConfigRendererBlueprint.refreshRoot
- Defined in node_modules/uiconfig.js/dist/UiConfigRendererBase.d.ts:15

removeChild

removeChild(config: UiObjectConfig<any, string, any>): void
Parameters
- config: UiObjectConfig<any, string, any>
Returns void
Inherited from UiConfigRendererBlueprint.removeChild
- Defined in node_modules/uiconfig.js/dist/UiConfigRendererBase.d.ts:14

removeEventListener

removeEventListener(type: "preRender" | "postRender" | "preFrame" | "postFrame", listener: ((event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">) => void)): void
Parameters
- type: "preRender" | "postRender" | "preFrame" | "postFrame"
- listener: ((event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">) => void)
  - - (event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">): void
    - Parameters
      
      event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">
      
      Returns void
Returns void
Inherited from UiConfigRendererBlueprint.removeEventListener
- Defined in node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:45

renderUiConfig

renderUiConfig(_: UiObjectConfig<any, string, any>): void
Parameters
- _: UiObjectConfig<any, string, any>
Returns void
Inherited from UiConfigRendererBlueprint.renderUiConfig
- Defined in src/UiConfigRendererBlueprint.tsx:61

Class UI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

container: HTMLElement = document.body

__namedParameters: { autoPostFrame: undefined | boolean; } = {}

autoPostFrame: undefined | boolean

Returns UI

Properties

THREE

Protected _refreshQueue

Protected Optional _root

Readonly config

Readonly methods

Methods

Protected _createUiContainer

Returns HTMLDivElement

Protected _refreshUiConfigObject

Parameters

config: UiObjectConfig<any, string, any>

Returns void

addEventListener

Parameters

type: "preRender" | "postRender" | "preFrame" | "postFrame"

listener: ((event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">) => void)

Parameters

event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">

Returns void

Returns void

addToRefreshQueue

Parameters

mode: TUiRefreshModes | "immediate"

uiConfig: UiObjectConfig<any, string, any>

deep: boolean

delay: number

Returns void

appendChild

Parameters

Optional config: UiObjectConfig<any, string, any>

Optional params: UiObjectConfig<any, string, any>

Returns void

dispatchEvent

Parameters

event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">

Returns void

dispose

Returns void

disposeUiConfig

Parameters

Optional config: UiObjectConfig<any, string, any>

Optional performDispose: boolean

Returns void

hasEventListener

Parameters

type: "preRender" | "postRender" | "preFrame" | "postFrame"

listener: ((event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">) => void)

Parameters

event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">

Returns void

Returns boolean

refreshQueue

Parameters

mode: TUiRefreshModes

Returns void

refreshRoot

Parameters

Optional deep: boolean

Optional mode: TUiRefreshModes | "immediate"

Optional delay: number

Returns void

removeChild

Parameters

config: UiObjectConfig<any, string, any>

Returns void

removeEventListener

__namedParameters: {
autoPostFrame: undefined | boolean;
} = {}

`Protected` _refreshQueue

`Protected` `Optional` _root

`Readonly` config

`Readonly` methods

`Protected` _createUiContainer

`Protected` _refreshUiConfigObject

`Optional` config: UiObjectConfig<any, string, any>

`Optional` params: UiObjectConfig<any, string, any>

`Optional` config: UiObjectConfig<any, string, any>

`Optional` performDispose: boolean

`Optional` deep: boolean

`Optional` mode: TUiRefreshModes | "immediate"

`Optional` delay: number