# SyGridAlignedGridsReport

Fields, allowed values, and APIs that use SyGridAlignedGridsReport.

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

<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 SyGridAlignedGridsReport {
  readonly configured: boolean;
  readonly group: string | null;
  readonly memberId: string;
  readonly members: ReadonlyArray<string>;
  readonly generation: number;
  readonly alignedColumns: ReadonlyArray<string>;
  readonly canonical: { readonly columns: ReadonlyArray<SyGridAlignedColumnState>; readonly scrollLeft: number } | null;
  readonly mismatches: ReadonlyArray<SyGridAlignedMismatch>;
  readonly stats: SyGridAlignedStats | null;
}
```

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

## APIs using this type

- [getAlignedGrids](https://grid.syidax.com/docs/methods/getAlignedGrids.md) — Reads connected Grids and alignment state.

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

## Contracts containing this type

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

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

## Related types

- [SyGridAlignedColumnState](https://grid.syidax.com/docs/types/SyGridAlignedColumnState.md)
- [SyGridAlignedMismatch](https://grid.syidax.com/docs/types/SyGridAlignedMismatch.md)
- [SyGridAlignedStats](https://grid.syidax.com/docs/types/SyGridAlignedStats.md)