changeInsightWidgetInsight()
Home > @gooddata/sdk-ui-dashboard > changeInsightWidgetInsight
changeInsightWidgetInsight() function
This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Creates the ChangeInsightWidgetInsight command. Dispatching this command will result in change of what insight is rendered inside particular insight widget - while keeping all the other setup the same (filtering, drilling).
Signature:
export declare function changeInsightWidgetInsight(ref: ObjRef, insightRef: ObjRef, visualizationProperties?: VisualizationProperties, correlationId?: string): IChangeInsightWidgetInsight;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
ref |
reference to insight widget whose insight should be changed | |
|
insightRef |
reference to the new insight to use in the widget | |
|
visualizationProperties |
(Optional) specify visualization properties to use. Undefined value means keeping the existing properties on record in the widget | |
|
correlationId |
string |
(Optional) specify correlation id to use for this command. this will be included in all events that will be emitted during the command processing |
Returns: