Previous Page Next Page

@serenity-is/sleekgrid / ISleekGrid

Interface: ISleekGrid<TItem>

Defined in: src/core/isleekgrid.ts:12

Extends

Type Parameters

TItem

TItem = any

Properties

onActiveCellChanged

readonly onActiveCellChanged: EventEmitter<ArgsCell>

Defined in: src/core/isleekgrid.ts:13

onActiveCellPositionChanged

readonly onActiveCellPositionChanged: EventEmitter<ArgsGrid>

Defined in: src/core/isleekgrid.ts:14

onAddNewRow

readonly onAddNewRow: EventEmitter<ArgsAddNewRow>

Defined in: src/core/isleekgrid.ts:15

onAfterInit

readonly onAfterInit: EventEmitter<ArgsGrid>

Defined in: src/core/isleekgrid.ts:16

onBeforeCellEditorDestroy

readonly onBeforeCellEditorDestroy: EventEmitter<ArgsEditorDestroy>

Defined in: src/core/isleekgrid.ts:17

onBeforeDestroy

readonly onBeforeDestroy: EventEmitter<ArgsGrid>

Defined in: src/core/isleekgrid.ts:18

onBeforeEditCell

readonly onBeforeEditCell: EventEmitter<ArgsCellEdit>

Defined in: src/core/isleekgrid.ts:19

onBeforeFooterRowCellDestroy

readonly onBeforeFooterRowCellDestroy: EventEmitter<ArgsColumnNode>

Defined in: src/core/isleekgrid.ts:20

onBeforeHeaderCellDestroy

readonly onBeforeHeaderCellDestroy: EventEmitter<ArgsColumnNode>

Defined in: src/core/isleekgrid.ts:21

onBeforeHeaderRowCellDestroy

readonly onBeforeHeaderRowCellDestroy: EventEmitter<ArgsColumnNode>

Defined in: src/core/isleekgrid.ts:22

onCellChange

readonly onCellChange: EventEmitter<ArgsCellChange>

Defined in: src/core/isleekgrid.ts:23

onCellCssStylesChanged

readonly onCellCssStylesChanged: EventEmitter<ArgsCssStyle>

Defined in: src/core/isleekgrid.ts:24

onClick

readonly onClick: EventEmitter<ArgsCell, MouseEvent>

Defined in: src/core/isleekgrid.ts:25

onColumnsReordered

readonly onColumnsReordered: EventEmitter<ArgsGrid>

Defined in: src/core/isleekgrid.ts:26

onColumnsResized

readonly onColumnsResized: EventEmitter<ArgsGrid>

Defined in: src/core/isleekgrid.ts:27

onCompositeEditorChange

onCompositeEditorChange: EventEmitter<any>

Defined in: src/core/editing.ts:28

Inherited from

EditorHost.onCompositeEditorChange

onContextMenu

readonly onContextMenu: EventEmitter<ArgsGrid, UIEvent>

Defined in: src/core/isleekgrid.ts:28

onDblClick

readonly onDblClick: EventEmitter<ArgsCell, MouseEvent>

Defined in: src/core/isleekgrid.ts:29

onDrag

readonly onDrag: EventEmitter<ArgsDrag, UIEvent>

Defined in: src/core/isleekgrid.ts:30

onDragEnd

readonly onDragEnd: EventEmitter<ArgsDrag, UIEvent>

Defined in: src/core/isleekgrid.ts:31

onDragInit

readonly onDragInit: EventEmitter<ArgsDrag, UIEvent>

Defined in: src/core/isleekgrid.ts:32

onDragStart

readonly onDragStart: EventEmitter<ArgsDrag, UIEvent>

Defined in: src/core/isleekgrid.ts:33

onFooterRowCellRendered

readonly onFooterRowCellRendered: EventEmitter<ArgsColumnNode>

Defined in: src/core/isleekgrid.ts:34

onHeaderCellRendered

readonly onHeaderCellRendered: EventEmitter<ArgsColumnNode>

Defined in: src/core/isleekgrid.ts:35

onHeaderClick

readonly onHeaderClick: EventEmitter<ArgsColumn, MouseEvent>

Defined in: src/core/isleekgrid.ts:36

onHeaderContextMenu

readonly onHeaderContextMenu: EventEmitter<ArgsColumn, MouseEvent>

