@serenity-is/sleekgrid / GridOptions

Interface: GridOptions<TItem>

Type parameters

Name	Type
TItem	any

Table of contents

Properties

• addNewRowCssClass
• alwaysAllowHorizontalScroll
• alwaysShowVerticalScroll
• asyncEditorLoadDelay
• asyncEditorLoading
• asyncPostCleanupDelay
• asyncPostRenderDelay
• autoEdit
• autoHeight
• cellFlashingCssClass
• cellHighlightCssClass
• columns
• createPreHeaderPanel
• dataItemColumnValueExtractor
• defaultColumnWidth
• defaultFormat
• defaultFormatter
• editCommandHandler
• editable
• editorCellNavOnLRKeys
• editorFactory
• editorLock
• emptyNode
• enableAddRow
• enableAsyncPostRender
• enableAsyncPostRenderCleanup
• enableCellNavigation
• enableCellRangeSelection
• enableColumnReorder
• enableRowReordering
• enableTabKeyNavigation
• enableTextSelectionOnCells
• explicitInitialization
• footerRowHeight
• forceFitColumns
• forceSyncScrollInterval
• forceSyncScrolling
• formatterFactory
• frozenBottom
• frozenColumns
• frozenRows
• fullWidthRows
• groupTotalsFormatter
• groupingPanel
• groupingPanelHeight
• headerRowHeight
• jQuery
• layoutEngine
• leaveSpaceForNewRows
• minBuffer
• multiColumnSort
• multiSelect
• preHeaderPanelHeight
• removeNode
• renderAllCells
• rowHeight
• rtl
• selectedCellCssClass
• showCellSelection
• showColumnHeader
• showFooterRow
• showGroupingPanel
• showHeaderRow
• showPreHeaderPanel
• showTopPanel
• slickCompat
• suppressActiveCellChangeOnEdit
• syncColumnCellResize
• topPanelHeight
• useCssVars
• useLegacyUI
• viewportClass

Properties

addNewRowCssClass

• Optional addNewRowCssClass: string

Defined in

grid/gridoptions.ts:6

---

alwaysAllowHorizontalScroll

• Optional alwaysAllowHorizontalScroll: boolean

Defined in

grid/gridoptions.ts:7

---

alwaysShowVerticalScroll

• Optional alwaysShowVerticalScroll: boolean

Defined in

grid/gridoptions.ts:8

---

asyncEditorLoadDelay

• Optional asyncEditorLoadDelay: number

Defined in

grid/gridoptions.ts:9

---

asyncEditorLoading

• Optional asyncEditorLoading: boolean

Defined in

grid/gridoptions.ts:10

---

asyncPostCleanupDelay

• Optional asyncPostCleanupDelay: number

Defined in

grid/gridoptions.ts:11

---

asyncPostRenderDelay

• Optional asyncPostRenderDelay: number

Defined in

grid/gridoptions.ts:12

---

autoEdit

• Optional autoEdit: boolean

Defined in

grid/gridoptions.ts:13

---

autoHeight

• Optional autoHeight: boolean

Defined in

grid/gridoptions.ts:14

---

cellFlashingCssClass

• Optional cellFlashingCssClass: string

Defined in

grid/gridoptions.ts:15

---

cellHighlightCssClass

• Optional cellHighlightCssClass: string

Defined in

grid/gridoptions.ts:16

---

columns

• Optional columns: Column<TItem>[]

Defined in

grid/gridoptions.ts:18

---

createPreHeaderPanel

• Optional createPreHeaderPanel: boolean

Defined in

grid/gridoptions.ts:19

---

dataItemColumnValueExtractor

• Optional dataItemColumnValueExtractor: (item: TItem, column: Column<TItem>) => void

Type declaration

▸ (item, column): void

Parameters

Name	Type
item	TItem
column	Column<TItem>

Returns

void

Defined in

grid/gridoptions.ts:20

---

defaultColumnWidth

• Optional defaultColumnWidth: number

Defined in

grid/gridoptions.ts:21

---

defaultFormat

• Optional defaultFormat: ColumnFormat<TItem>

Defined in

grid/gridoptions.ts:22

---

defaultFormatter

• Optional defaultFormatter: CompatFormatter<TItem>

Defined in

grid/gridoptions.ts:23

---

editCommandHandler

• Optional editCommandHandler: (item: TItem, column: Column<TItem>, command: EditCommand) => void

Type declaration

▸ (item, column, command): void

Parameters

Name	Type
item	TItem
column	Column<TItem>
command	EditCommand

Returns

void

Defined in

grid/gridoptions.ts:25

---

editable

• Optional editable: boolean

Defined in

grid/gridoptions.ts:24

---

editorCellNavOnLRKeys

• Optional editorCellNavOnLRKeys: boolean

Defined in

grid/gridoptions.ts:26

---

editorFactory

• Optional editorFactory: EditorFactory

Defined in

grid/gridoptions.ts:27

---

editorLock

• Optional editorLock: EditorLock

Defined in

grid/gridoptions.ts:28

---

emptyNode

• Optional emptyNode: (node: Element) => void

Type declaration

▸ (node): void

Parameters

Name	Type
node	Element

Returns

void

Defined in

grid/gridoptions.ts:17

---

enableAddRow

• Optional enableAddRow: boolean

Defined in

grid/gridoptions.ts:29

---

enableAsyncPostRender

• Optional enableAsyncPostRender: boolean

Defined in

grid/gridoptions.ts:30

---

enableAsyncPostRenderCleanup

