@serenity-is/sleekgrid / SleekGrid

Class: SleekGrid<TItem>

Defined in: src/grid/sleekgrid.tsx:33

Type Parameters

TItem

TItem = any

Implements

• ISleekGrid<TItem>

Constructors

Constructor

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

Defined in: src/grid/sleekgrid.tsx:165

Parameters

container

string | HTMLElement | ArrayLike<HTMLElement>

data

any

columns

Column<TItem>[]

options

GridOptions<TItem>

Returns

SleekGrid<TItem>

Properties

onActiveCellChanged

readonly onActiveCellChanged: EventEmitter<ArgsCell, { }>

Defined in: src/grid/sleekgrid.tsx:126

Implementation of

ISleekGrid.onActiveCellChanged

---

onActiveCellPositionChanged

readonly onActiveCellPositionChanged: EventEmitter<ArgsGrid, { }>

Defined in: src/grid/sleekgrid.tsx:127

Implementation of

ISleekGrid.onActiveCellPositionChanged

---

onAddNewRow

readonly onAddNewRow: EventEmitter<ArgsAddNewRow, { }>

Defined in: src/grid/sleekgrid.tsx:128

Implementation of

ISleekGrid.onAddNewRow

---

onAfterInit

readonly onAfterInit: EventEmitter<ArgsGrid, { }>

Defined in: src/grid/sleekgrid.tsx:130

Implementation of

ISleekGrid.onAfterInit

---

onBeforeCellEditorDestroy

readonly onBeforeCellEditorDestroy: EventEmitter<ArgsEditorDestroy, { }>

Defined in: src/grid/sleekgrid.tsx:131

Implementation of

ISleekGrid.onBeforeCellEditorDestroy

---

onBeforeDestroy

readonly onBeforeDestroy: EventEmitter<ArgsGrid, { }>

Defined in: src/grid/sleekgrid.tsx:132

Implementation of

ISleekGrid.onBeforeDestroy

---

onBeforeEditCell

readonly onBeforeEditCell: EventEmitter<ArgsCellEdit, { }>

Defined in: src/grid/sleekgrid.tsx:133

Implementation of

ISleekGrid.onBeforeEditCell

---

onBeforeFooterRowCellDestroy

readonly onBeforeFooterRowCellDestroy: EventEmitter<ArgsColumnNode, { }>

Defined in: src/grid/sleekgrid.tsx:134

Implementation of

ISleekGrid.onBeforeFooterRowCellDestroy

---

onBeforeHeaderCellDestroy

readonly onBeforeHeaderCellDestroy: EventEmitter<ArgsColumnNode, { }>

Defined in: src/grid/sleekgrid.tsx:135

Implementation of

ISleekGrid.onBeforeHeaderCellDestroy

---

onBeforeHeaderRowCellDestroy

readonly onBeforeHeaderRowCellDestroy: EventEmitter<ArgsColumnNode, { }>

Defined in: src/grid/sleekgrid.tsx:136

Implementation of

ISleekGrid.onBeforeHeaderRowCellDestroy

---

onCellChange

readonly onCellChange: EventEmitter<ArgsCellChange, { }>

Defined in: src/grid/sleekgrid.tsx:137

Implementation of

ISleekGrid.onCellChange

---

onCellCssStylesChanged

readonly onCellCssStylesChanged: EventEmitter<ArgsCssStyle, { }>

Defined in: src/grid/sleekgrid.tsx:138

Implementation of

ISleekGrid.onCellCssStylesChanged

---

onClick

readonly onClick: EventEmitter<ArgsCell, MouseEvent>

Defined in: src/grid/sleekgrid.tsx:139

Implementation of

ISleekGrid.onClick

---

onColumnsReordered

readonly onColumnsReordered: EventEmitter<ArgsGrid, { }>

Defined in: src/grid/sleekgrid.tsx:140

Implementation of

ISleekGrid.onColumnsReordered

---

onColumnsResized

readonly onColumnsResized: EventEmitter<ArgsGrid, { }>

Defined in: src/grid/sleekgrid.tsx:141

Implementation of

ISleekGrid.onColumnsResized

---

onCompositeEditorChange

readonly onCompositeEditorChange: EventEmitter<ArgsGrid, { }>

Defined in: src/grid/sleekgrid.tsx:142

Implementation of

ISleekGrid.onCompositeEditorChange

---

onContextMenu

readonly onContextMenu: EventEmitter<ArgsGrid, UIEvent>

Defined in: src/grid/sleekgrid.tsx:143

Implementation of

ISleekGrid.onContextMenu

---

onDblClick

readonly onDblClick: EventEmitter<ArgsCell, MouseEvent>

Defined in: src/grid/sleekgrid.tsx:144

