PivotArea
PivotArea class
Presents the selected area of the PivotTable.
class PivotArea;
Constructors
Constructor | Description |
---|---|
constructor(PivotTable) | Presents the selected area of the PivotTable. |
Properties
Property | Type | Description |
---|---|---|
filters | PivotAreaFilterCollection | Readonly. 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 include the item labels. |
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 | PivotFieldType | Gets and sets the region of the PivotTable to which this rule applies. |
ruleType | PivotAreaType | Gets and sets the type of selection rule. |
isOutline | boolean | Indicates whether the rule refers to an area that is in outline mode. |
Methods
Method | Description |
---|---|
getFilters() | @deprecated. Please use the ‘filters’ property instead. Gets all filters for this PivotArea. |
getOnlyData() | @deprecated. Please use the ‘onlyData’ property instead. 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) | @deprecated. Please use the ‘onlyData’ property instead. 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() | @deprecated. Please use the ‘onlyLabel’ property instead. Indicates whether only the data labels for an item selection are selected. |
setOnlyLabel(boolean) | @deprecated. Please use the ‘onlyLabel’ property instead. Indicates whether only the data labels for an item selection are selected. |
isRowGrandIncluded() | @deprecated. Please use the ‘isRowGrandIncluded’ property instead. Indicates whether the row grand total is included. |
setIsRowGrandIncluded(boolean) | @deprecated. Please use the ‘isRowGrandIncluded’ property instead. Indicates whether the row grand total is included. |
isColumnGrandIncluded() | @deprecated. Please use the ‘isColumnGrandIncluded’ property instead. Indicates whether the column grand total is included. |
setIsColumnGrandIncluded(boolean) | @deprecated. Please use the ‘isColumnGrandIncluded’ property instead. Indicates whether the column grand total is included. |
getAxisType() | @deprecated. Please use the ‘axisType’ property instead. Gets and sets the region of the PivotTable to which this rule applies. |
setAxisType(PivotFieldType) | @deprecated. Please use the ‘axisType’ property instead. Gets and sets the region of the PivotTable to which this rule applies. |
getRuleType() | @deprecated. Please use the ‘ruleType’ property instead. Gets and sets the type of selection rule. |
setRuleType(PivotAreaType) | @deprecated. Please use the ‘ruleType’ property instead. Gets and sets the type of selection rule. |
isOutline() | @deprecated. Please use the ‘isOutline’ property instead. Indicates whether the rule refers to an area that is in outline mode. |
setIsOutline(boolean) | @deprecated. Please use the ‘isOutline’ property instead. Indicates whether the rule refers to an area that is in outline mode. |
select(PivotFieldType, number, PivotTableSelectionType) | Select the area with filters. |
selectField(PivotFieldType, string) | Select a field in the region as an area. |
selectField(PivotFieldType, PivotField) | Select a field in the region as an area. |
getCellAreas() | Gets cell areas of this pivot area. |
isNull() | Checks whether the implementation object is null. |
constructor(PivotTable)
Presents the selected area of the PivotTable.
constructor(table: PivotTable);
Parameters:
Parameter | Type | Description |
---|---|---|
table | PivotTable |
filters
Readonly. Gets all filters for this PivotArea.
filters : PivotAreaFilterCollection;
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.
onlyData : boolean;
onlyLabel
Indicates whether only the data labels for an item selection are selected.
onlyLabel : boolean;
isRowGrandIncluded
Indicates whether the row grand total is included.
isRowGrandIncluded : boolean;
isColumnGrandIncluded
Indicates whether the column grand total is included.
isColumnGrandIncluded : boolean;
axisType
Gets and sets the region of the PivotTable to which this rule applies.
axisType : PivotFieldType;
ruleType
Gets and sets the type of selection rule.
ruleType : PivotAreaType;
isOutline
Indicates whether the rule refers to an area that is in outline mode.
isOutline : boolean;
getFilters()
@deprecated. Please use the ‘filters’ property instead. Gets all filters for this PivotArea.
getFilters() : PivotAreaFilterCollection;
Returns
getOnlyData()
@deprecated. Please use the ‘onlyData’ property instead. 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)
@deprecated. Please use the ‘onlyData’ property instead. 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:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getOnlyLabel()
@deprecated. Please use the ‘onlyLabel’ property instead. Indicates whether only the data labels for an item selection are selected.
getOnlyLabel() : boolean;
setOnlyLabel(boolean)
@deprecated. Please use the ‘onlyLabel’ property instead. Indicates whether only the data labels for an item selection are selected.
setOnlyLabel(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
isRowGrandIncluded()
@deprecated. Please use the ‘isRowGrandIncluded’ property instead. Indicates whether the row grand total is included.
isRowGrandIncluded() : boolean;
setIsRowGrandIncluded(boolean)
@deprecated. Please use the ‘isRowGrandIncluded’ property instead. Indicates whether the row grand total is included.
setIsRowGrandIncluded(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
isColumnGrandIncluded()
@deprecated. Please use the ‘isColumnGrandIncluded’ property instead. Indicates whether the column grand total is included.
isColumnGrandIncluded() : boolean;
setIsColumnGrandIncluded(boolean)
@deprecated. Please use the ‘isColumnGrandIncluded’ property instead. Indicates whether the column grand total is included.
setIsColumnGrandIncluded(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getAxisType()
@deprecated. Please use the ‘axisType’ property instead. Gets and sets the region of the PivotTable to which this rule applies.
getAxisType() : PivotFieldType;
Returns
setAxisType(PivotFieldType)
@deprecated. Please use the ‘axisType’ property instead. Gets and sets the region of the PivotTable to which this rule applies.
setAxisType(value: PivotFieldType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | PivotFieldType | The value to set. |
getRuleType()
@deprecated. Please use the ‘ruleType’ property instead. Gets and sets the type of selection rule.
getRuleType() : PivotAreaType;
Returns
setRuleType(PivotAreaType)
@deprecated. Please use the ‘ruleType’ property instead. Gets and sets the type of selection rule.
setRuleType(value: PivotAreaType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | PivotAreaType | The value to set. |
isOutline()
@deprecated. Please use the ‘isOutline’ property instead. Indicates whether the rule refers to an area that is in outline mode.
isOutline() : boolean;
setIsOutline(boolean)
@deprecated. Please use the ‘isOutline’ property instead. Indicates whether the rule refers to an area that is in outline mode.
setIsOutline(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
select(PivotFieldType, number, PivotTableSelectionType)
Select the area with filters.
select(axisType: PivotFieldType, fieldPosition: number, selectionType: PivotTableSelectionType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
axisType | PivotFieldType | 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 | 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.
selectField(axisType: PivotFieldType, fieldName: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
axisType | PivotFieldType | The region type. |
fieldName | string | The name of pivot field. |
selectField(PivotFieldType, PivotField)
Select a field in the region as an area.
selectField(axisType: PivotFieldType, field: PivotField) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
axisType | PivotFieldType | The region type. |
field | PivotField | The pivot field. |
getCellAreas()
Gets cell areas of this pivot area.
getCellAreas() : CellArea[];
Returns
CellArea[]
isNull()
Checks whether the implementation object is null.
isNull() : boolean;