SetRowAxisLayout

Sets the way the specified pivot table items appear — in table format or in outline format.

Syntax

expression.SetRowAxisLayout(type, compact);

expression - A variable that represents a ApiPivotTable class.

Parameters

Name	Required/Optional	Data type	Default	Description
type	Required	PivotLayoutType		The layout type of the pivot table report.
compact	Required	boolean		Specifies whether the pivot table items will be displayed in the compact form.

Returns

This method doesn't return any data.

Example

Set row axis layout of a pivot table in a spreadsheet.

// How to set row axis layout of a table in a spreadsheet.

// Create a pivot table, add data to it then set its row axis layout 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', 'Style'],
});

pivotTable.AddDataField('Price');

pivotTable.SetRowAxisLayout('Tabular', false);