Implementation of

ISleekGrid.onDblClick

---

onDrag

readonly onDrag: EventEmitter<ArgsDrag, UIEvent>

Defined in: src/grid/sleekgrid.tsx:145

Implementation of

ISleekGrid.onDrag

---

onDragEnd

readonly onDragEnd: EventEmitter<ArgsDrag, UIEvent>

Defined in: src/grid/sleekgrid.tsx:146

Implementation of

ISleekGrid.onDragEnd

---

onDragInit

readonly onDragInit: EventEmitter<ArgsDrag, UIEvent>

Defined in: src/grid/sleekgrid.tsx:147

Implementation of

ISleekGrid.onDragInit

---

onDragStart

readonly onDragStart: EventEmitter<ArgsDrag, UIEvent>

Defined in: src/grid/sleekgrid.tsx:148

Implementation of

ISleekGrid.onDragStart

---

onFooterRowCellRendered

readonly onFooterRowCellRendered: EventEmitter<ArgsColumnNode, { }>

Defined in: src/grid/sleekgrid.tsx:149

Implementation of

ISleekGrid.onFooterRowCellRendered

---

onHeaderCellRendered

readonly onHeaderCellRendered: EventEmitter<ArgsColumnNode, { }>

Defined in: src/grid/sleekgrid.tsx:150

Implementation of

ISleekGrid.onHeaderCellRendered

---

onHeaderClick

readonly onHeaderClick: EventEmitter<ArgsColumn, MouseEvent>

Defined in: src/grid/sleekgrid.tsx:151

Implementation of

ISleekGrid.onHeaderClick

---

onHeaderContextMenu

readonly onHeaderContextMenu: EventEmitter<ArgsColumn, MouseEvent>

Defined in: src/grid/sleekgrid.tsx:152

Implementation of

ISleekGrid.onHeaderContextMenu

---

onHeaderMouseEnter

readonly onHeaderMouseEnter: EventEmitter<ArgsColumn, MouseEvent>

Defined in: src/grid/sleekgrid.tsx:153

Implementation of

ISleekGrid.onHeaderMouseEnter

---

onHeaderMouseLeave

readonly onHeaderMouseLeave: EventEmitter<ArgsColumn, MouseEvent>

Defined in: src/grid/sleekgrid.tsx:154

Implementation of

ISleekGrid.onHeaderMouseLeave

---

onHeaderRowCellRendered

readonly onHeaderRowCellRendered: EventEmitter<ArgsColumnNode, { }>

Defined in: src/grid/sleekgrid.tsx:155

Implementation of

ISleekGrid.onHeaderRowCellRendered

---

onKeyDown

readonly onKeyDown: EventEmitter<ArgsCell, KeyboardEvent>

Defined in: src/grid/sleekgrid.tsx:156

Implementation of

ISleekGrid.onKeyDown

---

onMouseEnter

readonly onMouseEnter: EventEmitter<ArgsGrid, MouseEvent>

Defined in: src/grid/sleekgrid.tsx:157

Implementation of

ISleekGrid.onMouseEnter

---

onMouseLeave

readonly onMouseLeave: EventEmitter<ArgsGrid, MouseEvent>

Defined in: src/grid/sleekgrid.tsx:158

Implementation of

ISleekGrid.onMouseLeave

---

onScroll

readonly onScroll: EventEmitter<ArgsScroll, { }>

Defined in: src/grid/sleekgrid.tsx:159

Implementation of

ISleekGrid.onScroll

---

onSelectedRowsChanged

readonly onSelectedRowsChanged: EventEmitter<ArgsSelectedRowsChange, { }>

Defined in: src/grid/sleekgrid.tsx:160

Implementation of

ISleekGrid.onSelectedRowsChanged

---

onSort

readonly onSort: EventEmitter<ArgsSort, { }>

Defined in: src/grid/sleekgrid.tsx:161

Implementation of

ISleekGrid.onSort

---

onValidationError

readonly onValidationError: EventEmitter<ArgsValidationError, { }>

Defined in: src/grid/sleekgrid.tsx:162

Implementation of

ISleekGrid.onValidationError

---

onViewportChanged

readonly onViewportChanged: EventEmitter<ArgsGrid, { }>

Defined in: src/grid/sleekgrid.tsx:163

Implementation of

ISleekGrid.onViewportChanged

---

onAfterInit

readonly static onAfterInit: EventEmitter<ArgsGrid, { }>

Defined in: src/grid/sleekgrid.tsx:129

Methods

addCellCssStyles()

addCellCssStyles(key, hash): void

Defined in: src/grid/sleekgrid.tsx:2815

Parameters

key

string

hash

CellStylesHash

Returns

void

Implementation of