Defined in: src/core/isleekgrid.ts:37

onHeaderMouseEnter

readonly onHeaderMouseEnter: EventEmitter<ArgsColumn, MouseEvent>

Defined in: src/core/isleekgrid.ts:38

onHeaderMouseLeave

readonly onHeaderMouseLeave: EventEmitter<ArgsColumn, MouseEvent>

Defined in: src/core/isleekgrid.ts:39

onHeaderRowCellRendered

readonly onHeaderRowCellRendered: EventEmitter<ArgsColumnNode>

Defined in: src/core/isleekgrid.ts:40

onKeyDown

readonly onKeyDown: EventEmitter<ArgsCell, KeyboardEvent>

Defined in: src/core/isleekgrid.ts:41

onMouseEnter

readonly onMouseEnter: EventEmitter<ArgsGrid, MouseEvent>

Defined in: src/core/isleekgrid.ts:42

onMouseLeave

readonly onMouseLeave: EventEmitter<ArgsGrid, MouseEvent>

Defined in: src/core/isleekgrid.ts:43

onScroll

readonly onScroll: EventEmitter<ArgsScroll>

Defined in: src/core/isleekgrid.ts:44

onSelectedRowsChanged

readonly onSelectedRowsChanged: EventEmitter<ArgsSelectedRowsChange>

Defined in: src/core/isleekgrid.ts:45

onSort

readonly onSort: EventEmitter<ArgsSort>

Defined in: src/core/isleekgrid.ts:46

onValidationError

readonly onValidationError: EventEmitter<ArgsValidationError>

Defined in: src/core/isleekgrid.ts:47

onViewportChanged

readonly onViewportChanged: EventEmitter<ArgsGrid>

Defined in: src/core/isleekgrid.ts:48

render()

render: () => void

Defined in: src/core/isleekgrid.ts:129

Returns

void

resizeCanvas()

resizeCanvas: () => void

Defined in: src/core/isleekgrid.ts:138

Returns

void

Methods

addCellCssStyles()

addCellCssStyles(key, hash): void

Defined in: src/core/isleekgrid.ts:50

Parameters

key

string

hash

CellStylesHash

Returns

void

autosizeColumns()

autosizeColumns(): void

Defined in: src/core/isleekgrid.ts:51

Returns

void

canCellBeActive()

canCellBeActive(row, cell): boolean

Defined in: src/core/isleekgrid.ts:52

Parameters

row

number

cell

number

Returns

boolean

canCellBeSelected()

canCellBeSelected(row, cell): boolean

Defined in: src/core/isleekgrid.ts:53

Parameters

row

number

cell

number

Returns

boolean

clearTextSelection()

clearTextSelection(): void

Defined in: src/core/isleekgrid.ts:54

Returns

void

columnsResized()

columnsResized(invalidate?): void

Defined in: src/core/isleekgrid.ts:55

Parameters

invalidate?

boolean

Returns

void

commitCurrentEdit()

commitCurrentEdit(): boolean

Defined in: src/core/isleekgrid.ts:56

Returns

boolean

destroy()

destroy(): void

Defined in: src/core/isleekgrid.ts:57

Returns

void

editActiveCell()

editActiveCell(editor?): void

Defined in: src/core/isleekgrid.ts:58

Parameters

editor?

EditorClass

Returns

void

flashCell()

flashCell(row, cell, speed?): void

Defined in: src/core/isleekgrid.ts:59

Parameters

row

number

cell

number

speed?

number

Returns

void

focus()

focus(): void

Defined in: src/core/isleekgrid.ts:60

Returns

void

getAbsoluteColumnMinWidth()

getAbsoluteColumnMinWidth(): number

Defined in: src/core/isleekgrid.ts:61

Returns

number

getActiveCanvasNode()

getActiveCanvasNode(e?): HTMLElement

Defined in: src/core/isleekgrid.ts:62

Parameters

e?
target

EventTarget

Returns

HTMLElement

getActiveCell()

getActiveCell(): RowCell

Defined in: src/core/editing.ts:25

Returns

RowCell

Inherited from

EditorHost.getActiveCell

getActiveCellNode()

getActiveCellNode(): HTMLElement

Defined in: src/core/isleekgrid.ts:63

Returns

HTMLElement

getActiveViewportNode()

getActiveViewportNode(e?): HTMLElement

