keyDriverAnalysis()
Home > @gooddata/sdk-ui-dashboard > keyDriverAnalysis
keyDriverAnalysis() 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 IKeyDriverAnalysis command. Dispatching this command will result into applying intersection attribute filters to the dashboard and insight will ignore these filters further Eventually a IDashboardKeyDriverAnalysisResolved event will be dispatched at the end.
Signature:
export declare function keyDriverAnalysis(drillDefinition: IKeyDriveAnalysis, drillEvent: IDashboardDrillEvent, filters: FilterContextItem[], keyDriveItem: IDashboardKeyDriverCombinationItem, correlationId?: string): IKeyDriverAnalysis;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
drillDefinition |
drill definition to apply. | |
|
drillEvent |
original drill event, that triggered this particular drill interaction. | |
|
filters |
filters to apply. | |
|
keyDriveItem |
IDashboardKeyDriverCombinationItem |
key driver item to analyze. |
|
correlationId |
string |
(Optional) specify correlation id. It will be included in all events that will be emitted during the command processing. |
Returns:
cross filtering command