ISleekGrid.addCellCssStyles

---

autosizeColumns()

autosizeColumns(): void

Defined in: src/grid/sleekgrid.tsx:1203

Returns

void

Implementation of

ISleekGrid.autosizeColumns

---

canCellBeActive()

canCellBeActive(row, cell): boolean

Defined in: src/grid/sleekgrid.tsx:3815

Parameters

row

number

cell

number

Returns

boolean

Implementation of

ISleekGrid.canCellBeActive

---

canCellBeSelected()

canCellBeSelected(row, cell): boolean

Defined in: src/grid/sleekgrid.tsx:3838

Parameters

row

number

cell

number

Returns

boolean

Implementation of

ISleekGrid.canCellBeSelected

---

clearTextSelection()

clearTextSelection(): void

Defined in: src/grid/sleekgrid.tsx:3355

Returns

void

Implementation of

ISleekGrid.clearTextSelection

---

columnsResized()

columnsResized(invalidate): void

Defined in: src/grid/sleekgrid.tsx:1046

Parameters

invalidate

boolean = true

Returns

void

Implementation of

ISleekGrid.columnsResized

---

commitCurrentEdit()

commitCurrentEdit(): boolean

Defined in: src/grid/sleekgrid.tsx:3883

Returns

boolean

Implementation of

ISleekGrid.commitCurrentEdit

---

destroy()

destroy(): void

Defined in: src/grid/sleekgrid.tsx:1120

Returns

void

Implementation of

ISleekGrid.destroy

---

editActiveCell()

editActiveCell(editor?): void

Defined in: src/grid/sleekgrid.tsx:3412

Parameters

editor?

EditorClass

Returns

void

Implementation of

ISleekGrid.editActiveCell

---

flashCell()

flashCell(row, cell, speed?): void

Defined in: src/grid/sleekgrid.tsx:2850

Parameters

row

number

cell

number

speed?

number

Returns

void

Implementation of

ISleekGrid.flashCell

---

focus()

focus(): void

Defined in: src/grid/sleekgrid.tsx:3245

Returns

void

Implementation of

ISleekGrid.focus

---

getAbsoluteColumnMinWidth()

getAbsoluteColumnMinWidth(): number

Defined in: src/grid/sleekgrid.tsx:495

Returns

number

Implementation of

ISleekGrid.getAbsoluteColumnMinWidth

---

getActiveCanvasNode()

getActiveCanvasNode(e?): HTMLElement

Defined in: src/grid/sleekgrid.tsx:547

Parameters

e?

target

EventTarget

Returns

HTMLElement

Implementation of

ISleekGrid.getActiveCanvasNode

---

getActiveCell()

getActiveCell(): RowCell

Defined in: src/grid/sleekgrid.tsx:3536

Returns

RowCell

Implementation of

ISleekGrid.getActiveCell

---

getActiveCellNode()

getActiveCellNode(): HTMLElement

Defined in: src/grid/sleekgrid.tsx:3544

Returns

HTMLElement

Implementation of

ISleekGrid.getActiveCellNode

---

getActiveViewportNode()

getActiveViewportNode(e?): HTMLElement

Defined in: src/grid/sleekgrid.tsx:566

Parameters

e?

target

EventTarget

Returns

HTMLElement

Implementation of

ISleekGrid.getActiveViewportNode

---

getAllColumns()

getAllColumns(): Column<TItem>[]

Defined in: src/grid/sleekgrid.tsx:1328

Returns all columns in the grid, including hidden ones, the order might not match visible columns due to pinning, ordering etc.

Returns

Column<TItem>[]

Implementation of

ISleekGrid.getAllColumns

---

getCanvases()

getCanvases(): any

Defined in: src/grid/sleekgrid.tsx:542

Returns

any

Implementation of

ISleekGrid.getCanvases

---

getCanvasNode()

getCanvasNode(row?, cell?): HTMLElement

Defined in: src/grid/sleekgrid.tsx:529

Parameters

row?

number

cell?

number

Returns

HTMLElement

Implementation of

ISleekGrid.getCanvasNode

---

getCellCssStyles()

getCellCssStyles(key): CellStylesHash

Defined in: src/grid/sleekgrid.tsx:2846

Parameters

key

string

Returns

CellStylesHash

Implementation of

ISleekGrid.getCellCssStyles

---

getCellEditor()

getCellEditor(): Editor

Defined in: src/grid/sleekgrid.tsx:3532

Returns

Editor

Implementation of

ISleekGrid.getCellEditor

---

getCellFromEvent()

getCellFromEvent(e): object

Defined in: src/grid/sleekgrid.tsx:3188

Parameters

e

any

Returns

object

cell

cell: number

row

row: number

Implementation of

ISleekGrid.getCellFromEvent

