@serenity-is/sleekgrid

@serenity-is/sleekgrid

Table of contents

Namespaces

• Editors
• Formatters

Classes

• AutoTooltips
• CheckboxEditor
• DateEditor
• EditorLock
• EventData
• EventEmitter
• EventSubscriber
• FloatEditor
• Grid
• Group
• GroupItemMetadataProvider
• GroupTotals
• IntegerEditor
• LongTextEditor
• NonDataRow
• PercentCompleteEditor
• Range
• TextEditor
• YesNoSelectEditor

Interfaces

• ArgsAddNewRow
• ArgsCell
• ArgsCellChange
• ArgsCellEdit
• ArgsColumn
• ArgsColumnNode
• ArgsCssStyle
• ArgsEditorDestroy
• ArgsGrid
• ArgsScroll
• ArgsSelectedRowsChange
• ArgsSort
• ArgsValidationError
• AutoTooltipsOptions
• Column
• ColumnMetadata
• ColumnSort
• CompatFormatterResult
• EditCommand
• EditController
• Editor
• EditorClass
• EditorFactory
• EditorHost
• EditorOptions
• FormatterContext
• FormatterFactory
• GridOptions
• GroupItemMetadataProviderOptions
• IEventData
• IPlugin
• ItemMetadata
• LayoutEngine
• LayoutHost
• Position
• RowCell
• SelectionModel
• ValidationResult
• ViewRange
• ViewportInfo

Type Aliases

• ArgsSortCol
• AsyncPostCleanup
• AsyncPostRender
• CellStylesHash
• ColumnFormat
• CompatFormatter
• EventListener

Variables

• BasicLayout
• FrozenLayout
• GlobalEditorLock
• columnDefaults
• gridDefaults
• keyCode
• preClickClassName

Functions

• CheckboxFormatter
• CheckmarkFormatter
• H
• PercentCompleteBarFormatter
• PercentCompleteFormatter
• YesNoFormatter
• addClass
• applyFormatterResultToCellNode
• convertCompatFormatter
• defaultColumnFormat
• disableSelection
• escape
• initializeColumns
• parsePx
• patchEvent
• removeClass
• spacerDiv
• titleize

Type Aliases

ArgsSortCol

Ƭ ArgsSortCol: Object

Type declaration

Name	Type
sortAsc	boolean
sortCol	Column

Defined in

grid/eventargs.ts:16

---

AsyncPostCleanup

Ƭ AsyncPostCleanup<TItem>: (cellNode: HTMLElement, row?: number, column?: Column<TItem>) => void

Type parameters

Name	Type
TItem	any

Type declaration

▸ (cellNode, row?, column?): void

Parameters

Name	Type
cellNode	HTMLElement
row?	number
column?	Column<TItem>

Returns

void

Defined in

core/formatting.ts:35

---

AsyncPostRender

Ƭ AsyncPostRender<TItem>: (cellNode: HTMLElement, row: number, item: TItem, column: Column<TItem>, reRender: boolean) => void

Type parameters

Name	Type
TItem	any

Type declaration

▸ (cellNode, row, item, column, reRender): void

Parameters

Name	Type
cellNode	HTMLElement
row	number
item	TItem
column	Column<TItem>
reRender	boolean

Returns

void

Defined in

core/formatting.ts:34

---

CellStylesHash

Ƭ CellStylesHash: Object

Index signature

▪ [row: number]: { [columnId: string]: string; }

Defined in

core/formatting.ts:37

---

ColumnFormat

Ƭ ColumnFormat<TItem>: (ctx: FormatterContext<TItem>) => string

Type parameters

Name	Type
TItem	any

Type declaration

▸ (ctx): string

Parameters

Name	Type
ctx	FormatterContext<TItem>

Returns

string

Defined in

core/formatting.ts:19

---

CompatFormatter

Ƭ CompatFormatter<TItem>: (row: number, cell: number, value: any, column: Column<TItem>, item: TItem, grid?: any) => string | CompatFormatterResult

Type parameters

Name	Type
TItem	any

Type declaration

▸ (row, cell, value, column, item, grid?): string | CompatFormatterResult

Parameters

Name	Type
row	number
cell	number
value	any
column	Column<TItem>
item	TItem
grid?	any

Returns

string | CompatFormatterResult

Defined in

core/formatting.ts:27

---

EventListener

Ƭ EventListener<TArgs, TEventData>: (e: TEventData, args: TArgs) => void

Type parameters

Name	Type
TArgs	TArgs
TEventData	extends IEventData = IEventData

Type declaration

▸ (e, args): void

Parameters

Name	Type
e	TEventData
args	TArgs

Returns

void

Defined in

core/event.ts:1

Variables

BasicLayout

• Const BasicLayout: () => LayoutEngine

Type declaration

• new BasicLayout(): LayoutEngine

Returns

LayoutEngine

Defined in

