AddFields

Adds the row, column, and page fields to the pivot table report.

Syntax

expression.AddFields(options);

expression - A variable that represents a ApiPivotTable class.

Parameters

Name	Required/Optional	Data type	Default	Description
options	Required	PivotTableFieldOptions		The settings for adding row, column, and page fields to the pivot table report.

Returns

This method doesn't return any data.

Example

Assign row and column fields to organize a pivot table in a spreadsheet.

// How do I arrange source columns into rows and columns of a pivot table in a spreadsheet?

// Group data by two categories at once to build a two-dimensional summary 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);
let dataField = pivotTable.AddDataField('Price');
dataField.SetName('Regional prices');
pivotTable.AddFields({
    rows: 'Region',
    columns: 'Style',
});