---

getCellFromNode()

getCellFromNode(cellNode): number

Defined in: src/grid/sleekgrid.tsx:3147

Parameters

cellNode

Element

Returns

number

Implementation of

ISleekGrid.getCellFromNode

---

getCellFromPoint()

getCellFromPoint(x, y): object

Defined in: src/grid/sleekgrid.tsx:3130

Parameters

x

number

y

number

Returns

object

cell

cell: number

row

row: number

Implementation of

ISleekGrid.getCellFromPoint

---

getCellNode()

getCellNode(row, cell): HTMLElement

Defined in: src/grid/sleekgrid.tsx:3780

Parameters

row

number

cell

number

Returns

HTMLElement

Implementation of

ISleekGrid.getCellNode

---

getCellNodeBox()

getCellNodeBox(row, cell): object

Defined in: src/grid/sleekgrid.tsx:3208

Parameters

row

number

cell

number

Returns

object

bottom

bottom: number

left

left: number

right

right: number

top

top: number

Implementation of

ISleekGrid.getCellNodeBox

---

getColspan()

getColspan(row, cell): number

Defined in: src/grid/sleekgrid.tsx:3669

Parameters

row

number

cell

number

Returns

number

Implementation of

ISleekGrid.getColspan

---

getColumnById()

getColumnById(id): Column<TItem>

Defined in: src/grid/sleekgrid.tsx:1195

Gets a column by its ID. May also return hidden columns.

Parameters

id

string

Returns

Column<TItem>

Implementation of

ISleekGrid.getColumnById

---

getColumnFromNode()

getColumnFromNode(cellNode): Column<TItem>

Defined in: src/grid/sleekgrid.tsx:3163

Parameters

cellNode

Element

Returns

Column<TItem>

Implementation of

ISleekGrid.getColumnFromNode

---

getColumnIndex()

getColumnIndex(id, opt?): number

Defined in: src/grid/sleekgrid.tsx:1199

Returns a column's index in the visible columns list by its column ID. If opt.inAll is true, it will return index in all columns.

Parameters

id

string

opt?

inAll?

boolean

Returns

number

Implementation of

ISleekGrid.getColumnIndex

---

getColumns()

getColumns(): Column<TItem>[]

Defined in: src/grid/sleekgrid.tsx:1332

Returns only the visible columns in order

Returns

Column<TItem>[]

Implementation of

ISleekGrid.getColumns

---

getContainerNode()

getContainerNode(): HTMLElement

Defined in: src/grid/sleekgrid.tsx:1663

Returns

HTMLElement

Implementation of

ISleekGrid.getContainerNode

---

getData()

getData(): any

Defined in: src/grid/sleekgrid.tsx:1594

Returns

any

Implementation of

ISleekGrid.getData

---

getDataItem()

getDataItem(row): TItem

Defined in: src/grid/sleekgrid.tsx:1611

Parameters

row

number

Returns

TItem

Implementation of

ISleekGrid.getDataItem

---

getDataItemValueForColumn()

getDataItemValueForColumn(item, columnDef): any

Defined in: src/grid/sleekgrid.tsx:1816

Parameters

item

TItem

columnDef

Column<TItem>

Returns

any

Implementation of

ISleekGrid.getDataItemValueForColumn

---

getDataLength()

getDataLength(): number

Defined in: src/grid/sleekgrid.tsx:1598

Returns

number

Implementation of

ISleekGrid.getDataLength

---

getDisplayedScrollbarDimensions()

getDisplayedScrollbarDimensions(): object

Defined in: src/grid/sleekgrid.tsx:488

Returns

object

height

height: number

width

width: number

Implementation of

ISleekGrid.getDisplayedScrollbarDimensions

---

getEditController()

getEditController(): EditController

Defined in: src/grid/sleekgrid.tsx:1191

Returns

EditController

Implementation of

ISleekGrid.getEditController

---

getEditorFactory()

getEditorFactory(): EditorFactory

Defined in: src/grid/sleekgrid.tsx:1183

Returns

EditorFactory

Implementation of

ISleekGrid.getEditorFactory

---

getEditorLock()

getEditorLock(): EditorLock

Defined in: src/grid/sleekgrid.tsx:1187

Returns

EditorLock

Implementation of

ISleekGrid.getEditorLock

---

getFooterRow()

getFooterRow(): HTMLElement

Defined in: src/grid/sleekgrid.tsx:785

Returns

HTMLElement

Implementation of

ISleekGrid.getFooterRow

---

getFooterRowColumn()

getFooterRowColumn(cell): HTMLElement

Defined in: src/grid/sleekgrid.tsx:789

Parameters

cell

string | number

Returns

HTMLElement

Implementation of

