withCustomInsightBodyProvider()
Home > @gooddata/sdk-ui-dashboard > IDashboardInsightCustomizer > withCustomInsightBodyProvider
IDashboardInsightCustomizer.withCustomInsightBodyProvider() method
This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Register a provider for React components to render insight body inside of the DefaultDashboardInsight.
Signature:
withCustomInsightBodyProvider(provider: OptionalInsightBodyComponentProvider): IDashboardInsightCustomizer;
Parameters
| Parameter | Type | Description |
|---|---|---|
| provider | OptionalInsightBodyComponentProvider | provider to register |
Returns:
self, for call chaining sakes
Remarks
A provider takes the insight and widget that it is part of as input and is expected to return a React component that should be used to render that insight.
If the provider returns undefined then:
- if there are other providers registered, they will be called to see if they can provide a component to render the insight - if there are no other providers registered, the default, built-in component will be used.
You may register multiple providers. They will be evaluated in the order you register them.