setAttributeFilterParents()
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Creates the SetAttributeFilterParents command. Dispatching this command will result in setting a parent-child relationship between two or more dashboard attribute filters.
When an attribute filter has a parent set up, the attribute elements that will be available in the child filter will be influenced by the selection in the parent. The child filter will show only those elements for which a link exists to the selected elements in the parent.
Take for example a model where there are continent and country attributes. You add continent and country as filters onto a dashboard and establish parent-child relationship between them. When users select some continents in the filter, the country filter will only show elements for countries on the selected contents.
export declare function setAttributeFilterParents(filterLocalId: string, parentFilters: IDashboardAttributeFilterParent[], correlationId?: string): ISetAttributeFilterParents;
Parameters
Parameter | Type | Description |
|---|---|---|
filterLocalId | string | local id of filter that will be a child in the relationship |
parentFilters | definition of the relationship to parent, this contains local id of the parent filter and one or more ‘over’ attributes. The ‘over’ attributes will be included when querying | |
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