ISleekGrid.getFooterRowColumn

---

getFormatter()

getFormatter(row, column): ColumnFormat<TItem>

Defined in: src/grid/sleekgrid.tsx:1718

Parameters

row

number

column

Column<TItem>

Returns

ColumnFormat<TItem>

Implementation of

ISleekGrid.getFormatter

---

getFormatterContext()

getFormatterContext(row, cell): FormatterContext

Defined in: src/grid/sleekgrid.tsx:1771

Parameters

row

number

cell

number

Returns

FormatterContext

Implementation of

ISleekGrid.getFormatterContext

---

getGridPosition()

getGridPosition(): Position

Defined in: src/grid/sleekgrid.tsx:3505

Returns

Position

Implementation of

ISleekGrid.getGridPosition

---

getGroupingPanel()

getGroupingPanel(): HTMLElement

Defined in: src/grid/sleekgrid.tsx:762

Returns

HTMLElement

Implementation of

ISleekGrid.getGroupingPanel

---

getHeader()

getHeader(): HTMLElement

Defined in: src/grid/sleekgrid.tsx:747

Returns

HTMLElement

Implementation of

ISleekGrid.getHeader

---

getHeaderColumn()

getHeaderColumn(cell): HTMLElement

Defined in: src/grid/sleekgrid.tsx:751

Parameters

cell

string | number

Returns

HTMLElement

Implementation of

ISleekGrid.getHeaderColumn

---

getHeaderRow()

getHeaderRow(): HTMLElement

Defined in: src/grid/sleekgrid.tsx:770

Returns

HTMLElement

Implementation of

ISleekGrid.getHeaderRow

---

getHeaderRowColumn()

getHeaderRowColumn(cell): HTMLElement

Defined in: src/grid/sleekgrid.tsx:774

Parameters

cell

string | number

Returns

HTMLElement

Implementation of

ISleekGrid.getHeaderRowColumn

---

getLayoutInfo()

getLayoutInfo(): GridLayoutInfo

Defined in: src/grid/sleekgrid.tsx:514

Returns

GridLayoutInfo

Implementation of

ISleekGrid.getLayoutInfo

---

getOptions()

getOptions(): GridOptions<TItem>

Defined in: src/grid/sleekgrid.tsx:1491

Returns

GridOptions<TItem>

Implementation of

ISleekGrid.getOptions

---

getPluginByName()

getPluginByName(name): GridPlugin

Defined in: src/grid/sleekgrid.tsx:459

Parameters

name

string

Returns

GridPlugin

Implementation of

ISleekGrid.getPluginByName

---

getPreHeaderPanel()

getPreHeaderPanel(): HTMLElement

Defined in: src/grid/sleekgrid.tsx:766

Returns

HTMLElement

Implementation of

ISleekGrid.getPreHeaderPanel

---

getRenderedRange()

getRenderedRange(viewportTop?, viewportLeft?): ViewRange

Defined in: src/grid/sleekgrid.tsx:2172

Parameters

viewportTop?

number

viewportLeft?

number

Returns

ViewRange

Implementation of

ISleekGrid.getRenderedRange

---

getRowFromNode()

getRowFromNode(rowNode): number

Defined in: src/grid/sleekgrid.tsx:3174

Parameters

rowNode

Element

Returns

number

Implementation of

ISleekGrid.getRowFromNode

---

getScrollBarDimensions()

getScrollBarDimensions(): object

Defined in: src/grid/sleekgrid.tsx:484

Returns

object

height

height: number

width

width: number

Implementation of

ISleekGrid.getScrollBarDimensions

---

getScrollContainerX()

getScrollContainerX(): HTMLElement

Defined in: src/grid/sleekgrid.tsx:2046

Returns

HTMLElement

---

getScrollContainerY()

getScrollContainerY(): HTMLElement

Defined in: src/grid/sleekgrid.tsx:2050

Returns

HTMLElement

---

getSelectedRows()

getSelectedRows(): number[]

Defined in: src/grid/sleekgrid.tsx:3976

Returns

number[]

Implementation of

ISleekGrid.getSelectedRows

---

getSelectionModel()

getSelectionModel(): SelectionModel

Defined in: src/grid/sleekgrid.tsx:499

Returns

SelectionModel

Implementation of

ISleekGrid.getSelectionModel

---

getSortColumns()

getSortColumns(): ColumnSort[]

Defined in: src/grid/sleekgrid.tsx:1267

Returns

ColumnSort[]

Implementation of

ISleekGrid.getSortColumns

---

getTopPanel()

getTopPanel(): HTMLElement

Defined in: src/grid/sleekgrid.tsx:1619

Returns

HTMLElement

Implementation of

ISleekGrid.getTopPanel

---

