DataGridElement (Plugin API)

Internal API for plugin developers. Members marked with @internal Plugin API or using the _underscore prefix convention.

See the public API documentation for consumer-facing members.

Prefix	Meaning
(none)	Public API
_	Protected/plugin-accessible
__	Deeply internal (not documented)

Events

Event	Description	Triggered By
cell-activate	Unified activation event (cancelable) - fires FIRST	_dispatchCellClick()
cell-click	Emitted after plugins process the click, with full cell context	_dispatchCellClick()
row-click	Emitted after plugins process the click, with full row context	_dispatchRowClick()

Properties

Property	Type	Description
_rows	T[]
_headerRowEl	HTMLElement
_bodyEl	HTMLElement
_rowPool	RowElementInternal[]
_resizeController	ResizeController
_focusRow	number
_focusCol	number
_restoreFocusAfterRender	boolean	Flag to restore focus styling after next render.
_sortState	object | unknown
_gridTemplate	string

Event Dispatching

Plugin API - called by event-delegation.ts

_dispatchCellMouseDown()

Dispatch cell mouse events for drag operations. Returns true if any plugin started a drag.

_dispatchCellMouseDown(event: CellMouseEvent): boolean

Parameters

Name	Type	Description
event	CellMouseEvent

---

_dispatchCellMouseMove()

Dispatch cell mouse move during drag.

_dispatchCellMouseMove(event: CellMouseEvent): void

Parameters

Name	Type	Description
event	CellMouseEvent

---

_dispatchCellMouseUp()

Dispatch cell mouse up to end drag.

_dispatchCellMouseUp(event: CellMouseEvent): void

Parameters

Name	Type	Description
event	CellMouseEvent

---

Plugin Hooks

Plugin API - called by rows.ts

_afterCellRender()

Call afterCellRender hook on all plugins. This is called by rows.ts for each cell after it’s rendered, allowing plugins to modify cells during render rather than requiring expensive post-render DOM queries.

_afterCellRender(context: AfterCellRenderContext<T>): void

Parameters

Name	Type	Description
context	AfterCellRenderContext<T>

---

_hasAfterCellRenderHook()

Check if any plugin has registered an afterCellRender hook. Used to skip the hook call entirely for performance when no plugins need it.

_hasAfterCellRenderHook(): boolean

---

_afterRowRender()

Call afterRowRender hook on all plugins that have registered for it. Called by rows.ts after each row is completely rendered.

_afterRowRender(context: AfterRowRenderContext<T>): void

Parameters

Name	Type	Description
context	AfterRowRenderContext<T>	Context containing row data, index, and DOM element

---

_hasAfterRowRenderHook()

Check if any plugin has registered an afterRowRender hook. Used to skip the hook call entirely for performance when no plugins need it.

_hasAfterRowRenderHook(): boolean

---

Accessors

_pluginManager

Exposes plugin manager for event bus operations (subscribe/unsubscribe/emit). Plugins access this via this.grid._pluginManager in BaseGridPlugin.on/off/emitPluginEvent.

readonly _pluginManager: PluginManager | undefined

---

_columns

_columns: ColumnInternal<T>[]

---

_visibleColumns

Visible columns only (excludes hidden). Use for rendering.

readonly _visibleColumns: ColumnInternal<T>[]

---

_virtualization

_virtualization: VirtualState

---

_schedulerIsConnected

Whether the grid is fully connected (scheduler guard).

readonly _schedulerIsConnected: boolean

---

_hostElement

The grid’s host HTMLElement. Use instead of casting grid as unknown as HTMLElement.

readonly _hostElement: HTMLElement

---

_renderRoot

The grid’s render root element for DOM queries.

readonly _renderRoot: HTMLElement

---

_accordionIcons

Get accordion expand/collapse icons from effective config.

readonly _accordionIcons: object

---

_shellState

Shell state for config manager shell merging.

readonly _shellState: ShellState

---

Methods

_emitDataChange()

_emitDataChange(): void

---

_rebuildRowIdMap()

Rebuild the row ID map for O(1) lookups. Called when rows array changes.

_rebuildRowIdMap(): void

---

_renderVisibleRows()

_renderVisibleRows(start: number, end: number, epoch: number): void

Parameters

Name	Type	Description
start	number
end	number
epoch	number

---

_updateAriaCounts()

Updates ARIA row/col counts. Delegates to aria.ts module.

_updateAriaCounts(rowCount: number, colCount: number): void

Parameters

Name	Type	Description
rowCount	number
colCount	number

---

_requestSchedulerPhase()

Request a render at the given phase through the scheduler.

_requestSchedulerPhase(phase: number, source: string): void

Parameters

Name	Type	Description
phase	number
source	string

---

_getPluginExtraHeight()

Plugin extra height for spacer calculation.

_getPluginExtraHeight(): number

---

_getPluginRowHeight()

Plugin-specific row height override.

_getPluginRowHeight(row: T, index: number): number | undefined

