# EditTransaction

Fields, allowed values, and APIs that use EditTransaction.

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

<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 EditTransaction<TValue = unknown> {
  rowIndex: number;
  colIndex: number;
  originalValue: TValue;
  draftValue: TValue;
  phase: Exclude<EditTransactionPhase, 'idle'>;
  id: number;
  meta: Readonly<Record<string, unknown>>;
}
```

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

## APIs using this type

- [getActiveEditTransaction](https://grid.syidax.com/docs/methods/getActiveEditTransaction.md) — Reads the active cell editing transaction, or null when not editing.

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

## Contracts containing this type

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

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

## Related types

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