PowerKeys Scripting API
    Preparing search index...

    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: UIStyle) => void;
    }

    Type Parameters

    • T

    Hierarchy (View Summary)

    Index
    GetValue SetValue Hide Show Destroy SetText SetStyle
    GetValue: () => T

    Returns the current display value.

    SetValue: (val: T) => void

    Programmatically updates the display value without persisting it to storage.

    Hide: () => void

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

    Show: () => void

    Makes a previously hidden element visible again.

    Destroy: () => void

    Permanently removes the element from the UI panel.

    SetText: (text: string) => void

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

    SetStyle: (style: UIStyle) => void

    Merges supported renderer style properties into the element; unsupported keys are ignored.

    Settings
    Member Visibility

    On This Page
    Properties