Parameters

Name	Type	Description
row	T
index	number

---

_getPluginExtraHeightBefore()

Plugin extra height before a given row index.

_getPluginExtraHeightBefore(start: number): number

Parameters

Name	Type	Description
start	number

---

_adjustPluginVirtualStart()

Let plugins adjust the virtual start index backwards.

_adjustPluginVirtualStart(start: number, scrollTop: number, rowHeight: number): number | undefined

Parameters

Name	Type	Description
start	number
scrollTop	number
rowHeight	number

---

_afterPluginRender()

Run plugin afterRender hooks.

_afterPluginRender(): void

---

_emitPluginEvent()

Emit a plugin event through the plugin manager.

_emitPluginEvent(event: string, detail: unknown): void

Parameters

Name	Type	Description
event	string
detail	unknown

---

_schedulerMergeConfig()

Merge effective config (FULL/COLUMNS phase).

_schedulerMergeConfig(): void

---

_schedulerProcessColumns()

Process columns through plugins (COLUMNS phase).

_schedulerProcessColumns(): void

---

_schedulerProcessRows()

Rebuild row model through plugins (ROWS phase).

_schedulerProcessRows(): void

---

_schedulerRenderHeader()

Render header DOM (HEADER phase).

_schedulerRenderHeader(): void

---

_schedulerUpdateTemplate()

Update CSS grid template (COLUMNS phase).

_schedulerUpdateTemplate(): void

---

_schedulerAfterRender()

Run afterRender hooks and post-render bookkeeping (STYLE phase).

_schedulerAfterRender(): void

---

_emit()

Emit a custom event from the grid.

_emit(eventName: string, detail: unknown): void

Parameters

Name	Type	Description
eventName	string
detail	unknown

---

_clearRowPool()

Clear the row pool and body element.

_clearRowPool(): void

---

_setup()

Run grid setup (DOM rebuild).

_setup(): void

---

_applyAnimationConfig()

Apply animation configuration to host element.

_applyAnimationConfig(config: GridConfig<T>): void

Parameters

Name	Type	Description
config	GridConfig<T>

---

_dispatchCellClick()

Dispatch a cell click event to the plugin system, then emit a public event. Plugins get first chance to handle the event. After plugins process it, a cell-click CustomEvent is dispatched for external listeners.

_dispatchCellClick(event: MouseEvent, rowIndex: number, colIndex: number, cellEl: HTMLElement): boolean

Parameters

Name	Type	Description
event	MouseEvent
rowIndex	number
colIndex	number
cellEl	HTMLElement

Returns

boolean - true if any plugin handled (consumed) the event, or if consumer canceled

Events

Event	Description
cell-activate	Unified activation event (cancelable) - fires FIRST
cell-click	Emitted after plugins process the click, with full cell context

---

_dispatchRowClick()

Dispatch a row click event to the plugin system, then emit a public event. Plugins get first chance to handle the event. After plugins process it, a row-click CustomEvent is dispatched for external listeners.

_dispatchRowClick(event: MouseEvent, rowIndex: number, row: any, rowEl: HTMLElement): boolean

Parameters

Name	Type	Description
event	MouseEvent
rowIndex	number
row	any
rowEl	HTMLElement

Returns

boolean - true if any plugin handled (consumed) the event

Events

Event	Description
row-click	Emitted after plugins process the click, with full row context

---

_dispatchHeaderClick()

Dispatch a header click event to the plugin system. Returns true if any plugin handled the event.

_dispatchHeaderClick(event: MouseEvent | KeyboardEvent, col: ColumnConfig, headerEl: HTMLElement): boolean

Parameters

Name	Type	Description
event	MouseEvent | KeyboardEvent
col	ColumnConfig
headerEl	HTMLElement

---

_dispatchKeyDown()

Dispatch a keyboard event to the plugin system. Returns true if any plugin handled the event.

_dispatchKeyDown(event: KeyboardEvent): boolean

Parameters

Name	Type	Description
event	KeyboardEvent

---

_getHorizontalScrollOffsets()

Get horizontal scroll boundary offsets from plugins. Used by keyboard navigation to ensure focused cells are fully visible when plugins like pinned columns obscure part of the scroll area.

_getHorizontalScrollOffsets(rowEl: HTMLElement, focusedCell: HTMLElement): object

Parameters

Name	Type	Description
rowEl	HTMLElement
focusedCell	HTMLElement

---

_getRowEntry()

Get a row and its current index by ID. Used internally by plugins to resolve a row’s current position in _rows after sorting, filtering, or rows replacement.

_getRowEntry(id: string): object | undefined

Parameters

Name	Type	Description
id	string

---

refreshShellHeader()

Re-parse light DOM shell elements and refresh shell header. Call this after dynamically modifying <tbw-grid-header> children.

Multiple calls are batched via microtask to avoid redundant DOM rebuilds when registering multiple tool panels in sequence.

Plugin API

refreshShellHeader(): void

---