Documentation

Upgrading

How versions are numbered

  • Patch (1.7.1 → 1.7.2): fixes.
  • Minor (1.7.2 → 1.8.0): new features, plus fixes. A fix can change what your app sees — a custom summary that now runs, column subtotals that are now on by default. Every such change is listed below, under the version that made it.
  • Major: none so far.

The packages of one product do not always share a number: in a release, each package moves by what changed in it. The changelog lists the exact number of every package in each release.

Upgrade the packages together

The Enterprise packages depend on an exact version of the Community ones. Upgrade every @kanunilabs/pivotgrid* package your app lists in the same command, to the set one release shipped:

npm i @kanunilabs/pivotgrid-react@latest @kanunilabs/pivotgrid-react-enterprise@latest

Upgrading only one of them can install a second copy of the engine next to the first. Two copies do not share state: a licence key set through one is not seen by the other. Check that one version is installed:

npm ls @kanunilabs/pivotgrid-core

One version in the tree is right; two mean a package was left behind.

What changes for you

The changes below can make an existing app behave or type-check differently after an upgrade. Versions not listed asked nothing of you. Going from an older version to the newest, read every entry in between.

PivotGrid 1.9.0

@kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected]

  • showRowGrandTotals now controls the grand total row and showColumnGrandTotals the grand total column, as documented; before, each switched the other — in both renderers, the exports and the clipboard. An app that turned off only one of them sees the other one hidden now; if you had swapped the two to get the right result, swap them back.
  • In the header filter list a tick always means "shown", in include and exclude mode alike. A saved filter is read the same; only what the list displays changed.
  • The footer toolbar buttons get the padding they were meant to have (a 27px target at normal density), so the toolbar is a little taller than in 1.8.0.

PivotGrid 1.7.2

@kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected]

  • A partial layout, such as { rowHeaderLayout: 'tree' }, keeps the defaults for the options it leaves out; before, the grid drew no values. A full set of defaults passed only to work around that can go.

PivotGrid 1.7.0

@kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected]

  • summaryType: 'custom' runs your calculateCustomSummary, or the aggregator registered under that name. Before, every custom measure showed a sum, so the numbers of such measures change. An unknown aggregator name is reported as an engine error.
  • controller.on('fieldMove', …) fires now. A handler registered for it starts running on every field drag; newIndex is where the field landed.
  • groupInterval: 'numeric' and 'custom' never grouped; they are now reported through onError.
  • Fourteen chart panel captions left the PivotDictionary type. A dictionary declared with that type that sets them no longer type-checks; your own messages still rename them.

PivotGrid 1.4.0

@kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected]

  • A dictionary typed as the full PivotDictionary needs the eight new licence keys; a partial dictionary needs nothing.

PivotGrid 1.3.0

@kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected]

  • Column subtotals are on by default, like row totals. Set showColumnTotals: false in layout to keep the columns you had.
  • Exported sheets name their totals in the grid's language instead of English.

PivotGrid 1.2.0

@kanunilabs/[email protected] · @kanunilabs/[email protected] · @kanunilabs/[email protected]

  • stateStoring does what it says: enabled: false stops saving, type: 'sessionStorage' saves there, and type: 'custom' calls your onSave / onLoad. Before, every setting saved to localStorage. Passing no stateStoring keeps the old behaviour, so saved layouts are kept.
  • The toolbar prop is honoured: switches you set in it take effect now.
  • On a Community grid the paid export formats (excel-list, excel-pivot, pdf) reject with an error routed to onError instead of silently doing nothing, and exportData returns a promise.

PivotGrid 1.0.5

  • The Web Workers are built into the package and start from a blob: URL: a worker file you copied into public/ can go, and an explicit workerUrl still wins. Under a Content-Security-Policy without worker-src blob:, the grid loads the worker file from the package instead.