@serenity-is/sleekgrid / Grid

Class: Grid<TItem>

Type Parameters

• TItem = any

Implements

• EditorHost

Constructors

new Grid()

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

Parameters

container

string | HTMLElement | ArrayLike<HTMLElement>

data

any

columns

Column<TItem>[]

options

GridOptions<TItem>

Returns

Grid<TItem>

Defined in

grid/grid.ts:126

Properties

onActiveCellChanged

readonly onActiveCellChanged: EventEmitter<ArgsCell, IEventData>

Defined in

grid/grid.ts:89

---

onActiveCellPositionChanged

readonly onActiveCellPositionChanged: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:90

---

onAddNewRow

readonly onAddNewRow: EventEmitter<ArgsAddNewRow, IEventData>

Defined in

grid/grid.ts:91

---

onBeforeCellEditorDestroy

readonly onBeforeCellEditorDestroy: EventEmitter<ArgsEditorDestroy, IEventData>

Defined in

grid/grid.ts:92

---

onBeforeDestroy

readonly onBeforeDestroy: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:93

---

onBeforeEditCell

readonly onBeforeEditCell: EventEmitter<ArgsCellEdit, IEventData>

Defined in

grid/grid.ts:94

---

onBeforeFooterRowCellDestroy

readonly onBeforeFooterRowCellDestroy: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:95

---

onBeforeHeaderCellDestroy

readonly onBeforeHeaderCellDestroy: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:96

---

onBeforeHeaderRowCellDestroy

readonly onBeforeHeaderRowCellDestroy: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:97

---

onCellChange

readonly onCellChange: EventEmitter<ArgsCellChange, IEventData>

Defined in

grid/grid.ts:98

---

onCellCssStylesChanged

readonly onCellCssStylesChanged: EventEmitter<ArgsCssStyle, IEventData>

Defined in

grid/grid.ts:99

---

onClick

readonly onClick: EventEmitter<ArgsCell, MouseEvent>

Defined in

grid/grid.ts:100

---

onColumnsReordered

readonly onColumnsReordered: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:101

---

onColumnsResized

readonly onColumnsResized: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:102

---

onCompositeEditorChange

readonly onCompositeEditorChange: EventEmitter<ArgsGrid, IEventData>

Implementation of

EditorHost.onCompositeEditorChange

Defined in

grid/grid.ts:103

---

onContextMenu

readonly onContextMenu: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:104

---

onDblClick

readonly onDblClick: EventEmitter<ArgsCell, MouseEvent>

Defined in

grid/grid.ts:105

---

onDrag

readonly onDrag: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:106

---

onDragEnd

readonly onDragEnd: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:107

---

onDragInit

readonly onDragInit: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:108

---

onDragStart

readonly onDragStart: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:109

---

onFooterRowCellRendered

readonly onFooterRowCellRendered: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:110

---

onHeaderCellRendered

readonly onHeaderCellRendered: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:111

---

onHeaderClick

readonly onHeaderClick: EventEmitter<ArgsColumn, IEventData>

Defined in

grid/grid.ts:112

---

onHeaderContextMenu

readonly onHeaderContextMenu: EventEmitter<ArgsColumn, IEventData>

Defined in

grid/grid.ts:113

---

onHeaderMouseEnter

readonly onHeaderMouseEnter: EventEmitter<ArgsColumn, MouseEvent>

Defined in

grid/grid.ts:114

---

onHeaderMouseLeave

readonly onHeaderMouseLeave: EventEmitter<ArgsColumn, MouseEvent>

Defined in

grid/grid.ts:115

---

onHeaderRowCellRendered

readonly onHeaderRowCellRendered: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:116

---

onKeyDown

readonly onKeyDown: EventEmitter<ArgsCell, KeyboardEvent>

Defined in

grid/grid.ts:117

---

onMouseEnter

readonly onMouseEnter: EventEmitter<ArgsGrid, MouseEvent>

Defined in

grid/grid.ts:118

---

onMouseLeave

readonly onMouseLeave: EventEmitter<ArgsGrid, MouseEvent>

Defined in

grid/grid.ts:119

---

onScroll

readonly onScroll: EventEmitter<ArgsScroll, IEventData>

Defined in

grid/grid.ts:120

---

onSelectedRowsChanged

readonly onSelectedRowsChanged: EventEmitter<ArgsSelectedRowsChange, IEventData>

Defined in

grid/grid.ts:121

---

onSort

readonly onSort: EventEmitter<ArgsSort, IEventData>

Defined in

grid/grid.ts:122

---

onValidationError

