PivotPageFields
Contents
[
Hide
]PivotPageFields class
Represents the pivot page field items if the pivot table data source is consolidation ranges. It only can contain up to 4 fields.
class PivotPageFields;
Constructors
| Name | Description |
|---|---|
| constructor() | Represents the pivot page field items. |
Methods
| Method | Description |
|---|---|
| getPageFieldCount() | Gets the number of page fields. |
| addPageField(string[]) | Adds a page field. |
| addIdentify(number, number[]) | Sets which item label in each page field to use to identify the data range. The pageItemIndex.Length must be equal to PageFieldCount, so please add the page field first. |
| isNull() | Checks whether the implementation object is null. |
constructor()
Represents the pivot page field items.
constructor();
getPageFieldCount()
Gets the number of page fields.
getPageFieldCount() : number;
addPageField(string[])
Adds a page field.
addPageField(pageItems: string[]) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pageItems | string[] | Page field item label |
addIdentify(number, number[])
Sets which item label in each page field to use to identify the data range. The pageItemIndex.Length must be equal to PageFieldCount, so please add the page field first.
addIdentify(rangeIndex: number, pageItemIndex: number[]) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| rangeIndex | number | The consolidation data range index. |
| pageItemIndex | number[] | The page item index in the each page field. /// pageItemIndex[2] = 1 means the second item in the third field to use to identify this range. /// pageItemIndex[1] = -1 means no item in the second field to use to identify this range /// and MS will auto create “blank” item in the second field to identify this range. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;