com.aspose.cells

Class AboveAverage

java.lang.Object

com.aspose.cells.AboveAverage

public class AboveAverage
extends java.lang.Object

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

Constructors

Constructor and Description
AboveAverage()

Method Summary

Methods

Modifier and Type	Method and Description
int	getStdDev() Gets the number of standard deviations to include above or below the average in the conditional formatting rule.
boolean	isAboveAverage() Gets the flag indicating whether the rule is an "above average" rule.
boolean	isEqualAverage() Gets the flag indicating whether the 'aboveAverage' and 'belowAverage' criteria is inclusive of the average itself, or exclusive of that value.
void	setAboveAverage(boolean value) Sets the flag indicating whether the rule is an "above average" rule.
void	setEqualAverage(boolean value) Sets the flag indicating whether the 'aboveAverage' and 'belowAverage' criteria is inclusive of the average itself, or exclusive of that value.
void	setStdDev(int value) Sets the number of standard deviations to include above or below the average in the conditional formatting rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AboveAverage

public AboveAverage()

Method Detail

isAboveAverage

public boolean isAboveAverage()

Gets the flag indicating whether the rule is an "above average" rule. 'true' indicates 'above average'. Default value is true.

setAboveAverage

public void setAboveAverage(boolean value)

Sets the flag indicating whether the rule is an "above average" rule. 'true' indicates 'above average'. Default value is true.

isEqualAverage

public boolean isEqualAverage()

Gets 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.

setEqualAverage

public void setEqualAverage(boolean value)

Sets 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

public int getStdDev()

Gets 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.

setStdDev

public void setStdDev(int value)

Sets 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.