@serenity-is/sleekgrid / GridLayoutRefs

Type Alias: GridLayoutRefs

GridLayoutRefs = object

Defined in: src/layouts/layout-refs.tsx:39

Aggregated refs for all bands and derived pinning/frozen indices.

Properties

config

config: object

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

Writable config inputs; setters trigger createGridSignalsAndRefs recalculation.

colCount?

optional colCount: number

Total column count driving index calculations.

dataLength?

optional dataLength: number

Total data row count driving frozen calculations.

frozenBottomRows?

optional frozenBottomRows: number

Desired bottom-frozen row count.

frozenLimit?

optional frozenLimit: number | null

Maximum total frozen rows, or null to allow all.

frozenTopRows?

optional frozenTopRows: number

Desired top-frozen row count.

pinnedEndCols?

optional pinnedEndCols: number

Desired end-pinned column count.

pinnedLimit?

optional pinnedLimit: number | null

Maximum total pinned columns, or null to allow all.

pinnedStartCols?

optional pinnedStartCols: number

Desired start-pinned column count.

---

end

readonly end: GridBandRefs

Defined in: src/layouts/layout-refs.tsx:45

Band refs for the pinned-end side.

---

frozenBottomFirst

readonly frozenBottomFirst: number

Defined in: src/layouts/layout-refs.tsx:63

First bottom-frozen row index or Infinity when none.

---

frozenBottomRows

readonly frozenBottomRows: number

Defined in: src/layouts/layout-refs.tsx:61

Number of bottom-frozen rows.

---

frozenTopLast

readonly frozenTopLast: number

Defined in: src/layouts/layout-refs.tsx:59

Last top-frozen row index or -Infinity when none.

---

frozenTopRows

readonly frozenTopRows: number

Defined in: src/layouts/layout-refs.tsx:57

Number of top-frozen rows.

---

main

readonly main: GridBandRefs

Defined in: src/layouts/layout-refs.tsx:43

Band refs for the main (center, scrollable) band.

---

pinnedEndCols

readonly pinnedEndCols: number

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

Number of columns pinned to the end.

---

pinnedEndFirst

readonly pinnedEndFirst: number

Defined in: src/layouts/layout-refs.tsx:55

First pinned-end column index or Infinity when none.

---

pinnedStartCols

readonly pinnedStartCols: number

Defined in: src/layouts/layout-refs.tsx:49

Number of columns pinned to the start (derived, bounded by config).

---

pinnedStartLast

readonly pinnedStartLast: number

Defined in: src/layouts/layout-refs.tsx:51

Last pinned-start column index or -Infinity when none.

---

start

readonly start: GridBandRefs

Defined in: src/layouts/layout-refs.tsx:41

Band refs for the pinned-start side.

---

topPanel?

optional topPanel: HTMLElement

Defined in: src/layouts/layout-refs.tsx:47

Top panel container element, if rendered.