Vue Data GridCommunity and EnterpriseEnterprise
AG Grid comes in two forms: AG Grid Community (free for everyone, including production use) and AG Grid Enterprise (you need a license to use).
See Pricing for details on purchasing an AG Grid Enterprise license.
It is free to try out AG Grid Enterprise. Please take AG Grid Enterprise for a test run. You do not need to contact us. All that we ask when trialing is that you don't use AG Grid Enterprise in a project intended for production.
Each of the Getting Started guides gives step by step instructions on how to get started using AG Grid Enterprise for the framework in question. In most cases, you do one of the following:
If including the bundled AG Grid script directly into your webpage, then reference ag-grid-enterprise/dist/ag-grid-enterprise.js instead of ag-grid-community/dist/ag-grid-community.js.
As before, you use AG Grid in the same way, but including the enterprise script will enable AG Grid to have all enterprise features at your disposal.
If using node modules and grid packages include the enterprise package ag-grid-enterprise.
"dependencies": {
"ag-grid-community": "~29.3.5",
"ag-grid-enterprise": "~29.3.5"
...
}Then import the AG Grid Enterprise package in your application before any grid instance is created.
import 'ag-grid-enterprise';The versions of ag-grid-community and ag-grid-enterprise should match. They are released in tandem and expect to be on the same version.
If using node modules and grid modules, include the enterprise feature modules for the features that you require. For example to add the enterprise Row Grouping feature along with Server Side row model add the following packages to your package.json file:
"dependencies": {
"@ag-grid-enterprise/row-grouping": "~29.3.5",
"@ag-grid-enterprise/server-side-row-model": "~29.3.5",
...
}Then reference and import the AG Grid Enterprise modules:
import { RowGroupingModule } from '@ag-grid-enterprise/row-grouping';
import { ServerSideRowModelModule } from '@ag-grid-enterprise/server-side-row-model';Then depending on your choice of framework you'll need to provide the modules to the grid or register them globally (see Installing Grid Modules for full details.). Please refer to the modules documentation for all the enterprise modules.
<ag-grid-vue
:rowData="rowData"
:columnDefs="columnDefs"
:modules="[ServerSideRowModelModule, RowGroupingModule]"
</ag-grid-vue>The versions of the modules you use, @ag-grid-community/** and @ag-grid-enterprise/** should match. They are released in tandem and expect to be on the same version.
When you do not have a license key installed then AG Grid Enterprise will display a invalid key watermark. If you would like to remove this watermark so it's not in the way, please send us an e-mail info@ag-grid.com and get a trial license key.
You can access Support via Zendesk for help while trialing. Email info@ag-grid.com to get set up with access.
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, it is just set once statically into the AG Grid library. You must set the license key before you create an instance of AG Grid, otherwise AG Grid will complain upon creation that no license key is set.
Note that you must pass the key exactly as provided by AG Grid - do not modify the key in any way.
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.
Use this if you are using CommonJS to load AG Grid.
var enterprise = require("@ag-grid-enterprise/core");
enterprise.LicenseManager.setLicenseKey("your license key");If you are using grid packages (e.g. you are using import ag-grid-enterprise) set the license like this.
import { LicenseManager } from 'ag-grid-enterprise'
LicenseManager.setLicenseKey("your license key")If you are using grid modules (e.g. you are using import { RowGroupingModule } from @ag-grid-enterprise/row-grouping) set the license like this.
import { LicenseManager } from '@ag-grid-enterprise/core'
LicenseManager.setLicenseKey("your license key")If you're using any Enterprise feature then @ag-grid-enterprise/core will be available - you do not need to specify it as a dependency.
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.
We recommend setting the license key in your main bootstrap file (typically named main.js), before you bootstrap your application.
For example:
import Vue from "vue";
import "@ag-grid-enterprise/styles/ag-grid.css";
import "@ag-grid-enterprise/styles/ag-theme-alpine.css";
import { LicenseManager } from "@ag-grid-enterprise/core";
LicenseManager.setLicenseKey("your license key");
new Vue({
el: "#el",
...
});If you have an enterprise grid running with an invalid license (no license, expired license) your console log will display a series of warnings and the grid will show a watermark for 5 seconds.
The below table summarizes the features included in AG Grid Community and AG Grid Enterprise. Note that AG Grid Enterprise builds on AG Grid Community, it offers everything AG Grid Community offers plus more.