> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IFilterBarProps

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/presentation/filterBar/filterBar/types.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
export interface IFilterBarProps 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [DefaultFilterBar](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ifilterbarprops/index.md#ifilterbarpropsdefaultfilterbar) |  | ComponentType<[IFilterBarProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ifilterbarprops/index.md)> | **_(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. |
| [filterGroupsConfig?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ifilterbarprops/index.md#ifilterbarpropsfiltergroupsconfig) |  | [IDashboardFilterGroupsConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardfiltergroupsconfig/index.md) | **_(ALPHA)_** _(Optional)_ Filter groups config. |
| [filters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ifilterbarprops/index.md#ifilterbarpropsfilters) |  | [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[] | **_(ALPHA)_** Filters that are set for the dashboard. |
| [onAttributeFilterChanged](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ifilterbarprops/index.md#ifilterbarpropsonattributefilterchanged) |  | (filter: [DashboardAttributeFilterItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.dashboardattributefilteritem/index.md), displayAsLabel?: [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md)) => 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](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ifilterbarprops/index.md#ifilterbarpropsondatefilterchanged) |  | (filter: [IDashboardDateFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboarddatefilter/index.md) \| 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. |
| [onMeasureValueFilterChanged?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ifilterbarprops/index.md#ifilterbarpropsonmeasurevaluefilterchanged) |  | (filter: [IDashboardMeasureValueFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardmeasurevaluefilter/index.md), conditions: [MeasureValueFilterCondition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.measurevaluefiltercondition/index.md)[] \| undefined, isWorkingSelectionChange?: boolean) => void | **_(ALPHA)_** _(Optional)_ When the condition of a dashboard measure value filter changes, the filter bar MUST propagate the event using this callback. |
| [workingFilters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ifilterbarprops/index.md#ifilterbarpropsworkingfilters) |  | [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md)[] | **_(ALPHA)_** _(Optional)_ Working filters that are used to dispaly filter selected values. If undefined, filters are used instead. |

## Property details

### IFilterBarProps.DefaultFilterBar

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

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.

**Signature:**

```typescript
DefaultFilterBar: ComponentType<IFilterBarProps>;
```

### IFilterBarProps.filterGroupsConfig

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Filter groups config.

**Signature:**

```typescript
filterGroupsConfig?: IDashboardFilterGroupsConfig;
```

### IFilterBarProps.filters

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Filters that are set for the dashboard.

**Signature:**

```typescript
filters: FilterContextItem[];
```

### IFilterBarProps.onAttributeFilterChanged

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

When value of an attribute filter that is part of the FilterBar changes, the filter bar MUST propagate the event using this callback.

**Signature:**

```typescript
onAttributeFilterChanged: (filter: DashboardAttributeFilterItem, displayAsLabel?: ObjRef) => void;
```

### IFilterBarProps.onDateFilterChanged

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

When value of a date filter that is part of the FilterBar changes, the filter bar MUST propagate the event using this callback.

**Signature:**

```typescript
onDateFilterChanged: (filter: IDashboardDateFilter | undefined, dateFilterOptionLocalId?: string) => void;
```

### IFilterBarProps.onMeasureValueFilterChanged

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

When the condition of a dashboard measure value filter changes, the filter bar MUST propagate the event using this callback.

**Signature:**

```typescript
onMeasureValueFilterChanged?: (filter: IDashboardMeasureValueFilter, conditions: MeasureValueFilterCondition[] | undefined, isWorkingSelectionChange?: boolean) => void;
```

### IFilterBarProps.workingFilters

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Working filters that are used to dispaly filter selected values. If undefined, filters are used instead.

**Signature:**

```typescript
workingFilters?: FilterContextItem[];
```