Class UiConfigRendererBlueprint

Readonly config

Readonly methods

raf

undoManager

• get undoManager(): undefined | JSUndoManager

• Returns undefined | JSUndoManager

• set undoManager(value): void

• Parameters

  • value: undefined | JSUndoManager

  Returns void

addEventListener

• addEventListener(type, listener): void

• Parameters

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

  • listener: ((event) => void)

    • • (event): void

      • Parameters

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

        Returns void

  Returns void

addToRefreshQueue

• addToRefreshQueue(mode, uiConfig, deep, delay): void

• Parameters

  • mode: TUiRefreshModes | "immediate"

  • uiConfig: UiObjectConfig<any, string, any>

  • deep: boolean

  • delay: number

  Returns void

appendChild

• appendChild(config?, params?): void

• Parameters

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

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

  Returns void

dispatchEvent

• dispatchEvent(event): void

• Parameters

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

  Returns void

disposeUiConfig

• disposeUiConfig(config?, performDispose?): 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

hasEventListener

• hasEventListener(type, listener): boolean

• Parameters

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

  • listener: ((event) => void)

    • • (event): void

      • Parameters

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

        Returns void

  Returns boolean

refreshQueue

• refreshQueue(mode): void

• Parameters

  • mode: TUiRefreshModes

  Returns void

refreshRoot

• refreshRoot(deep?, mode?, delay?): void

• Parameters

  • Optional deep: boolean

  • Optional mode: TUiRefreshModes | "immediate"

  • Optional delay: number

  Returns void

removeChild

• removeChild(config): void

• Parameters

  • config: UiObjectConfig<any, string, any>

  Returns void

removeEventListener

• removeEventListener(type, listener): void

• Parameters

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

  • listener: ((event) => void)

    • • (event): void

      • Parameters

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

        Returns void

  Returns void

start

• start(): void

• Returns void

stop

• stop(): void

• Returns void