PivotArea
PivotArea class
Presents the selected area of the PivotTable.
Constructors
| Name | Description |
|---|---|
| PivotArea | Presents the selected area of the PivotTable. |
Properties
| Name | Type | Description |
|---|---|---|
| Filters | PivotAreaFilterCollection | Gets all filters for this PivotArea. |
| OnlyData | boolean | Indicates whether only the data values (in the data area of the view) for an item selection are selected and does not in |
| OnlyLabel | boolean | Indicates whether only the data labels for an item selection are selected. |
| IsRowGrandIncluded | boolean | Indicates whether the row grand total is included. |
| IsColumnGrandIncluded | boolean | Indicates whether the column grand total is included. |
| AxisType | Number | Gets and sets the region of the PivotTable to which this rule applies. The value of the property is PivotFieldType integ |
| RuleType | Number | Gets and sets the type of selection rule. The value of the property is PivotAreaType integer constant. |
| IsOutline | boolean | Indicates whether the rule refers to an area that is in outline mode. |
Methods
| Name | Description |
|---|---|
| select | Select the area with filters. |
| selectField | |
| getCellAreas |
PivotArea(table)
Presents the selected area of the PivotTable.
| Parameter | Type | Description |
|---|---|---|
| table | PivotTable |
PivotArea.Filters property
Gets all filters for this PivotArea.
Type: PivotAreaFilterCollection
PivotArea.OnlyData property
Indicates whether only the data values (in the data area of the view) for an item selection are selected and does not include the item labels.
Type: boolean
PivotArea.OnlyLabel property
Indicates whether only the data labels for an item selection are selected.
Type: boolean
PivotArea.IsRowGrandIncluded property
Indicates whether the row grand total is included.
Type: boolean
PivotArea.IsColumnGrandIncluded property
Indicates whether the column grand total is included.
Type: boolean
PivotArea.AxisType property
Gets and sets the region of the PivotTable to which this rule applies. The value of the property is PivotFieldType integer constant.
Type: Number
PivotArea.RuleType property
Gets and sets the type of selection rule. The value of the property is PivotAreaType integer constant.
Type: Number
PivotArea.IsOutline property
Indicates whether the rule refers to an area that is in outline mode.
Type: boolean
select(axisType, fieldPosition, selectionType)
Select the area with filters.
| Parameter | Type | Description |
|---|---|---|
| axisType | Number | A PivotFieldType value. The region of the PivotTable to which this rule applies. |
| fieldPosition | Number | Position of the field within the axis to which this rule applies. |
| selectionType | Number | A PivotTableSelectionType value. Specifies what can be selected in a PivotTable during a structured selection. |