Skip to content

@serenity-is/sleekgrid / LayoutEngine

Interface: LayoutEngine

Properties

layoutName

layoutName: string

Defined in

grid/layout.ts:62

Methods

afterHeaderColumnDrag()

afterHeaderColumnDrag(): void

Returns

void

Defined in

grid/layout.ts:26


afterRenderRows()

afterRenderRows(rendered): void

Parameters

rendered

ViewRange

Returns

void

Defined in

grid/layout.ts:30


afterSetOptions()

afterSetOptions(args): void

Parameters

args

GridOptions<any>

Returns

void

Defined in

grid/layout.ts:27


appendCachedRow()

appendCachedRow(row, rowNodeL, rowNodeR): void

Parameters

row

number

rowNodeL

HTMLElement

rowNodeR

HTMLElement

Returns

void

Defined in

grid/layout.ts:25


applyColumnWidths()

applyColumnWidths(): void

Returns

void

Defined in

grid/layout.ts:28


beforeCleanupAndRenderCells()

beforeCleanupAndRenderCells(rendered): void

Parameters

rendered

ViewRange

Returns

void

Defined in

grid/layout.ts:29


bindAncestorScrollEvents()

bindAncestorScrollEvents(): void

Returns

void

Defined in

grid/layout.ts:31


calcCanvasWidth()

calcCanvasWidth(): number

Returns

number

Defined in

grid/layout.ts:32


destroy()

destroy(): void

Returns

void

Defined in

grid/layout.ts:35


getCanvasNodeFor()

getCanvasNodeFor(cell, row): HTMLElement

Parameters

cell

number

row

number

Returns

HTMLElement

Defined in

grid/layout.ts:36


getCanvasNodes()

getCanvasNodes(): HTMLElement[]

Returns

HTMLElement[]

Defined in

grid/layout.ts:37


getCanvasWidth()

getCanvasWidth(): number

Returns

number

Defined in

grid/layout.ts:38


getFooterRowCols()

getFooterRowCols(): HTMLElement[]

Returns

HTMLElement[]

Defined in

grid/layout.ts:40


getFooterRowColsFor()

getFooterRowColsFor(cell): HTMLElement

Parameters

cell

number

Returns

HTMLElement

Defined in

grid/layout.ts:41


getFooterRowColumn()

getFooterRowColumn(cell): HTMLElement

Parameters

cell

number

Returns

HTMLElement

Defined in

grid/layout.ts:42


getFrozenCols()

getFrozenCols(): number

Returns

number

Defined in

grid/layout.ts:43


getFrozenRowOffset()

getFrozenRowOffset(row): number

Parameters

row

number

Returns

number

Defined in

grid/layout.ts:44


getFrozenRows()

getFrozenRows(): number

Returns

number

Defined in

grid/layout.ts:45


getHeaderCols()

getHeaderCols(): HTMLElement[]

Returns

HTMLElement[]

Defined in

grid/layout.ts:46


getHeaderColsFor()

getHeaderColsFor(cell): HTMLElement

Parameters

cell

number

Returns

HTMLElement

Defined in

grid/layout.ts:47


getHeaderColumn()

getHeaderColumn(cell): HTMLElement

Parameters

cell

number

Returns

HTMLElement

Defined in

grid/layout.ts:48


getHeaderRowCols()

getHeaderRowCols(): HTMLElement[]

Returns

HTMLElement[]

Defined in

grid/layout.ts:49


getHeaderRowColsFor()

getHeaderRowColsFor(cell): HTMLElement

Parameters

cell

number

Returns

HTMLElement

Defined in

grid/layout.ts:50


getHeaderRowColumn()

getHeaderRowColumn(cell): HTMLElement

Parameters

cell

number

Returns

HTMLElement

Defined in

grid/layout.ts:51


getRowFromCellNode()

getRowFromCellNode(cellNode, clientX, clientY): number

Parameters

cellNode

HTMLElement

clientX

number

clientY

number

Returns

number

Defined in

grid/layout.ts:39


getScrollCanvasY()

getScrollCanvasY(): HTMLElement

Returns

HTMLElement

Defined in

grid/layout.ts:52


getScrollContainerX()

getScrollContainerX(): HTMLElement

Returns

HTMLElement

Defined in

grid/layout.ts:53


getScrollContainerY()

getScrollContainerY(): HTMLElement

Returns

HTMLElement

Defined in

grid/layout.ts:54


getTopPanelFor()

getTopPanelFor(arg0): HTMLElement

Parameters

arg0

number

Returns

HTMLElement

Defined in

grid/layout.ts:55


getTopPanelNodes()

getTopPanelNodes(): HTMLElement[]

Returns

HTMLElement[]

Defined in

grid/layout.ts:56


getViewportNodeFor()

getViewportNodeFor(cell, row): HTMLElement

Parameters

cell

number

row

number

Returns

HTMLElement

Defined in

grid/layout.ts:57


getViewportNodes()

getViewportNodes(): HTMLElement[]

Returns

HTMLElement[]

Defined in

grid/layout.ts:58


handleScrollH()

handleScrollH(): void

Returns

void

Defined in

grid/layout.ts:59


handleScrollV()

handleScrollV(): void

Returns

void

Defined in

grid/layout.ts:60


init()

init(host): void

Parameters

host

LayoutHost

Returns

void

Defined in

grid/layout.ts:61


isFrozenRow()

isFrozenRow(row): boolean

Parameters

row

number

Returns

boolean

Defined in

grid/layout.ts:34


realScrollHeightChange()

realScrollHeightChange(): void

Returns

void

Defined in

grid/layout.ts:63


reorderViewColumns()

reorderViewColumns(viewCols, options?): Column<any>[]

this might be called before init, chicken egg situation

Parameters

viewCols

Column<any>[]

options?

GridOptions<any>

Returns

Column<any>[]

Defined in

grid/layout.ts:65


resizeCanvas()

resizeCanvas(): void

Returns

void

Defined in

grid/layout.ts:66


setOverflow()

setOverflow(): void

Returns

void

Defined in

grid/layout.ts:69


setPaneVisibility()

setPaneVisibility(): void

Returns

void

Defined in

grid/layout.ts:67


setScroller()

setScroller(): void

Returns

void

Defined in

grid/layout.ts:68


updateCanvasWidth()

updateCanvasWidth(): boolean

Returns

boolean

Defined in

grid/layout.ts:70


updateHeadersWidth()

updateHeadersWidth(): void

Returns

void

Defined in

grid/layout.ts:33