Aspose::Cells::Pivot::PivotArea class

PivotArea class

Presents the selected area of the PivotTable.

class PivotArea

Methods

MethodDescription
GetAxisType()Gets and sets the region of the PivotTable to which this rule applies.
GetCellAreas()Gets cell areas of this pivot area.
GetFilters()Gets all filters for this PivotArea.
GetOnlyData()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.
GetOnlyLabel()Indicates whether only the data labels for an item selection are selected.
GetRuleType()Gets and sets the type of selection rule.
IsColumnGrandIncluded()Indicates whether the column grand total is included.
IsNull() constChecks whether the implementation object is nullptr.
IsOutline()Indicates whether the rule refers to an area that is in outline mode.
IsRowGrandIncluded()Indicates whether the row grand total is included.
explicit operator bool() constoperator bool()
operator=(const PivotArea& src)operator=
explicit PivotArea(const PivotTable& table)Presents the selected area of the PivotTable.
PivotArea(PivotArea_Impl* impl)Constructs from an implementation object.
PivotArea(const PivotArea& src)Copy constructor.
Select(PivotFieldType axisType, int32_t fieldPosition, PivotTableSelectionType selectionType)Select the area with filters.
SelectField(PivotFieldType axisType, const U16String& fieldName)Select a field in the region as an area.
SelectField(PivotFieldType axisType, const char16_t* fieldName)Select a field in the region as an area.
SelectField(PivotFieldType axisType, const PivotField& field)Select a field in the region as an area.
SetAxisType(PivotFieldType value)Gets and sets the region of the PivotTable to which this rule applies.
SetIsColumnGrandIncluded(bool value)Indicates whether the column grand total is included.
SetIsOutline(bool value)Indicates whether the rule refers to an area that is in outline mode.
SetIsRowGrandIncluded(bool value)Indicates whether the row grand total is included.
SetOnlyData(bool value)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.
SetOnlyLabel(bool value)Indicates whether only the data labels for an item selection are selected.
SetRuleType(PivotAreaType value)Gets and sets the type of selection rule.
~PivotArea()Destructor.

Fields

FieldDescription
_implThe implementation object.

See Also