# GridLiveObjectEvent

Fields, allowed values, and APIs that use GridLiveObjectEvent.

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

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

<a id="used-by"></a>

## APIs using this type

- [gridObjectChanged](https://grid.syidax.com/docs/events/gridObjectChanged.md) — Emitted when public objects such as rows and columns change. Read the target and changes from detail.

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

## Contracts containing this type

- [GridLiveObjectListener](https://grid.syidax.com/docs/types/GridLiveObjectListener.md)
- [SyGridEventMap](https://grid.syidax.com/docs/types/SyGridEventMap.md)

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

## Related types

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