uiconfig.js
    Preparing search index...

    Class UiConfigRendererBaseAbstract

    Hierarchy (View Summary)

    • SimpleEventDispatcher<"preFrame" | "preRender" | "postRender" | "postFrame">
    Index

    Constructors

    Properties

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

    Accessors

    Methods

    • 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

    • Fire an event type.

      Parameters

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

          The type of event that gets fired.

      Returns 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

    • 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

    • 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