next

Start with Visual Components

GoodData.UI comes with ready-made visual components listed in the Visual Components section. You can use these visual components as-is or customize them. You can also use the unique InsightView component that simply renders any chart that you create on the GoodData platform.

This article provides components examples and basic instructions on component usage.

NOTE: All examples in this section showcase the use of the code generated by catalog-export and assume that the application is set up with BackendProvider and WorkspaceProvider as described in Connecting to an Analytical Backend.

Responsive UI

The visual components are responsive by nature and take the whole space of their wrapper element. This behavior implicates that if you want to create a visualization with a specific height and width, you must specify those dimensions in the wrapper element. Otherwise, the visualization may not be visible.

Example

<div style={{ height: 400, width: 600 }}>
    <AreaChart ... />
</div>

Visual component props

The component props can be of the following types:

  • Style props that define the style and interaction
  • Data props that define what data to calculate and render

The style props define style and interaction of a visualization. For more information, see the articles in the Properties section.

The data props pass measures and attributes. These props are similar to the drag and drop sections in Analytical Designer and use similar names such as "View by", "Stack by" and so on. A data prop can be a single value or an array of either the IMeasure or IAttribute type, which is passed to the component as an object literal.

You can find more information about data props in the articles about individual components in the Visual Components section.

Example

const style = { height: 300 };

<div style={style}>
    <AreaChart
        measures={[Md.$TotalSales]}
        viewBy={Md.TimelineMonth.Long}
    />
</div>

Visualization lifecycle

The visualization lifecycle is a series of events that take place between mounting and rendering a visualization.

The following component props can be used as lifecycle callbacks:

PropertyDescriptionParameters
onLoadingChangedA function that is called when a loading state changes{ isLoading: boolean }
onErrorA function that is called when an error state changes{ status: string, ...}
onExportReadyA function that is called when the underlying data can be exportedfunction
onLegendReadyA function that is called when a chart legend is rendered{ legendItems: [...] }

Visualization rendered successfully

If a visualization is successfully rendered, the following events occur:

  1. The visualization is mounted and rendered immediately using LoadingComponent.
  2. The onLoadingChanged callback is called with a parameter of { isLoading: true }.
  3. The onError callback is called with a parameter of { status: "OK" }.
  4. The onLoadingChanged callback is called with a parameter of { isLoading: false }.
  5. The visualization is rendered.
  6. The onExportReady callback is called with a function that you can call to trigger the export.
  7. For visualizations that have a legend, the onLegendReady callback is called with a parameter of { legendItems: [...] }.

Visualization failed to render

If an error is encountered during rendering a visualization (for example, too much data to display), the following events occur:

  1. The visualization is mounted and rendered immediately using LoadingComponent.

  2. The onLoadingChanged callback is called with a parameter of { isLoading: true }.

  3. The onError callback is called with a parameter of { status: "OK" }.

  4. The onLoadingChanged callback is called with a parameter of { isLoading: false }.

  5. The onError callback is called with the following parameter:

    {
    "status": "DATA_TOO_LARGE_TO_DISPLAY",
    "options": {
        "dateOptionsDisabled": false
    }
}

  6. The visualization is rerendered using ErrorComponent.

← LimitationsTheme Provider →