# SyGridFillRangeOptions

Fields, allowed values, and APIs that use SyGridFillRangeOptions.

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

<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 SyGridFillRangeOptions {
  to: { row: number; col: number };
  source?: CellRangeBounds;
  mode?: 'copy' | 'series';
  formatted?: boolean;
  atomicity?: 'atomic' | 'best-effort';
  formulaPolicy?: 'overwrite' | 'skip';
  allowedDirections?: ReadonlyArray<FillDirection>;
  pattern?: ((laneValues: ReadonlyArray<unknown>, index: number, target: { row: number; col: number }) => unknown) | null;
  setFillValue?: ((target: { row: number; col: number; sourceRow: number; sourceCol: number; proposed: unknown; kind: string }) => unknown) | null;
}
```

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

## APIs using this type

- [fillRange](https://grid.syidax.com/docs/methods/fillRange.md) — Fills a target range from source values or patterns and reports applied and rejected results.

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

## Contracts containing this type

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

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

## Related types

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