@serenity-is/sleekgrid / LayoutEngine
Interface: LayoutEngine
Table of contents
Properties
Methods
- afterHeaderColumnDrag
- afterRenderRows
- afterSetOptions
- appendCachedRow
- applyColumnWidths
- beforeCleanupAndRenderCells
- bindAncestorScrollEvents
- calcCanvasWidth
- destroy
- getCanvasNodeFor
- getCanvasNodes
- getCanvasWidth
- getFooterRowCols
- getFooterRowColsFor
- getFooterRowColumn
- getFrozenCols
- getFrozenRowOffset
- getFrozenRows
- getHeaderCols
- getHeaderColsFor
- getHeaderColumn
- getHeaderRowCols
- getHeaderRowColsFor
- getHeaderRowColumn
- getRowFromCellNode
- getScrollCanvasY
- getScrollContainerX
- getScrollContainerY
- getTopPanelFor
- getTopPanelNodes
- getViewportNodeFor
- getViewportNodes
- handleScrollH
- handleScrollV
- init
- isFrozenRow
- realScrollHeightChange
- reorderViewColumns
- resizeCanvas
- setOverflow
- setPaneVisibility
- setScroller
- updateCanvasWidth
- updateHeadersWidth
Properties
layoutName
• layoutName: string
Defined in
Methods
afterHeaderColumnDrag
▸ afterHeaderColumnDrag(): void
Returns
void
Defined in
afterRenderRows
▸ afterRenderRows(rendered
): void
Parameters
Name | Type |
---|---|
rendered |
ViewRange |
Returns
void
Defined in
afterSetOptions
▸ afterSetOptions(args
): void
Parameters
Name | Type |
---|---|
args |
GridOptions <any > |
Returns
void
Defined in
appendCachedRow
▸ appendCachedRow(row
, rowNodeL
, rowNodeR
): void
Parameters
Name | Type |
---|---|
row |
number |
rowNodeL |
HTMLElement |
rowNodeR |
HTMLElement |
Returns
void
Defined in
applyColumnWidths
▸ applyColumnWidths(): void
Returns
void
Defined in
beforeCleanupAndRenderCells
▸ beforeCleanupAndRenderCells(rendered
): void
Parameters
Name | Type |
---|---|
rendered |
ViewRange |
Returns
void
Defined in
bindAncestorScrollEvents
▸ bindAncestorScrollEvents(): void
Returns
void
Defined in
calcCanvasWidth
▸ calcCanvasWidth(): number
Returns
number
Defined in
destroy
▸ destroy(): void
Returns
void
Defined in
getCanvasNodeFor
▸ getCanvasNodeFor(cell
, row
): HTMLElement
Parameters
Name | Type |
---|---|
cell |
number |
row |
number |
Returns
HTMLElement
Defined in
getCanvasNodes
▸ getCanvasNodes(): HTMLElement
[]
Returns
HTMLElement
[]
Defined in
getCanvasWidth
▸ getCanvasWidth(): number
Returns
number
Defined in
getFooterRowCols
▸ getFooterRowCols(): HTMLElement
[]
Returns
HTMLElement
[]
Defined in
getFooterRowColsFor
▸ getFooterRowColsFor(cell
): HTMLElement
Parameters
Name | Type |
---|---|
cell |
number |
Returns
HTMLElement
Defined in
getFooterRowColumn
▸ getFooterRowColumn(cell
): HTMLElement
Parameters
Name | Type |
---|---|
cell |
number |
Returns
HTMLElement
Defined in
getFrozenCols
▸ getFrozenCols(): number
Returns
number
Defined in
getFrozenRowOffset
▸ getFrozenRowOffset(row
): number
Parameters
Name | Type |
---|---|
row |
number |
Returns
number
Defined in
getFrozenRows
▸ getFrozenRows(): number
Returns
number
Defined in
getHeaderCols
▸ getHeaderCols(): HTMLElement
[]
Returns
HTMLElement
[]
Defined in
getHeaderColsFor
▸ getHeaderColsFor(cell
): HTMLElement
Parameters
Name | Type |
---|---|
cell |
number |
Returns
HTMLElement
Defined in
getHeaderColumn
▸ getHeaderColumn(cell
): HTMLElement
Parameters
Name | Type |
---|---|
cell |
number |
Returns
HTMLElement
Defined in
getHeaderRowCols
▸ getHeaderRowCols(): HTMLElement
[]
Returns
HTMLElement
[]
Defined in
getHeaderRowColsFor
▸ getHeaderRowColsFor(cell
): HTMLElement
Parameters
Name | Type |
---|---|
cell |
number |
Returns
HTMLElement
Defined in
getHeaderRowColumn
▸ getHeaderRowColumn(cell
): HTMLElement
Parameters
Name | Type |
---|---|
cell |
number |
Returns
HTMLElement
Defined in
getRowFromCellNode
▸ getRowFromCellNode(cellNode
, clientX
, clientY
): number
Parameters
Name | Type |
---|---|
cellNode |
HTMLElement |
clientX |
number |
clientY |
number |
Returns
number
Defined in
getScrollCanvasY
▸ getScrollCanvasY(): HTMLElement
Returns
HTMLElement
Defined in
getScrollContainerX
▸ getScrollContainerX(): HTMLElement
Returns
HTMLElement
Defined in
getScrollContainerY
▸ getScrollContainerY(): HTMLElement
Returns
HTMLElement
Defined in
getTopPanelFor
▸ getTopPanelFor(arg0
): HTMLElement
Parameters
Name | Type |
---|---|
arg0 |
number |
Returns
HTMLElement
Defined in
getTopPanelNodes
▸ getTopPanelNodes(): HTMLElement
[]
Returns
HTMLElement
[]
Defined in
getViewportNodeFor
▸ getViewportNodeFor(cell
, row
): HTMLElement
Parameters
Name | Type |
---|---|
cell |
number |
row |
number |
Returns
HTMLElement
Defined in
getViewportNodes
▸ getViewportNodes(): HTMLElement
[]
Returns
HTMLElement
[]
Defined in
handleScrollH
▸ handleScrollH(): void
Returns
void
Defined in
handleScrollV
▸ handleScrollV(): void
Returns
void
Defined in
init
▸ init(host
): void
Parameters
Name | Type |
---|---|
host |
LayoutHost |
Returns
void
Defined in
isFrozenRow
▸ isFrozenRow(row
): boolean
Parameters
Name | Type |
---|---|
row |
number |
Returns
boolean
Defined in
realScrollHeightChange
▸ realScrollHeightChange(): void
Returns
void
Defined in
reorderViewColumns
▸ reorderViewColumns(viewCols
, options?
): Column
<any
>[]
this might be called before init, chicken egg situation
Parameters
Name | Type |
---|---|
viewCols |
Column <any >[] |
options? |
GridOptions <any > |
Returns
Column
<any
>[]
Defined in
resizeCanvas
▸ resizeCanvas(): void
Returns
void
Defined in
setOverflow
▸ setOverflow(): void
Returns
void
Defined in
setPaneVisibility
▸ setPaneVisibility(): void
Returns
void
Defined in
setScroller
▸ setScroller(): void
Returns
void
Defined in
updateCanvasWidth
▸ updateCanvasWidth(): boolean
Returns
boolean
Defined in
updateHeadersWidth
▸ updateHeadersWidth(): void
Returns
void