PivotArea

PivotArea class

Presents the selected area of the PivotTable.

class PivotArea;

Constructors

NameDescription
constructor(PivotTable)Presents the selected area of the PivotTable.

Methods

MethodDescription
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.
setOnlyData(boolean)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.
setOnlyLabel(boolean)Indicates whether only the data labels for an item selection are selected.
isRowGrandIncluded()Indicates whether the row grand total is included.
setIsRowGrandIncluded(boolean)Indicates whether the row grand total is included.
isColumnGrandIncluded()Indicates whether the column grand total is included.
setIsColumnGrandIncluded(boolean)Indicates whether the column grand total is included.
getAxisType()Gets and sets the region of the PivotTable to which this rule applies.
setAxisType(PivotFieldType)Gets and sets the region of the PivotTable to which this rule applies.
getRuleType()Gets and sets the type of selection rule.
setRuleType(PivotAreaType)Gets and sets the type of selection rule.
isOutline()Indicates whether the rule refers to an area that is in outline mode.
setIsOutline(boolean)Indicates whether the rule refers to an area that is in outline mode.
select(PivotFieldType, number, PivotTableSelectionType)Select the area with filters.
isNull()Checks whether the implementation object is null.

constructor(PivotTable)

Presents the selected area of the PivotTable.

constructor(table: PivotTable);

Parameters:

ParameterTypeDescription
tablePivotTable

getFilters()

Gets all filters for this PivotArea.

getFilters() : PivotAreaFilterCollection;

Returns

PivotAreaFilterCollection

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.

getOnlyData() : boolean;

setOnlyData(boolean)

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.

setOnlyData(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getOnlyLabel()

Indicates whether only the data labels for an item selection are selected.

getOnlyLabel() : boolean;

setOnlyLabel(boolean)

Indicates whether only the data labels for an item selection are selected.

setOnlyLabel(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

isRowGrandIncluded()

Indicates whether the row grand total is included.

isRowGrandIncluded() : boolean;

setIsRowGrandIncluded(boolean)

Indicates whether the row grand total is included.

setIsRowGrandIncluded(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

isColumnGrandIncluded()

Indicates whether the column grand total is included.

isColumnGrandIncluded() : boolean;

setIsColumnGrandIncluded(boolean)

Indicates whether the column grand total is included.

setIsColumnGrandIncluded(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getAxisType()

Gets and sets the region of the PivotTable to which this rule applies.

getAxisType() : PivotFieldType;

Returns

PivotFieldType

setAxisType(PivotFieldType)

Gets and sets the region of the PivotTable to which this rule applies.

setAxisType(value: PivotFieldType) : void;

Parameters:

ParameterTypeDescription
valuePivotFieldTypeThe value to set.

getRuleType()

Gets and sets the type of selection rule.

getRuleType() : PivotAreaType;

Returns

PivotAreaType

setRuleType(PivotAreaType)

Gets and sets the type of selection rule.

setRuleType(value: PivotAreaType) : void;

Parameters:

ParameterTypeDescription
valuePivotAreaTypeThe value to set.

isOutline()

Indicates whether the rule refers to an area that is in outline mode.

isOutline() : boolean;

setIsOutline(boolean)

Indicates whether the rule refers to an area that is in outline mode.

setIsOutline(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

select(PivotFieldType, number, PivotTableSelectionType)

Select the area with filters.

select(axisType: PivotFieldType, fieldPosition: number, selectionType: PivotTableSelectionType) : void;

Parameters:

ParameterTypeDescription
axisTypePivotFieldTypeThe region of the PivotTable to which this rule applies.
fieldPositionnumberPosition of the field within the axis to which this rule applies.
selectionTypePivotTableSelectionTypeSpecifies what can be selected in a PivotTable during a structured selection.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;