GetPivotData

Returns a Range object with information about a data item in the pivot table report.

Syntax

expression.GetPivotData(dataField, fieldItemsArray);

expression - A variable that represents a ApiPivotTable class.

Parameters

Name	Required/Optional	Data type	Default	Description
dataField	Optional	string		The name of the field containing the data for the PivotTable.
fieldItemsArray	Optional	string[]		An array of field items from the pivot table.

Returns

ApiRange

Example

var oWorksheet = Api.GetActiveSheet();

oWorksheet.GetRange('B1').SetValue('Region');
oWorksheet.GetRange('C1').SetValue('Style');
oWorksheet.GetRange('D1').SetValue('Price');

oWorksheet.GetRange('B2').SetValue('East');
oWorksheet.GetRange('B3').SetValue('West');
oWorksheet.GetRange('B4').SetValue('East');
oWorksheet.GetRange('B5').SetValue('West');

oWorksheet.GetRange('C2').SetValue('Fancy');
oWorksheet.GetRange('C3').SetValue('Fancy');
oWorksheet.GetRange('C4').SetValue('Tee');
oWorksheet.GetRange('C5').SetValue('Tee');

oWorksheet.GetRange('D2').SetValue(42.5);
oWorksheet.GetRange('D3').SetValue(35.2);
oWorksheet.GetRange('D4').SetValue(12.3);
oWorksheet.GetRange('D5').SetValue(24.8);

var dataRef = Api.GetRange("'Sheet1'!$B$1:$D$5");
var pivotTable = Api.InsertPivotNewWorksheet(dataRef);
var dataField = pivotTable.AddDataField('Price');
dataField.SetName('Regional prices');
pivotTable.AddFields({
	rows: 'Region',
	columns: 'Style',
});

var pivotWorksheet = Api.GetActiveSheet();

pivotWorksheet.GetRange('A9').SetValue('East Total:');

var range = pivotTable.GetPivotData('Price', ['Region', 'East']);
var value = range.GetValue();
pivotWorksheet.GetRange('B9').SetValue(value);