Defined in: src/core/isleekgrid.ts:64

Parameters

e?
target

EventTarget

Returns

HTMLElement

getAllColumns()

getAllColumns(): Column<TItem>[]

Defined in: src/core/isleekgrid.ts:66

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

Returns

Column<TItem>[]

getCanvases()

getCanvases(): any

Defined in: src/core/isleekgrid.ts:67

Returns

any

getCanvasNode()

getCanvasNode(row?, cell?): HTMLElement

Defined in: src/core/isleekgrid.ts:68

Parameters

row?

number

cell?

number

Returns

HTMLElement

getCellCssStyles()

getCellCssStyles(key): CellStylesHash

Defined in: src/core/isleekgrid.ts:69

Parameters

key

string

Returns

CellStylesHash

getCellEditor()

getCellEditor(): Editor

Defined in: src/core/isleekgrid.ts:70

Returns

Editor

getCellFromEvent()

getCellFromEvent(e): object

Defined in: src/core/isleekgrid.ts:71

Parameters

e

any

Returns

object

cell

cell: number

row

row: number

getCellFromNode()

getCellFromNode(cellNode): number

Defined in: src/core/isleekgrid.ts:72

Parameters

cellNode

Element

Returns

number

getCellFromPoint()

getCellFromPoint(x, y): object

Defined in: src/core/isleekgrid.ts:73

Parameters

x

number

y

number

Returns

object

cell

cell: number

row

row: number

getCellNode()

getCellNode(row, cell): HTMLElement

Defined in: src/core/isleekgrid.ts:74

Parameters

row

number

cell

number

Returns

HTMLElement

getCellNodeBox()

getCellNodeBox(row, cell): object

Defined in: src/core/isleekgrid.ts:75

Parameters

row

number

cell

number

Returns

object

bottom

bottom: number

left

left: number

right: number

top

top: number

getColspan()

getColspan(row, cell): number

Defined in: src/core/isleekgrid.ts:76

Parameters

row

number

cell

number

Returns

number

getColumnById()

getColumnById(id): Column<TItem>

Defined in: src/core/isleekgrid.ts:78

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

Parameters

id

string

Returns

Column<TItem>

getColumnFromNode()

getColumnFromNode(cellNode): Column<TItem>

Defined in: src/core/isleekgrid.ts:79

Parameters

cellNode

Element

Returns

Column<TItem>

getColumnIndex()

getColumnIndex(id, opt?): number

Defined in: src/core/isleekgrid.ts:81

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

getColumns()

getColumns(): Column<TItem>[]

Defined in: src/core/isleekgrid.ts:83

Returns only the visible columns in order

Returns

Column<TItem>[]

getContainerNode()

getContainerNode(): HTMLElement

Defined in: src/core/isleekgrid.ts:84

Returns

HTMLElement

getData()

getData(): any

Defined in: src/core/isleekgrid.ts:85

Returns

any

getDataItem()

getDataItem(row): TItem

Defined in: src/core/isleekgrid.ts:86

Parameters

row

number

Returns

TItem

getDataItemValueForColumn()

getDataItemValueForColumn(item, columnDef): any

Defined in: src/core/isleekgrid.ts:87

Parameters

item

TItem

columnDef

Column<TItem>

Returns

any

getDataLength()

getDataLength(): number

Defined in: src/core/isleekgrid.ts:88

Returns

number

getDisplayedScrollbarDimensions()

getDisplayedScrollbarDimensions(): object

Defined in: src/core/isleekgrid.ts:89

Returns

object

height

height: number

width

width: number

getEditController()

getEditController(): EditController

Defined in: src/core/isleekgrid.ts:90

Returns

EditController

getEditorFactory()

getEditorFactory(): EditorFactory

Defined in: src/core/editing.ts:29

Returns

EditorFactory

Inherited from

EditorHost.getEditorFactory

getEditorLock()

getEditorLock(): EditorLock

Defined in: src/core/isleekgrid.ts:91

Returns

EditorLock

getFooterRow()

getFooterRow(): HTMLElement

Defined in: src/core/isleekgrid.ts:92

Returns

HTMLElement

getFooterRowColumn()

getFooterRowColumn(columnIdOrIdx): HTMLElement

Defined in: src/core/isleekgrid.ts:93

Parameters

columnIdOrIdx

