Class: FrozenLayout

Defined in: src/layouts/frozen-layout.tsx:12

Frozen/pinned layout providing pinned columns and frozen top panes. Renders start/main bands with top/body panes and handles frozenRows/frozenBottom and legacy frozenColumns options.

Implements

LayoutEngine

Constructors

Constructor

new FrozenLayout(): FrozenLayout

Returns

FrozenLayout

Properties

layoutName

readonly layoutName: "FrozenLayout" = "FrozenLayout"

Defined in: src/layouts/frozen-layout.tsx:91

Layout identifier.

Implementation of

LayoutEngine.layoutName

supportFrozenRows

supportFrozenRows: true = true

Defined in: src/layouts/frozen-layout.tsx:96

Indicates this layout supports top-frozen rows.

Implementation of

LayoutEngine.supportFrozenRows

supportPinnedCols

supportPinnedCols: true = true

Defined in: src/layouts/frozen-layout.tsx:94

Indicates this layout supports pinned columns.

Implementation of

LayoutEngine.supportPinnedCols

Methods

adjustFrozenRowsOption()

adjustFrozenRowsOption(): void

Defined in: src/layouts/frozen-layout.tsx:78

Syncs refs.config.frozenTopRows from frozenRows/frozenBottom grid options.

Returns

void

Implementation of

LayoutEngine.adjustFrozenRowsOption

afterSetOptions()

afterSetOptions(arg): void

Defined in: src/layouts/frozen-layout.tsx:65

Reacts to grid option changes (frozen rows/columns).

Parameters

arg

GridOptions

Options delta from grid.setOptions().

Returns

void

Implementation of

LayoutEngine.afterSetOptions

destroy()

destroy(): void

Defined in: src/layouts/frozen-layout.tsx:86

Clears the host reference.

Returns

void

Implementation of

LayoutEngine.destroy

init()

init(host): void

Defined in: src/layouts/frozen-layout.tsx:23

Builds the frozen layout DOM (headers, header rows, viewports, footer rows) across start/main bands and top/body panes.

Parameters

host

LayoutHost

Layout host.

Returns

void

Implementation of

LayoutEngine.init

reorderViewColumns()

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

Defined in: src/layouts/frozen-layout.tsx:53

Reorders visible columns so that pinned (non-"end") columns come first. Also writes refs.config.pinnedStartCols for later layout calculations.

Parameters

viewCols

Column<any>[]

Visible columns in current order.

refs

GridLayoutRefs

Mutable layout refs to update.

Returns

Column<any>[]

Reordered columns when pinning exists, null otherwise.

Implementation of

LayoutEngine.reorderViewColumns