setAttributeFilterDependentDateFilters()
Home > @gooddata/sdk-ui-dashboard > setAttributeFilterDependentDateFilters
setAttributeFilterDependentDateFilters() 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 SetAttributeFilterDependentDateFilters command. Dispatching this command will result in setting a relationship between one dashboard attribute filters and one or more date filters.
When an attribute filter has a dependent date filter set up, the attribute elements that will be available in the attribute filter will be influenced by the selection in the date filter. The attribute filter will show only those elements for which a link exists to the selected elements in the dependent date filter.
Signature:
export declare function setAttributeFilterDependentDateFilters(filterLocalId: string, dependentDateFilters: IDashboardAttributeFilterByDate[], correlationId?: string): ISetAttributeFilterDependentDateFilters;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
filterLocalId |
string |
local id of filter that will be a child in the relationship |
|
dependentDateFilters | ||
|
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: