Skip to main content

SetTableStyleRowHeaders

Sets the setting which specifies whether the row headers of the pivot table will be highlighted with the special formatting.

Syntax

expression.SetTableStyleRowHeaders(show);

expression - A variable that represents a ApiPivotTable class.

Parameters

NameRequired/OptionalData typeDefaultDescription
showRequiredbooleanSpecifies whether the row headers of the pivot table will be highlighted with the special formatting.

Returns

This method doesn't return any data.

Example

Turn row header formatting on or off for a pivot table style in a spreadsheet.

// How do I control whether row headers use special style formatting in a pivot table in a spreadsheet?

// Remove or restore the distinct appearance of row header cells in a pivot table 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.SetTableStyleRowHeaders(false);

let pivotWorksheet = Api.GetActiveSheet();

pivotWorksheet.GetRange('A12').SetValue('Table Style Row Headers');
pivotWorksheet.GetRange('B12').SetValue(pivotTable.GetTableStyleRowHeaders());