getTotalsFormatter()

getTotalsFormatter(column): ColumnFormat<TItem>

Defined in: src/grid/sleekgrid.tsx:1784

Parameters

column

Column<TItem>

Returns

ColumnFormat<TItem>

Implementation of

ISleekGrid.getTotalsFormatter

---

getUID()

getUID(): string

Defined in: src/grid/sleekgrid.tsx:1667

Returns

string

Implementation of

ISleekGrid.getUID

---

getViewport()

getViewport(viewportTop?, viewportLeft?): ViewRange

Defined in: src/grid/sleekgrid.tsx:2150

Gets the viewport range

Parameters

viewportTop?

number

viewportLeft?

number

Returns

ViewRange

Implementation of

ISleekGrid.getViewport

---

getViewportNode()

getViewportNode(row?, cell?): HTMLElement

Defined in: src/grid/sleekgrid.tsx:554

Parameters

row?

number

cell?

number

Returns

HTMLElement

Implementation of

ISleekGrid.getViewportNode

---

getVisibleRange()

getVisibleRange(viewportTop?, viewportLeft?): ViewRange

Defined in: src/grid/sleekgrid.tsx:2154

Parameters

viewportTop?

number

viewportLeft?

number

Returns

ViewRange

Implementation of

ISleekGrid.getVisibleRange

---

gotoCell()

gotoCell(row, cell, forceEdit?): void

Defined in: src/grid/sleekgrid.tsx:3857

Parameters

row

number

cell

number

forceEdit?

boolean

Returns

void

Implementation of

ISleekGrid.gotoCell

---

init()

init(): void

Defined in: src/grid/sleekgrid.tsx:327

Returns

void

Implementation of

ISleekGrid.init

---

invalidate()

invalidate(): void

Defined in: src/grid/sleekgrid.tsx:1834

Returns

void

Implementation of

ISleekGrid.invalidate

---

invalidateAllRows()

invalidateAllRows(): void

Defined in: src/grid/sleekgrid.tsx:1841

Returns

void

Implementation of

ISleekGrid.invalidateAllRows

---

invalidateColumns()

invalidateColumns(): void

Defined in: src/grid/sleekgrid.tsx:1470

Invalidates various elements after properties of columns have changed. Call this if you change columns properties that don't require a full setColumns call (e.g. width, name, visible etc.)

Returns

void

Implementation of

ISleekGrid.invalidateColumns

---

invalidateRow()

invalidateRow(row): void

Defined in: src/grid/sleekgrid.tsx:1930

Parameters

row

number

Returns

void

Implementation of

ISleekGrid.invalidateRow

---

invalidateRows()

invalidateRows(rows): void

Defined in: src/grid/sleekgrid.tsx:1912

Parameters

rows

number[]

Returns

void

Implementation of

ISleekGrid.invalidateRows

---

navigate()

navigate(dir): boolean

Defined in: src/grid/sleekgrid.tsx:3731

Navigate the active cell in the specified direction.

Parameters

dir

string

Navigation direction.

Returns

boolean

Whether navigation resulted in a change of active cell.

Implementation of

ISleekGrid.navigate

---

navigateBottom()

navigateBottom(): void

Defined in: src/grid/sleekgrid.tsx:3632

Returns

void

Implementation of

ISleekGrid.navigateBottom

---

navigateDown()

navigateDown(): boolean

Defined in: src/grid/sleekgrid.tsx:3695

Returns

boolean

Implementation of

ISleekGrid.navigateDown

---

navigateLeft()

navigateLeft(): boolean

Defined in: src/grid/sleekgrid.tsx:3691

Returns

boolean

Implementation of

ISleekGrid.navigateLeft

---

navigateNext()

navigateNext(): boolean

Defined in: src/grid/sleekgrid.tsx:3703

Returns

boolean

Implementation of

ISleekGrid.navigateNext

---

navigatePageDown()

navigatePageDown(): void

Defined in: src/grid/sleekgrid.tsx:3620

Returns

void

Implementation of

ISleekGrid.navigatePageDown

---

navigatePageUp()

navigatePageUp(): void

Defined in: src/grid/sleekgrid.tsx:3624

Returns

void

Implementation of

ISleekGrid.navigatePageUp

---

navigatePrev()

navigatePrev(): boolean

Defined in: src/grid/sleekgrid.tsx:3707

Returns

boolean

Implementation of

ISleekGrid.navigatePrev

---

navigateRight()

navigateRight(): boolean

Defined in: src/grid/sleekgrid.tsx:3687

Returns

boolean

Implementation of

ISleekGrid.navigateRight

---

navigateRowEnd()

navigateRowEnd(): boolean

Defined in: src/grid/sleekgrid.tsx:3715

Returns

