Previous Page Next Page

@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): Grid<TItem>

Type parameters

Name Type
TItem any

Parameters

Name Type
container HTMLElement | ArrayLike<HTMLElement>
data any
columns Column<TItem>[]
options GridOptions<TItem>

Returns

Grid<TItem>

Defined in

grid/grid.ts:124

Properties

onActiveCellChanged

• Readonly onActiveCellChanged: EventEmitter<ArgsCell, IEventData>

Defined in

grid/grid.ts:87

onActiveCellPositionChanged

• Readonly onActiveCellPositionChanged: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:88

onAddNewRow

• Readonly onAddNewRow: EventEmitter<ArgsAddNewRow, IEventData>

Defined in

grid/grid.ts:89

onBeforeCellEditorDestroy

• Readonly onBeforeCellEditorDestroy: EventEmitter<ArgsEditorDestroy, IEventData>

Defined in

grid/grid.ts:90

onBeforeDestroy

• Readonly onBeforeDestroy: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:91

onBeforeEditCell

• Readonly onBeforeEditCell: EventEmitter<ArgsCellEdit, IEventData>

Defined in

grid/grid.ts:92

onBeforeFooterRowCellDestroy

• Readonly onBeforeFooterRowCellDestroy: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:93

onBeforeHeaderCellDestroy

• Readonly onBeforeHeaderCellDestroy: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:94

onBeforeHeaderRowCellDestroy

• Readonly onBeforeHeaderRowCellDestroy: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:95

onCellChange

• Readonly onCellChange: EventEmitter<ArgsCellChange, IEventData>

Defined in

grid/grid.ts:96

onCellCssStylesChanged

• Readonly onCellCssStylesChanged: EventEmitter<ArgsCssStyle, IEventData>

Defined in

grid/grid.ts:97

onClick

• Readonly onClick: EventEmitter<ArgsCell, MouseEvent>

Defined in

grid/grid.ts:98

onColumnsReordered

• Readonly onColumnsReordered: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:99

onColumnsResized

• Readonly onColumnsResized: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:100

onCompositeEditorChange

• Readonly onCompositeEditorChange: EventEmitter<ArgsGrid, IEventData>

Implementation of

EditorHost.onCompositeEditorChange

Defined in

grid/grid.ts:101

onContextMenu

• Readonly onContextMenu: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:102

onDblClick

• Readonly onDblClick: EventEmitter<ArgsCell, MouseEvent>

Defined in

grid/grid.ts:103

onDrag

• Readonly onDrag: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:104

onDragEnd

• Readonly onDragEnd: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:105

onDragInit

• Readonly onDragInit: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:106

onDragStart

• Readonly onDragStart: EventEmitter<ArgsGrid, UIEvent>

Defined in

grid/grid.ts:107

onFooterRowCellRendered

• Readonly onFooterRowCellRendered: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:108

onHeaderCellRendered

• Readonly onHeaderCellRendered: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:109

onHeaderClick

• Readonly onHeaderClick: EventEmitter<ArgsColumn, IEventData>

Defined in

grid/grid.ts:110

onHeaderContextMenu

• Readonly onHeaderContextMenu: EventEmitter<ArgsColumn, IEventData>

Defined in

grid/grid.ts:111

onHeaderMouseEnter

• Readonly onHeaderMouseEnter: EventEmitter<ArgsColumn, MouseEvent>

Defined in

grid/grid.ts:112

onHeaderMouseLeave

• Readonly onHeaderMouseLeave: EventEmitter<ArgsColumn, MouseEvent>

Defined in

grid/grid.ts:113

onHeaderRowCellRendered

• Readonly onHeaderRowCellRendered: EventEmitter<ArgsColumnNode, IEventData>

Defined in

grid/grid.ts:114

onKeyDown

• Readonly onKeyDown: EventEmitter<ArgsCell, KeyboardEvent>

Defined in

grid/grid.ts:115

onMouseEnter

• Readonly onMouseEnter: EventEmitter<ArgsGrid, MouseEvent>

Defined in

grid/grid.ts:116

onMouseLeave

• Readonly onMouseLeave: EventEmitter<ArgsGrid, MouseEvent>