readonly onValidationError: EventEmitter<ArgsValidationError, IEventData>

Defined in

grid/grid.ts:123

---

onViewportChanged

readonly onViewportChanged: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:124

Methods

addCellCssStyles()

addCellCssStyles(key, hash): void

Parameters

key

string

hash

CellStylesHash

Returns

void

Defined in

grid/grid.ts:2883

---

autosizeColumns()

autosizeColumns(): void

Returns

void

Defined in

grid/grid.ts:1282

---

canCellBeActive()

canCellBeActive(row, cell): boolean

Parameters

row

number

cell

number

Returns

boolean

Defined in

grid/grid.ts:3862

---

canCellBeSelected()

canCellBeSelected(row, cell): any

Parameters

row

number

cell

number

Returns

any

Defined in

grid/grid.ts:3885

---

clearTextSelection()

clearTextSelection(): void

Returns

void

Defined in

grid/grid.ts:3416

---

columnsResized()

columnsResized(invalidate): void

Parameters

invalidate

boolean = true

Returns

void

Defined in

grid/grid.ts:1062

---

commitCurrentEdit()

commitCurrentEdit(): boolean

Returns

boolean

Defined in

grid/grid.ts:3930

---

destroy()

destroy(): void

Returns

void

Defined in

grid/grid.ts:1199

---

editActiveCell()

editActiveCell(editor?): void

Parameters

editor?

EditorClass

Returns

void

Defined in

grid/grid.ts:3473

---

flashCell()

flashCell(row, cell, speed?): void

Parameters

row

number

cell

number

speed?

number

Returns

void

Defined in

grid/grid.ts:2918

---

focus()

focus(): void

Returns

void

Defined in

grid/grid.ts:3310

---

getAbsoluteColumnMinWidth()

getAbsoluteColumnMinWidth(): number

Returns

number

Defined in

grid/grid.ts:466

---

getActiveCanvasNode()

getActiveCanvasNode(e?): HTMLElement

Parameters

e?

IEventData

Returns

HTMLElement

Defined in

grid/grid.ts:493

---

getActiveCell()

getActiveCell(): RowCell

Returns

RowCell

Implementation of

EditorHost.getActiveCell

Defined in

grid/grid.ts:3594

---

getActiveCellNode()

