Skip to content

@serenity-is/sleekgrid / Grid

Class: Grid<TItem>

Type parameters

Name Type
TItem any

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new Grid<TItem>(container, data, columns, options)

Type parameters

Name Type
TItem any

Parameters

Name Type
container HTMLElement | { jquery: string ; length: number }
data any
columns Column<TItem>[]
options GridOptions<TItem>

Defined in

grid/grid.ts:121

Properties

_absoluteColMinWidth

• Private _absoluteColMinWidth: number

Defined in

grid/grid.ts:12

_activeCanvasNode

• Private _activeCanvasNode: HTMLElement

Defined in

grid/grid.ts:13

_activeCell

• Private _activeCell: number

Defined in

grid/grid.ts:14

_activeCellNode

• Private _activeCellNode: HTMLElement = null

Defined in

grid/grid.ts:15

_activePosX

• Private _activePosX: number

Defined in

grid/grid.ts:16

_activeRow

• Private _activeRow: number

Defined in

grid/grid.ts:17

_activeViewportNode

• Private _activeViewportNode: HTMLElement

Defined in

grid/grid.ts:18

_boundAncestorScroll

• Private _boundAncestorScroll: HTMLElement[] = []

Defined in

grid/grid.ts:78

_cellCssClasses

• Private _cellCssClasses: Record<string, CellStylesHash> = {}

Defined in

grid/grid.ts:19

_cellHeightDiff

• Private _cellHeightDiff: number = 0

Defined in

grid/grid.ts:20

_cellNavigator

• Private _cellNavigator: CellNavigator

Defined in

grid/grid.ts:22

_cellWidthDiff

• Private _cellWidthDiff: number = 0

Defined in

grid/grid.ts:21

_colById

• Private _colById: Object

Index signature

▪ [key: string]: number

Defined in

grid/grid.ts:23

_colDefaults

• Private _colDefaults: Partial<Column<any>>

Defined in

grid/grid.ts:24

_colLeft

• Private _colLeft: number[] = []

Defined in

grid/grid.ts:25

_colRight

• Private _colRight: number[] = []

Defined in

grid/grid.ts:26

_cols

• Private _cols: Column<TItem>[]

Defined in

grid/grid.ts:27

_columnCssRulesL

• Private _columnCssRulesL: any

Defined in

grid/grid.ts:28

_columnCssRulesR

• Private _columnCssRulesR: any

Defined in

grid/grid.ts:29

_container

• Private _container: HTMLElement

Defined in

grid/grid.ts:79

_currentEditor

• Private _currentEditor: Editor = null

Defined in

grid/grid.ts:30

_data

• Private _data: any

Defined in

grid/grid.ts:31

_editController

• Private _editController: EditController

Defined in

grid/grid.ts:32

_focusSink1

• Private _focusSink1: HTMLElement

Defined in

grid/grid.ts:80

_focusSink2

• Private _focusSink2: HTMLElement

Defined in

grid/grid.ts:81

_groupingPanel

• Private _groupingPanel: HTMLElement

Defined in

grid/grid.ts:82

_hEditorLoader

• Private _hEditorLoader: number = null

Defined in

grid/grid.ts:34

_hPostRender

• Private _hPostRender: number = null

Defined in

grid/grid.ts:35

_hPostRenderCleanup

• Private _hPostRenderCleanup: number = null

Defined in

grid/grid.ts:36

_hRender

• Private _hRender: number = null

Defined in

grid/grid.ts:37

_headerColumnWidthDiff

• Private _headerColumnWidthDiff: number = 0

Defined in

grid/grid.ts:33

_ignoreScrollUntil

• Private _ignoreScrollUntil: number = 0

Defined in

grid/grid.ts:38

_initColById

• Private _initColById: Object

Index signature

▪ [key: string]: number

Defined in

grid/grid.ts:39

_initCols

• Private _initCols: Column<TItem>[]

Defined in

grid/grid.ts:40

_initialized

• Private _initialized: boolean = false

Defined in

grid/grid.ts:41

_jQuery

• Private _jQuery: any

Defined in

grid/grid.ts:42

_jumpinessCoefficient

• Private _jumpinessCoefficient: number

Defined in

grid/grid.ts:43

_lastRenderTime

• Private _lastRenderTime: number

Defined in

grid/grid.ts:44

_layout

• Private _layout: LayoutEngine

Defined in

grid/grid.ts:45

_numberOfPages

• Private _numberOfPages: number

Defined in

grid/grid.ts:46

_options

• Private _options: GridOptions<TItem>

Defined in

grid/grid.ts:47

_page

• Private _page: number = 0

Defined in

grid/grid.ts:48

_pageHeight

• Private _pageHeight: number

Defined in

grid/grid.ts:49

_pageOffset

• Private _pageOffset: number = 0

Defined in

grid/grid.ts:50

_pagingActive

• Private _pagingActive: boolean = false

Defined in

grid/grid.ts:51

_pagingIsLastPage

• Private _pagingIsLastPage: boolean = false

Defined in

grid/grid.ts:52

_plugins

• Private _plugins: IPlugin[] = []

Defined in

grid/grid.ts:53

_postProcessCleanupQueue

• Private _postProcessCleanupQueue: PostProcessCleanupEntry[] = []

Defined in

grid/grid.ts:54

_postProcessFromRow

• Private _postProcessFromRow: number = null

Defined in

grid/grid.ts:56

_postProcessGroupId

• Private _postProcessGroupId: number = 0

Defined in

grid/grid.ts:57

_postProcessToRow

• Private _postProcessToRow: number = null

