Skip to content

Configurator

The configurator is the drag-and-drop field panel for Pivot. It gives users a visual way to rearrange dimensions between rows, columns, and values without writing a new PivotConfig by hand.

The configurator renders:

  • a dimension list
  • a rows drop zone
  • a columns drop zone
  • a values drop zone

When users move a field:

  • the configurator emits updated rows, columns, or values
  • PivotPlugin re-emits pivot-config-update
  • the Pivot result is recomputed and the grid updates
const pivot: PivotConfig = {
dimensions: [...],
rows: ['region'],
columns: ['quarter'],
values: [{ prop: 'sales', aggregator: 'sum' }],
hasConfigurator: true,
};

Use these options to hide zones:

  • showRows
  • showColumns
  • showValues

These only affect the configurator UI. They do not remove support for the corresponding Pivot feature.

By default, PivotPlugin creates the configurator inside the grid wrapper. If you set mountTo, it mounts into the supplied element instead.

The configurator’s value zone reads available aggregators from the matching dimension. That means aggregator choices stay consistent with the field definition, rather than being hard-coded in the panel.

Configurator labels come from i18n. If omitted, Pivot uses the built-in English defaults from PIVOT_CONFIG_EN.

  • Enabling hasConfigurator without providing useful dimensions.
  • Expecting hidden zones to disable Pivot features globally.
  • Treating the configurator as the state owner. It is a UI for editing Pivot state, not the persistence layer.

Continue with Field Panel for the compact in-grid layout, Configurator API for the standalone embedding surface, or Server-Side Pivot for remote analytical usage.