IDashboardInsightCustomizer
Set of functions you can use to customize how insights are rendered.
export interface IDashboardInsightCustomizer
Methods
Method | Description |
|---|---|
Register a factory for insight decorator providers. | |
(ALPHA) Register a provider for React components to render insight body inside of the DefaultDashboardInsight(). | |
Register a provider for React components to render insights. | |
(ALPHA) Register a provider for the component standing in for an insight widget the current user is not allowed to see. | |
A convenience method that will register a specific React component to use for rendering any insight that is tagged with the provided |
Method details
IDashboardInsightCustomizer.withCustomDecorator()method
Register a factory for insight decorator providers.
withCustomDecorator(providerFactory: (next: InsightComponentProvider) => OptionalInsightComponentProvider): IDashboardInsightCustomizer;
Parameters
Parameter | Type | Description |
|---|---|---|
providerFactory | (next: InsightComponentProvider) => OptionalInsightComponentProvider | factory |
Returns
Remarks
Decorators are a way to add customizations or embellishments on top of an existing component. Decorators are more complex to write because they need to work with the component they should decorate and add ‘something’ on top of that component.
This is best illustrated on an example:
Example
withCustomDecorator((next) => {
return (insight, widget) => {
if (some_condition_to_prevent_decoration) {
return undefined;
}
// Make sure you call this outside the component render function,
// otherwise a new instance of the decorated component is created on each re-render.
const Decorated = next(insight, widget);
function MyCustomDecorator(props) {
return (
<div>
<p>My Custom Decoration</p>
<Decorated {...props} />
</div>
)
}
return MyCustomDecorator;
}
})
The above shows how to register a decorator that will use some condition to determine whether particular insight is eligible for decoration. If yes, it will add some extra text in front of the insight. Decorator defers rendering of the actual insight to the underlying provider.
Note: the factory function that you specify will be called immediately at the registration time. The provider that it returns will be called at render time.
IDashboardInsightCustomizer.withCustomInsightBodyProvider()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Register a provider for React components to render insight body inside of the DefaultDashboardInsight().
withCustomInsightBodyProvider(provider: OptionalInsightBodyComponentProvider): IDashboardInsightCustomizer;
Parameters
Parameter | Type | Description |
|---|---|---|
provider | 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.
IDashboardInsightCustomizer.withCustomProvider()method
Register a provider for React components to render insights.
withCustomProvider(provider: OptionalInsightComponentProvider): IDashboardInsightCustomizer;
Parameters
Parameter | Type | Description |
|---|---|---|
provider | 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.
IDashboardInsightCustomizer.withRestrictedPlaceholderProvider()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Register a provider for the component standing in for an insight widget the current user is not allowed to see.
withRestrictedPlaceholderProvider(provider: OptionalRestrictedPlaceholderComponentProvider): IDashboardInsightCustomizer;
Parameters
Parameter | Type | Description |
|---|---|---|
provider | provider of the replacement component |
Returns
self, for call chaining
Remarks
The insight is deliberately not passed to the provider — it is the object being withheld. Returning undefined keeps the default placeholder for that widget.
IDashboardInsightCustomizer.withTag()method
A convenience method that will register a specific React component to use for rendering any insight that is tagged with the provided tag.
withTag(tag: string, component: CustomDashboardInsightComponent): IDashboardInsightCustomizer;
Parameters
Parameter | Type | Description |
|---|---|---|
tag | string | tag to look for on the insight, this function will do nothing if this argument is an empty string |
component | component to use if the tag is found |
Returns
self, for call chaining sakes
Remarks
If plugins register multiple providers for the same tag, then the provider will be picked using ’last-win’ strategy.