grid/basiclayout.ts:4

---

FrozenLayout

• Const FrozenLayout: () => LayoutEngine

Type declaration

• new FrozenLayout(): LayoutEngine

Returns

LayoutEngine

Defined in

layouts/frozenlayout.ts:4

---

GlobalEditorLock

• Const GlobalEditorLock: EditorLock

A global singleton editor lock.

Static

Defined in

core/editing.ts:176

---

columnDefaults

• Const columnDefaults: Partial<Column>

Defined in

core/column.ts:41

---

gridDefaults

• Const gridDefaults: GridOptions

Defined in

grid/gridoptions.ts:78

---

keyCode

• Const keyCode: Object

Deprecated

Type declaration

Name	Type
BACKSPACE	number
DELETE	number
DOWN	number
END	number
ENTER	number
ESCAPE	number
HOME	number
INSERT	number
LEFT	number
PAGEDOWN	number
PAGEUP	number
RIGHT	number
TAB	number
UP	number

Defined in

core/event.ts:159

---

preClickClassName

• Const preClickClassName: "slick-edit-preclick"

Defined in

core/base.ts:8

Functions

CheckboxFormatter

▸ CheckboxFormatter(ctx): string

Parameters

Name	Type
ctx	FormatterContext<any>

Returns

string

Defined in

formatters/formatters.ts:32

---

CheckmarkFormatter

▸ CheckmarkFormatter(ctx): "" | "<i class=\"slick-checkmark\"></i>"

Parameters

Name	Type
ctx	FormatterContext<any>

Returns

"" | "<i class=\"slick-checkmark\"></i>"

Defined in

formatters/formatters.ts:36

---

H

▸ H<K>(tag, attr?, ...children): HTMLElementTagNameMap[K]

Type parameters

Name	Type
K	extends keyof HTMLElementTagNameMap

Parameters

Name	Type
tag	K
attr?	Object
attr.ref?	(el?: HTMLElementTagNameMap[K]) => void
...children	(string | Node)[]

Returns

HTMLElementTagNameMap[K]

Defined in

core/util.ts:60

---

PercentCompleteBarFormatter

▸ PercentCompleteBarFormatter(ctx): string

Parameters

Name	Type
ctx	FormatterContext<any>

Returns

string

Defined in

formatters/formatters.ts:12

---

PercentCompleteFormatter

▸ PercentCompleteFormatter(ctx): string

Parameters

Name	Type
ctx	FormatterContext<any>

Returns

string

Defined in

formatters/formatters.ts:3

---

YesNoFormatter

▸ YesNoFormatter(ctx): "Yes" | "No"

Parameters

Name	Type
ctx	FormatterContext<any>

Returns

"Yes" | "No"

Defined in

formatters/formatters.ts:27

---

addClass

▸ addClass(el, cls): void

Parameters

Name	Type
el	Element
cls	string

Returns

void

Defined in

core/util.ts:1

---

applyFormatterResultToCellNode

▸ applyFormatterResultToCellNode(ctx, html, node): void

Parameters

Name	Type
ctx	FormatterContext<any>
html	string
node	HTMLElement

Returns

void

Defined in

core/formatting.ts:58

---

convertCompatFormatter

▸ convertCompatFormatter(compatFormatter): ColumnFormat

Parameters

Name	Type
compatFormatter	CompatFormatter<any>

Returns

ColumnFormat

Defined in

core/formatting.ts:43

---

defaultColumnFormat

▸ defaultColumnFormat(ctx): any

Parameters

Name	Type
ctx	FormatterContext<any>

Returns

any

Defined in

core/formatting.ts:39

---

disableSelection

▸ disableSelection(target): void

Parameters

Name	Type
target	HTMLElement

Returns

void

Defined in

core/util.ts:39

---

escape

▸ escape(s): any

Parameters

Name	Type
s	any

Returns

any

Defined in

core/util.ts:26

---

initializeColumns

▸ initializeColumns(columns, defaults): void

Parameters

Name	Type
columns	Column<any>[]
defaults	Partial<Column<any>>

Returns

void

Defined in

core/column.ts:76

---

parsePx

▸ parsePx(str): number

Parameters

Name	Type
str	string

Returns

number

Defined in

core/util.ts:88

---

patchEvent

▸ patchEvent(e): IEventData

Parameters

Name	Type
e	IEventData

Returns

IEventData

Defined in

core/event.ts:185

---

removeClass

▸ removeClass(el, cls): void

Parameters

Name	Type
el	Element
cls	string

Returns

void

Defined in

core/util.ts:47

---

spacerDiv

▸ spacerDiv(width): HTMLDivElement

Parameters

Name	Type
width	string

Returns

HTMLDivElement

Defined in

core/util.ts:84

---

titleize

▸ titleize(str): string

Parameters

Name	Type
str	string

Returns

string

Defined in

core/column.ts:112