Defined in

grid/grid.ts:117

onScroll

• Readonly onScroll: EventEmitter<ArgsScroll, IEventData>

Defined in

grid/grid.ts:118

onSelectedRowsChanged

• Readonly onSelectedRowsChanged: EventEmitter<ArgsSelectedRowsChange, IEventData>

Defined in

grid/grid.ts:119

onSort

• Readonly onSort: EventEmitter<ArgsSort, IEventData>

Defined in

grid/grid.ts:120

onValidationError

• Readonly onValidationError: EventEmitter<ArgsValidationError, IEventData>

Defined in

grid/grid.ts:121

onViewportChanged

• Readonly onViewportChanged: EventEmitter<ArgsGrid, IEventData>

Defined in

grid/grid.ts:122

Methods

addCellCssStyles

▸ addCellCssStyles(key, hash): void

Parameters

Name Type
key string
hash CellStylesHash

Returns

void

Defined in

grid/grid.ts:2840

autosizeColumns

▸ autosizeColumns(): void

Returns

void

Defined in

grid/grid.ts:1252

canCellBeActive

▸ canCellBeActive(row, cell): boolean

Parameters

Name Type
row number
cell number

Returns

boolean

Defined in

grid/grid.ts:3796

canCellBeSelected

▸ canCellBeSelected(row, cell): any

Parameters

Name Type
row number
cell number

Returns

any

Defined in

grid/grid.ts:3819

clearTextSelection

▸ clearTextSelection(): void

Returns

void

Defined in

grid/grid.ts:3350

columnsResized

▸ columnsResized(invalidate?): void

Parameters

Name Type Default value
invalidate boolean true

Returns

void

Defined in

grid/grid.ts:1037

commitCurrentEdit

▸ commitCurrentEdit(): boolean

Returns

boolean

Defined in

grid/grid.ts:3864

destroy

▸ destroy(): void

Returns

void

Defined in

grid/grid.ts:1174

editActiveCell

▸ editActiveCell(editor?): void

Parameters

Name Type
editor? EditorClass

Returns

void

Defined in

grid/grid.ts:3407

flashCell

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

Parameters

Name Type
row number
cell number
speed? number

Returns

void

Defined in

grid/grid.ts:2875

focus

▸ focus(): void

Returns

void

Defined in

grid/grid.ts:3244

getAbsoluteColumnMinWidth

▸ getAbsoluteColumnMinWidth(): number

Returns

number

Defined in

grid/grid.ts:452

getActiveCanvasNode

▸ getActiveCanvasNode(e?): HTMLElement

Parameters

Name Type
e? IEventData

Returns

HTMLElement

Defined in

grid/grid.ts:479

getActiveCell

▸ getActiveCell(): RowCell

Returns

RowCell

Implementation of

EditorHost.getActiveCell

Defined in

grid/grid.ts:3528

getActiveCellNode

