IAboveAverage

```
public interface IAboveAverage
```
Represents an above average visual of a conditional formatting rule. Applies a color or fill to a range or selection to help you see the value of a cell relative to other cells.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`delete()` Deletes this conditional format.
`void`	`fromJson(java.lang.String json)` Generates the conditional format from the json string.
`AboveBelow`	`getAboveBelow()` Returns one of the constants of the `AboveBelow` enumeration, specifying if the conditional formatting rule looks for cell values above or below the range average or standard deviation.
`IRange`	`getAppliesTo()` Returns a range object specifying the cell range to which the formatting rule is applied.
`IBorders`	`getBorders()` Returns an instance of `IBorders` which represents the borders of this conditional format.
`IFont`	`getFont()` Returns an instance of `IFont` which represents the font of this conditional format.
`IInterior`	`getInterior()` Returns an instance of `IInterior` which represents the background color of this conditional format.
`java.lang.String`	`getNumberFormat()` Returns the number format applied to a cell if the conditional formatting rule evaluates to true.
`int`	`getNumStdDev()` Returns the numeric standard deviation for an AboveAverage object.
`int`	`getPriority()` Returns the priority value of the conditional formatting rule.
`boolean`	`getStopIfTrue()` Returns a boolean value that determines if additional formatting rules on the cell should be evaluated if the current rule evaluates to true.
`FormatConditionType`	`getType()` Returns the type of this conditional format.
`void`	`setAboveBelow(AboveBelow value)` Sets one of the constants of the `AboveBelow` enumeration, specifying if the conditional formatting rule looks for cell values above or below the range average or standard deviation.
`void`	`setAppliesTo(IRange value)` Sets a range object specifying the cell range to which the formatting rule is applied.
`void`	`setFirstPriority()` Sets the priority value for this conditional formatting rule to "1" so that it will be evaluated before all other rules on the worksheet.
`void`	`setLastPriority()` Sets the evaluation order for this conditional formatting rule so it is evaluated after all other rules on the worksheet.
`void`	`setNumberFormat(java.lang.String value)` Sets the number format applied to a cell if the conditional formatting rule evaluates to True.
`void`	`setNumStdDev(int value)` Sets the numeric standard deviation for an AboveAverage object.
`void`	`setPriority(int value)` Sets the priority value of the conditional formatting rule.
`void`	`setStopIfTrue(boolean value)` Sets a boolean value that determines if additional formatting rules on the cell should be evaluated if the current rule evaluates to true.
`java.lang.String`	`toJson()` Generates a json string from the conditional format.

- Method Detail
  - getAboveBelow
```
AboveBelow getAboveBelow()
```
    Returns one of the constants of the AboveBelow enumeration, specifying if the conditional formatting rule looks for cell values above or below the range average or standard deviation.
  - setAboveBelow
```
void setAboveBelow(AboveBelow value)
```
    Sets one of the constants of the AboveBelow enumeration, specifying if the conditional formatting rule looks for cell values above or below the range average or standard deviation.
  - getAppliesTo
```
IRange getAppliesTo()
```
    Returns a range object specifying the cell range to which the formatting rule is applied.
  - setAppliesTo
```
void setAppliesTo(IRange value)
```
    Sets a range object specifying the cell range to which the formatting rule is applied.
  - getBorders
```
IBorders getBorders()
```
    Returns an instance of IBorders which represents the borders of this conditional format.
  - getFont
```
IFont getFont()
```
    Returns an instance of IFont which represents the font of this conditional format.
  - getInterior
```
IInterior getInterior()
```
    Returns an instance of IInterior which represents the background color of this conditional format.
  - getNumberFormat
```
java.lang.String getNumberFormat()
```
    Returns the number format applied to a cell if the conditional formatting rule evaluates to true.
  - setNumberFormat
```
void setNumberFormat(java.lang.String value)
```
    Sets the number format applied to a cell if the conditional formatting rule evaluates to True.
  - getNumStdDev
```
int getNumStdDev()
```
    Returns the numeric standard deviation for an AboveAverage object.
  - setNumStdDev
```
void setNumStdDev(int value)
```
    Sets the numeric standard deviation for an AboveAverage object.
  - getPriority
```
int getPriority()
```
    Returns the priority value of the conditional formatting rule. The priority determines the order of evaluation when multiple conditional formatting rules exist in a worksheet.
    
    When setting the priority, the value must be a positive integer between 1 and the total number of conditional formatting rules on the worksheet. The priority must be a unique value for all rules on the worksheet, so changing the priority for the specified conditional formatting rule may cause the priority value of the other rules on the worksheet to be shifted.
  - setPriority
```
void setPriority(int value)
```
    Sets the priority value of the conditional formatting rule. The priority determines the order of evaluation when multiple conditional formatting rules exist in a worksheet.
    
    When setting the priority, the value must be a positive integer between 1 and the total number of conditional formatting rules on the worksheet. The priority must be a unique value for all rules on the worksheet, so changing the priority for the specified conditional formatting rule may cause the priority value of the other rules on the worksheet to be shifted.
  - getStopIfTrue
```
boolean getStopIfTrue()
```
    Returns a boolean value that determines if additional formatting rules on the cell should be evaluated if the current rule evaluates to true.
  - setStopIfTrue
```
void setStopIfTrue(boolean value)
```
    Sets a boolean value that determines if additional formatting rules on the cell should be evaluated if the current rule evaluates to true.
  - getType
```
FormatConditionType getType()
```
    Returns the type of this conditional format.
  - delete
```
void delete()
```
    Deletes this conditional format.
  - setFirstPriority
```
void setFirstPriority()
```
    Sets the priority value for this conditional formatting rule to "1" so that it will be evaluated before all other rules on the worksheet.
  - setLastPriority
```
void setLastPriority()
```
    Sets the evaluation order for this conditional formatting rule so it is evaluated after all other rules on the worksheet.
  - fromJson
```
void fromJson(java.lang.String json)
```
    Generates the conditional format from the json string.
    
    Parameters:
    
    json - the json string
  - toJson
```
java.lang.String toJson()
```
    Generates a json string from the conditional format.
    
    Returns:
    
    the conditional format json string

Interface IAboveAverage

Method Summary

Method Detail

getAboveBelow

setAboveBelow

getAppliesTo

setAppliesTo

getBorders

getFont

getInterior

getNumberFormat

setNumberFormat

getNumStdDev

setNumStdDev

getPriority

setPriority

getStopIfTrue

setStopIfTrue

getType

delete

setFirstPriority

setLastPriority

fromJson

toJson