boolean

Implementation of

ISleekGrid.navigateRowEnd

---

navigateRowStart()

navigateRowStart(): boolean

Defined in: src/grid/sleekgrid.tsx:3711

Returns

boolean

Implementation of

ISleekGrid.navigateRowStart

---

navigateTop()

navigateTop(): void

Defined in: src/grid/sleekgrid.tsx:3628

Returns

void

Implementation of

ISleekGrid.navigateTop

---

navigateToRow()

navigateToRow(row): boolean

Defined in: src/grid/sleekgrid.tsx:3636

Parameters

row

number

Returns

boolean

Implementation of

ISleekGrid.navigateToRow

---

navigateUp()

navigateUp(): boolean

Defined in: src/grid/sleekgrid.tsx:3699

Returns

boolean

Implementation of

ISleekGrid.navigateUp

---

registerPlugin()

registerPlugin(plugin): void

Defined in: src/grid/sleekgrid.tsx:442

Parameters

plugin

GridPlugin

Returns

void

Implementation of

ISleekGrid.registerPlugin

---

removeCellCssStyles()

removeCellCssStyles(key): void

Defined in: src/grid/sleekgrid.tsx:2826

Parameters

key

string

Returns

void

Implementation of

ISleekGrid.removeCellCssStyles

---

render()

render(): void

Defined in: src/grid/sleekgrid.tsx:2549

Returns

void

Implementation of

ISleekGrid.render

---

reorderColumns()

reorderColumns(columnIds, opt?): void

Defined in: src/grid/sleekgrid.tsx:1447

Reorders columns based on their IDs and notifies onColumnsReordered by default.

Parameters

columnIds

string[]

opt?

Whether to notify onColumnsReordered (default true). If setVisible is provided, it will also set visibility based on that. This function is used by column picker and other plugins to reorder columns and set visibility in one shot.

notify?

boolean

setVisible?

string[]

Returns

void

Implementation of

ISleekGrid.reorderColumns

---

resetActiveCell()

resetActiveCell(): void

Defined in: src/grid/sleekgrid.tsx:3241

Returns

void

Implementation of

ISleekGrid.resetActiveCell

---

resizeCanvas()

resizeCanvas(): void

Defined in: src/grid/sleekgrid.tsx:2018

Returns

void

Implementation of

ISleekGrid.resizeCanvas

---

scrollActiveCellIntoView()

scrollActiveCellIntoView(): void

Defined in: src/grid/sleekgrid.tsx:3548

Returns

void

Implementation of

ISleekGrid.scrollActiveCellIntoView

---

scrollCellIntoView()

scrollCellIntoView(row, cell, doPaging?): void

Defined in: src/grid/sleekgrid.tsx:3257

Parameters

row

number

cell

number

doPaging?

boolean

Returns

void

Implementation of

ISleekGrid.scrollCellIntoView

---

scrollColumnIntoView()

scrollColumnIntoView(cell): void

Defined in: src/grid/sleekgrid.tsx:3268

Parameters

cell

number

Returns

void

Implementation of

ISleekGrid.scrollColumnIntoView

---

scrollRowIntoView()

scrollRowIntoView(row, doPaging?): void

Defined in: src/grid/sleekgrid.tsx:3554

Parameters

row

number

doPaging?

boolean

Returns

void

Implementation of

ISleekGrid.scrollRowIntoView

---

scrollRowToTop()

scrollRowToTop(row): void

Defined in: src/grid/sleekgrid.tsx:3582

Parameters

row

number

Returns

void

Implementation of

ISleekGrid.scrollRowToTop

---

setActiveCell()

setActiveCell(row, cell): void

Defined in: src/grid/sleekgrid.tsx:3788

Parameters

row

number

cell

number

Returns

void

Implementation of

ISleekGrid.setActiveCell

---

setActiveRow()

setActiveRow(row, cell, suppressScrollIntoView?): void

Defined in: src/grid/sleekgrid.tsx:3803

Parameters

row

number

cell

number

suppressScrollIntoView?

boolean

Returns

void

Implementation of

ISleekGrid.setActiveRow

---

setCellCssStyles()

setCellCssStyles(key, hash): void

Defined in: src/grid/sleekgrid.tsx:2837

Parameters

key

string

hash

CellStylesHash

Returns

void

Implementation of

ISleekGrid.setCellCssStyles

---

setColumnHeaderVisibility()

setColumnHeaderVisibility(visible): void

Defined in: src/grid/sleekgrid.tsx:1630

Parameters

visible

boolean

Returns

void

Implementation of

ISleekGrid.setColumnHeaderVisibility

---

setColumns()

setColumns(columns): void

Defined in: src/grid/sleekgrid.tsx:1414

Parameters

