# getColumns

Reads current column objects to connect widths, order, and visibility to your app.

Canonical: https://grid.syidax.com/docs/methods/getColumns/

<a id="meaning"></a>

## What does this API do?

Reads current column objects to connect widths, order, and visibility to your app.

<a id="contract"></a>

## Exact input and result types

```typescript
getColumns(): Promise<ReadonlyArray<GridColumnRef<GridData, unknown, unknown>>>
```

| Arguments | Required | Type |
| --- | --- | --- |

The return type is `Promise<ReadonlyArray<GridColumnRef<GridData, unknown, unknown>>>`.

<a id="usage"></a>

## Usage flow

After registering and initializing the Grid element, call grid.getColumns(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.

<a id="types"></a>

## Read related types

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

<a id="recipes"></a>

## Feature explanations and examples

- [Live column API](https://grid.syidax.com/docs/features/column-api.md) — Live column objects are references connected to the current Grid. They differ from serializable column-state arrays: references suit UI controls for individual columns, while state arrays suit saved preferences.