asposecells.api

asposecells.api

Class AboveAverage

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.

Constructor Summary
AboveAverage()
 
Property Getters/Setters Summary
methodisAboveAverage()
method
setAboveAverage(value)
           Get or set the flag indicating whether the rule is an "above average" rule. 'true' indicates 'above average'. Default value is true.
methodisEqualAverage()
method
setEqualAverage(value)
           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.
methodgetStdDev()
method
setStdDev(value)
           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 Detail

      • AboveAverage

        AboveAverage()

    • Property Getters/Setters Detail

      • isAboveAverage/setAboveAverage : boolean 

        boolean isAboveAverage() / setAboveAverage(value)
        Get or set the flag indicating whether the rule is an "above average" rule. 'true' indicates 'above average'. Default value is true.

      • isEqualAverage/setEqualAverage : boolean 

        boolean isEqualAverage() / setEqualAverage(value)
        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.

      • getStdDev/setStdDev : int 

        int getStdDev() / setStdDev(value)
        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.