@serenity-is/sleekgrid / Column

Interface: Column<TItem>

Type parameters

Name	Type
TItem	any

Table of contents

Properties

• asyncPostRender
• asyncPostRenderCleanup
• behavior
• cannotTriggerInsert
• cssClass
• defaultSortAsc
• editor
• editorFixedDecimalPlaces
• field
• focusable
• footerCssClass
• format
• formatter
• frozen
• groupTotalsFormatter
• headerCssClass
• id
• maxWidth
• minWidth
• name
• nameIsHtml
• previousWidth
• referencedFields
• rerenderOnResize
• resizable
• selectable
• sortOrder
• sortable
• toolTip
• validator
• visible
• width

Properties

asyncPostRender

• Optional asyncPostRender: AsyncPostRender<TItem>

Defined in

core/column.ts:6

---

asyncPostRenderCleanup

• Optional asyncPostRenderCleanup: AsyncPostCleanup<TItem>

Defined in

core/column.ts:7

---

behavior

• Optional behavior: any

Defined in

core/column.ts:8

---

cannotTriggerInsert

• Optional cannotTriggerInsert: boolean

Defined in

core/column.ts:9

---

cssClass

• Optional cssClass: string

Defined in

core/column.ts:10

---

defaultSortAsc

• Optional defaultSortAsc: boolean

Defined in

core/column.ts:11

---

editor

• Optional editor: EditorClass

Defined in

core/column.ts:12

---

editorFixedDecimalPlaces

• Optional editorFixedDecimalPlaces: number

Defined in

core/column.ts:13

---

field

• Optional field: string

Defined in

core/column.ts:14

---

focusable

• Optional focusable: boolean

Defined in

core/column.ts:16

---

footerCssClass

• Optional footerCssClass: string

Defined in

core/column.ts:17

---

format

• Optional format: ColumnFormat<TItem>

Defined in

core/column.ts:18

---

formatter

• Optional formatter: CompatFormatter<TItem>

Deprecated

Defined in

core/column.ts:20

---

frozen

• Optional frozen: boolean

Defined in

core/column.ts:15

---

groupTotalsFormatter

• Optional groupTotalsFormatter: (p1?: GroupTotals<TItem>, p2?: Column<TItem>, grid?: unknown) => string

Type declaration

▸ (p1?, p2?, grid?): string

Parameters

Name	Type
p1?	GroupTotals<TItem>
p2?	Column<TItem>
grid?	unknown

Returns

string

Defined in

core/column.ts:21

---

headerCssClass

• Optional headerCssClass: string

Defined in

core/column.ts:22

---

id

• Optional id: string

Defined in

core/column.ts:23

---

maxWidth

• Optional maxWidth: any

Defined in

core/column.ts:24

---

minWidth

• Optional minWidth: number

Defined in

core/column.ts:25

---

name

• Optional name: string

Defined in

core/column.ts:26

---

nameIsHtml

• Optional nameIsHtml: boolean

Defined in

core/column.ts:27

---

previousWidth

• Optional previousWidth: number

Defined in

core/column.ts:28

---

referencedFields

• Optional referencedFields: string[]

Defined in

core/column.ts:29

---

rerenderOnResize

• Optional rerenderOnResize: boolean

Defined in

core/column.ts:30

---

resizable

• Optional resizable: boolean

Defined in

core/column.ts:31

---

selectable

• Optional selectable: boolean

Defined in

core/column.ts:32

---

sortOrder

• Optional sortOrder: number

Defined in

core/column.ts:34

---

sortable

• Optional sortable: boolean

Defined in

core/column.ts:33

---

toolTip

• Optional toolTip: string

Defined in

core/column.ts:35

---

validator

• Optional validator: (value: any, editorArgs?: any) => ValidationResult

Type declaration

▸ (value, editorArgs?): ValidationResult

Parameters

Name	Type
value	any
editorArgs?	any

Returns

ValidationResult

Defined in

core/column.ts:36

---

visible

• Optional visible: boolean

Defined in

core/column.ts:37

---

width

• Optional width: number

Defined in

core/column.ts:38