Analytical Designer
Embed Analytical Designer, the GoodData editor for creating and editing visualizations, in your React application as a component.
Analytical Designer is the GoodData editor for creating visualizations from your data. The user drags attributes, metrics, and facts from the catalog into the drop zones, changes the visualization type and its properties in the configuration panel, filters the data, and saves the result so that it can be added to dashboards. For how the editor works for its users, see Analytical Designer in the GoodData Cloud documentation.
@gooddata/sdk-ui-analytical-designer is the Analytical Designer application as a React component, AnalyticalDesigner. It looks and works the same as Analytical Designer in GoodData Cloud: the same catalog, drop zones, configuration panel, filters, and saving. You render it inside your own React application, on your backend instance, without an iframe. You configure it with props, react to what the user does through typed callbacks, send it commands through a ref, and replace parts of its user interface with your own components. It is the counterpart of the Dashboard component for visualizations.
@gooddata/sdk-ui-analytical-designer is @alpha: it can change outside of the usual SemVer guarantees. See API maturity before you depend on it.Start with Embed Analytical Designer, then look up the props on the AnalyticalDesigner component page. To open Analytical Designer from an embedded dashboard instead, see Edit visualizations on a dashboard.
AnalyticalDesigner component
Props, configuration, startup data, and limits of the AnalyticalDesigner component.
Embed Analytical Designer
Install @gooddata/sdk-ui-analytical-designer, load its styles, and render Analytical Designer on your backend in a React application.
Handle Analytical Designer events
React to what the user does in Analytical Designer with the typed onEvent callback, and drive it with commands through apiRef.
Customize Analytical Designer
Hide header actions, make Analytical Designer read-only, filter its catalog, theme it, and replace its loading and error screens with slots.
Metric editor
How users create and edit metrics in Analytical Designer, who can do it, and how your application keeps its data fresh afterwards.