About GoodData.UI
GoodData.UI is a TypeScript framework for building analytical applications on top of the GoodData platform or GoodData.CN.
GoodData.UI consists of multiple libraries with clear-cut responsibilities ranging from low-level REST API clients up to visualization libraries that deliver React-based components to render different types of charts and tables.
With GoodData.UI, you can:
Create utility programs that interact directly with the GoodData platform or GoodData.CN APIs (for example, to automate routine maintenance and management tasks).
Create visualizations of data stored on the GoodData platform or GoodData.CN using visual components.
Embed insights created in Analytical Designer using InsightView.
Create new visual components for your data to address your specific analytical needs.
This documentation is intended for front-end software developers and requires JavaScript knowledge.
Supported technologies
GoodData.UI is compatible with:
- React >=16.8.0 <17.0.0, Angular 9+
- TypeScript >=4.0.2, ES6, ES5
- Node ^12.15.0 LTS
- Officially supported browsers
NOTE: Server-side rendering is not supported.
Internet Explorer and mandatory polyfills
ES6 polyfill
To run a GoodData.UI application in Internet Explorer 11, you must have the ES6 polyfill. For more information, see the compatibility table and the instructions here.
If you are using Babel, you can use the Babel polyfill in your index to specifically include only the needed polyfill code.
CSS variable polyfill
Because Internet Explorer 11 does not support CSS variables, add one of the polyfills to avoid styling issues. We do not recommend any specific polyfill, because you may approach this situation differently (for example, transform variables to static values at build time vs. generate and append CSS classes at runtime). Each approach has certain limitations, so choose the one that best suits your needs.
Get GoodData
To use GoodData.UI, you must have an account on the GoodData platform or an installation of GoodData.CN. You can create a GoodData platform account for free at https://www.gooddata.com/free/ or download GoodData.CN at https://www.gooddata.com/developers/.
Upcoming features
Take a look at our Roadmap to see what new features are coming to GoodData.UI.