▸ getActiveCellNode(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:3536

getActiveViewportNode

▸ getActiveViewportNode(e?): HTMLElement

Parameters

Name Type
e? IEventData

Returns

HTMLElement

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:470

getCanvases

▸ getCanvases(): any

Returns

any

Defined in

grid/grid.ts:474

getCellCssStyles

▸ getCellCssStyles(key): CellStylesHash

Parameters

Name Type
key string

Returns

CellStylesHash

Defined in

grid/grid.ts:2871

getCellEditor

▸ getCellEditor(): Editor

Returns

Editor

Defined in

grid/grid.ts:3524

getCellFromEvent

▸ getCellFromEvent(e): Object

Parameters

Name Type
e any

Returns

Object

Name Type
cell number
row number

Defined in

grid/grid.ts:3186

getCellFromNode

▸ getCellFromNode(cellNode): number

Parameters

Name Type
cellNode Element

Returns

number

Defined in

grid/grid.ts:3148

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:3131

getCellNode

▸ getCellNode(row, cell): HTMLElement

Parameters

Name Type
row number
cell number

Returns

HTMLElement

Defined in

grid/grid.ts:3761

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:3206

getColspan

▸ getColspan(row, cell): number

Parameters

Name Type
row number
cell number

Returns

number

Defined in

grid/grid.ts:3660

getColumnById

▸ getColumnById(id): Column<TItem>

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

Parameters

Name Type
id string

Returns

Column<TItem>

Defined in

grid/grid.ts:1233

getColumnFromNode

▸ getColumnFromNode(cellNode): Column<TItem>

Parameters

Name Type
cellNode Element

Returns

Column<TItem>

Defined in

grid/grid.ts:3164

getColumnIndex

▸ getColumnIndex(id): number

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

Parameters

Name Type
id string

Returns

number

Defined in

grid/grid.ts:1238

getColumns

▸ getColumns(): Column<TItem>[]

Returns only the visible columns in order

Returns

Column<TItem>[]

Defined in

grid/grid.ts:1370

getContainerNode

▸ getContainerNode(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:1664

getData

▸ getData(): any

Returns

any

Defined in

grid/grid.ts:1555

getDataItem

▸ getDataItem(i): TItem

Parameters

Name Type
i number

Returns

TItem

Defined in

grid/grid.ts:1572

getDataItemValueForColumn

▸ getDataItemValueForColumn(item, columnDef): any

Parameters

Name Type
item TItem
columnDef Column<TItem>

Returns

any

Defined in

grid/grid.ts:1797

getDataLength

▸ getDataLength(): number

Returns

number

Defined in

grid/grid.ts:1559

getDisplayedScrollbarDimensions

▸ getDisplayedScrollbarDimensions(): Object

Returns

Object

Name Type
height number
width number

Defined in

grid/grid.ts:445

getEditController

▸ getEditController(): EditController

Returns

EditController

Defined in

grid/grid.ts:1228

getEditorLock

▸ getEditorLock(): EditorLock

Returns

EditorLock

Defined in

grid/grid.ts:1224

getFooterRow

▸ getFooterRow(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:598

getFooterRowColumn

▸ getFooterRowColumn(columnIdOrIdx): HTMLElement

Parameters

Name Type
columnIdOrIdx string | number

Returns

HTMLElement

Defined in

grid/grid.ts:602

getFormatter

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

Parameters

Name Type
row number
column Column<TItem>

Returns

ColumnFormat<TItem>

Defined in

grid/grid.ts:1712

getFormatterContext

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

Parameters

Name Type
row number
cell number

Returns

FormatterContext<any>

Defined in

grid/grid.ts:1766

getGridPosition

▸ getGridPosition(): Position

Returns

Position

Defined in

grid/grid.ts:3497

getGroupingPanel

▸ getGroupingPanel(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:578

getHeader

▸ getHeader(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:566

getHeaderColumn

▸ getHeaderColumn(columnIdOrIdx): HTMLElement

Parameters

Name Type
columnIdOrIdx string | number

Returns

HTMLElement

Defined in

grid/grid.ts:570

getHeaderRow

▸ getHeaderRow(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:586

getHeaderRowColumn

▸ getHeaderRowColumn(columnIdOrIdx): HTMLElement

Parameters

Name Type
columnIdOrIdx string | number

Returns

HTMLElement

Defined in

grid/grid.ts:590

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

Name Type
id string

Returns

number

Defined in

grid/grid.ts:1243

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:1375

getOptions

▸ getOptions(): GridOptions<TItem>

Returns

GridOptions<TItem>

Defined in

grid/grid.ts:1465

getPluginByName

▸ getPluginByName(name): IPlugin

Parameters

Name Type
name string

Returns

IPlugin

Defined in

grid/grid.ts:416

getPreHeaderPanel

▸ getPreHeaderPanel(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:582

getRenderedRange

▸ getRenderedRange(viewportTop?, viewportLeft?): ViewRange

Parameters

Name Type
viewportTop? number
viewportLeft? number

Returns

ViewRange

Defined in

grid/grid.ts:2271

getRowFromNode

▸ getRowFromNode(rowNode): number

Parameters

Name Type
rowNode Element

Returns

number

Defined in

grid/grid.ts:3175

getScrollBarDimensions

▸ getScrollBarDimensions(): Object

Returns

Object

Name Type
height number
width number

Defined in

grid/grid.ts:441

getSelectedRows

▸ getSelectedRows(): number[]

Returns

number[]

Defined in

grid/grid.ts:3957

getSelectionModel

▸ getSelectionModel(): SelectionModel

Returns

SelectionModel

Defined in

grid/grid.ts:456

getSortColumns

▸ getSortColumns(): ColumnSort[]

Returns

ColumnSort[]

Defined in

grid/grid.ts:1314

getTopPanel

▸ getTopPanel(): HTMLElement

Returns

HTMLElement

Defined in

grid/grid.ts:1580

getUID

▸ getUID(): string

Returns

string

Defined in

grid/grid.ts:1668

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:2249

getViewportNode

▸ getViewportNode(columnIdOrIdx?, row?): HTMLElement

Parameters

Name Type
columnIdOrIdx? string | number
row? number

Returns

HTMLElement

Defined in

grid/grid.ts:486

getVisibleColumnById

▸ getVisibleColumnById(id): Column<TItem>

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

Parameters

Name Type
id string

Returns

Column<TItem>

Defined in

grid/grid.ts:1248

getVisibleRange

▸ getVisibleRange(viewportTop?, viewportLeft?): ViewRange

Parameters

Name Type
viewportTop? number
viewportLeft? number

Returns

ViewRange

Defined in

grid/grid.ts:2253

gotoCell

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

Parameters

Name Type
row number
cell number
forceEdit? boolean

Returns

void

Defined in

grid/grid.ts:3838

groupTotalsFormatter

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

Parameters

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

Returns

string

Defined in

grid/grid.ts:2612

init

▸ init(): void

Returns

void

Defined in

grid/grid.ts:262

invalidate

▸ invalidate(): void

Returns

void

Defined in

grid/grid.ts:1961

invalidateAllRows

▸ invalidateAllRows(): void

Returns

void

Defined in

grid/grid.ts:1968

invalidateRow

▸ invalidateRow(row): void

Parameters

Name Type
row number

Returns

void

Defined in

grid/grid.ts:2054

invalidateRows

▸ invalidateRows(rows): void

Parameters

Name Type
rows number[]

Returns

void

Defined in

grid/grid.ts:2036

▸ 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:3714

▸ navigateBottom(): void

Returns

void

Defined in

grid/grid.ts:3623

▸ navigateDown(): boolean

Returns

boolean

Defined in

grid/grid.ts:3686

▸ navigateLeft(): boolean

Returns

boolean

Defined in

grid/grid.ts:3682

▸ navigateNext(): boolean

Returns

boolean

Implementation of

EditorHost.navigateNext

Defined in

grid/grid.ts:3694

▸ navigatePageDown(): void

Returns

void

Defined in

grid/grid.ts:3611

▸ navigatePageUp(): void

Returns

void

Defined in

grid/grid.ts:3615

▸ navigatePrev(): boolean

Returns

boolean

Implementation of

EditorHost.navigatePrev

Defined in

grid/grid.ts:3698

▸ navigateRight(): boolean

Returns

boolean

Defined in

grid/grid.ts:3678

▸ navigateRowEnd(): boolean

Returns

boolean

Defined in

grid/grid.ts:3706

▸ navigateRowStart(): boolean

Returns

boolean

Defined in

grid/grid.ts:3702

▸ navigateToRow(row): boolean

Parameters

Name Type
row number

Returns

boolean

Defined in

grid/grid.ts:3627

▸ navigateTop(): void

Returns

void

Defined in

grid/grid.ts:3619

▸ navigateUp(): boolean

Returns

boolean

Defined in

grid/grid.ts:3690

registerPlugin

▸ registerPlugin(plugin): void

Parameters

Name Type
plugin IPlugin

Returns

void

Defined in

grid/grid.ts:399

removeCellCssStyles

▸ removeCellCssStyles(key): void

Parameters

Name Type
key string

Returns

void

Defined in

grid/grid.ts:2851

render

▸ render(): void

Returns

void

Defined in

grid/grid.ts:2616

resetActiveCell

▸ resetActiveCell(): void

Returns

void

Defined in

grid/grid.ts:3240

resizeCanvas

▸ resizeCanvas(): void

Returns

void

Defined in

grid/grid.ts:2133

scrollActiveCellIntoView

▸ scrollActiveCellIntoView(): void

Returns

void

Defined in

grid/grid.ts:3540

scrollCellIntoView

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

Parameters

Name Type
row number
cell number
doPaging? boolean

Returns

void

Defined in

grid/grid.ts:3256

scrollColumnIntoView

▸ scrollColumnIntoView(cell): void

Parameters

Name Type
cell number

Returns

void

Defined in

grid/grid.ts:3266

scrollRowIntoView

▸ scrollRowIntoView(row, doPaging?): void

Parameters

Name Type
row number
doPaging? boolean

Returns

void

Defined in

grid/grid.ts:3546

scrollRowToTop

▸ scrollRowToTop(row): void

Parameters

Name Type
row number

Returns

void

Defined in

grid/grid.ts:3573

setActiveCell

▸ setActiveCell(row, cell): void

Parameters

Name Type
row number
cell number

Returns

void

Defined in

grid/grid.ts:3769

setActiveRow

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

Parameters

Name Type
row number
cell number
suppressScrollIntoView? boolean

Returns

void

Defined in

grid/grid.ts:3784

setCellCssStyles

▸ setCellCssStyles(key, hash): void

Parameters

Name Type
key string
hash CellStylesHash

Returns

void

Defined in

grid/grid.ts:2862

setColumnHeaderVisibility

▸ setColumnHeaderVisibility(visible, animate?): void

Parameters

Name Type
visible boolean
animate? boolean

Returns

void

Defined in

grid/grid.ts:1599

setColumns

▸ setColumns(columns): void

Parameters

Name Type
columns Column<TItem>[]

Returns

void

Defined in

grid/grid.ts:1427

setData

▸ setData(newData, scrollToTop?): void

Parameters

Name Type
newData any
scrollToTop? boolean

Returns

void

Defined in

grid/grid.ts:1544

setFooterRowVisibility

▸ setFooterRowVisibility(visible): void

Parameters

Name Type
visible boolean

Returns

void

Defined in

grid/grid.ts:1614

setGroupingPanelVisibility

▸ setGroupingPanelVisibility(visible): void

Parameters

Name Type
visible boolean

Returns

void

Defined in

grid/grid.ts:1629

setHeaderRowVisibility

▸ setHeaderRowVisibility(visible): void

Parameters

Name Type
visible boolean

Returns

void

Defined in

grid/grid.ts:1649

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:1469

setPreHeaderPanelVisibility

▸ setPreHeaderPanelVisibility(visible): void

Parameters

Name Type
visible boolean

Returns

void

Defined in

grid/grid.ts:1645

setSelectedRows

▸ setSelectedRows(rows): void

Parameters

Name Type
rows number[]

Returns

void

Defined in

grid/grid.ts:3964

setSelectionModel

▸ setSelectionModel(model): void

Parameters

Name Type
model SelectionModel

Returns

void

Defined in

grid/grid.ts:423

setSortColumn

▸ setSortColumn(columnId, ascending): void

Parameters

Name Type
columnId string
ascending boolean

Returns

void

Defined in

grid/grid.ts:1283

setSortColumns

▸ setSortColumns(cols): void

Parameters

Name Type
cols ColumnSort[]

Returns

void

Defined in

grid/grid.ts:1287

setTopPanelVisibility

▸ setTopPanelVisibility(visible): void

Parameters

Name Type
visible boolean

Returns

void

Defined in

grid/grid.ts:1584

unregisterPlugin

▸ unregisterPlugin(plugin): void

Parameters

Name Type
plugin IPlugin

Returns

void

Defined in

grid/grid.ts:404

updateCell

▸ updateCell(row, cell): void

Parameters

Name Type
row number
cell number

Returns

void

Defined in

grid/grid.ts:2058

updateColumnHeader

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

Parameters

Name Type
columnId string
title? string
toolTip? string

Returns

void

Defined in

grid/grid.ts:522

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:2156

updateRow

▸ updateRow(row): void

Parameters

Name Type
row number

Returns

void

Defined in

grid/grid.ts:2080