# sortBy

Sets one column's sorting. Omitted direction cycles sorting; null clears that column. Use setSortModel for the full multi-column model.

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

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

## What does this API do?

Sets one column's sorting. Omitted direction cycles sorting; null clears that column. Use setSortModel for the full multi-column model.

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

## Exact input and result types

```typescript
sortBy(column: string, direction?: GridSortDirection | null): Promise<void>
```

| Arguments | Required | Type |
| --- | --- | --- |
| column | Required | string |
| direction | Optional | GridSortDirection \| null |

The return type is `Promise<void>`.

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

## Usage flow

After registering and initializing the Grid element, call grid.sortBy(…). 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

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

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

## Feature explanations and examples

- [Single and multiple sorting](https://grid.syidax.com/docs/features/sorting.md) — Sorting changes display order without modifying data values. Single sorting uses one criterion; multiple sorting uses prioritized criteria.