# GridLiveRef

Fields, allowed values, and APIs that use GridLiveRef.

Canonical: https://grid.syidax.com/docs/types/GridLiveRef/

<a id="definition"></a>

## 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;
}
```

<a id="parents"></a>

## Contracts containing this type

- [GridColumnGroupRef](https://grid.syidax.com/docs/types/GridColumnGroupRef.md)
- [GridColumnRef](https://grid.syidax.com/docs/types/GridColumnRef.md)
- [GridRowRef](https://grid.syidax.com/docs/types/GridRowRef.md)

<a id="related"></a>

## Related types

- [GridData](https://grid.syidax.com/docs/types/GridData.md)
- [GridRowId](https://grid.syidax.com/docs/types/GridRowId.md)
- [GridRefInvalidationReason](https://grid.syidax.com/docs/types/GridRefInvalidationReason.md)
- [GridLiveObjectEventType](https://grid.syidax.com/docs/types/GridLiveObjectEventType.md)
- [GridLiveObjectListener](https://grid.syidax.com/docs/types/GridLiveObjectListener.md)