SetVisible

Sets the visibility of the pivot item. 💡 At least one item must remain visible when hiding others.

Syntax

expression.SetVisible(visible);

expression - A variable that represents a ApiPivotItem class.

Parameters

Name	Required/Optional	Data type	Default	Description
visible	Required	boolean		Specifies whether the pivot item is visible.

Returns

This method doesn't return any data.

Example

This example shows how to set the visibility of a pivot item.

• Code
• Result

// How to show/hide pivot items using SetVisible method and Visible property.

// Create a pivot table, add data to it then demonstrate setting visibility of pivot items.

let worksheet = Api.GetActiveSheet();

worksheet.GetRange('B1').SetValue('Region');
worksheet.GetRange('C1').SetValue('Sales');

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

worksheet.GetRange('C2').SetValue(15000);
worksheet.GetRange('C3').SetValue(12000);
worksheet.GetRange('C4').SetValue(8000);
worksheet.GetRange('C5').SetValue(9500);

let dataRef = Api.GetRange(`'${worksheet.Name}'!$B$1:$C$5`);
let pivotTable = Api.InsertPivotNewWorksheet(dataRef);

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

pivotTable.AddDataField('Sales');

let pivotWorksheet = Api.GetActiveSheet();
let regionField = pivotTable.GetPivotFields('Region');
let regionItems = regionField.GetPivotItems();

// Remove label/value filters so you’re only using checkbox visibility.
regionField.ClearAllFilters();

// Hide the first region item using SetVisible method
if (regionItems.length > 0) {
    regionItems[0].SetVisible(false);
}

// Hide the second region item using Visible property
if (regionItems.length > 1) {
    regionItems[1].Visible = false;
}

pivotWorksheet.GetRangeByNumber(8, 0).SetValue('Region item visibility after changes');

for (let i = 0; i < regionItems.length; i += 1) {
    let isVisible = regionItems[i].Visible;
    let status = isVisible ? 'Visible' : 'Hidden';
    pivotWorksheet.GetRangeByNumber(8 + i, 1).SetValue(regionItems[i].GetName() + ': ' + status);
}