Defined in

grid/grid.ts:58

_postProcessedRows

• Private _postProcessedRows: any = {}

Defined in

grid/grid.ts:55

_rowsCache

• Private _rowsCache: Object = {}

Index signature

▪ [key: number]: CachedRow

Defined in

grid/grid.ts:59

_scrollDims

• Private _scrollDims: Object

Type declaration

Name Type
height number
width number

Defined in

grid/grid.ts:60

_scrollLeft

• Private _scrollLeft: number = 0

Defined in

grid/grid.ts:61

_scrollLeftPrev

• Private _scrollLeftPrev: number = 0

Defined in

grid/grid.ts:62

_scrollLeftRendered

• Private _scrollLeftRendered: number = 0

Defined in

grid/grid.ts:63

_scrollTop

• Private _scrollTop: number = 0

Defined in

grid/grid.ts:64

_scrollTopPrev

• Private _scrollTopPrev: number = 0

Defined in

grid/grid.ts:65

_scrollTopRendered

• Private _scrollTopRendered: number = 0

Defined in

grid/grid.ts:66

_selectedRows

• Private _selectedRows: number[] = []

Defined in

grid/grid.ts:67

_selectionModel

• Private _selectionModel: SelectionModel

Defined in

grid/grid.ts:68

_serializedEditorValue

• Private _serializedEditorValue: any

Defined in

grid/grid.ts:69

_sortColumns

• Private _sortColumns: ColumnSort[] = []

Defined in

grid/grid.ts:70

_styleNode

• Private _styleNode: HTMLStyleElement

Defined in

grid/grid.ts:71

_stylesheet

• Private _stylesheet: any

Defined in

grid/grid.ts:72

_tabbingDirection

• Private _tabbingDirection: number = 1

Defined in

grid/grid.ts:73

_uid

• Private _uid: string

Defined in

grid/grid.ts:74

_vScrollDir

• Private _vScrollDir: number = 1

Defined in

grid/grid.ts:76

_viewportInfo

• Private _viewportInfo: ViewportInfo

Defined in

grid/grid.ts:75

onActiveCellChanged

• Readonly onActiveCellChanged: EventEmitter<ArgsCell, IEventData>

Defined in

grid/grid.ts:84

onActiveCellPositionChanged

• Readonly onActiveCellPositionChanged: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:85

onAddNewRow

• Readonly onAddNewRow: EventEmitter<ArgsAddNewRow, IEventData>

Defined in

grid/grid.ts:86

onBeforeCellEditorDestroy

• Readonly onBeforeCellEditorDestroy: EventEmitter<ArgsEditorDestroy, IEventData>

Defined in

grid/grid.ts:87

onBeforeDestroy

• Readonly onBeforeDestroy: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:88

onBeforeEditCell

• Readonly onBeforeEditCell: EventEmitter<ArgsCellEdit, IEventData>

Defined in

grid/grid.ts:89

onBeforeFooterRowCellDestroy

• Readonly onBeforeFooterRowCellDestroy: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:90

onBeforeHeaderCellDestroy

• Readonly onBeforeHeaderCellDestroy: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:91

onBeforeHeaderRowCellDestroy

• Readonly onBeforeHeaderRowCellDestroy: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:92

onCellChange

• Readonly onCellChange: EventEmitter<ArgsCellChange, IEventData>

Defined in

grid/grid.ts:93

onCellCssStylesChanged

• Readonly onCellCssStylesChanged: EventEmitter<ArgsCssStyle, IEventData>

Defined in

grid/grid.ts:94

onClick

• Readonly onClick: EventEmitter<ArgsCell, MouseEvent>

Defined in

grid/grid.ts:95

onColumnsReordered

• Readonly onColumnsReordered: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:96

onColumnsResized

• Readonly onColumnsResized: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:97

onCompositeEditorChange

• Readonly onCompositeEditorChange: EventEmitter<ArgsGrid, IEventData>

Implementation of

EditorHost.onCompositeEditorChange

Defined in

grid/grid.ts:98

onContextMenu

• Readonly onContextMenu: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:99

onDblClick

• Readonly onDblClick: EventEmitter<ArgsCell, MouseEvent>

Defined in

grid/grid.ts:100

onDrag

• Readonly onDrag: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:101

onDragEnd

• Readonly onDragEnd: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:102

onDragInit

• Readonly onDragInit: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:103

onDragStart

• Readonly onDragStart: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:104

onFooterRowCellRendered

• Readonly onFooterRowCellRendered: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:105

onHeaderCellRendered

• Readonly onHeaderCellRendered: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:106

onHeaderClick

• Readonly onHeaderClick: EventEmitter<ArgsColumn, IEventData>

Defined in

grid/grid.ts:107

onHeaderContextMenu

• Readonly onHeaderContextMenu: EventEmitter<ArgsColumn, IEventData>

Defined in

grid/grid.ts:108

onHeaderMouseEnter

• Readonly onHeaderMouseEnter: EventEmitter<ArgsColumn, MouseEvent>

Defined in

grid/grid.ts:109

onHeaderMouseLeave

• Readonly onHeaderMouseLeave: EventEmitter<ArgsColumn, MouseEvent>

Defined in

grid/grid.ts:110

onHeaderRowCellRendered

• Readonly onHeaderRowCellRendered: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:111

onKeyDown

• Readonly onKeyDown: EventEmitter<ArgsCell, KeyboardEvent>

Defined in

grid/grid.ts:112

onMouseEnter

• Readonly onMouseEnter: EventEmitter<ArgsGrid, MouseEvent>