getActiveCellNode(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:3602

---

getActiveViewportNode()

getActiveViewportNode(e?): HTMLElement

Parameters

e?

IEventData

Returns

HTMLElement

Defined in

grid/grid.ts:508

---

getCanvases()

getCanvases(): any

Returns

any

Defined in

grid/grid.ts:488

---

getCanvasNode()

getCanvasNode(columnIdOrIdx?, row?): HTMLElement

Parameters

columnIdOrIdx?

string | number

row?

number

Returns

HTMLElement

Defined in

grid/grid.ts:484

---

getCellCssStyles()

getCellCssStyles(key): CellStylesHash

Parameters

key

string

Returns

CellStylesHash

Defined in

grid/grid.ts:2914

---

getCellEditor()

getCellEditor(): Editor

Returns

Editor

Defined in

grid/grid.ts:3590

---

getCellFromEvent()

getCellFromEvent(e): object

Parameters

e

any

Returns

object

cell

cell: number

row

row: number

Defined in

grid/grid.ts:3252

---

getCellFromNode()

getCellFromNode(cellNode): number

Parameters

cellNode

Element

Returns

number

Defined in

grid/grid.ts:3214

---

getCellFromPoint()

getCellFromPoint(x, y): object

Parameters

x

number

y

number

Returns

object

cell

cell: number

row

row: number

Defined in

grid/grid.ts:3197

---

getCellNode()

getCellNode(row, cell): HTMLElement

Parameters

row

number

cell

number

Returns

HTMLElement

Defined in

grid/grid.ts:3827

---

getCellNodeBox()

getCellNodeBox(row, cell): object

Parameters

row

number

cell

number

Returns

object

bottom

bottom: number

left

left: number

right

right: number

top

top: number

Defined in

grid/grid.ts:3272

---

getColspan()

getColspan(row, cell): number

Parameters

row

number

cell

number

Returns

number

Defined in

grid/grid.ts:3726

---

getColumnById()

getColumnById(id): Column<TItem>

Gets a column by its ID. May also return non visible columns

Parameters

id

string

Returns

Column<TItem>

Defined in

grid/grid.ts:1263

---

getColumnFromNode()

getColumnFromNode(cellNode): Column<TItem>

Parameters

cellNode

Element

Returns

Column<TItem>

Defined in

grid/grid.ts:3230

---

getColumnIndex()

getColumnIndex(id): number

Returns a column's index in the visible columns list by its column ID

Parameters

id

string

Returns

number

Defined in

grid/grid.ts:1268

---

getColumns()

getColumns(): Column<TItem>[]

Returns only the visible columns in order

Returns

Column<TItem>[]

Defined in

grid/grid.ts:1400

---

getContainerNode()

getContainerNode(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:1694

---

getData()

getData(): any

Returns

any

Defined in

grid/grid.ts:1585

---

getDataItem()

getDataItem(i): TItem

Parameters

i

number

Returns

TItem

Defined in

grid/grid.ts:1602

---

getDataItemValueForColumn()

getDataItemValueForColumn(item, columnDef): any

Parameters

item

TItem

columnDef

Column<TItem>

Returns

any

Defined in

grid/grid.ts:1827

---

getDataLength()

getDataLength(): number

Returns

number

Defined in

grid/grid.ts:1589

---

getDisplayedScrollbarDimensions()

getDisplayedScrollbarDimensions(): object

Returns

object

height

height: number

width

width: number

Defined in

grid/grid.ts:459

---

getEditController()

getEditController(): EditController

Returns

EditController

Defined in

grid/grid.ts:1258

---

getEditorLock()

getEditorLock(): EditorLock

Returns

EditorLock

Defined in

grid/grid.ts:1254

---

getFooterRow()

getFooterRow(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:612

---

getFooterRowColumn()

getFooterRowColumn(columnIdOrIdx): HTMLElement

Parameters

columnIdOrIdx

string | number

Returns

HTMLElement

Defined in

grid/grid.ts:616

---

getFormatter()

getFormatter(row, column): ColumnFormat<TItem>

Parameters

row

number

column

Column<TItem>

Returns

ColumnFormat<TItem>

Defined in

grid/grid.ts:1742

---

getFormatterContext()

getFormatterContext(row, cell): FormatterContext<any>

Parameters

row

number

cell

number

Returns

FormatterContext<any>

Defined in

grid/grid.ts:1796

---

getGridPosition()

getGridPosition(): Position

Returns

Position

Defined in

grid/grid.ts:3563

---

getGroupingPanel()

getGroupingPanel(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:592

---

getHeader()

getHeader(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:580

---

getHeaderColumn()

getHeaderColumn(columnIdOrIdx): HTMLElement

Parameters

columnIdOrIdx

string | number

Returns

HTMLElement

Defined in

grid/grid.ts:584

---

getHeaderRow()

getHeaderRow(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:600

---

getHeaderRowColumn()

getHeaderRowColumn(columnIdOrIdx): HTMLElement

Parameters

columnIdOrIdx

string | number

Returns

HTMLElement

Defined in

grid/grid.ts:604

---

getInitialColumnIndex()

getInitialColumnIndex(id): number

Gets index of a column in the initial column list passed to the grid, or setColumns method. May include invisible cols and index does not have to match visible column order.

Parameters

id

string

Returns

number

Defined in

grid/grid.ts:1273

---

getInitialColumns()

getInitialColumns(): Column<TItem>[]

Returns list of columns passed to the grid constructor, or setColumns method. May include invisible columns and order does not match visible column order.

Returns

Column<TItem>[]

Defined in

grid/grid.ts:1405

---

getOptions()

getOptions(): GridOptions<TItem>

Returns

GridOptions<TItem>

Defined in

grid/grid.ts:1495

---

getPluginByName()

getPluginByName(name): IPlugin

Parameters

name

string

Returns

IPlugin

Defined in

grid/grid.ts:430

---

getPreHeaderPanel()

getPreHeaderPanel(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:596

---

getRenderedRange()

getRenderedRange(viewportTop?, viewportLeft?): ViewRange

Parameters

viewportTop?

number

viewportLeft?

number

Returns

ViewRange

Defined in

grid/grid.ts:2309

---

getRowFromNode()

getRowFromNode(rowNode): number

Parameters

rowNode

Element

Returns

number

Defined in

grid/grid.ts:3241

---

getScrollBarDimensions()

getScrollBarDimensions(): object

Returns

object

height

height: number

width

width: number

Defined in

grid/grid.ts:455

---

getSelectedRows()

getSelectedRows(): number[]

Returns

number[]

Defined in

grid/grid.ts:4023

---

getSelectionModel()

getSelectionModel(): SelectionModel

Returns

SelectionModel

Defined in

grid/grid.ts:470

---

getSortColumns()

getSortColumns(): ColumnSort[]

Returns

ColumnSort[]

Defined in

grid/grid.ts:1344

---

getTopPanel()

getTopPanel(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:1610

---

getUID()

getUID(): string

Returns

string

Defined in

grid/grid.ts:1698

---

getViewport()

getViewport(viewportTop?, viewportLeft?): ViewRange

Parameters

viewportTop?

number

optional viewport top

viewportLeft?

number

optional viewport left

Returns

ViewRange

viewport range

Defined in

grid/grid.ts:2287

---

getViewportNode()

getViewportNode(columnIdOrIdx?, row?): HTMLElement

Parameters

columnIdOrIdx?

string | number

row?

number

Returns

HTMLElement

Defined in

grid/grid.ts:500

---

getVisibleColumnById()

getVisibleColumnById(id): Column<TItem>

Gets a view (e.g. visible) column by its column ID

Parameters

id

string

Returns

Column<TItem>

Defined in

grid/grid.ts:1278

---

getVisibleRange()

getVisibleRange(viewportTop?, viewportLeft?): ViewRange

Parameters

viewportTop?

number

viewportLeft?

number

Returns

ViewRange

Defined in

grid/grid.ts:2291

---

gotoCell()

gotoCell(row, cell, forceEdit?): void

Parameters

row

number

cell

number

forceEdit?

boolean

Returns

void

Defined in

grid/grid.ts:3904

---

groupTotalsFormatter()

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

Parameters

p1?

GroupTotals<TItem>

p2?

Column<TItem>

grid?

any

Returns

string

Defined in

grid/grid.ts:2655

---

init()

init(): void

Returns

void

Defined in

grid/grid.ts:266

---

invalidate()

invalidate(): void

Returns

void

Defined in

grid/grid.ts:1995

---

invalidateAllRows()

invalidateAllRows(): void

Returns

void

Defined in

grid/grid.ts:2002

---

invalidateRow()

invalidateRow(row): void

Parameters

row

number

Returns

void

Defined in

grid/grid.ts:2088

---

invalidateRows()

invalidateRows(rows): void

Parameters

rows

number[]

Returns

void

Defined in

grid/grid.ts:2070

---

navigate()

navigate(dir): boolean

Parameters

dir

string

Navigation direction.

Returns

boolean

Whether navigation resulted in a change of active cell.

Defined in

grid/grid.ts:3780

---

navigateBottom()

navigateBottom(): void

Returns

void

Defined in

grid/grid.ts:3689

---

navigateDown()

navigateDown(): boolean

Returns

boolean

Defined in

grid/grid.ts:3752

---

navigateLeft()

navigateLeft(): boolean

Returns

boolean

Defined in

grid/grid.ts:3748

---

navigateNext()

navigateNext(): boolean

Returns

boolean

Implementation of

EditorHost.navigateNext

Defined in

grid/grid.ts:3760

---

navigatePageDown()

navigatePageDown(): void

Returns

void

Defined in

grid/grid.ts:3677

---

navigatePageUp()

navigatePageUp(): void

Returns

void

Defined in

grid/grid.ts:3681

---

navigatePrev()

navigatePrev(): boolean

Returns

boolean

Implementation of

EditorHost.navigatePrev

Defined in

grid/grid.ts:3764

---

navigateRight()

navigateRight(): boolean

Returns

boolean

Defined in

grid/grid.ts:3744

---

navigateRowEnd()

navigateRowEnd(): boolean

Returns

boolean

Defined in

grid/grid.ts:3772

---

navigateRowStart()

navigateRowStart(): boolean

Returns

boolean

Defined in

grid/grid.ts:3768

---

navigateTop()

navigateTop(): void

Returns

void

Defined in

grid/grid.ts:3685

---

navigateToRow()

navigateToRow(row): boolean

Parameters

row

number

Returns

boolean

Defined in

grid/grid.ts:3693

---

navigateUp()

navigateUp(): boolean

Returns

boolean

Defined in

grid/grid.ts:3756

---

registerPlugin()

registerPlugin(plugin): void

Parameters

plugin

IPlugin

Returns

void

Defined in

grid/grid.ts:413

---

removeCellCssStyles()

removeCellCssStyles(key): void

Parameters

key

string

Returns

void

Defined in

grid/grid.ts:2894

---

render()

render(): void

Returns

void

Defined in

grid/grid.ts:2659

---

resetActiveCell()

resetActiveCell(): void

Returns

void

Defined in

grid/grid.ts:3306

---

resizeCanvas()

resizeCanvas(): void

Returns

void

Defined in

grid/grid.ts:2171

---

scrollActiveCellIntoView()

scrollActiveCellIntoView(): void

Returns

void

Defined in

grid/grid.ts:3606

---

scrollCellIntoView()

scrollCellIntoView(row, cell, doPaging?): void

Parameters

row

number

cell

number

doPaging?

boolean

Returns

void

Defined in

grid/grid.ts:3322

---

scrollColumnIntoView()

scrollColumnIntoView(cell): void

Parameters

cell

number

Returns

void

Defined in

grid/grid.ts:3332

---

scrollRowIntoView()

scrollRowIntoView(row, doPaging?): void

Parameters

row

number

doPaging?

boolean

Returns

void

Defined in

grid/grid.ts:3612

---

scrollRowToTop()

scrollRowToTop(row): void

Parameters

row

number

Returns

void

Defined in

grid/grid.ts:3639

---

setActiveCell()

setActiveCell(row, cell): void

Parameters

row

number

cell

number

Returns

void

Defined in

grid/grid.ts:3835

---

setActiveRow()

setActiveRow(row, cell, suppressScrollIntoView?): void

Parameters

row

number

cell

number

suppressScrollIntoView?

boolean

Returns

void

Defined in

grid/grid.ts:3850

---

setCellCssStyles()

setCellCssStyles(key, hash): void

Parameters

key

string

hash

CellStylesHash

Returns

void

Defined in

grid/grid.ts:2905

---

setColumnHeaderVisibility()

setColumnHeaderVisibility(visible, animate?): void

Parameters

visible

boolean

animate?

boolean

Returns

void

Defined in

grid/grid.ts:1629

---

setColumns()

setColumns(columns): void

Parameters

columns

Column<TItem>[]

Returns

void

Defined in

grid/grid.ts:1457

---

setData()

setData(newData, scrollToTop?): void

Parameters

newData

any

scrollToTop?

boolean

Returns

void

Defined in

grid/grid.ts:1574

---

setFooterRowVisibility()

setFooterRowVisibility(visible): void

Parameters

visible

boolean

Returns

void

Defined in

grid/grid.ts:1644

---

setGroupingPanelVisibility()

setGroupingPanelVisibility(visible): void

Parameters

visible

boolean

Returns

void

Defined in

grid/grid.ts:1659

---

setHeaderRowVisibility()

setHeaderRowVisibility(visible): void

Parameters

visible

boolean

Returns

void

Defined in

grid/grid.ts:1679

---

setOptions()

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

Parameters

args

GridOptions<TItem>

suppressRender?

boolean

suppressColumnSet?

boolean

suppressSetOverflow?

boolean

Returns

void

Defined in

grid/grid.ts:1499

---

setPreHeaderPanelVisibility()

setPreHeaderPanelVisibility(visible): void

Parameters

visible

boolean

Returns

void

Defined in

grid/grid.ts:1675

---

setSelectedRows()

setSelectedRows(rows): void

Parameters

rows

number[]

Returns

void

Defined in

grid/grid.ts:4030

---

setSelectionModel()

setSelectionModel(model): void

Parameters

model

SelectionModel

Returns

void

Defined in

grid/grid.ts:437

---

setSortColumn()

setSortColumn(columnId, ascending): void

Parameters

columnId

string

ascending

boolean

Returns

void

Defined in

grid/grid.ts:1313

---

setSortColumns()

setSortColumns(cols): void

Parameters

cols

ColumnSort[]

Returns

void

Defined in

grid/grid.ts:1317

---

setTopPanelVisibility()

setTopPanelVisibility(visible): void

Parameters

visible

boolean

Returns

void

Defined in

grid/grid.ts:1614

---

unregisterPlugin()

unregisterPlugin(plugin): void

Parameters

plugin

IPlugin

Returns

void

Defined in

grid/grid.ts:418

---

updateCell()

updateCell(row, cell): void

Parameters

row

number

cell

number

Returns

void

Defined in

grid/grid.ts:2092

---

updateColumnHeader()

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

Parameters

columnId

string

title?

string

toolTip?

string

Returns

void

Defined in

grid/grid.ts:536

---

updatePagingStatusFromView()

updatePagingStatusFromView(pagingInfo): void

Parameters

pagingInfo

pagingInfo.pageNum

number

pagingInfo.pageSize

number

pagingInfo.totalPages

number

Returns

void

Defined in

grid/grid.ts:2194

---

updateRow()

updateRow(row): void

Parameters

row

number

Returns

void

Defined in

grid/grid.ts:2118

---

updateRowCount()

updateRowCount(): void

Returns

void

Defined in

grid/grid.ts:2199