RevGrid - v0.9.3
    Preparing search index...

    Interface NotificationsClient

    Interface specifying callbacks from server which are used to advise client that server data has changed

    interface NotificationsClient {
        allRowsDeleted: (this: void) => void;
        beginChange: (this: void) => void;
        endChange: (this: void) => void;
        invalidateAll: (this: void) => void;
        invalidateCell: (this: void, fieldIndex: number, rowIndex: number) => void;
        invalidateRow: (this: void, rowIndex: number) => void;
        invalidateRowCells: (
            this: void,
            rowIndex: number,
            fieldIndexes: number[],
        ) => void;
        invalidateRowColumns: (
            this: void,
            rowIndex: number,
            fieldIndex: number,
            columnCount: number,
        ) => void;
        invalidateRows: (this: void, rowIndex: number, count: number) => void;
        postReindex: (this: void, allRowsKept: boolean) => void;
        preReindex: (this: void) => void;
        rowsDeleted: (this: void, rowIndex: number, rowCount: number) => void;
        rowsInserted: (this: void, rowIndex: number, rowCount: number) => void;
        rowsLoaded: (this: void) => void;
        rowsMoved: (
            this: void,
            oldRowIndex: number,
            newRowIndex: number,
            rowCount: number,
        ) => void;
    }
    Index

    Properties

    allRowsDeleted beginChange endChange invalidateAll invalidateCell invalidateRow invalidateRowCells invalidateRowColumns invalidateRows postReindex preReindex rowsDeleted rowsInserted rowsLoaded rowsMoved

    Properties

    allRowsDeleted: (this: void) => void
    beginChange: (this: void) => void
    endChange: (this: void) => void
    invalidateAll: (this: void) => void
    invalidateCell: (this: void, fieldIndex: number, rowIndex: number) => void
    invalidateRow: (this: void, rowIndex: number) => void
    invalidateRowCells: (
        this: void,
        rowIndex: number,
        fieldIndexes: number[],
    ) => void
    invalidateRowColumns: (
        this: void,
        rowIndex: number,
        fieldIndex: number,
        columnCount: number,
    ) => void
    invalidateRows: (this: void, rowIndex: number, count: number) => void
    postReindex: (this: void, allRowsKept: boolean) => void

    Notifies that ordering of data rows in server is has changed.

    Type declaration

      • (this: void, allRowsKept: boolean): void

      • Parameters

        • this: void
        • allRowsKept: boolean

          True if all rows are kept (eg. rows were not discarded due to server filtering)

        Returns void

    This callback always be follows by the preReindex callback. When client receives this notification, it restores the focus and selection from the stash of these saved to a temporary location. Typically this notification is called after rows are sorted or filtered on the server.

    preReindex: (this: void) => void

    Notifies that ordering of data rows in server is about to change.

    When client receives this notification, it saves focus and selection to a temporary location. Typically this notification is called before rows are sorted or filtered on the server. This callback will always be followed by the postReindex callback.

    rowsDeleted: (this: void, rowIndex: number, rowCount: number) => void
    rowsInserted: (this: void, rowIndex: number, rowCount: number) => void
    rowsLoaded: (this: void) => void
    rowsMoved: (
        this: void,
        oldRowIndex: number,
        newRowIndex: number,
        rowCount: number,
    ) => void

    Settings

    Member Visibility

    On This Page

    Properties