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

# IFilterElementsQuery

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/workspace/attributes/elements/index.ts

Service to query valid filter elements for particular filter.

**Signature:**

```typescript
export interface IFilterElementsQuery 
```

## Methods

| Method | Description |
| --- | --- |
| [query()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ifilterelementsquery/index.md#ifilterelementsqueryquery) | Starts the valid elements query. |
| [withLimit(limit)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ifilterelementsquery/index.md#ifilterelementsquerywithlimit) | Sets number of valid elements to return per page. Default limit is specific per backend |
| [withOffset(offset)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ifilterelementsquery/index.md#ifilterelementsquerywithoffset) | Sets starting point for the query. Backend WILL return no data if the offset is greater than total number of valid elements. Default offset: 0 |

## Method details

### IFilterElementsQuery.query()

Starts the valid elements query.

**Signature:**

```typescript
query(): Promise<IElementsQueryResult>;
```
**Returns:**

Promise&lt;[IElementsQueryResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ielementsqueryresult/index.md)&gt;

promise of first page of the results

### IFilterElementsQuery.withLimit()

Sets number of valid elements to return per page. Default limit is specific per backend

**Signature:**

```typescript
withLimit(limit: number): IFilterElementsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| limit | number | desired max number of valid elements per page; must be a positive number |

**Returns:**

[IFilterElementsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ifilterelementsquery/index.md)

element query

### IFilterElementsQuery.withOffset()

Sets starting point for the query. Backend WILL return no data if the offset is greater than total number of valid elements. Default offset: 0

**Signature:**

```typescript
withOffset(offset: number): IFilterElementsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| offset | number | zero indexed, must be non-negative |

**Returns:**

[IFilterElementsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ifilterelementsquery/index.md)

element query
