Interface Signature<DataType, Key>

utility class to help with autocompletion / documentation in the editor while while defining the signature of custom plugins.

interface Signature<DataType = any, Key = DataType> {
    Meta: { Row: RowMeta; Table: TableMeta };
    Options: {
        Plugin: { selection: Set<Key> | Key[] } & (
            | {
                key: (data: DataType) => Key;
                onDeselect: (item: Key, row: Row<DataType>) => void;
                onSelect: (item: Key, row: Row<DataType>) => void;
            }
            | {
                onDeselect: (item: any, row: Row<DataType>) => void;
                onSelect: (item: any, row: Row<DataType>) => void;
            }
        );
    };
}

Type Parameters

Hierarchy (View Summary)

Properties

Meta Options

Properties

Meta

Meta: { Row: RowMeta; Table: TableMeta }

Meta is how plugins can manage per-{table,columns,rows} state, event listeners, and general public API

Options

Options: {
    Plugin: { selection: Set<Key> | Key[] } & (
        | {
            key: (data: DataType) => Key;
            onDeselect: (item: Key, row: Row<DataType>) => void;
            onSelect: (item: Key, row: Row<DataType>) => void;
        }
        | {
            onDeselect: (item: any, row: Row<DataType>) => void;
            onSelect: (item: any, row: Row<DataType>) => void;
        }
    );
}

Settings

Member Visibility

On This Page

Properties