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

# IRankingFilterProps

- Package: [@gooddata/sdk-ui-filters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/index.md)
- Kind: interface
- Stability: beta
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-filters/src/RankingFilter/RankingFilter.tsx

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
export interface IRankingFilterProps 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [attributeItems](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.irankingfilterprops/index.md#irankingfilterpropsattributeitems) |  | [IAttributeDropdownItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.iattributedropdownitem/index.md)[] | **_(BETA)_** |
| [buttonTitle](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.irankingfilterprops/index.md#irankingfilterpropsbuttontitle) |  | string | **_(BETA)_** |
| [customGranularitySelection?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.irankingfilterprops/index.md#irankingfilterpropscustomgranularityselection) |  | [ICustomGranularitySelection](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.icustomgranularityselection/index.md) | **_(BETA)_** _(Optional)_ |
| [filter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.irankingfilterprops/index.md#irankingfilterpropsfilter) |  | [IRankingFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.irankingfilter/index.md) | **_(BETA)_** |
| [locale?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.irankingfilterprops/index.md#irankingfilterpropslocale) |  | string | **_(BETA)_** _(Optional)_ |
| [measureItems](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.irankingfilterprops/index.md#irankingfilterpropsmeasureitems) |  | [IMeasureDropdownItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.imeasuredropdownitem/index.md)[] | **_(BETA)_** |
| [onApply](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.irankingfilterprops/index.md#irankingfilterpropsonapply) |  | (filter: [IRankingFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.irankingfilter/index.md)) => void | **_(BETA)_** |
| [onCancel?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.irankingfilterprops/index.md#irankingfilterpropsoncancel) |  | () => void | **_(BETA)_** _(Optional)_ |
| [onDropDownItemMouseOut?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.irankingfilterprops/index.md#irankingfilterpropsondropdownitemmouseout) |  | () => void | **_(BETA)_** _(Optional)_ |
| [onDropDownItemMouseOver?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-filters/sdk-ui-filters.irankingfilterprops/index.md#irankingfilterpropsondropdownitemmouseover) |  | (ref: [ObjRefInScope](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objrefinscope/index.md)) => void | **_(BETA)_** _(Optional)_ |

## Property details

### IRankingFilterProps.attributeItems

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
attributeItems: IAttributeDropdownItem[];
```

### IRankingFilterProps.buttonTitle

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
buttonTitle: string;
```

### IRankingFilterProps.customGranularitySelection

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
customGranularitySelection?: ICustomGranularitySelection;
```

### IRankingFilterProps.filter

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
filter: IRankingFilter;
```

### IRankingFilterProps.locale

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
locale?: string;
```

### IRankingFilterProps.measureItems

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
measureItems: IMeasureDropdownItem[];
```

### IRankingFilterProps.onApply

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
onApply: (filter: IRankingFilter) => void;
```

### IRankingFilterProps.onCancel

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
onCancel?: () => void;
```

### IRankingFilterProps.onDropDownItemMouseOut

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
onDropDownItemMouseOut?: () => void;
```

### IRankingFilterProps.onDropDownItemMouseOver

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
onDropDownItemMouseOver?: (ref: ObjRefInScope) => void;
```