PivotArea class

PivotArea class

Presents the selected area of the PivotTable.

The PivotArea type exposes the following members:

Constructors

ConstructorDescription
__init__(self, table)Presents the selected area of the PivotTable.

Properties

PropertyDescription
filtersGets all filters for this PivotArea.
only_dataIndicates 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.
only_labelIndicates whether only the data labels for an item selection are selected.
is_row_grand_includedIndicates whether the row grand total is included.
is_column_grand_includedIndicates whether the column grand total is included.
axis_typeGets and sets the region of the PivotTable to which this rule applies.
rule_typeGets and sets the type of selection rule.
is_outlineIndicates whether the rule refers to an area that is in outline mode.

Methods

MethodDescription
select_field(self, axis_type, field_name)Select a field in the region as an area.
select_field(self, axis_type, field)Select a field in the region as an area.
select(self, axis_type, field_position, selection_type)Select the area with filters.
get_cell_areas(self)Gets cell areas of this pivot area.

See Also