Defined in

grid/grid.ts:113

onMouseLeave

• Readonly onMouseLeave: EventEmitter<ArgsGrid, MouseEvent>

Defined in

grid/grid.ts:114

onScroll

• Readonly onScroll: EventEmitter<ArgsScroll, IEventData>

Defined in

grid/grid.ts:115

onSelectedRowsChanged

• Readonly onSelectedRowsChanged: EventEmitter<ArgsSelectedRowsChange, IEventData>

Defined in

grid/grid.ts:116

onSort

• Readonly onSort: EventEmitter<ArgsSort, IEventData>

Defined in

grid/grid.ts:117

onValidationError

• Readonly onValidationError: EventEmitter<ArgsValidationError, IEventData>

Defined in

grid/grid.ts:118

onViewportChanged

• Readonly onViewportChanged: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:119

Methods

addCellCssStyles

▸ addCellCssStyles(key, hash): void

Parameters

Name Type
key string
hash CellStylesHash

Returns

void

Defined in

grid/grid.ts:2784

appendCellHtml

▸ Private appendCellHtml(sb, row, cell, colspan, item, metadata): void

Parameters

Name Type
sb string[]
row number
cell number
colspan number
item TItem
metadata ColumnMetadata<any>

Returns

void

Defined in

grid/grid.ts:1822

appendRowHtml

▸ Private appendRowHtml(stringArrayL, stringArrayR, row, range, dataLength): void

Parameters

Name Type
stringArrayL string[]
stringArrayR string[]
row number
range ViewRange
dataLength number

Returns

void

Defined in

grid/grid.ts:1754

applyColumnHeaderWidths

▸ Private applyColumnHeaderWidths(): void

Returns

void

Defined in

grid/grid.ts:1241

asyncPostProcessCleanupRows

▸ Private asyncPostProcessCleanupRows(): void

Returns

void

Defined in

grid/grid.ts:2725

asyncPostProcessRows

▸ Private asyncPostProcessRows(): void

Returns

void

Defined in

grid/grid.ts:2683

autosizeColumns

▸ autosizeColumns(): void

Returns

void

Defined in

grid/grid.ts:1227

bindAncestorScroll

▸ Private bindAncestorScroll(elem): void

Parameters

Name Type
elem HTMLElement

Returns

void

Defined in

grid/grid.ts:246

bindToData

▸ Private bindToData(): void

Returns

void

Defined in

grid/grid.ts:1479

calcViewportSize

▸ Private calcViewportSize(): void

Returns

void

Defined in

grid/grid.ts:2052

canCellBeActive

▸ Private canCellBeActive(row, cell): boolean

Parameters

Name Type
row number
cell number

Returns

boolean

Defined in

grid/grid.ts:3740

canCellBeSelected

▸ canCellBeSelected(row, cell): any

Parameters

Name Type
row number
cell number

Returns

any

Defined in

grid/grid.ts:3763

cancelCurrentEdit

▸ Private cancelCurrentEdit(): boolean

Returns

boolean

Defined in

grid/grid.ts:3887

cancelEditAndSetFocus

▸ Private cancelEditAndSetFocus(): void

Returns

void

Defined in

grid/grid.ts:3431

cellExists

▸ Private cellExists(row, cell): boolean

Parameters

Name Type
row number
cell number

Returns

boolean

Defined in

grid/grid.ts:3071

cleanUpAndRenderCells

▸ Private cleanUpAndRenderCells(range): void

Parameters

Name Type
range ViewRange

Returns

void

Defined in

grid/grid.ts:2321

cleanUpCells

▸ Private cleanUpCells(range, row): void

Parameters

Name Type
range ViewRange
row number

Returns

void

Defined in

grid/grid.ts:2272

cleanupRows

▸ Private cleanupRows(rangeToKeep): void

Parameters

Name Type
rangeToKeep ViewRange

Returns

void

Defined in

grid/grid.ts:1898

clearTextSelection

▸ clearTextSelection(): void

Returns

void

Defined in

grid/grid.ts:3294

colIdOrIdxToCell

▸ Private colIdOrIdxToCell(columnIdOrIdx): number

Parameters

Name Type
columnIdOrIdx string | number

Returns

number

Defined in

grid/grid.ts:452

commitCurrentEdit

▸ commitCurrentEdit(): boolean

Returns

boolean

Defined in

grid/grid.ts:3808

commitEditAndSetFocus

▸ Private commitEditAndSetFocus(): void

Returns

void

Defined in

grid/grid.ts:3420

createColumnFooters

▸ Private createColumnFooters(): void

Returns

void

Defined in

grid/grid.ts:602

createColumnHeaders

▸ Private createColumnHeaders(): void

Returns

void

Defined in

grid/grid.ts:645

createCssRules

▸ Private createCssRules(): void

Returns

void

Defined in

grid/grid.ts:1064

createGroupingPanel

▸ Private createGroupingPanel(): void

Returns

void

Defined in

grid/grid.ts:232

destroy

▸ destroy(): void

Returns

void

Defined in

grid/grid.ts:1161

editActiveCell

▸ editActiveCell(editor?): void

Parameters

Name Type
editor? EditorClass

Returns

void

Defined in

grid/grid.ts:3351

ensureCellNodesInRowsCache

▸ Private ensureCellNodesInRowsCache(row): void

Parameters

Name Type
row number

Returns

void

Defined in

grid/grid.ts:2254

flashCell

▸ flashCell(row, cell, speed?): void

Parameters

Name Type
row number
cell number
speed? number

Returns

