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. |
| format(number, number, Style) | Formats the cell in the pivottable area |
| format(PivotArea, Style) | Formats selected area of the PivotTable. |
| format(CellArea, Style) | Formats selected area of the PivotTable. |
| formatArea(PivotFieldType, number, PivotFieldSubtotalType, PivotTableSelectionType, boolean, boolean, Style) | Formats selected area. |
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.
format(number, number, Style)
Formats the cell in the pivottable area
format(row: number, column: number, style: Style) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| row | number | Row Index of the cell |
| column | number | Column index of the cell |
| style | Style | Style which is to format the cell |
format(PivotArea, Style)
Formats selected area of the PivotTable.
format(pivotArea: PivotArea, style: Style) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pivotArea | PivotArea | The selected pivot view area. |
| style | Style | The formatted setting. |
format(CellArea, Style)
Formats selected area of the PivotTable.
format(ca: CellArea, style: Style) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| ca | CellArea | The range of the cells. |
| style | Style | The style |
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