
## PivotAreaFilter class

Represents the filter of PivotArea for PivotTable.

```js
new PivotAreaFilter()
```

## Methods

| Name | Description |
| --- | --- |
| [getFieldIndex()](#getfieldindex) |  |
| [getSelected()](#getselected) | Indicates whether this field has selection. Only works when the PivotTable is in Outline view. |
| [isSubtotalSet(subtotalType)](#issubtotalset) | Gets which subtotal is set for this filter. |
| [setSelected()](#setselected) | Indicates whether this field has selection. Only works when the PivotTable is in Outline view. |
| [setSubtotals(subtotalType, shown)](#setsubtotals) | Subtotal for the filter. |

### getFieldIndex() {#getfieldindex}

### getSelected() {#getselected}

Indicates whether this field has selection. Only works when the PivotTable is in Outline view.

### isSubtotalSet(subtotalType) {#issubtotalset}

Gets which subtotal is set for this filter.

| Parameter | Type | Description |
| --- | --- | --- |
| subtotalType | Number | PivotFieldSubtotalType |

**Returns:** boolean — `boolean`

### setSelected() {#setselected}

Indicates whether this field has selection. Only works when the PivotTable is in Outline view.

### setSubtotals(subtotalType, shown) {#setsubtotals}

Subtotal for the filter.

| Parameter | Type | Description |
| --- | --- | --- |
| subtotalType | Number | PivotFieldSubtotalType |
| shown | boolean | Indicates if showing this subtotal data. |
