AboveAverage

AboveAverage class

Describe the AboveAverage conditional formatting rule. This conditional formatting rule highlights cells that are above or below the average for all values in the range.

class AboveAverage;

Constructors

Name	Description
constructor()	Default Constructor.

Properties

Property	Type	Description
isAboveAverage	boolean	Get or set the flag indicating whether the rule is an “above average” rule. ’true’ indicates ‘above average’. Default value is true.
isEqualAverage	boolean	Get or set the flag indicating whether the ‘aboveAverage’ and ‘belowAverage’ criteria is inclusive of the average itself, or exclusive of that value. ’true’ indicates to include the average value in the criteria. Default value is false.
stdDev	number	Get or set the number of standard deviations to include above or below the average in the conditional formatting rule. The input value must between 0 and 3 (include 0 and 3). Setting this value to 0 means stdDev is not set. The default value is 0.

constructor()

Default Constructor.

constructor();

isAboveAverage

Get or set the flag indicating whether the rule is an “above average” rule. ’true’ indicates ‘above average’. Default value is true.

isAboveAverage : boolean;

isEqualAverage

Get or set the flag indicating whether the ‘aboveAverage’ and ‘belowAverage’ criteria is inclusive of the average itself, or exclusive of that value. ’true’ indicates to include the average value in the criteria. Default value is false.

isEqualAverage : boolean;

stdDev

Get or set the number of standard deviations to include above or below the average in the conditional formatting rule. The input value must between 0 and 3 (include 0 and 3). Setting this value to 0 means stdDev is not set. The default value is 0.

stdDev : number;