Set License

ag-Grid Enterprise   Setting of License Key is required when using ag-Grid Enterprise.

Setting the License Key

Set the license key via the JavaScript method as described below. ag-Grid checks the license key without making any network calls. The license key is set once for the grid library. You do not need to set the license key for each instance of ag-Grid that you create. You must set the license key before you create an instance of ag-Grid.

JavaScript

Use this if you are using the Webpack bundled version of ag-Grid (eg you are using ag-grid-enterprise.js).

agGrid.LicenseManager.setLicenseKey("your license key");

CommonJS

Use this if you are using CommonJS to load ag-Grid.

var enterprise = require("ag-grid-enterprise");
enterprise.LicenseManager.setLicenseKey("your license key");

ECMA 6

Use this if you are using ECMA 6 imports to load ag-Grid.

import {LicenseManager} from "ag-grid-enterprise/main";
LicenseManager.setLicenseKey("your license key");

Do Not Mix Loading Mechanisms

If you mix the methods above (eg if you are using CommonJS in your application, but use the JavaScript approach above to set license key) then it will not work. This is because the ag-Grid library will be loaded twice, one will have the license key and the other will be used in your application without the license key.

Note on Aurelia

For Aurelia users, we suggest you set your License Key in the configure function, as follows:

export function configure(aurelia: Aurelia) {
  aurelia.use
    .standardConfiguration()
    .plugin('ag-grid-aurelia')
    .feature('resources');

  // enterprise uncomment and set licence key here
  // LicenseManager.setLicenseKey('LICENSE KEY');

  ...rest of function
If you are distributing your product and including ag-Grid Enterprise, we realise that your license key will be visible to others. We appreciate that this is happening and just ask that you don't advertise it. Given our product is JavaScript, there is little we can do to prevent this.