PivotValueCell

Returns the value of a pivot table cell.

Syntax

expression.PivotValueCell(rowLine, colLine);

expression - A variable that represents an ApiPivotTable class.

Parameters

Name	Required/Optional	Data type	Default	Description
rowLine	Required	number		The position of the pivot line (a line of rows in the pivot table) on the row area.
colLine	Required	number		The position of the pivot line (a line of columns in the pivot table) on the column area.

Returns

number | string | null

Example

Read a specific data cell from a pivot table by its row and column position in a spreadsheet.

// How do I look up a single numeric result inside a pivot table in a spreadsheet?

// Extract a particular summary value from a pivot table to use elsewhere in a spreadsheet.

let worksheet = Api.GetActiveSheet();

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

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

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

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

let dataRef = Api.GetRange("'Sheet1'!$B$1:$D$5");
let pivotTable = Api.InsertPivotNewWorksheet(dataRef);

pivotTable.AddFields({
    rows: 'Region',
    columns: 'Style',
});

pivotTable.AddDataField('Price');

let pivotWorksheet = Api.GetActiveSheet();

pivotWorksheet.GetRange('A9').SetValue('First value in Pivot Table');

pivotWorksheet.GetRange('C9').SetValue(pivotTable.PivotValueCell(1, 1));