# GridColumnGroupRef

Fields, allowed values, and APIs that use GridColumnGroupRef.

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

<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 GridColumnGroupRef<
  TData = GridData,
  TContext = unknown,
> extends GridLiveRef<TData> {
  readonly id: string;
  getDefinition(): Readonly<GridColumnGroupDef<TData, TContext>> | null;
  getChildren(): ReadonlyArray<
    GridColumnRef<TData, unknown, TContext> | GridColumnGroupRef<TData, TContext>
  >;
  getLeafColumns(): ReadonlyArray<GridColumnRef<TData, unknown, TContext>>;
  getParent(): GridColumnGroupRef<TData, TContext> | null;
  isExpanded(): boolean;
  isPadding(): boolean;
  isDisplayed(): boolean;
  setExpanded(expanded: boolean): Promise<boolean>;
}
```

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

## APIs using this type

- [getColumnGroup](https://grid.syidax.com/docs/methods/getColumnGroup.md) — Finds a current column group by ID. Returns null if absent.
- [getColumnGroups](https://grid.syidax.com/docs/methods/getColumnGroups.md) — Reads current column group objects.

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

## Contracts containing this type

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

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

## Related types

- [GridData](https://grid.syidax.com/docs/types/GridData.md)
- [GridLiveRef](https://grid.syidax.com/docs/types/GridLiveRef.md)
- [GridColumnGroupDef](https://grid.syidax.com/docs/types/GridColumnGroupDef.md)
- [GridColumnRef](https://grid.syidax.com/docs/types/GridColumnRef.md)