weasel API - v0.8.0
    Preparing search index...

    Interface ToolPrefNumber

    interface ToolPrefNumber {
        block?: boolean;
        control?: ToolPrefNumberControl;
        default: number;
        description: string;
        hidden?: boolean;
        kind: "number";
        max?: number;
        min?: number;
        name: string;
        pair?: string;
        step?: number;
        unit?: ToolPrefNumberUnit;
    }

    Hierarchy

    • ToolPrefBase<"number", number>
      • ToolPrefNumber
    Index

    Properties

    block? control? default description hidden? kind max? min? name pair? step? unit?

    Properties

    block?: boolean

    Render full-width with no label row in schema-driven settings UIs (weasel-ui PrefsForm honors this for leaves whose control brings its own chrome).

    control?: ToolPrefNumberControl
    default: number

    Fallback when nothing is persisted.

    description: string

    Longer help text — shown in tooltips / a settings pane.

    hidden?: boolean

    Hide from a host app's settings UI by default.

    kind: "number"
    max?: number
    min?: number
    name: string

    Human-readable label.

    pair?: string

    Row-pairing hint for compact property UIs (weasel-ui SelectionPanel): leaves sharing a pair id render side-by-side on one row labeled with the pair string (e.g. 'Position' for pose.x / pose.y). Purely presentational.

    step?: number
    unit?: ToolPrefNumberUnit

    Settings

    Member Visibility

    On This Page

    Properties