@serenity-is/sleekgrid / Column

Interface: Column<TItem>

Defined in: src/core/column.ts:6

Type Parameters

TItem

TItem = any

Properties

asyncPostRender?

optional asyncPostRender: AsyncPostRender<TItem>

Defined in: src/core/column.ts:7

---

asyncPostRenderCleanup?

optional asyncPostRenderCleanup: AsyncPostCleanup<TItem>

Defined in: src/core/column.ts:8

---

behavior?

optional behavior: any

Defined in: src/core/column.ts:9

---

cannotTriggerInsert?

optional cannotTriggerInsert: boolean

Defined in: src/core/column.ts:10

---

cssClass?

optional cssClass: string

Defined in: src/core/column.ts:11

---

defaultSortAsc?

optional defaultSortAsc: boolean

Defined in: src/core/column.ts:12

---

editor?

optional editor: EditorClass

Defined in: src/core/column.ts:13

---

editorFixedDecimalPlaces?

optional editorFixedDecimalPlaces: number

Defined in: src/core/column.ts:14

---

field?

optional field: string

Defined in: src/core/column.ts:15

---

focusable?

optional focusable: boolean

Defined in: src/core/column.ts:17

---

footerCssClass?

optional footerCssClass: string

Defined in: src/core/column.ts:18

---

format?

optional format: ColumnFormat<TItem>

Defined in: src/core/column.ts:19

---

formatter?

optional formatter: CompatFormatter<TItem>

Defined in: src/core/column.ts:21

@deprecated, use

See

format

---

frozen?

optional frozen: boolean | "end" | "start"

Defined in: src/core/column.ts:16

---

groupTotalsFormat()?

optional groupTotalsFormat: (ctx) => FormatterResult

Defined in: src/core/column.ts:22

Parameters

ctx

FormatterContext<IGroupTotals<TItem>>

Returns

FormatterResult

---

groupTotalsFormatter()?

optional groupTotalsFormatter: (totals?, column?, grid?) => string

Defined in: src/core/column.ts:24

@deprecated, use

Parameters

totals?

IGroupTotals<TItem>

column?

Column<TItem>

grid?

unknown

Returns

string

See

groupTotalsFormat

---

headerCssClass?

optional headerCssClass: string

Defined in: src/core/column.ts:25

---

id?

optional id: string

Defined in: src/core/column.ts:26

---

maxWidth?

optional maxWidth: any

Defined in: src/core/column.ts:27

---

minWidth?

optional minWidth: number

Defined in: src/core/column.ts:28

---

name?

optional name: string

Defined in: src/core/column.ts:29

---

nameFormat()?

optional nameFormat: (ctx) => FormatterResult

Defined in: src/core/column.ts:30

Parameters

ctx

FormatterContext<TItem>

Returns

FormatterResult

---

previousWidth?

optional previousWidth: number

Defined in: src/core/column.ts:31

---

referencedFields?

optional referencedFields: string[]

Defined in: src/core/column.ts:32

---

rerenderOnResize?

optional rerenderOnResize: boolean

Defined in: src/core/column.ts:33

---

resizable?

optional resizable: boolean

Defined in: src/core/column.ts:34

---

selectable?

optional selectable: boolean

Defined in: src/core/column.ts:35

---

sortable?

optional sortable: boolean

Defined in: src/core/column.ts:36

---

sortOrder?

optional sortOrder: number

Defined in: src/core/column.ts:37

---

toolTip?

optional toolTip: string

Defined in: src/core/column.ts:38

---

validator()?

optional validator: (value, editorArgs?) => ValidationResult

Defined in: src/core/column.ts:39

Parameters

value

any

editorArgs?

any

Returns

ValidationResult

---

visible?

optional visible: boolean

Defined in: src/core/column.ts:40

---

width?

optional width: number

Defined in: src/core/column.ts:41