IFilterBarProps · GoodData.UI API reference

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

IFilterBarProps interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Signature:

export interface IFilterBarProps

Properties

Property	Type	Description
DefaultFilterBar	ComponentType<IFilterBarProps>	*(ALPHA)* Contains reference to default implementation of the filter bar. If you are implementing a custom filter bar that decorates default filter bar, then use this component to render the default filter bar.
filters	FilterContextItem[]	*(ALPHA)* Filters that are set for the dashboard.
onAttributeFilterChanged	(filter: IDashboardAttributeFilter, displayAsLabel?: ObjRef) => void	*(ALPHA)* When value of an attribute filter that is part of the FilterBar changes, the filter bar MUST propagate the event using this callback.
onDateFilterChanged	(filter: IDashboardDateFilter \| undefined, dateFilterOptionLocalId?: string) => void	*(ALPHA)* When value of a date filter that is part of the FilterBar changes, the filter bar MUST propagate the event using this callback.
workingFilters?	FilterContextItem[]	*(ALPHA)* (Optional) Working filters that are used to dispaly filter selected values. If undefined, filters are used instead.