PowerKeys Scripting API
    Preparing search index...

    Interface UIProgressOptions

    Options for AddProgress. The wrapper stores and returns the raw finite numeric value. Rendering computes (value - min) / (max - min), clamps the displayed percentage from 0% to 100%, and displays 0% when max <= min.

    interface UIProgressOptions {
        label?: string;
        value?: number;
        min?: number;
        max?: number;
        style?: UIStyle;
    }
    Index
    label? value? min? max? style?
    label?: string

    Optional label shown with the progress bar.

    value?: number

    Raw progress value returned by GetValue. Defaults to the resolved min (therefore 0 when min is omitted); rendering clamps only the displayed percentage, not this stored value.

    min?: number

    Minimum progress value. Defaults to 0.

    max?: number

    Maximum progress value. Defaults to 100.

    style?: UIStyle

    Supported renderer style properties. Unsupported keys are ignored.

    Settings
    Member Visibility

    On This Page
    Properties