Class PivotFactory

Creates pivot tables: rows grouped by row fields (a hierarchy with subtotals), the values of column fields as columns (several fields = a multi-row header), aggregated values in the cells, total column and total row. MIT-licensed, no dependencies – at ag-Grid this is an Enterprise feature.

The configuration has the form of a row grouping (RowGroupFactory): fields are property paths, functions (e.g. the quarter of a date) or RowGroupFieldIf with label, format and order; values use the aggregators of Aggregators (sum, avg, count …) or your own AggregatorIf. Subtotals and totals are merged from aggregation states – an average is always the average of the rows.

Filter with externalFilterFunction (it gets your source objects, before the aggregation), sort by clicking a value column, export with downloadExcel(), and pivot again at runtime with TableApi.setPivotConfig.

Example

// case 1: regions × months, sum of umsatz, total column and total row
const tableModel = PivotFactory.createTableModel<Sale>({
  rows: sales,
  rowFields: ["region"],
  columnFields: [{ value: "monat", order: "insertion" }],
  values: ["umsatz"]
});
// Region | Jan | Feb | Total
// Nord   | 150 | 120 |   270
// Süd    |  80 | 100 |   180
// Total  | 230 | 220 |   450
Copy

Example

// countries › cities × years, revenue, all groups closed; pivot by another field with a select
const tableModel = PivotFactory.createTableModel<Order>({
  rows: orders,
  rowFields: ["country", "city"],
  columnFields: [{ name: "year", label: "Year", value: o => new Date(o.date).getFullYear() }],
  values: [{ value: "total", label: "Revenue" }],
  expanded: 0
});
select.addEventListener("change", () => tableApi.setPivotConfig({ columnFields: [select.value] }));
Copy

See

Live demo: pivot tables · Training: Pivot tables

Since

1.1.94