string | number

Returns

HTMLElement

getFormatter()

getFormatter(row, column): ColumnFormat<TItem>

Defined in: src/core/isleekgrid.ts:94

Parameters

row

number

column

Column<TItem>

Returns

ColumnFormat<TItem>

getFormatterContext()

getFormatterContext(row, cell): FormatterContext

Defined in: src/core/isleekgrid.ts:95

Parameters

row

number

cell

number

Returns

FormatterContext

getGridPosition()

getGridPosition(): Position

Defined in: src/core/isleekgrid.ts:96

Returns

Position

getGroupingPanel()

getGroupingPanel(): HTMLElement

Defined in: src/core/isleekgrid.ts:97

Returns

HTMLElement

getHeader()

getHeader(): HTMLElement

Defined in: src/core/isleekgrid.ts:98

Returns

HTMLElement

getHeaderColumn()

getHeaderColumn(columnIdOrIdx): HTMLElement

Defined in: src/core/isleekgrid.ts:99

Parameters

columnIdOrIdx

string | number

Returns

HTMLElement

getHeaderRow()

getHeaderRow(): HTMLElement

Defined in: src/core/isleekgrid.ts:100

Returns

HTMLElement

getHeaderRowColumn()

getHeaderRowColumn(columnIdOrIdx): HTMLElement

Defined in: src/core/isleekgrid.ts:101

Parameters

columnIdOrIdx

string | number

Returns

HTMLElement

getLayoutInfo()

getLayoutInfo(): GridLayoutInfo

Defined in: src/core/isleekgrid.ts:102

Returns

GridLayoutInfo

getOptions()

getOptions(): GridOptions<TItem>

Defined in: src/core/isleekgrid.ts:103

Returns

GridOptions<TItem>

getPluginByName()

getPluginByName(name): GridPlugin

Defined in: src/core/grid-plugin.ts:15

Parameters

name

string

Returns

GridPlugin

Inherited from

GridPluginHost.getPluginByName

getPreHeaderPanel()

getPreHeaderPanel(): HTMLElement

Defined in: src/core/isleekgrid.ts:104

Returns

HTMLElement

getRenderedRange()

getRenderedRange(viewportTop?, viewportLeft?): ViewRange

Defined in: src/core/isleekgrid.ts:105

Parameters

viewportTop?

number

viewportLeft?

number

Returns

ViewRange

getRowFromNode()

getRowFromNode(rowNode): number

Defined in: src/core/isleekgrid.ts:106

Parameters

rowNode

Element

Returns

number

getScrollBarDimensions()

getScrollBarDimensions(): object

Defined in: src/core/isleekgrid.ts:107

Returns

object

height

height: number

width

width: number

getSelectedRows()

getSelectedRows(): number[]

Defined in: src/core/isleekgrid.ts:108

Returns

number[]

getSelectionModel()

getSelectionModel(): SelectionModel

Defined in: src/core/isleekgrid.ts:109

Returns

SelectionModel

getSortColumns()

getSortColumns(): ColumnSort[]

Defined in: src/core/isleekgrid.ts:110

Returns

ColumnSort[]

getTopPanel()

getTopPanel(): HTMLElement

Defined in: src/core/isleekgrid.ts:111

Returns

HTMLElement

getTotalsFormatter()

getTotalsFormatter(column): ColumnFormat<TItem>

Defined in: src/core/isleekgrid.ts:112

Parameters

column

Column<TItem>

Returns

ColumnFormat<TItem>

getUID()

getUID(): string

Defined in: src/core/isleekgrid.ts:113

Returns

string

getViewport()

getViewport(viewportTop?, viewportLeft?): ViewRange

Defined in: src/core/isleekgrid.ts:115

Gets the viewport range

Parameters

viewportTop?

number

viewportLeft?

number

Returns

ViewRange

getViewportNode()

getViewportNode(row?, cell?): HTMLElement

Defined in: src/core/isleekgrid.ts:116

Parameters

row?

number

cell?

number

Returns

HTMLElement

getVisibleRange()

getVisibleRange(viewportTop?, viewportLeft?): ViewRange

Defined in: src/core/isleekgrid.ts:117

Parameters

viewportTop?

number

viewportLeft?

number

Returns

ViewRange

gotoCell()

gotoCell(row, cell, forceEdit?): void

