Interface: UseViewStateOptions

Defined in: src/model/use-view-state.ts:6

Properties

getColumnOrder

getColumnOrder: () => string[]

Defined in: src/model/use-view-state.ts:8

Returns

string[]

---

getColumnPinning

getColumnPinning: () => object

Defined in: src/model/use-view-state.ts:10

Returns

object

left

left: string[]

right

right: string[]

---

getColumnSizing

getColumnSizing: () => Record<string, number>

Defined in: src/model/use-view-state.ts:9

Returns

Record<string, number>

---

getExpandedIds

getExpandedIds: () => string[]

Defined in: src/model/use-view-state.ts:13

Returns

string[]

---

getFilters

getFilters: () => FilterExpression[]

Defined in: src/model/use-view-state.ts:12

Returns

FilterExpression[]

---

getHiddenColumns

getHiddenColumns: () => string[]

Defined in: src/model/use-view-state.ts:14

Returns

string[]

---

getSorting

getSorting: () => ColumnSort[]

Defined in: src/model/use-view-state.ts:11

Returns

ColumnSort[]

---

setColumnOrder?

optional setColumnOrder?: (order) => void

Defined in: src/model/use-view-state.ts:17

Parameters

order

string[]

Returns

void

---

setColumnPinning?

optional setColumnPinning?: (pinning) => void

Defined in: src/model/use-view-state.ts:19

Parameters

pinning

left

string[]

right

string[]

Returns

void

---

setColumnSizing?

optional setColumnSizing?: (sizing) => void

Defined in: src/model/use-view-state.ts:18

Parameters

sizing

Record<string, number>

Returns

void

---

setExpandedIds?

optional setExpandedIds?: (ids) => void

Defined in: src/model/use-view-state.ts:22

Parameters

ids

string[]

Returns

void

---

setFilters?

optional setFilters?: (filters) => void

Defined in: src/model/use-view-state.ts:21

Parameters

filters

FilterExpression[]

Returns

void

---

setHiddenColumns?

optional setHiddenColumns?: (ids) => void

Defined in: src/model/use-view-state.ts:23

Parameters

ids

string[]

Returns

void

---

setSorting?

optional setSorting?: (sorting) => void

Defined in: src/model/use-view-state.ts:20

Parameters

sorting

ColumnSort[]

Returns

void

---

validColumnIds?

optional validColumnIds?: string[]

Defined in: src/model/use-view-state.ts:26

Valid column ids for filtering unknown columns on import.