SetNumStdDev

Sets the number of standard deviations from the average.

Syntax

expression.SetNumStdDev(numStdDev);

expression - A variable that represents a ApiAboveAverage class.

Parameters

Name	Required/Optional	Data type	Default	Description
numStdDev	Required	number		The number of standard deviations (0 for simple average, positive numbers for deviations).

Returns

This method doesn't return any data.

Example

Set the number of standard deviations from the average in a spreadsheet.

// How to modify the standard deviation setting for above average conditions in a spreadsheet.

// Change the number of standard deviations for conditional formatting.

let worksheet = Api.GetActiveSheet();

worksheet.GetRange("A1").SetValue("Test Data");
worksheet.GetRange("A2").SetValue(10);
worksheet.GetRange("A3").SetValue(20);
worksheet.GetRange("A4").SetValue(30);
worksheet.GetRange("A5").SetValue(40);
worksheet.GetRange("A6").SetValue(50);

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

let condition = formatConditions.AddAboveAverage();
condition.SetFillColor(Api.CreateColorFromRGB(255, 255, 0));

worksheet.GetRange("C1").SetValue("Before:");
worksheet.GetRange("C2").SetValue(condition.GetNumStdDev().toString());

condition.SetNumStdDev(2);

worksheet.GetRange("C3").SetValue("After:");
worksheet.GetRange("C4").SetValue(condition.GetNumStdDev().toString());