Class UiConfigRenderer`Abstract`

Hierarchy (View Summary)

UiConfigRendererBase
- UiConfigRenderer

Index

Constructors

`Protected`constructor

new UiConfigRenderer(
    container?: HTMLElement,
    autoFrameEvents?: boolean,
    methods?: UiConfigMethods,
    undoManager?: false | JSUndoManager,
): UiConfigRenderer
Parameters
- container: HTMLElement = document.body
- autoFrameEvents: boolean = true
- Optionalmethods: UiConfigMethods
- OptionalundoManager: false | JSUndoManager
Returns UiConfigRenderer
Overrides UiConfigRendererBase.constructor
- Defined in src/UiConfigRenderer.ts:15

Properties

`Protected`_autoFrameEvents

_autoFrameEvents: boolean

`Protected`_refreshQueue

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

`Readonly`config

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

`Readonly`methods

methods: UiConfigMethods

Accessors

undoManager

get undoManager(): undefined | JSUndoManager
Returns undefined | JSUndoManager
Inherited from UiConfigRendererBase.undoManager
- Defined in src/UiConfigRendererBase.ts:9
set undoManager(value: undefined | JSUndoManager): void
Parameters
- value: undefined | JSUndoManager
Returns void
Inherited from UiConfigRendererBase.undoManager
- Defined in src/UiConfigRendererBase.ts:12

Methods

`Protected`_createUiContainer

_createUiContainer(): HTMLDivElement
Returns HTMLDivElement
- Defined in src/UiConfigRenderer.ts:54

`Protected` `Abstract`_refreshUiConfigObject

_refreshUiConfigObject(config: UiObjectConfig): void
Parameters
- config: UiObjectConfig
Returns void
Inherited from UiConfigRendererBase._refreshUiConfigObject
- Defined in src/UiConfigRendererBase.ts:124

addEventListener

addEventListener(
    type: "preRender" | "postRender" | "preFrame" | "postFrame",
    listener: (
        event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">,
    ) => void,
): 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.
Returns void
Inherited from UiConfigRendererBase.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 UiConfigRendererBase.addToRefreshQueue
- Defined in src/UiConfigRendererBase.ts:117

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
- Defined in src/UiConfigRenderer.ts:33

dispatchEvent

dispatchEvent(
event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">,
): void
Fire an event type.
Parameters
- event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">
  - type
    The type of event that gets fired.
Returns void
Inherited from UiConfigRendererBase.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>
- performDispose: boolean = true
Returns void
Inherited from UiConfigRendererBase.disposeUiConfig
- Defined in src/UiConfigRendererBase.ts:107

hasEventListener

hasEventListener(
    type: "preRender" | "postRender" | "preFrame" | "postFrame",
    listener: (
        event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">,
    ) => void,
): 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.
Returns boolean
Inherited from UiConfigRendererBase.hasEventListener
- Defined in node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:50

raf

raf(): void
Returns void
Inherited from UiConfigRendererBase.raf
- Defined in src/UiConfigRendererBase.ts:33

refreshQueue

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

refreshRoot

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

removeChild

removeChild(config: UiObjectConfig): void
Parameters
- config: UiObjectConfig
Returns void
- Defined in src/UiConfigRenderer.ts:40

removeEventListener

removeEventListener(
    type: "preRender" | "postRender" | "preFrame" | "postFrame",
    listener: (
        event: IEvent<"preRender" | "postRender" | "preFrame" | "postFrame">,
    ) => void,
): 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.
Returns void
Inherited from UiConfigRendererBase.removeEventListener
- Defined in node_modules/ts-browser-helpers/dist/EventDispatcher.d.ts:51

`Abstract`renderUiConfig

renderUiConfig(uiConfig: UiObjectConfig): void
Parameters
- uiConfig: UiObjectConfig
Returns void
- Defined in src/UiConfigRenderer.ts:52

start

start(): void
Returns void
Inherited from UiConfigRendererBase.start
- Defined in src/UiConfigRendererBase.ts:43

stop

stop(): void
Returns void
Inherited from UiConfigRendererBase.stop
- Defined in src/UiConfigRendererBase.ts:49

unmount

unmount(): void
Returns void
- Defined in src/UiConfigRenderer.ts:22

Class UiConfigRendererAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Parameters

Returns UiConfigRenderer

Properties

Protected_autoFrameEvents

Protected_refreshQueue

Readonlyconfig

Readonlymethods

Accessors

undoManager

Returns undefined | JSUndoManager

Parameters

Returns void

Methods

Protected_createUiContainer

Returns HTMLDivElement

Protected Abstract_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

raf

Returns void

refreshQueue

Parameters

Returns void

refreshRoot

Parameters

Returns void

removeChild

Parameters

Returns void

removeEventListener

Parameters

Returns void

AbstractrenderUiConfig

Parameters

Returns void

start

Returns void

stop

Returns void

unmount

Returns void

Settings

On This Page

Class UiConfigRenderer`Abstract`

`Protected`constructor

`Protected`_autoFrameEvents

`Protected`_refreshQueue

`Readonly`config

`Readonly`methods

`Protected`_createUiContainer

`Protected` `Abstract`_refreshUiConfigObject

`Abstract`renderUiConfig