• Optional enableAsyncPostRenderCleanup: boolean

Defined in

grid/gridoptions.ts:31

---

enableCellNavigation

• Optional enableCellNavigation: boolean

Defined in

grid/gridoptions.ts:32

---

enableCellRangeSelection

• Optional enableCellRangeSelection: boolean

Defined in

grid/gridoptions.ts:33

---

enableColumnReorder

• Optional enableColumnReorder: boolean

Defined in

grid/gridoptions.ts:34

---

enableRowReordering

• Optional enableRowReordering: boolean

Defined in

grid/gridoptions.ts:35

---

enableTabKeyNavigation

• Optional enableTabKeyNavigation: boolean

Defined in

grid/gridoptions.ts:36

---

enableTextSelectionOnCells

• Optional enableTextSelectionOnCells: boolean

Defined in

grid/gridoptions.ts:37

---

explicitInitialization

• Optional explicitInitialization: boolean

Defined in

grid/gridoptions.ts:38

---

footerRowHeight

• Optional footerRowHeight: number

Defined in

grid/gridoptions.ts:39

---

forceFitColumns

• Optional forceFitColumns: boolean

Defined in

grid/gridoptions.ts:40

---

forceSyncScrollInterval

• Optional forceSyncScrollInterval: number

Defined in

grid/gridoptions.ts:42

---

forceSyncScrolling

• Optional forceSyncScrolling: boolean

Defined in

grid/gridoptions.ts:41

---

formatterFactory

• Optional formatterFactory: FormatterFactory<any>

Defined in

grid/gridoptions.ts:43

---

frozenBottom

• Optional frozenBottom: boolean

Defined in

grid/gridoptions.ts:44

---

frozenColumns

• Optional frozenColumns: number

Defined in

grid/gridoptions.ts:45

---

frozenRows

• Optional frozenRows: number

Defined in

grid/gridoptions.ts:46

---

fullWidthRows

• Optional fullWidthRows: boolean

Defined in

grid/gridoptions.ts:47

---

groupTotalsFormatter

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

Type declaration

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

Parameters

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

Returns

string

Defined in

grid/gridoptions.ts:50

---

groupingPanel

• Optional groupingPanel: boolean

Defined in

grid/gridoptions.ts:48

---

groupingPanelHeight

• Optional groupingPanelHeight: number

Defined in

grid/gridoptions.ts:49

---

headerRowHeight

• Optional headerRowHeight: number

Defined in

grid/gridoptions.ts:51

---

jQuery

• Optional jQuery: Object

Type declaration

Name	Type
fn	any
ready	any

Defined in

grid/gridoptions.ts:52

---

layoutEngine

• Optional layoutEngine: LayoutEngine

Defined in

grid/gridoptions.ts:54

---

leaveSpaceForNewRows

• Optional leaveSpaceForNewRows: boolean

Defined in

grid/gridoptions.ts:53

---

minBuffer

• Optional minBuffer: number

Defined in

grid/gridoptions.ts:55

---

multiColumnSort

• Optional multiColumnSort: boolean

Defined in

grid/gridoptions.ts:56

---

multiSelect

• Optional multiSelect: boolean

Defined in

grid/gridoptions.ts:57

---

preHeaderPanelHeight

• Optional preHeaderPanelHeight: number

Defined in

grid/gridoptions.ts:58

---

removeNode

• Optional removeNode: (node: Element) => void

Type declaration

▸ (node): void

Parameters

Name	Type
node	Element

Returns

void

Defined in

grid/gridoptions.ts:60

---

renderAllCells

• Optional renderAllCells: boolean

Defined in

grid/gridoptions.ts:59

---

rowHeight

• Optional rowHeight: number

Defined in

grid/gridoptions.ts:61

---

rtl

• Optional rtl: boolean

Defined in

grid/gridoptions.ts:62

---

selectedCellCssClass

• Optional selectedCellCssClass: string

Defined in

grid/gridoptions.ts:63

---

showCellSelection

• Optional showCellSelection: boolean

Defined in

grid/gridoptions.ts:64

---

showColumnHeader

• Optional showColumnHeader: boolean

Defined in

grid/gridoptions.ts:65

---

showFooterRow

• Optional showFooterRow: boolean

Defined in

grid/gridoptions.ts:66

---

showGroupingPanel

• Optional showGroupingPanel: boolean

Defined in

grid/gridoptions.ts:67

---

showHeaderRow

• Optional showHeaderRow: boolean

Defined in

grid/gridoptions.ts:68

---

showPreHeaderPanel

• Optional showPreHeaderPanel: boolean

Defined in

grid/gridoptions.ts:69

---

showTopPanel

• Optional showTopPanel: boolean

Defined in

grid/gridoptions.ts:70

---

slickCompat

• Optional slickCompat: boolean

Defined in

grid/gridoptions.ts:71

---

suppressActiveCellChangeOnEdit

• Optional suppressActiveCellChangeOnEdit: boolean

Defined in

grid/gridoptions.ts:72

---

syncColumnCellResize

• Optional syncColumnCellResize: boolean

Defined in

grid/gridoptions.ts:73

---

topPanelHeight

• Optional topPanelHeight: number

Defined in

grid/gridoptions.ts:74

---

useCssVars

• Optional useCssVars: boolean

Defined in

grid/gridoptions.ts:76

---

useLegacyUI

• Optional useLegacyUI: boolean

Defined in

grid/gridoptions.ts:75

---

viewportClass

• Optional viewportClass: string

Defined in

grid/gridoptions.ts:77