Defined in: src/core/isleekgrid.ts:118

Parameters

row

number

cell

number

forceEdit?

boolean

Returns

void

init()

init(): void

Defined in: src/core/isleekgrid.ts:49

Returns

void

invalidate()

invalidate(): void

Defined in: src/core/isleekgrid.ts:119

Returns

void

invalidateAllRows()

invalidateAllRows(): void

Defined in: src/core/isleekgrid.ts:120

Returns

void

invalidateColumns()

invalidateColumns(): void

Defined in: src/core/isleekgrid.ts:125

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

invalidateRow()

invalidateRow(row): void

Defined in: src/core/isleekgrid.ts:126

Parameters

row

number

Returns

void

invalidateRows()

invalidateRows(rows): void

Defined in: src/core/isleekgrid.ts:127

Parameters

rows

number[]

Returns

void

navigate(dir): boolean

Defined in: src/core/cellnavigation.ts:22

Navigate the active cell in the specified direction.

Parameters

dir

CellNavigationDirection

Navigation direction.

Returns

boolean

Whether navigation resulted in a change of active cell.

Inherited from

CellNavigation.navigate

navigateBottom(): void

Defined in: src/core/cellnavigation.ts:4

Returns

void

Inherited from

CellNavigation.navigateBottom

navigateDown(): boolean

Defined in: src/core/cellnavigation.ts:5

Returns

boolean

Inherited from

CellNavigation.navigateDown

navigateLeft(): boolean

Defined in: src/core/cellnavigation.ts:6

Returns

boolean

Inherited from

CellNavigation.navigateLeft

navigateNext(): boolean

Defined in: src/core/cellnavigation.ts:7

Returns

boolean

Inherited from

CellNavigation.navigateNext

navigatePageDown(): void

Defined in: src/core/cellnavigation.ts:8

Returns

void

Inherited from

CellNavigation.navigatePageDown

navigatePageUp(): void

Defined in: src/core/cellnavigation.ts:9

Returns

void

Inherited from

CellNavigation.navigatePageUp

navigatePrev(): boolean

Defined in: src/core/cellnavigation.ts:10

Returns

boolean

Inherited from

CellNavigation.navigatePrev

navigateRight(): boolean

Defined in: src/core/cellnavigation.ts:11

Returns

boolean

Inherited from

CellNavigation.navigateRight

navigateRowEnd(): boolean

Defined in: src/core/cellnavigation.ts:12

Returns

boolean

Inherited from

CellNavigation.navigateRowEnd

navigateRowStart(): boolean

Defined in: src/core/cellnavigation.ts:13

Returns

boolean

Inherited from

CellNavigation.navigateRowStart

navigateTop(): void

Defined in: src/core/cellnavigation.ts:14

Returns

void

Inherited from

CellNavigation.navigateTop

navigateToRow(row): boolean

Defined in: src/core/cellnavigation.ts:15

Parameters

row

number

Returns

boolean

Inherited from

CellNavigation.navigateToRow

navigateUp(): boolean

Defined in: src/core/cellnavigation.ts:16

Returns

boolean

Inherited from

CellNavigation.navigateUp

registerPlugin()

registerPlugin(plugin): void

Defined in: src/core/grid-plugin.ts:16

Parameters

plugin

GridPlugin

Returns

void

Inherited from

GridPluginHost.registerPlugin

removeCellCssStyles()

removeCellCssStyles(key): void

Defined in: src/core/isleekgrid.ts:128

Parameters

key

string

Returns

void

reorderColumns()

reorderColumns(columnIds, opt?): void

Defined in: src/core/isleekgrid.ts:136

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

resetActiveCell()

resetActiveCell(): void

Defined in: src/core/isleekgrid.ts:137

Returns

void

scrollActiveCellIntoView()

scrollActiveCellIntoView(): void

Defined in: src/core/isleekgrid.ts:139

Returns

void

scrollCellIntoView()

scrollCellIntoView(row, cell, doPaging?): void

Defined in: src/core/isleekgrid.ts:140

Parameters

row

number

cell

number

doPaging?

boolean

Returns

void

scrollColumnIntoView()

scrollColumnIntoView(cell): void

Defined in: src/core/isleekgrid.ts:141

Parameters

cell

number

Returns

void

scrollRowIntoView()

scrollRowIntoView(row, doPaging?): void

