PivotAreaFilter
Contents
[
Hide
]PivotAreaFilter class
Represents the filter of PivotArea for PivotTable.
class PivotAreaFilter;
Constructors
| Name | Description |
|---|---|
| constructor() | Default Constructor. |
Methods
| Method | Description |
|---|---|
| getSelected() | Indicates whether this field has selection. Only works when the PivotTable is in Outline view. |
| setSelected(boolean) | Indicates whether this field has selection. Only works when the PivotTable is in Outline view. |
| isSubtotalSet(PivotFieldSubtotalType) | Gets which subtotal is set for this filter. |
| setSubtotals(PivotFieldSubtotalType, boolean) | Subtotal for the filter. |
| isNull() | Checks whether the implementation object is null. |
constructor()
Default Constructor.
constructor();
getSelected()
Indicates whether this field has selection. Only works when the PivotTable is in Outline view.
getSelected() : boolean;
setSelected(boolean)
Indicates whether this field has selection. Only works when the PivotTable is in Outline view.
setSelected(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
isSubtotalSet(PivotFieldSubtotalType)
Gets which subtotal is set for this filter.
isSubtotalSet(subtotalType: PivotFieldSubtotalType) : boolean;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| subtotalType | PivotFieldSubtotalType | The subtotal function type. |
setSubtotals(PivotFieldSubtotalType, boolean)
Subtotal for the filter.
setSubtotals(subtotalType: PivotFieldSubtotalType, shown: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| subtotalType | PivotFieldSubtotalType | The subtotal function. |
| shown | boolean | Indicates if showing this subtotal data. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;