Interface DataGridWrapper

A tabular UI element with typed rows. Row data is automatically persisted to storage on every change and restored on next run.

interface DataGridWrapper {
    GetValue: () => Record<string, unknown>[];
    SetValue: (rows: Record<string, unknown>[]) => void;
    OnRowAction: (
        callback: (
            rowIndex: number,
            columnKey: string,
            rowData: Record<string, unknown>,
        ) => void,
    ) => void;
    Hide: () => void;
    Show: () => void;
    Destroy: () => void;
    SetText: (text: string) => void;
    SetStyle: (style: Record<string, unknown>) => void;
}

Hierarchy (View Summary)

Properties

GetValue SetValue OnRowAction Hide Show Destroy SetText SetStyle

Properties

GetValue

GetValue: () => Record<string, unknown>[]

Returns all current rows as an array of plain objects keyed by column key.

SetValue

SetValue: (rows: Record<string, unknown>[]) => void

Replaces all rows with the provided array. Persists to storage immediately.

OnRowAction

OnRowAction: (
    callback: (
        rowIndex: number,
        columnKey: string,
        rowData: Record<string, unknown>,
    ) => void,
) => void

Fires when the user interacts with a button-type column cell.

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