Defined in: src/core/isleekgrid.ts:142

Parameters

row

number

doPaging?

boolean

Returns

void

scrollRowToTop()

scrollRowToTop(row): void

Defined in: src/core/isleekgrid.ts:143

Parameters

row

number

Returns

void

setActiveCell()

setActiveCell(row, cell): void

Defined in: src/core/isleekgrid.ts:144

Parameters

row

number

cell

number

Returns

void

setActiveRow()

setActiveRow(row, cell, suppressScrollIntoView?): void

Defined in: src/core/isleekgrid.ts:145

Parameters

row

number

cell

number

suppressScrollIntoView?

boolean

Returns

void

setCellCssStyles()

setCellCssStyles(key, hash): void

Defined in: src/core/isleekgrid.ts:146

Parameters

key

string

hash

CellStylesHash

Returns

void

setColumnHeaderVisibility()

setColumnHeaderVisibility(visible): void

Defined in: src/core/isleekgrid.ts:147

Parameters

visible

boolean

Returns

void

setColumns()

setColumns(columns): void

Defined in: src/core/isleekgrid.ts:148

Parameters

columns

Column<TItem>[]

Returns

void

setData()

setData(newData, scrollToTop?): void

Defined in: src/core/isleekgrid.ts:157

Parameters

newData

any

scrollToTop?

boolean

Returns

void

setFooterRowVisibility()

setFooterRowVisibility(visible): void

Defined in: src/core/isleekgrid.ts:158

Parameters

visible

boolean

Returns

void

setGroupingPanelVisibility()

setGroupingPanelVisibility(visible): void

Defined in: src/core/isleekgrid.ts:159

Parameters

visible

boolean

Returns

void

setHeaderRowVisibility()

setHeaderRowVisibility(visible): void

Defined in: src/core/isleekgrid.ts:160

Parameters

visible

boolean

Returns

void

setOptions()

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

Defined in: src/core/isleekgrid.ts:161

Parameters

args

GridOptions<TItem>

suppressRender?

boolean

suppressColumnSet?

boolean

suppressSetOverflow?

boolean

Returns

void

setPreHeaderPanelVisibility()

setPreHeaderPanelVisibility(visible): void

Defined in: src/core/isleekgrid.ts:162

Parameters

visible

boolean

Returns

void

setSelectedRows()

setSelectedRows(rows): void

Defined in: src/core/isleekgrid.ts:163

Parameters

rows

number[]

Returns

void

setSelectionModel()

setSelectionModel(model): void

Defined in: src/core/isleekgrid.ts:164

Parameters

model

SelectionModel

Returns

void

setSortColumn()

setSortColumn(columnId, ascending): void

Defined in: src/core/isleekgrid.ts:165

Parameters

columnId

string

ascending

boolean

Returns

void

setSortColumns()

setSortColumns(cols): void

Defined in: src/core/isleekgrid.ts:166

Parameters

cols

ColumnSort[]

Returns

void

setTopPanelVisibility()

setTopPanelVisibility(visible): void

Defined in: src/core/isleekgrid.ts:167

Parameters

visible

boolean

Returns

void

setVisibleColumns()

setVisibleColumns(columnIds, opt?): void

Defined in: src/core/isleekgrid.ts:156

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

unregisterPlugin()

unregisterPlugin(plugin): void

Defined in: src/core/grid-plugin.ts:17

Parameters

plugin

GridPlugin

Returns

void

Inherited from

GridPluginHost.unregisterPlugin

updateCell()

updateCell(row, cell): void

Defined in: src/core/isleekgrid.ts:168

Parameters

row

number

cell

number

Returns

void

updateColumnHeader()

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

Defined in: src/core/isleekgrid.ts:169

Parameters

columnId

string

title?

string | ColumnFormat<any>

toolTip?

string

Returns

void

updatePagingStatusFromView()

updatePagingStatusFromView(pagingInfo): void

Defined in: src/core/isleekgrid.ts:170

Parameters

pagingInfo
pageNum

number

pageSize

number

totalPages

number

Returns

void

updateRow()

updateRow(row): void

Defined in: src/core/isleekgrid.ts:171

Parameters

row

number

Returns

void

updateRowCount()

updateRowCount(): void

Defined in: src/core/isleekgrid.ts:172

Returns

void