Skip to main content

GetPTCondition

Returns the pivot table condition object.

Inherited from ApiFormatCondition.GetPTCondition.

Syntax​

expression.GetPTCondition();

expression - A variable that represents an ApiTop10 class.

Parameters​

This method doesn't have any parameters.

Returns​

PTCondition | null

Example​

Check whether a top 10 conditional formatting rule is linked to a pivot table in a spreadsheet.

// How do I tell if a top 10 conditional formatting rule applies to a pivot table in a spreadsheet?

// Verify if the top 10 highlight rule targets pivot table data in a spreadsheet.

let worksheet = Api.GetActiveSheet();

worksheet.GetRange("A1").SetValue("Sales Data");
worksheet.GetRange("A2").SetValue(100);
worksheet.GetRange("A3").SetValue(250);
worksheet.GetRange("A4").SetValue(150);
worksheet.GetRange("A5").SetValue(300);
worksheet.GetRange("A6").SetValue(75);

let dataRange = worksheet.GetRange("A2:A6");
let formatConditions = dataRange.GetFormatConditions();

let condition1 = formatConditions.AddTop10();
condition1.SetFillColor(Api.CreateColorFromRGB(255, 255, 0));

let ptCondition = condition1.GetPTCondition();

worksheet.GetRange("C1").SetValue("Pivot table condition:");
worksheet.GetRange("C2").SetValue(ptCondition ? "Yes" : "No");