columns

Column<TItem>[]

Returns

void

Implementation of

ISleekGrid.setColumns

---

setData()

setData(newData, scrollToTop?): void

Defined in: src/grid/sleekgrid.tsx:1583

Parameters

newData

any

scrollToTop?

boolean

Returns

void

Implementation of

ISleekGrid.setData

---

setFooterRowVisibility()

setFooterRowVisibility(visible): void

Defined in: src/grid/sleekgrid.tsx:1637

Parameters

visible

boolean

Returns

void

Implementation of

ISleekGrid.setFooterRowVisibility

---

setGroupingPanelVisibility()

setGroupingPanelVisibility(visible): void

Defined in: src/grid/sleekgrid.tsx:1644

Parameters

visible

boolean

Returns

void

Implementation of

ISleekGrid.setGroupingPanelVisibility

---

setHeaderRowVisibility()

setHeaderRowVisibility(visible): void

Defined in: src/grid/sleekgrid.tsx:1656

Parameters

visible

boolean

Returns

void

Implementation of

ISleekGrid.setHeaderRowVisibility

---

setOptions()

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

Defined in: src/grid/sleekgrid.tsx:1495

Parameters

args

GridOptions<TItem>

suppressRender?

boolean

suppressColumnSet?

boolean

suppressSetOverflow?

boolean

Returns

void

Implementation of

ISleekGrid.setOptions

---

setPreHeaderPanelVisibility()

setPreHeaderPanelVisibility(visible): void

Defined in: src/grid/sleekgrid.tsx:1652

Parameters

visible

boolean

Returns

void

Implementation of

ISleekGrid.setPreHeaderPanelVisibility

---

setSelectedRows()

setSelectedRows(rows): void

Defined in: src/grid/sleekgrid.tsx:3983

Parameters

rows

number[]

Returns

void

Implementation of

ISleekGrid.setSelectedRows

---

setSelectionModel()

setSelectionModel(model): void

Defined in: src/grid/sleekgrid.tsx:466

Parameters

model

SelectionModel

Returns

void

Implementation of

ISleekGrid.setSelectionModel

---

setSortColumn()

setSortColumn(columnId, ascending): void

Defined in: src/grid/sleekgrid.tsx:1234

Parameters

columnId

string

ascending

boolean

Returns

void

Implementation of

ISleekGrid.setSortColumn

---

setSortColumns()

setSortColumns(cols): void

Defined in: src/grid/sleekgrid.tsx:1238

Parameters

cols

ColumnSort[]

Returns

void

Implementation of

ISleekGrid.setSortColumns

---

setTopPanelVisibility()

setTopPanelVisibility(visible): void

Defined in: src/grid/sleekgrid.tsx:1623

Parameters

visible

boolean

Returns

void

Implementation of

ISleekGrid.setTopPanelVisibility

---

setVisibleColumns()

setVisibleColumns(columnIds, opt?): void

Defined in: src/grid/sleekgrid.tsx:1457

Sets the visible columns based on their IDs and reorders them to provided order unless specified otherwise.

Parameters

columnIds

string[]

The IDs of the columns to be made visible.

opt?

Whether to reorder the visible columns based on the provided IDs (default true), and notify onColumnsReordered (default true).

notify?

boolean

reorder?

boolean

Returns

void

Implementation of

ISleekGrid.setVisibleColumns

---

unregisterPlugin()

unregisterPlugin(plugin): void

Defined in: src/grid/sleekgrid.tsx:447

Parameters

plugin

GridPlugin

Returns

void

Implementation of

ISleekGrid.unregisterPlugin

---

updateCell()

updateCell(row, cell): void

Defined in: src/grid/sleekgrid.tsx:1934

Parameters

row

number

cell

number

Returns

void

Implementation of

ISleekGrid.updateCell

---

updateColumnHeader()

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

Defined in: src/grid/sleekgrid.tsx:694

Parameters

columnId

string

title?

string | ColumnFormat<any>

toolTip?

string

Returns

void

Implementation of

ISleekGrid.updateColumnHeader

---

updatePagingStatusFromView()

updatePagingStatusFromView(pagingInfo): void

Defined in: src/grid/sleekgrid.tsx:2041

Parameters

pagingInfo

pageNum

number

pageSize

number

totalPages

number

Returns

void

Implementation of

ISleekGrid.updatePagingStatusFromView

---

updateRow()

updateRow(row): void

Defined in: src/grid/sleekgrid.tsx:1960

Parameters

row

number

Returns

void

Implementation of

ISleekGrid.updateRow

---

updateRowCount()

updateRowCount(): void

Defined in: src/grid/sleekgrid.tsx:2054

Returns

void

Implementation of

ISleekGrid.updateRowCount