apex-grid-enterprise
v0.2.0
Published
Enterprise (pro-licensed) features for apex-grid.
Maintainers
Readme
apex-grid-enterprise
Pro-licensed enterprise features for apex-grid.
apex-grid-enterprise extends the community grid and registers as
<apex-grid-enterprise>, layering enterprise-only features on top of everything
apex-grid already does. Use it as a drop-in replacement for <apex-grid>.
Requires a valid license key for production use. Without one, the grid keeps working but renders a watermark and logs a console notice. Set a key with
ApexGridEnterprise.setLicense(...)— see Licensing below.
Enterprise features
- Column aggregations — sum / avg / min / max / count per column via the
aggregationsproperty andgetAggregations(). - Excel (XLSX) export —
grid.exportToXLSX({ filename, sheetName, source, columns }), and an "Export XLSX" entry added to the toolbar's export menu (alongside the community grid's CSV). Numbers, booleans, andDatevalues keep their native Excel cell types. (Moved here from the community package in apex-grid v3; CSV export stays free.)
import 'apex-grid-enterprise/define';
const grid = document.querySelector('apex-grid-enterprise');
grid.exportToXLSX({ filename: 'users', sheetName: 'Users' });Column aggregations
Request sum / avg / min / max / count per column via the aggregations property,
then read the computed values with getAggregations():
grid.aggregations = { price: ['sum', 'avg'], sold: ['sum', 'max'] };
const totals = grid.getAggregations();
// → { price: { sum: 657.92, avg: 109.65 }, sold: { sum: 347, max: 91 } }Licensing
Licensing is offline and non-hostile: without a valid key the grid keeps working but renders a watermark and logs a console notice — no network calls, no hard blocking. Set the key once (globally) before or after the grid renders:
import { ApexGridEnterprise } from 'apex-grid-enterprise';
ApexGridEnterprise.setLicense('APEX-…'); // removes the watermark on all instancesLicenseManager (re-exported from apex-commons) is also available for advanced
use, but setLicense is the supported entry point.
Install
npm install apex-grid-enterprise apex-grid lit igniteui-webcomponentsapex-grid, lit, and igniteui-webcomponents are peer dependencies shared
with the community package — install a single copy of each.
Usage
import 'apex-grid-enterprise/define'; // registers <apex-grid-enterprise>The configuration API is identical to apex-grid; see the apex-grid README
for column configuration, theming, and events.
