PivotTableFormatCollection
Contents
[
Hide
]PivotTableFormatCollection class
Represents the collection of formats applied to PivotTable.
class PivotTableFormatCollection;
Methods
| Method | Description |
|---|---|
| get(number) | Gets the format by the index. |
| add() | Add a PivotTableFormat. |
| formatArea(PivotFieldType, number, PivotFieldSubtotalType, PivotTableSelectionType, boolean, boolean, Style) | Formats selected area. |
| getCount() | Gets the number of elements contained in. |
| isNull() | Checks whether the implementation object is null. |
get(number)
Gets the format by the index.
get(index: number) : PivotTableFormat;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
Returns
add()
Add a PivotTableFormat.
add() : number;
Returns
The index of new format.
formatArea(PivotFieldType, number, PivotFieldSubtotalType, PivotTableSelectionType, boolean, boolean, Style)
Formats selected area.
formatArea(axisType: PivotFieldType, fieldPosition: number, subtotalType: PivotFieldSubtotalType, selectionType: PivotTableSelectionType, isGrandRow: boolean, isGrandColumn: boolean, style: Style) : PivotTableFormat;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| axisType | PivotFieldType | The region of the PivotTable to which this rule applies. |
| fieldPosition | number | Position of the field within the axis to which this rule applies. |
| subtotalType | PivotFieldSubtotalType | The subtotal filter type of the pivot field |
| selectionType | PivotTableSelectionType | Indicates how to select data. |
| isGrandRow | boolean | Indicates whether selecting grand total rows. |
| isGrandColumn | boolean | Indicates whether selecting grand total columns. |
| style | Style | The style which appies to the area of the pivot table. |
Returns
getCount()
Gets the number of elements contained in.
getCount() : number;
isNull()
Checks whether the implementation object is null.
isNull() : boolean;