API REFERENCE

GridLiveObjectEvent

Fields, allowed values, and APIs that use GridLiveObjectEvent.

Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

typescript
export interface GridLiveObjectEvent<
  TData = GridData,
  TValue = unknown,
> {
  readonly mutationId: GridMutationId;
  readonly kind: GridLiveObjectKind;
  readonly type: GridLiveObjectEventType;
  readonly id: string | GridRowId;
  readonly source: GridEventSource;
  readonly timestamp: number;
  readonly field?: string;
  readonly data?: Readonly<TData>;
  readonly value?: TValue;
  readonly before?: unknown;
  readonly after?: unknown;
  readonly reason?: GridRefInvalidationReason;
}

APIs using this type

Contracts containing this type