Interface DataGridWrapper

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

Example

const grid = UI.AddDataGrid("items", [
  { key: "name", title: "Name", type: "text" },
  { key: "active", title: "Active", type: "checkbox" },
]);
grid.OnRowAction((rowIndex, colKey, rowData) => {
  Console.Log("row " + rowIndex + " col " + colKey);
});
interface DataGridWrapper {
    Hide(): void;
    Show(): void;
    Destroy(): void;
    GetValue(): Record<string, unknown>[];
    SetValue(rows: Record<string, unknown>[]): void;
    OnRowAction(
        callback: (
            rowIndex: number,
            columnKey: string,
            rowData: Record<string, unknown>,
        ) => void,
    ): void;
}

Hierarchy (View Summary)

Methods

Hide Show Destroy GetValue SetValue OnRowAction

Methods

Hide

  • Hide(): void

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

    Returns void

Show

  • Show(): void

    Makes a previously hidden element visible again.

    Returns void

Destroy

  • Destroy(): void

    Permanently removes the element from the UI panel.

    Returns void

GetValue

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

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

    Returns Record<string, unknown>[]

SetValue

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

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

    Parameters

    • rows: Record<string, unknown>[]

    Returns void

OnRowAction

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

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

    Parameters

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

    Returns void

Settings

Member Visibility

On This Page

Methods