Class PivotArea
Namespace: Aspose.Cells.Pivot
Assembly: Aspose.Cells.dll (25.2.0)
Presents the selected area of the PivotTable.
public class PivotArea
Inheritance
Inherited Members
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Constructors
PivotArea(PivotTable)
Presents the selected area of the PivotTable.
public PivotArea(PivotTable table)
Parameters
table
PivotTable
Properties
AxisType
Gets and sets the region of the PivotTable to which this rule applies.
public PivotFieldType AxisType { get; set; }
Property Value
Filters
Gets all filters for this PivotArea.
public PivotAreaFilterCollection Filters { get; }
Property Value
IsColumnGrandIncluded
Indicates whether the column grand total is included.
public bool IsColumnGrandIncluded { get; set; }
Property Value
IsOutline
Indicates whether the rule refers to an area that is in outline mode.
public bool IsOutline { get; set; }
Property Value
IsRowGrandIncluded
Indicates whether the row grand total is included.
public bool IsRowGrandIncluded { get; set; }
Property Value
OnlyData
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.
public bool OnlyData { get; set; }
Property Value
OnlyLabel
Indicates whether only the data labels for an item selection are selected.
public bool OnlyLabel { get; set; }
Property Value
RuleType
Gets and sets the type of selection rule.
public PivotAreaType RuleType { get; set; }
Property Value
Methods
GetCellAreas()
Gets cell areas of this pivot area.
public CellArea[] GetCellAreas()
Returns
CellArea[]
Select(PivotFieldType, int, PivotTableSelectionType)
Select the area with filters.
public void Select(PivotFieldType axisType, int fieldPosition, PivotTableSelectionType selectionType)
Parameters
axisType
PivotFieldType
The region of the PivotTable to which this rule applies.
fieldPosition
int
Position of the field within the axis to which this rule applies.
selectionType
PivotTableSelectionType
Specifies what can be selected in a PivotTable during a structured selection.
SelectField(PivotFieldType, string)
Select a field in the region as an area.
public void SelectField(PivotFieldType axisType, string fieldName)
Parameters
axisType
PivotFieldType
The region type.
fieldName
string
The name of pivot field.
SelectField(PivotFieldType, PivotField)
Select a field in the region as an area.
public void SelectField(PivotFieldType axisType, PivotField field)
Parameters
axisType
PivotFieldType
The region type.
field
PivotField
The pivot field.