crossFiltering()

Home > @gooddata/sdk-ui-dashboard > crossFiltering

crossFiltering() 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 ICrossFiltering command. Dispatching this command will result into applying intersection attribute filters to the dashboard and insight will ignore these filters further Eventually a IDashboardCrossFilteringResolved event will be dispatched at the end.

Signature:

export declare function crossFiltering(insight: IInsight, drillDefinition: ICrossFilteringModel, drillEvent: IDashboardDrillEvent, correlationId?: string): ICrossFiltering;

Parameters

Parameter	Type	Description
insight	IInsight	insight from which the cross filtering is coming.
drillDefinition	ICrossFilteringModel	drill definition to apply.
drillEvent	IDashboardDrillEvent	original drill event, that triggered this particular drill interaction.
correlationId	string	(Optional) specify correlation id. It will be included in all events that will be emitted during the command processing.

Returns:

ICrossFiltering

cross filtering command