Interface: LayoutHost

Defined in: src/layouts/layout-host.ts:11

Minimal host surface exposed to LayoutEngine implementations. Narrower than ISleekGrid; only what layouts need is exposed.

Extends

Pick<ISleekGrid, "getAllColumns" | "getColumns" | "getOptions" | "getContainerNode" | "getDataLength" | "onAfterInit">.GridPluginHost

Properties

onAfterInit

readonly onAfterInit: EventEmitter<ArgsGrid>

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

Fired once after init() completes. ArgsGrid payload.

Inherited from

Pick.onAfterInit

refs

readonly refs: GridLayoutRefs

Defined in: src/layouts/layout-host.ts:29

Mutable refs tracking per-band DOM nodes and pinning/frozen state.

Methods

getAllColumns()

getAllColumns(): Column<any>[]

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

Returns all columns in the grid, including hidden ones; order may differ from visible columns due to pinning/reordering.

Returns

Column<any>[]

Inherited from

Pick.getAllColumns

getColumns()

getColumns(): Column<any>[]

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

Returns only the visible columns in display order.

Returns

Column<any>[]

Inherited from

Pick.getColumns

getContainerNode()

getContainerNode(): HTMLElement

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

Returns the root container element of the grid.

Returns

HTMLElement

Inherited from

Pick.getContainerNode

getDataLength()

getDataLength(): number

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

Returns the number of rows in the grid's data source/view.

Returns

number

Inherited from

Pick.getDataLength

getOptions()

getOptions(): GridOptions<any>

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

Returns the current grid options.

Returns

GridOptions<any>

Inherited from

Pick.getOptions

getPluginByName()

getPluginByName(name): GridPlugin

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

Retrieves a plugin by its GridPlugin.pluginName.

Parameters

name

string

Plugin name to look up.

Returns

GridPlugin

The plugin instance, or null/undefined when not found.

Inherited from

GridPluginHost.getPluginByName

getSignals()

getSignals(): GridSignals

Defined in: src/layouts/layout-host.ts:17

Returns the shared reactive signals controlling visibility/pinning.

Returns

GridSignals

Grid signals object.

getViewportInfo()

getViewportInfo(): ViewportInfo

Defined in: src/layouts/layout-host.ts:22

Returns computed viewport metrics (dimensions, scroll flags, heights).

Returns

ViewportInfo

Current ViewportInfo.

registerPlugin()

registerPlugin(plugin): void

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

Registers a plugin and calls its GridPlugin.init.

Parameters

plugin

GridPlugin

Plugin to register.

Returns

void

Inherited from

GridPluginHost.registerPlugin

removeNode()

removeNode(node): void

Defined in: src/layouts/layout-host.ts:27

Removes a DOM node via the grid's configured sanitizer/custom remover.

Parameters

node

HTMLElement

Element to remove.

Returns

void

unregisterPlugin()

unregisterPlugin(plugin): void

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

Unregisters a plugin, calling GridPlugin.destroy if defined.

Parameters

plugin

GridPlugin

Plugin to remove.

Returns

void

Inherited from

GridPluginHost.unregisterPlugin