withCustomProvider()
Home > @gooddata/sdk-ui-dashboard > IDashboardInsightCustomizer > withCustomProvider
IDashboardInsightCustomizer.withCustomProvider() method
Register a provider for React components to render insights.
Signature:
withCustomProvider(provider: OptionalInsightComponentProvider): IDashboardInsightCustomizer;
Parameters
Parameter | Type | Description |
---|---|---|
provider | OptionalInsightComponentProvider | 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.
See the IDashboardInsightCustomizer.withTag() convenience method to register components for insights with particular tags.