PivotPlugin

Pivot Table Plugin for tbw-grid

Transforms flat data into a pivot table view with grouped rows, grouped columns, and aggregated values. Includes an interactive tool panel for configuring row groups, column groups, and value aggregations at runtime.

Installation

import { PivotPlugin } from '@toolbox-web/grid/plugins/pivot';

Configuration Options

Option	Type	Default	Description
active	boolean	true	Whether pivot is active on load
rowGroupFields	string[]	[]	Fields for row grouping
columnGroupFields	string[]	[]	Fields for column grouping
valueFields	ValueField[]	[]	Aggregation value fields
showTotals	boolean	true	Show row subtotals
showGrandTotal	boolean	true	Show grand total row
showToolPanel	boolean	true	Show interactive pivot panel
defaultExpanded	boolean	true	Groups expanded by default
indentWidth	number	20	Indent per depth level (px)
animation	false | 'slide' | 'fade'	'slide'	Expand/collapse animation

Aggregation Functions

sum, avg, count, min, max, first, last

Programmatic API

Method	Signature	Description
expandGroup	(path: string[]) => void	Expand a specific group
collapseGroup	(path: string[]) => void	Collapse a specific group
expandAll	() => void	Expand all groups
collapseAll	() => void	Collapse all groups

CSS Custom Properties

Property	Default	Description
--tbw-pivot-group-bg	var(--tbw-color-row-alt)	Group row background
--tbw-pivot-grand-total-bg	var(--tbw-color-header-bg)	Grand total row

Examples

Basic Pivot Table

import '@toolbox-web/grid';
import { PivotPlugin } from '@toolbox-web/grid/plugins/pivot';

grid.gridConfig = {
  columns: [...],
  plugins: [
    new PivotPlugin({
      rowGroupFields: ['region', 'product'],
      columnGroupFields: ['quarter'],
      valueFields: [{ field: 'sales', aggFunc: 'sum', header: 'Total' }],
    }),
  ],
};

Programmatic-Only (No Tool Panel)

new PivotPlugin({
  showToolPanel: false,
  rowGroupFields: ['category'],
  valueFields: [{ field: 'amount', aggFunc: 'sum' }],
})

See Also

• PivotConfig for all configuration options
• PivotValueField for value field structure

Extends BaseGridPlugin

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

Properties

Property	Type	Description
PANEL_ID	pivot	Tool panel ID for shell integration

Methods

toggle()

toggle(key: string): void

Parameters

Name	Type	Description
key	string

---

expand()

expand(key: string): void

Parameters

Name	Type	Description
key	string

---

collapse()

collapse(key: string): void

Parameters

Name	Type	Description
key	string

---

expandAll()

expandAll(): void

---

collapseAll()

collapseAll(): void

---

isExpanded()

isExpanded(key: string): boolean

Parameters

Name	Type	Description
key	string

---

enablePivot()

enablePivot(): void

---

disablePivot()

disablePivot(): void

---

isPivotActive()

isPivotActive(): boolean

---

getPivotResult()

getPivotResult(): PivotResult | null

---

setRowGroupFields()

setRowGroupFields(fields: string[]): void

Parameters

Name	Type	Description
fields	string[]

---

setColumnGroupFields()

setColumnGroupFields(fields: string[]): void

Parameters

Name	Type	Description
fields	string[]

---

setValueFields()

setValueFields(fields: PivotValueField[]): void

Parameters

Name	Type	Description
fields	PivotValueField[]

---

refresh()

refresh(): void

---

showPanel()

Show the pivot tool panel. Opens the tool panel and ensures this section is expanded.

showPanel(): void

---

hidePanel()

Hide the tool panel.

hidePanel(): void

---

togglePanel()

Toggle the pivot tool panel section.

togglePanel(): void

---

isPanelVisible()

Check if the pivot panel section is currently expanded.

isPanelVisible(): boolean

---