Interface DisplayValueWrapper<T>

A display-only element with a mutable value. Returned by AddProgress.

interface DisplayValueWrapper<T> {
    GetValue: () => T;
    SetValue: (val: T) => void;
    Hide: () => void;
    Show: () => void;
    Destroy: () => void;
    SetText: (text: string) => void;
    SetStyle: (style: Record<string, unknown>) => void;
}

Type Parameters

  • T

Hierarchy (View Summary)

Properties

GetValue SetValue Hide Show Destroy SetText SetStyle

Properties

GetValue

GetValue: () => T

Returns the current display value.

SetValue

SetValue: (val: T) => void

Programmatically updates the display value without persisting it to storage.

Hide

Hide: () => void

Hides the element without destroying it. Call Show() to make it visible again.

Show

Show: () => void

Makes a previously hidden element visible again.

Destroy

Destroy: () => void

Permanently removes the element from the UI panel.

SetText

SetText: (text: string) => void

Updates the element's display text when the element has a label.

SetStyle

SetStyle: (style: Record<string, unknown>) => void

Merges safe CSS-like renderer style metadata into the element.

Settings

Member Visibility

On This Page

Properties