API REFERENCE

GridLiveRef

Fields, allowed values, and APIs that use GridLiveRef.

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 GridLiveRef<
  TData = GridData,
  TValue = unknown,
> {
  readonly id: string | GridRowId;
  isValid(): boolean;
  getInvalidationReason(): GridRefInvalidationReason | null;
  addEventListener(
    type: GridLiveObjectEventType | '*',
    listener: GridLiveObjectListener<TData, TValue>,
  ): () => void;
  removeEventListener(
    type: GridLiveObjectEventType | '*',
    listener: GridLiveObjectListener<TData, TValue>,
  ): void;
}

Contracts containing this type