void

Defined in

grid/grid.ts:2819

focus

▸ focus(): void

Returns

void

Defined in

grid/grid.ts:3188

getAbsoluteColumnMinWidth

▸ getAbsoluteColumnMinWidth(): number

Returns

number

Defined in

grid/grid.ts:444

getActiveCanvasNode

▸ getActiveCanvasNode(e?): HTMLElement

Parameters

Name Type
e? IEventData

Returns

HTMLElement

Defined in

grid/grid.ts:471

getActiveCell

▸ getActiveCell(): RowCell

Returns

RowCell

Implementation of

EditorHost.getActiveCell

Defined in

grid/grid.ts:3472

getActiveCellNode

▸ getActiveCellNode(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:3480

getActiveCellPosition

▸ Private getActiveCellPosition(): Position

Returns

Position

Defined in

grid/grid.ts:3437

getActiveViewportNode

▸ getActiveViewportNode(e?): HTMLElement

Parameters

Name Type
e? IEventData

Returns

HTMLElement

Defined in

grid/grid.ts:486

getAvailableWidth

▸ Private getAvailableWidth(): number

Returns

number

Defined in

grid/grid.ts:494

getCanvasNode

▸ getCanvasNode(columnIdOrIdx?, row?): HTMLElement

Parameters

Name Type
columnIdOrIdx? string | number
row? number

Returns

HTMLElement

Defined in

grid/grid.ts:462

getCanvases

▸ getCanvases(): any

Returns

any

Defined in

grid/grid.ts:466

getCellCssStyles

▸ getCellCssStyles(key): CellStylesHash

Parameters

Name Type
key string

Returns

CellStylesHash

Defined in

grid/grid.ts:2815

getCellEditor

▸ getCellEditor(): Editor

Returns

Editor

Defined in

grid/grid.ts:3468

getCellFromEvent

▸ getCellFromEvent(e): Object

Parameters

Name Type
e any

Returns

Object

Name Type
cell number
row number

Defined in

grid/grid.ts:3130

getCellFromNode

▸ getCellFromNode(cellNode): number

Parameters

Name Type
cellNode Element

Returns

number

Defined in

grid/grid.ts:3092

getCellFromPoint

▸ getCellFromPoint(x, y): Object

Parameters

Name Type
x number
y number

Returns

Object

Name Type
cell number
row number

Defined in

grid/grid.ts:3075

getCellNode

▸ getCellNode(row, cell): HTMLElement

Parameters

Name Type
row number
cell number

Returns

HTMLElement

Defined in

grid/grid.ts:3705

getCellNodeBox

▸ getCellNodeBox(row, cell): Object

Parameters

Name Type
row number
cell number

Returns

Object

Name Type
bottom number
left number
right number
top number

Defined in

grid/grid.ts:3150

getColspan

▸ getColspan(row, cell): number

Parameters

Name Type
row number
cell number

Returns

number

Defined in

grid/grid.ts:3604

getColumnCssRules

▸ Private getColumnCssRules(idx): Object

Parameters

Name Type
idx number

Returns

Object

Name Type
left any
right any

Defined in

grid/grid.ts:1107

getColumnFromNode

▸ getColumnFromNode(cellNode): Column<TItem>

Parameters

Name Type
cellNode Element

Returns

Column<TItem>

Defined in

grid/grid.ts:3108

getColumnIndex

▸ getColumnIndex(id): number

Parameters

Name Type
id string

Returns

number

Defined in

grid/grid.ts:1219

getColumns

▸ getColumns(): Column<TItem>[]

Returns

Column<TItem>[]

Defined in

grid/grid.ts:1344

getContainerNode

▸ getContainerNode(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:1615

getData

▸ getData(): any

Returns

any

Defined in

grid/grid.ts:1506

getDataItem

▸ getDataItem(i): TItem

Parameters

Name Type
i number

Returns

TItem

Defined in

grid/grid.ts:1523

getDataItemValueForColumn

▸ getDataItemValueForColumn(item, columnDef): any

Parameters

Name Type
item TItem
columnDef Column<TItem>

Returns

any

Defined in

grid/grid.ts:1748

getDataLength

▸ getDataLength(): number

Returns

number

Defined in

grid/grid.ts:1510

getDataLengthIncludingAddNew

▸ Private getDataLengthIncludingAddNew(): number

Returns

number

Defined in

grid/grid.ts:1518

getDisplayedScrollbarDimensions

▸ getDisplayedScrollbarDimensions(): Object

Returns

Object

Name Type
height number
width number

Defined in

grid/grid.ts:437

getEditController

▸ getEditController(): EditController

Returns

EditController

Defined in

grid/grid.ts:1215

getEditor

▸ Private getEditor(row, cell): EditorClass

Parameters

Name Type
row number
cell number

Returns

EditorClass

Defined in

grid/grid.ts:1733

getEditorLock

▸ getEditorLock(): EditorLock

Returns

EditorLock

Defined in

grid/grid.ts:1211

getFooterRow

▸ getFooterRow(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:590

getFooterRowColumn

▸ getFooterRowColumn(columnIdOrIdx): HTMLElement

Parameters

Name Type
columnIdOrIdx string | number

Returns

HTMLElement

Defined in

grid/grid.ts:594

getFormatter

▸ getFormatter(row, column): ColumnFormat<TItem>

Parameters

Name Type
row number
column Column<TItem>

Returns

ColumnFormat<TItem>

Defined in

grid/grid.ts:1663

getFormatterContext

▸ getFormatterContext(row, cell): FormatterContext<any>

Parameters

Name Type
row number
cell number

Returns

FormatterContext<any>

Defined in

grid/grid.ts:1717

getGridPosition

▸ getGridPosition(): Position

Returns

Position

Defined in

grid/grid.ts:3441

getGroupingPanel

▸ getGroupingPanel(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:570

getHeader

▸ getHeader(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:558

getHeaderColumn

▸ getHeaderColumn(columnIdOrIdx): HTMLElement

Parameters

Name Type
columnIdOrIdx string | number

Returns

HTMLElement

Defined in

grid/grid.ts:562

getHeaderRow

▸ getHeaderRow(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:578

getHeaderRowColumn

▸ getHeaderRowColumn(columnIdOrIdx): HTMLElement

Parameters

Name Type
columnIdOrIdx string | number

Returns

HTMLElement

Defined in

grid/grid.ts:582

getInitialColumnIndex

▸ getInitialColumnIndex(id): number

Parameters

Name Type
id string

Returns

number

Defined in

grid/grid.ts:1223

getInitialColumns

▸ getInitialColumns(): Column<TItem>[]

Returns

Column<TItem>[]

Defined in

grid/grid.ts:1348

getOptions

▸ getOptions(): GridOptions<TItem>

Returns

GridOptions<TItem>

Defined in

grid/grid.ts:1416

getPluginByName

▸ getPluginByName(name): IPlugin

Parameters

Name Type
name string

Returns

IPlugin

Defined in

grid/grid.ts:408

getPreHeaderPanel

▸ getPreHeaderPanel(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:574

getRenderedRange

▸ getRenderedRange(viewportTop?, viewportLeft?): ViewRange

Parameters

Name Type
viewportTop? number
viewportLeft? number

Returns

ViewRange

Defined in

grid/grid.ts:2220

getRowFromNode

▸ getRowFromNode(rowNode): number

Parameters

Name Type
rowNode Element

Returns

number

Defined in

grid/grid.ts:3119

getRowFromPosition

▸ Private getRowFromPosition(y): number

Parameters

Name Type
y number

Returns

number

Defined in

grid/grid.ts:1630

getRowTop

▸ Private getRowTop(row): number

Parameters

Name Type
row number

Returns

number

Defined in

grid/grid.ts:1626

getScrollBarDimensions

▸ getScrollBarDimensions(): Object

Returns

Object

Name Type
height number
width number

Defined in

grid/grid.ts:433

getSelectedRows

▸ getSelectedRows(): number[]

Returns

number[]

Defined in

grid/grid.ts:3901

getSelectionModel

▸ getSelectionModel(): SelectionModel

Returns

SelectionModel

Defined in

grid/grid.ts:448

getSortColumns

▸ getSortColumns(): ColumnSort[]

Returns

ColumnSort[]

Defined in

grid/grid.ts:1289

getTopPanel

▸ getTopPanel(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:1531

getUID

▸ getUID(): string

Returns

string

Defined in

grid/grid.ts:1619

getViewport

▸ getViewport(viewportTop?, viewportLeft?): ViewRange

Parameters

Name Type Description
viewportTop? number optional viewport top
viewportLeft? number optional viewport left

Returns

ViewRange

viewport range

Defined in

grid/grid.ts:2198

getViewportNode

▸ getViewportNode(columnIdOrIdx?, row?): HTMLElement

Parameters

Name Type
columnIdOrIdx? string | number
row? number

Returns

HTMLElement

Defined in

grid/grid.ts:478

getViewports

▸ Private getViewports(): HTMLElement[]

Returns

HTMLElement[]

Defined in

grid/grid.ts:482

getVisibleRange

▸ getVisibleRange(viewportTop?, viewportLeft?): ViewRange

Parameters

Name Type
viewportTop? number
viewportLeft? number

Returns

ViewRange

Defined in

grid/grid.ts:2202

gotoCell

▸ gotoCell(row, cell, forceEdit?): void

Parameters

Name Type
row number
cell number
forceEdit? boolean

Returns

void

Defined in

grid/grid.ts:3782

groupTotalsFormatter

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

Parameters

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

Returns

string

Defined in

grid/grid.ts:2552

handleActiveCellPositionChange

▸ Private handleActiveCellPositionChange(): void

Returns

void

Defined in

grid/grid.ts:3445

handleClick

▸ Private handleClick(e): void

Parameters

Name Type
e MouseEvent

Returns

void

Defined in

grid/grid.ts:2980

handleContextMenu

▸ Private handleContextMenu(e): void

Parameters

Name Type
e MouseEvent

Returns

void

Defined in

grid/grid.ts:3011

handleDblClick

▸ Private handleDblClick(e): void

Parameters

Name Type
e MouseEvent

Returns

void

Defined in

grid/grid.ts:3025

handleDrag

▸ Private handleDrag(e, dd): any

Parameters

Name Type
e UIEvent
dd any

Returns

any

Defined in

grid/grid.ts:2874

handleDragEnd

▸ Private handleDragEnd(e, dd): void

Parameters

Name Type
e UIEvent
dd any

Returns

void

Defined in

grid/grid.ts:2878

handleDragInit

▸ Private handleDragInit(e, dd): boolean

Parameters

Name Type
e UIEvent
dd any

Returns

boolean

Defined in

grid/grid.ts:2844

handleDragStart

▸ Private handleDragStart(e, dd): boolean

Parameters

Name Type
e UIEvent
dd any

Returns

boolean

Defined in

grid/grid.ts:2860

handleFooterRowScroll

▸ Private handleFooterRowScroll(e): void

Parameters

Name Type
e IEventData

Returns

void

Defined in

grid/grid.ts:2594

handleHeaderClick

▸ Private handleHeaderClick(e): void

Parameters

Name Type
e any

Returns

void

Defined in

grid/grid.ts:3057

handleHeaderContextMenu

▸ Private handleHeaderContextMenu(e): void

Parameters

Name Type
e any

Returns

void

Defined in

grid/grid.ts:3051

handleHeaderMouseEnter

▸ Private handleHeaderMouseEnter(e): void

Parameters

Name Type
e MouseEvent

Returns

void

Defined in

grid/grid.ts:3041

handleHeaderMouseLeave

▸ Private handleHeaderMouseLeave(e): void

Parameters

Name Type
e MouseEvent

Returns

void

Defined in

grid/grid.ts:3046

handleHeaderRowScroll

▸ Private handleHeaderRowScroll(e): void

Parameters

Name Type
e IEventData

Returns

void

Defined in

grid/grid.ts:2584

handleKeyDown

▸ Private handleKeyDown(e): void

Parameters

Name Type
e KeyboardEvent

Returns

void

Defined in

grid/grid.ts:2882

handleMouseEnter

▸ Private handleMouseEnter(e): void

Parameters

Name Type
e MouseEvent

Returns

void

Defined in

grid/grid.ts:3063

handleMouseLeave

▸ Private handleMouseLeave(e): void

Parameters

Name Type
e MouseEvent

Returns

void

Defined in

grid/grid.ts:3067

handleMouseWheel

▸ Private handleMouseWheel(e, delta, deltaX, deltaY): void

Parameters

Name Type
e MouseEvent
delta number
deltaX number
deltaY number

Returns

void

Defined in

grid/grid.ts:2604

handleScroll

▸ Private handleScroll(isMouseWheel?): boolean

Parameters

Name Type
isMouseWheel? boolean

Returns

boolean

Defined in

grid/grid.ts:2612

handleSelectedRangesChanged

▸ Private handleSelectedRangesChanged(e, ranges): void

Parameters

Name Type
e IEventData
ranges Range[]

Returns

void

Defined in

grid/grid.ts:1293

hasFrozenColumns

▸ Private hasFrozenColumns(): boolean

Returns

boolean

Defined in

grid/grid.ts:383

hasFrozenRows

▸ Private hasFrozenRows(): boolean

Returns

boolean

Defined in

grid/grid.ts:387

init

▸ init(): void

Returns

void

Defined in

grid/grid.ts:254

internalScrollColumnIntoView

▸ Private internalScrollColumnIntoView(left, right): void

Parameters

Name Type
left number
right number

Returns

void

Defined in

grid/grid.ts:3214

invalidate

▸ invalidate(): void

Returns

void

Defined in

grid/grid.ts:1910

invalidateAllRows

▸ invalidateAllRows(): void

Returns

void

Defined in

grid/grid.ts:1917

invalidatePostProcessingResults

▸ Private invalidatePostProcessingResults(row): void

Parameters

Name Type
row number

Returns

void

Defined in

grid/grid.ts:2503

invalidateRow

▸ invalidateRow(row): void

Parameters

Name Type
row number

Returns

void

Defined in

grid/grid.ts:2000

invalidateRows

▸ invalidateRows(rows): void

Parameters

Name Type
rows number[]

Returns

void

Defined in

grid/grid.ts:1982

isCellPotentiallyEditable

▸ Private isCellPotentiallyEditable(row, cell): boolean

Parameters

Name Type
row number
cell number

Returns

boolean

Defined in

grid/grid.ts:3308

makeActiveCellEditable

▸ Private makeActiveCellEditable(editor?, preClickModeOn?, e?): void

Parameters

Name Type
editor? EditorClass
preClickModeOn? boolean
e? any

Returns

void

Defined in

grid/grid.ts:3355

makeActiveCellNormal

▸ Private makeActiveCellNormal(): void

Returns

void

Defined in

grid/grid.ts:3328

measureCellPaddingAndBorder

▸ Private measureCellPaddingAndBorder(): void

Returns

void

Defined in

grid/grid.ts:1039

▸ navigate(dir): boolean

Parameters

Name Type Description
dir string Navigation direction.

Returns

boolean

Whether navigation resulted in a change of active cell.

Defined in

grid/grid.ts:3658

▸ navigateBottom(): void

Returns

void

Defined in

grid/grid.ts:3567

▸ navigateDown(): boolean

Returns

boolean

Defined in

grid/grid.ts:3630

▸ navigateLeft(): boolean

Returns

boolean

Defined in

grid/grid.ts:3626

▸ navigateNext(): boolean

Returns

boolean

Implementation of

EditorHost.navigateNext

Defined in

grid/grid.ts:3638

▸ navigatePageDown(): void

Returns

void

Defined in

grid/grid.ts:3555

▸ navigatePageUp(): void

Returns

void

Defined in

grid/grid.ts:3559

▸ navigatePrev(): boolean

Returns

boolean

Implementation of

EditorHost.navigatePrev

Defined in

grid/grid.ts:3642

▸ navigateRight(): boolean

Returns

boolean

Defined in

grid/grid.ts:3622

▸ navigateRowEnd(): boolean

Returns

boolean

Defined in

grid/grid.ts:3650

▸ navigateRowStart(): boolean

Returns

boolean

Defined in

grid/grid.ts:3646

▸ navigateToRow(row): boolean

Parameters

Name Type
row number

Returns

boolean

Defined in

grid/grid.ts:3571

▸ navigateTop(): void

Returns

void

Defined in

grid/grid.ts:3563

▸ navigateUp(): boolean

Returns

boolean

Defined in

grid/grid.ts:3634

queuePostProcessedCellForCleanup

▸ Private queuePostProcessedCellForCleanup(cellnode, columnIdx, rowIdx): void

Parameters

Name Type
cellnode HTMLElement
columnIdx number
rowIdx number

Returns

void

Defined in

grid/grid.ts:1954

queuePostProcessedRowForCleanup

▸ Private queuePostProcessedRowForCleanup(cacheEntry, postProcessedRow, rowIdx): void

Parameters

Name Type
cacheEntry CachedRow
postProcessedRow Object
rowIdx number

Returns

void

Defined in

grid/grid.ts:1928

registerPlugin

▸ registerPlugin(plugin): void

Parameters

Name Type
plugin IPlugin

Returns

void

Defined in

grid/grid.ts:391

removeCellCssStyles

▸ removeCellCssStyles(key): void

Parameters

Name Type
key string

Returns

void

Defined in

grid/grid.ts:2795

removeCssRules

▸ Private removeCssRules(): void

Returns

void

Defined in

grid/grid.ts:1155

removeRowFromCache

▸ Private removeRowFromCache(row): void

Parameters

Name Type
row number

Returns

void

Defined in

grid/grid.ts:1964

render

▸ render(): void

Returns

void

Defined in

grid/grid.ts:2556

renderRows

▸ Private renderRows(range): void

Parameters

Name Type
range ViewRange

Returns

void

Defined in

grid/grid.ts:2410

resetActiveCell

▸ resetActiveCell(): void

Returns

void

Defined in

grid/grid.ts:3184

resizeCanvas

▸ resizeCanvas(): void

Returns

void

Defined in

grid/grid.ts:2082

rowsToRanges

▸ Private rowsToRanges(rows): Range[]

Parameters

Name Type
rows number[]

Returns

Range[]

Defined in

grid/grid.ts:3892

scrollActiveCellIntoView

▸ scrollActiveCellIntoView(): void

Returns

void

Defined in

grid/grid.ts:3484

scrollCellIntoView

▸ scrollCellIntoView(row, cell, doPaging?): void

Parameters

Name Type
row number
cell number
doPaging? boolean

Returns

void

Defined in

grid/grid.ts:3200

scrollColumnIntoView

▸ scrollColumnIntoView(cell): void

Parameters

Name Type
cell number

Returns

void

Defined in

grid/grid.ts:3210

scrollPage

▸ Private scrollPage(dir): void

Parameters

Name Type
dir number

Returns

void

Defined in

grid/grid.ts:3522

scrollRowIntoView

▸ scrollRowIntoView(row, doPaging?): void

Parameters

Name Type
row number
doPaging? boolean

Returns

void

Defined in

grid/grid.ts:3490

scrollRowToTop

▸ scrollRowToTop(row): void

Parameters

Name Type
row number

Returns

void

Defined in

grid/grid.ts:3517

scrollTo

▸ Private scrollTo(y): void

Parameters

Name Type
y number

Returns

void

Defined in

grid/grid.ts:1634

setActiveCell

▸ setActiveCell(row, cell): void

Parameters

Name Type
row number
cell number

Returns

void

Defined in

grid/grid.ts:3713

setActiveCellInternal

▸ Private setActiveCellInternal(newCell, opt_editMode?, preClickModeOn?, suppressActiveCellChangedEvent?, e?): void

Parameters

Name Type
newCell HTMLElement
opt_editMode? boolean
preClickModeOn? boolean
suppressActiveCellChangedEvent? boolean
e? any

Returns

void

Defined in

grid/grid.ts:3232

setActiveRow

▸ setActiveRow(row, cell, suppressScrollIntoView?): void

Parameters

Name Type
row number
cell number
suppressScrollIntoView? boolean

Returns

void

Defined in

grid/grid.ts:3728

setCellCssStyles

▸ setCellCssStyles(key, hash): void

Parameters

Name Type
key string
hash CellStylesHash

Returns

void

Defined in

grid/grid.ts:2806

setColumnHeaderVisibility

▸ setColumnHeaderVisibility(visible, animate?): void

Parameters

Name Type
visible boolean
animate? boolean

Returns

void

Defined in

grid/grid.ts:1550

setColumns

▸ setColumns(columns): void

Parameters

Name Type
columns Column<TItem>[]

Returns

void

Defined in

grid/grid.ts:1394

setData

▸ setData(newData, scrollToTop?): void

Parameters

Name Type
newData any
scrollToTop? boolean

Returns

void

Defined in

grid/grid.ts:1495

setFocus

▸ Private setFocus(): void

Returns

void

Defined in

grid/grid.ts:3192

setFooterRowVisibility

▸ setFooterRowVisibility(visible): void

Parameters

Name Type
visible boolean

Returns

void

Defined in

grid/grid.ts:1565

setGroupingPanelVisibility

▸ setGroupingPanelVisibility(visible): void

Parameters

Name Type
visible boolean

Returns

void

Defined in

grid/grid.ts:1580

setHeaderRowVisibility

▸ setHeaderRowVisibility(visible): void

Parameters

Name Type
visible boolean

Returns

void

Defined in

grid/grid.ts:1600

setInitialCols

▸ Private setInitialCols(initCols): void

Parameters

Name Type
initCols Column<any>[]

Returns

void

Defined in

grid/grid.ts:1366

setOptions

▸ setOptions(args, suppressRender?, suppressColumnSet?, suppressSetOverflow?): void

Parameters

Name Type
args GridOptions<TItem>
suppressRender? boolean
suppressColumnSet? boolean
suppressSetOverflow? boolean

Returns

void

Defined in

grid/grid.ts:1420

setOverflow

▸ Private setOverflow(): void

Returns

void

Defined in

grid/grid.ts:1033

setPreHeaderPanelVisibility

▸ setPreHeaderPanelVisibility(visible): void

Parameters

Name Type
visible boolean

Returns

void

Defined in

grid/grid.ts:1596

setSelectedRows

▸ setSelectedRows(rows): void

Parameters

Name Type
rows number[]

Returns

void

Defined in

grid/grid.ts:3908

setSelectionModel

▸ setSelectionModel(model): void

Parameters

Name Type
model SelectionModel

Returns

void

Defined in

grid/grid.ts:415

setSortColumn

▸ setSortColumn(columnId, ascending): void

Parameters

Name Type
columnId string
ascending boolean

Returns

void

Defined in

grid/grid.ts:1258

setSortColumns

▸ setSortColumns(cols): void

Parameters

Name Type
cols ColumnSort[]

Returns

void

Defined in

grid/grid.ts:1262

setTopPanelVisibility

▸ setTopPanelVisibility(visible): void

Parameters

Name Type
visible boolean

Returns

void

Defined in

grid/grid.ts:1535

setupColumnReorder

▸ Private setupColumnReorder(): void

Returns

void

Defined in

grid/grid.ts:832

setupColumnResize

▸ Private setupColumnResize(): void

Returns

void

Defined in

grid/grid.ts:919

setupColumnSort

▸ Private setupColumnSort(): void

Returns

void

Defined in

grid/grid.ts:760

startPostProcessing

▸ Private startPostProcessing(): void

Returns

void

Defined in

grid/grid.ts:2474

startPostProcessingCleanup

▸ Private startPostProcessingCleanup(): void

Returns

void

Defined in

grid/grid.ts:2488

trigger

▸ Private trigger<TArgs, TEventData>(evt, args?, e?): any

Type parameters

Name Type
TArgs extends ArgsGrid
TEventData extends IEventData = IEventData

Parameters

Name Type
evt EventEmitter<TArgs, TEventData>
args? TArgs
e? TEventData

Returns

any

Defined in

grid/grid.ts:1203

unbindAncestorScrollEvents

▸ Private unbindAncestorScrollEvents(): void

Returns

void

Defined in

grid/grid.ts:506

unbindFromData

▸ Private unbindFromData(): void

Returns

void

Defined in

grid/grid.ts:1487

unregisterPlugin

▸ unregisterPlugin(plugin): void

Parameters

Name Type
plugin IPlugin

Returns

void

Defined in

grid/grid.ts:396

unregisterSelectionModel

▸ Private unregisterSelectionModel(): void

Returns

void

Defined in

grid/grid.ts:425

updateCanvasWidth

▸ Private updateCanvasWidth(forceColumnWidthsUpdate?): void

Parameters

Name Type
forceColumnWidthsUpdate? boolean

Returns

void

Defined in

grid/grid.ts:498

updateCell

▸ updateCell(row, cell): void

Parameters

Name Type
row number
cell number

Returns

void

Defined in

grid/grid.ts:2004

updateCellCssStylesOnRenderedRows

▸ Private updateCellCssStylesOnRenderedRows(addedHash, removedHash): void

Parameters

Name Type
addedHash CellStylesHash
removedHash CellStylesHash

Returns

void

Defined in

grid/grid.ts:2752

updateCellWithFormatter

▸ Private updateCellWithFormatter(cellNode, row, cell): void

Parameters

Name Type
cellNode HTMLElement
row number
cell number

Returns

void

Defined in

grid/grid.ts:2017

updateColumnHeader

▸ updateColumnHeader(columnId, title?, toolTip?): void

Parameters

Name Type
columnId string
title? string
toolTip? string

Returns

void

Defined in

grid/grid.ts:514

updateGrandTotals

▸ Private updateGrandTotals(): void

Returns

void

Defined in

grid/grid.ts:2530

updatePagingStatusFromView

▸ updatePagingStatusFromView(pagingInfo): void

Parameters

Name Type
pagingInfo Object
pagingInfo.pageNum number
pagingInfo.pageSize number
pagingInfo.totalPages number

Returns

void

Defined in

grid/grid.ts:2105

updateRow

▸ updateRow(row): void

Parameters

Name Type
row number

Returns

void

Defined in

grid/grid.ts:2025

updateRowCount

▸ Private updateRowCount(): void

Returns

void

Defined in

grid/grid.ts:2110

updateRowPositions

▸ Private updateRowPositions(): void

Returns

void

Defined in

grid/grid.ts:2521

updateViewColLeftRight

▸ Private updateViewColLeftRight(): void

Returns

void

Defined in

grid/grid.ts:1352

validateAndEnforceOptions

▸ Private validateAndEnforceOptions(): void

Returns

void

Defined in

grid/grid.ts:1457

viewOnDataChanged

▸ Private viewOnDataChanged(): void

Returns

void

Defined in

grid/grid.ts:1474

viewOnRowCountChanged

▸ Private viewOnRowCountChanged(): void

Returns

void

Defined in

grid/grid.ts:1463

viewOnRowsChanged

▸ Private viewOnRowsChanged(_, args): void

Parameters

Name Type
_ any
args Object
args.rows number[]

Returns

void

Defined in

grid/grid.ts:1468

Previous Page Next Page