Apex Grid Enterprise

apex-grid-enterprise is the pro-licensed companion to the community apex-grid package. It registers as <apex-grid-enterprise> and is a drop-in replacement for <apex-grid> — the same configuration API, columns, data binding, sorting, filtering, editing, and theming — plus the enterprise-only features below.

Installation

Install the enterprise package alongside the community grid and the shared peer dependencies:

npm install apex-grid-enterprise apex-grid lit igniteui-webcomponents

apex-grid, lit, and igniteui-webcomponents are shared peer dependencies — install a single copy of each. The enterprise package requires apex-grid@^3.0.0.

Import the self-registering entry point and swap the tag name:

import 'apex-grid-enterprise/define';

const grid = document.createElement('apex-grid-enterprise');
grid.columns = [/* … */];
grid.data = [/* … */];
document.querySelector('#app').appendChild(grid);

Everything you configure on <apex-grid> works unchanged on <apex-grid-enterprise> — see the community docs for columns, data binding, styling, and the rest.

Licensing

Licensing is offline and non-hostile. Without a valid key the grid keeps working — it renders a small watermark and logs a one-time console notice. There are no network calls and no hard blocking.

import { ApexGridEnterprise } from 'apex-grid-enterprise';

ApexGridEnterprise.setLicense('APEX-…');

Call setLicense() once, before (or shortly after) your grids mount. A valid key removes the watermark and the console notice.

Column aggregations

Request per-column aggregations — sum, avg, min, max, count — through the aggregations property, then read the computed values with getAggregations().

grid.aggregations = {
  price: ['sum', 'avg', 'min', 'max'],
  sold:  ['sum', 'max'],
  rating: ['avg'],
};

const totals = grid.getAggregations();
// → {
//     price:  { sum: 657.92, avg: 109.65, min: 49.99, max: 189 },
//     sold:   { sum: 347, max: 91 },
//     rating: { avg: 4.12 },
//   }

Each key in aggregations is a column key, mapped to the list of aggregations to compute. getAggregations() returns an object of the same shape, with each requested aggregation resolved to a number.

See the live Column Aggregations demo.

Excel (XLSX) export

XLSX export moved out of core in v3 and now lives here (CSV export stays free in the community grid — see Exporting). Numbers, booleans, and Date values keep their native Excel cell types.

grid.exportToXLSX({ filename: 'users', sheetName: 'Users' });

// Same source / column options as CSV export:
grid.exportToXLSX({ filename: 'selected', sheetName: 'Users', source: 'selected' });
grid.exportToXLSX({ filename: 'all',      sheetName: 'Users', source: 'all' });

type XLSXExportOptions = {
  filename?: string;                                  // download name (no extension)
  sheetName?: string;                                 // worksheet name; defaults to Sheet1
  source?: 'view' | 'page' | 'selected' | 'all';      // which rows to write; defaults to 'view'
  columns?: string[];                                 // restrict to these column keys
};

When the toolbar export menu is enabled (show-export), <apex-grid-enterprise> adds an Export XLSX entry alongside Export CSV.

See the live Excel (XLSX) Export demo.

API note

The enterprise API on this page (ApexGridEnterprise.setLicense(), aggregations / getAggregations(), exportToXLSX()) is documented by hand. The machine-readable Custom Elements Manifest (CEM) and TypeDoc that ship in the published package are core-only — there is no enterprise manifest.