Class UI

Hierarchy (View Summary)

UiConfigRendererBlueprint
- UI

Index

Constructors

constructor

new UI(
    container?: HTMLElement,
    __namedParameters?: { autoPostFrame?: boolean },
    undoManager?: false | JSUndoManager,
): UI
Parameters
- container: HTMLElement = document.body
- __namedParameters: { autoPostFrame?: boolean } = {}
- OptionalundoManager: false | JSUndoManager
Returns UI
Inherited from UiConfigRendererBlueprint.constructor
- Defined in packages/uiconfig-blueprint/src/UiConfigRendererBlueprint.tsx:13

Properties

`Protected`_autoFrameEvents

_autoFrameEvents: boolean

`Protected`_refreshQueue

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

`Protected`_root

_root: Root

`Readonly`config

config: UiObjectConfig<any, "panel">

`Readonly`methods

methods: UiConfigMethods

raf

raf: () => void

THREE

THREE: THREE | undefined = ...

Accessors

undoManager

get undoManager(): JSUndoManager | undefined
Returns JSUndoManager | undefined
Inherited from UiConfigRendererBlueprint.undoManager
- Defined in packages/uiconfig.js/dist/UiConfigRendererBase.d.ts:7
set undoManager(value: JSUndoManager | undefined): void
Parameters
- value: JSUndoManager | undefined
Returns void
Inherited from UiConfigRendererBlueprint.undoManager
- Defined in packages/uiconfig.js/dist/UiConfigRendererBase.d.ts:8

Methods

`Protected`_createUiContainer

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

`Protected`_refreshUiConfigObject

_refreshUiConfigObject(config: UiObjectConfig): void
Parameters
- config: UiObjectConfig
Returns void
Inherited from UiConfigRendererBlueprint._refreshUiConfigObject
- Defined in packages/uiconfig-blueprint/src/UiConfigRendererBlueprint.tsx:71

addEventListener

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

addToRefreshQueue

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

appendChild

appendChild(
config?: UiObjectConfig<any, string, any>,
params?: UiObjectConfig<any, string, any>,
): void
Parameters
- Optionalconfig: UiObjectConfig<any, string, any>
- Optionalparams: UiObjectConfig<any, string, any>
Returns void
Inherited from UiConfigRendererBlueprint.appendChild
- Defined in packages/uiconfig.js/dist/UiConfigRenderer.d.ts:10

dispatchEvent

dispatchEvent(
event: IEvent<"preFrame" | "preRender" | "postRender" | "postFrame">,
): void
Fire an event type.
Parameters
- event: IEvent<"preFrame" | "preRender" | "postRender" | "postFrame">
  - type
    
    The type of event that gets fired.
Returns void
Inherited from UiConfigRendererBlueprint.dispatchEvent
- Defined in node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:52

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
- Optionalconfig: UiObjectConfig<any, string, any>
- OptionalperformDispose: boolean
Returns void
Inherited from UiConfigRendererBlueprint.disposeUiConfig
- Defined in packages/uiconfig.js/dist/UiConfigRendererBase.d.ts:24

hasEventListener

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

refreshQueue

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

refreshRoot

refreshRoot(
    deep?: boolean,
    mode?: TUiRefreshModes | "immediate",
    delay?: number,
): void
Parameters
- Optionaldeep: boolean
- Optionalmode: TUiRefreshModes | "immediate"
- Optionaldelay: number
Returns void
Inherited from UiConfigRendererBlueprint.refreshRoot
- Defined in packages/uiconfig.js/dist/UiConfigRenderer.d.ts:12

removeChild

removeChild(config: UiObjectConfig): void
Parameters
- config: UiObjectConfig
Returns void
Inherited from UiConfigRendererBlueprint.removeChild
- Defined in packages/uiconfig.js/dist/UiConfigRenderer.d.ts:11

removeEventListener

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

renderUiConfig

renderUiConfig(_: UiObjectConfig): void
Parameters
- _: UiObjectConfig
Returns void
Inherited from UiConfigRendererBlueprint.renderUiConfig
- Defined in packages/uiconfig-blueprint/src/UiConfigRendererBlueprint.tsx:75

start

start(): void
Returns void
Inherited from UiConfigRendererBlueprint.start
- Defined in packages/uiconfig.js/dist/UiConfigRendererBase.d.ts:13

stop

stop(): void
Returns void
Inherited from UiConfigRendererBlueprint.stop
- Defined in packages/uiconfig.js/dist/UiConfigRendererBase.d.ts:14

unmount

unmount(): void
Returns void
Inherited from UiConfigRendererBlueprint.unmount
- Defined in packages/uiconfig-blueprint/src/UiConfigRendererBlueprint.tsx:82

Class UI

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns UI

Properties

Protected_autoFrameEvents

Protected_refreshQueue

Protected_root

Readonlyconfig

Readonlymethods

raf

THREE

Accessors

undoManager

Returns JSUndoManager | undefined

Parameters

Returns void

Methods

Protected_createUiContainer

Returns HTMLDivElement

Protected_refreshUiConfigObject

Parameters

Returns void

addEventListener

Parameters

Returns void

addToRefreshQueue

Parameters

Returns void

appendChild

Parameters

Returns void

dispatchEvent

Parameters

type

Returns void

disposeUiConfig

Parameters

Returns void

hasEventListener

Parameters

Returns boolean

refreshQueue

Parameters

Returns void

refreshRoot

Parameters

Returns void

removeChild

Parameters

Returns void

removeEventListener

Parameters

Returns void

renderUiConfig

Parameters

Returns void

start

Returns void

stop

Returns void

unmount

Returns void

Settings

On This Page

`Protected`_autoFrameEvents

`Protected`_refreshQueue

`Protected`_root

`Readonly`config

`Readonly`methods

`Protected`_createUiContainer

`Protected`_refreshUiConfigObject