ColumnVirtualizationPlugin

Column Virtualization Plugin for tbw-grid

Provides horizontal column virtualization for grids with many columns (30+). Only renders visible columns plus overscan, significantly improving rendering performance for wide grids.

Installation

import { ColumnVirtualizationPlugin } from '@toolbox-web/grid/plugins/column-virtualization';

Requirements

• Grid must use fitMode: 'fixed'
• Columns must have explicit widths
• Grid must have fixed height

Configuration Options

Option	Type	Description
autoEnable?	boolean	Auto-enable when column count exceeds threshold (default: true)
threshold?	number	Column count threshold for auto-enabling (default: 30)
overscan?	number	Extra columns to render on each side for smooth scrolling (default: 3)

Example

Wide Grid with Column Virtualization

import '@toolbox-web/grid';
import { ColumnVirtualizationPlugin } from '@toolbox-web/grid/plugins/column-virtualization';

grid.gridConfig = {
  columns: generateManyColumns(100), // 100 columns
  fitMode: 'fixed',                  // Required
  plugins: [
    new ColumnVirtualizationPlugin({
      threshold: 30,  // Enable when >30 columns
      overscan: 3,    // Render 3 extra columns each side
    }),
  ],
};

See Also

• ColumnVirtualizationConfig for configuration options

Extends BaseGridPlugin

Inherited methods like attach(), detach(), afterRender(), etc. are documented in the base class.

Methods

getIsVirtualized()

Check if column virtualization is currently active.

getIsVirtualized(): boolean

---

getVisibleColumnRange()

Get the current visible column range.

getVisibleColumnRange(): object

---

scrollToColumn()

Scroll the grid to bring a specific column into view.

scrollToColumn(columnIndex: number): void

Parameters

Name	Type	Description
columnIndex	number	Index of the column to scroll to

---

getColumnOffset()

Get the left offset for a specific column.

getColumnOffset(columnIndex: number): number

Parameters

Name	Type	Description
columnIndex	number	Index of the column

---

getTotalWidth()

Get the total width of all columns.

getTotalWidth(): number

---