Documentation

Enterprise & licensing

Advanced analytics ship in @kanunilabs/pivotgrid-react-enterprise: the no-code calculated-field editor, live chart integration, drill-down to source records, the visual prefilter builder, the node context menu (bulk expand/collapse), and styled Excel & PDF export. EnterprisePivotGrid is a drop-in replacement for BasePivotGrid — it accepts the same props and adds these.

Private registry

The enterprise package is delivered from our private registry with per-customer credentials. After purchase you receive a ready-to-paste .npmrc by email (also manageable from your dashboard):

@kanunilabs:registry=https://registry.kanunilabs.com/
//registry.kanunilabs.com/:_auth=<value from your email or dashboard>
//registry.kanunilabs.com/:always-auth=true

Then install:

npm i @kanunilabs/pivotgrid-react-enterprise

Setup details, CI usage and credential rotation are covered in the Private registry access guide.

License key

Set your key once at startup, then use EnterprisePivotGrid in place of BasePivotGrid:

import { EnterprisePivotGrid, LicenseManager } from '@kanunilabs/pivotgrid-react-enterprise';

LicenseManager.setLicenseKey('KLAB1....');

export function MyProGrid(props) {
  return <EnterprisePivotGrid {...props} />;
}

Without a valid license the grid still renders and shows an "Unlicensed" watermark. Nothing is logged to the console when no key is supplied at all — the banner only appears when a key IS given and fails to verify. Licenses are verified offline (signed) and optionally checked online for revocation:

<EnterprisePivotGrid
  licenseKey="KLAB1...."
  licenseValidateUrl="https://api.kanunilabs.com/api/license/validate"
/>

What the license key actually controls

One thing: the watermark. An unlicensed Enterprise build is not a crippled build, it is a watermarked one — a feature you cannot run is a feature you cannot evaluate before buying.

That is separate from the edition boundary, which is real and has two different shapes:

  • A runtime gate, on the three styled export formats. PivotController refuses excel-list, excel-pivot and pdf on a Community grid — see Styled Excel & PDF export. It is an edition check, not a licence check: an unlicensed Enterprise grid still exports.
  • A packaging boundary, for everything else on this page. The calculated-field designer, the prefilter builder, the node context menu, the drill-down modal and the chart renderer are components that exist only in the Enterprise package. BasePivotGrid does not disable them, it never renders them — the footer's calculator and filter buttons are absent rather than greyed out.

What Enterprise unlocks

Seven entries, and that is the whole paid surface. Everything not in this list is in Community and needs no licence — the full side-by-side table is on the pricing page.

Data & performance

Aggregation

Shaping the pivot

  • Node context menuRight-click a header node for bulk expand/collapse of that branch or that whole level.

Data in and out

  • Styled Excel exportThe view as a real workbook — merged header spans, total styling and per-measure number formats — or a flat list.
  • PDF exportA print-ready document of the current pivot.

Analytics

Where each feature is documented

Rendering EnterprisePivotGrid makes the paid surfaces available: the footer's calculator and filter buttons open their editors, right-clicking a header node offers bulk expand/collapse, and the Excel/PDF entries in the Export menu become active. Two of them — drill-down and charts — are headless: the grid hands you data and you decide where to render it.

Each has its own guide, with the configuration, the API and an honest account of where it stops:

GuideCovers
Calculated fieldsrow-level vs summary-level, the formula language, the designer modal, and what a saved report does to them
Prefilter & node menuthe pre-aggregation predicate, its AST, the builder, and the right-click expand/collapse items
Drill-down & chartsthe rows behind a cell, the chart transformer/sync/factory trio, and the wiring the grid does not do for you
Styled Excel & PDF exportthe three paid formats, the options that reach the exporter, and what the file will not match on screen

EnterprisePivotGrid vs BasePivotGrid

The wrapper hard-wires four props — advancedExport and the three render slots — and draws the watermark. It re-assigns them after spreading your props, so passing your own renderCalculatedFieldModal, renderPrefilterBuilder, renderNodeContextMenu or advancedExport has no effect. Use BasePivotGrid directly if you need to supply your own.

It is also not a type-level drop-in: forwardRef erases the generic, so the shipped type is EnterprisePivotGridProps<unknown> and a PivotField<Sale>[] will not assign to initialFields without a cast.