@helix-x/datagrid-ui - v0.2.0
    Preparing search index...

    Interface PersistedGridState

    What the grid writes to localStorage under DataGridProps.storageKey.

    Stored under the key hxg:<storageKey>.

    interface PersistedGridState {
        columns: {
            hidden: string[];
            order: string[];
            pinned: Record<string, Pinned>;
            widths: Record<string, number>;
        };
        filters: FilterModelMap;
        pagination: { pageSize: number };
        rowGroup?: string | null;
        sort: SortModelItem[];
        v: number;
    }
    Index
    columns filters pagination rowGroup? sort v
    columns: {
        hidden: string[];
        order: string[];
        pinned: Record<string, Pinned>;
        widths: Record<string, number>;
    }

    Column layout the user arranged.

    Type Declaration

    • hidden: string[]

      Ids of columns the user hid.

    • order: string[]

      Column ids in display order.

    • pinned: Record<string, Pinned>

      User-pinned columns, by column id.

    • widths: Record<string, number>

      User-resized widths, by column id.

    filters: FilterModelMap

    The filter model at the time of saving.

    pagination: { pageSize: number }

    Paging preferences.

    Type Declaration

    • pageSize: number

      Rows per page the user chose.

    rowGroup?: string | null

    The column id the user grouped by, or null when they ungrouped. Absent in state saved before grouping existed, which restores as "not set".

    sort: SortModelItem[]

    The sort model at the time of saving.

    v: number

    Schema version. Compared against GRID_STATE_VERSION on read.

    Settings
    Member Visibility

    On This Page
    Properties