IAboveAverage

Interface IAboveAverage

public interface IAboveAverage

表示通过将单元格值与区域平均值或标准差阈值进行比较来求值的条件格式规则。

使用此接口可配置匹配高于平均值、低于平均值、等于或高于平均值、等于或低于平均值、高于标准差或低于标准差的值的规则。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 format.setAboveBelow(AboveBelow.BelowAverage);

Method Summary

Modifier and Type

Method

Description

void

delete()

删除此条件格式。

void

fromJson(String json)

从 JSON 字符串生成条件格式。

AboveBelow

getAboveBelow()

返回 AboveBelow 枚举中的一个常量，指定条件格式规则如何将单元格值与区域平均值或标准差阈值进行比较。

IRange

getAppliesTo()

返回 Range 对象，指定应用此格式规则的单元格区域。

IBorders

getBorders()

返回 IBorders 实例，该实例表示此条件格式的边框。

IFont

getFont()

返回表示此条件格式字体的 IFont 实例。

IInterior

getInterior()

返回表示此条件格式背景颜色的 IInterior 实例。

String

getNumberFormat()

返回当条件格式规则计算结果为 true 时应用于单元格的数字格式。

int

getNumStdDev()

获取 AboveAverage 对象的数值标准差。

int

getPriority()

获取条件格式规则的优先级值。

boolean

getStopIfTrue()

返回布尔值，指示当当前规则求值为 true 时，是否应评估单元格上的其他格式规则。

FormatConditionType

getType()

返回此条件格式的类型。

void

setAboveBelow(AboveBelow value)

设置 AboveBelow 枚举中的一个常量，用于指定条件格式规则如何将单元格值与区域平均值或标准差阈值进行比较。

void

setAppliesTo(IRange value)

设置一个范围对象，指定应用格式规则的单元格区域。

void

setFirstPriority()

将此条件格式规则的优先级值设置为 1，以便它会在工作表上的所有其他规则之前进行评估。

void

setLastPriority()

设置此条件格式规则的评估顺序，使其在工作表上所有其他规则之后进行评估。

void

setNumberFormat(String value)

设置当条件格式规则评估为 true 时应用于单元格的数字格式。

void

setNumStdDev(int value)

设置 AboveAverage 对象的数值标准差。

void

setPriority(int value)

设置条件格式规则的优先级值。

void

setStopIfTrue(boolean value)

设置一个布尔值，指示如果当前规则评估为 true，是否应评估单元格上的其他格式规则。

String

toJson()

生成一个从条件格式转换而来的 json 字符串。

Method Details

getAboveBelow

AboveBelow getAboveBelow()
返回 AboveBelow 枚举中的一个常量，指定条件格式规则如何将单元格值与区域平均值或标准差阈值进行比较。
使用此方法可确定该规则评估的值是高于平均值、低于平均值、等于或高于平均值、等于或低于平均值、高于标准偏差，还是低于标准偏差。
```
 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 format.setAboveBelow(AboveBelow.BelowAverage);
 AboveBelow aboveBelow = format.getAboveBelow();
 
```
Returns:

AboveBelow 常量之一，指定条件格式规则是根据区域平均值还是标准偏差阈值来评估单元格值。
setAboveBelow

void setAboveBelow(AboveBelow value)
设置 AboveBelow 枚举中的一个常量，用于指定条件格式规则如何将单元格值与区域平均值或标准差阈值进行比较。
使用此方法可控制规则评估的是高于平均值、低于平均值、大于或等于平均值、小于或等于平均值、高于标准偏差，还是低于标准偏差的值。
```
 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 format.setAboveBelow(AboveBelow.BelowAverage);
 
```
Parameters:

value - AboveBelow 中的一个常量，用于指定条件格式规则是否根据区域平均值或标准偏差阈值评估单元格值；不能为 null。

getAppliesTo

IRange getAppliesTo()

返回 Range 对象，指定应用此格式规则的单元格区域。

使用此方法可获取当前高于平均值条件格式规则的目标区域。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 format.setAppliesTo(worksheet.getRange("B1:B5"));
 IRange range = format.getAppliesTo();

Returns:: 指定应用此格式规则的单元格区域的 Range 对象。

setAppliesTo

void setAppliesTo(IRange value)

设置一个范围对象，指定应用格式规则的单元格区域。

使用此方法可将现有的高于平均值条件格式规则重新分配给不同的 IRange。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 format.setAppliesTo(worksheet.getRange("B1:B5"));

Parameters:: value - 指定应用格式规则的单元格区域的 IRange 对象。

getBorders

IBorders getBorders()

返回 IBorders 实例，该实例表示此条件格式的边框。

使用返回的 IBorders 对象来配置当此高于平均值的条件格式规则计算结果为 true 时应用的边框样式。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 IBorders borders = format.getBorders();
 borders.setColor(Color.GetRed());

Returns:: 表示此条件格式边框的 IBorders 实例。

getFont

IFont getFont()

返回表示此条件格式字体的 IFont 实例。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 IFont font = format.getFont();
 font.setBold(true);

Returns:: 表示此条件格式字体的 IFont 实例。

getInterior

IInterior getInterior()

返回表示此条件格式背景颜色的 IInterior 实例。

使用返回的 IInterior 对象访问或修改高于平均值条件格式规则生效时应用的填充设置。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 IInterior interior = format.getInterior();
 interior.setColor(Color.GetYellow());

Returns:: 表示此条件格式背景颜色的 IInterior 实例。

getNumberFormat

String getNumberFormat()

返回当条件格式规则计算结果为 true 时应用于单元格的数字格式。

使用此方法可获取当前为高于平均值条件格式规则配置的格式代码。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 format.setNumberFormat("0.00");
 String numberFormat = format.getNumberFormat();

Returns:: 当条件格式规则计算结果为 true 时应用的数字格式字符串。

setNumberFormat

void setNumberFormat(String value)
设置当条件格式规则评估为 true 时应用于单元格的数字格式。
使用此方法设置当 above-average 条件格式规则评估为 true 时应用的数字格式。
```
 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 format.setNumberFormat("0.00");
 
```
Parameters:

value - 当条件格式规则评估为 true 时应用的数字格式字符串。

getNumStdDev

int getNumStdDev()

获取 AboveAverage 对象的数值标准差。

使用此方法可获取分配给高于平均值条件格式规则的标准差值。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 format.setNumStdDev(2);
 int numStdDev = format.getNumStdDev();

Returns:: 高于平均值规则的数值标准差。

setNumStdDev

void setNumStdDev(int value)

设置 AboveAverage 对象的数值标准差。

使用此方法设置分配给高于平均值条件格式规则的标准差值。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 format.setNumStdDev(2);

Parameters:: value - 高于平均值规则的数值标准差。

getPriority

int getPriority()
获取条件格式规则的优先级值。
当工作表中存在多个条件格式规则时，该优先级决定其评估顺序。

设置优先级时，该值必须是一个正整数，介于 1 与工作表上的条件格式规则总数之间。工作表上所有规则的优先级都必须是唯一值，因此更改指定条件格式规则的优先级可能会导致工作表上其他规则的优先级值发生变动。
```
 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 IAboveAverage condition = worksheet.getRange("B1:B5").getFormatConditions().addAboveAverage();
 condition.getInterior().setColor(Color.GetLightBlue());
 format.setPriority(2);
 int priority = format.getPriority();
 
```
Returns:

条件格式规则的优先级值。
setPriority

void setPriority(int value)
设置条件格式规则的优先级值。
当工作表中存在多个条件格式规则时，优先级决定其评估顺序。

设置优先级时，该值必须是介于 1 和工作表上条件格式规则总数之间的正整数。对于工作表上的所有规则，优先级必须是唯一值，因此更改指定条件格式规则的优先级可能会导致工作表上其他规则的优先级值发生变动。
```
 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 IAboveAverage condition = worksheet.getRange("B1:B5").getFormatConditions().addAboveAverage();
 condition.getInterior().setColor(Color.GetLightBlue());
 format.setPriority(2);
 
```
Parameters:

value - 条件格式规则的优先级值。

getStopIfTrue

boolean getStopIfTrue()

返回布尔值，指示当当前规则求值为 true 时，是否应评估单元格上的其他格式规则。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 format.setStopIfTrue(true);
 boolean stopIfTrue = format.getStopIfTrue();

Returns:: 一个布尔值，指示当当前规则求值为 true 时，是否应评估单元格上的其他格式规则。

setStopIfTrue

void setStopIfTrue(boolean value)
设置一个布尔值，指示如果当前规则评估为 true，是否应评估单元格上的其他格式规则。
```
 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 format.setStopIfTrue(true);
 
```
Parameters:

value - 一个布尔值，指示如果当前规则评估为 true，是否应评估单元格上的其他格式规则。

getType

FormatConditionType getType()

返回此条件格式的类型。

对于 IAboveAverage 规则，此方法返回 FormatConditionType.AboveAverageCondition。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 FormatConditionType type = format.getType();

Returns:: 条件格式类型。

delete

void delete()

删除此条件格式。

使用此方法可移除先前添加到某个范围的高于平均值条件格式规则。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 format.delete();

setFirstPriority

void setFirstPriority()

将此条件格式规则的优先级值设置为 1，以便它会在工作表上的所有其他规则之前进行评估。

使用 setLastPriority() 可将该规则移动到工作表条件格式评估顺序的末尾。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 ITop10 top10 = worksheet.getRange("A1:A5").getFormatConditions().addTop10();
 top10.getInterior().setColor(Color.GetYellow());
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetLightBlue());
 format.setFirstPriority();

setLastPriority

void setLastPriority()

设置此条件格式规则的评估顺序，使其在工作表上所有其他规则之后进行评估。

当存在多个规则时，使用此方法可将该规则移动到工作表级条件格式优先级顺序的末尾。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 ITop10 top10 = worksheet.getRange("A1:A5").getFormatConditions().addTop10();
 top10.getInterior().setColor(Color.GetYellow());
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetLightBlue());
 format.setLastPriority();

fromJson

void fromJson(String json)

从 JSON 字符串生成条件格式。

使用此方法可从 JSON 字符串恢复高于平均值条件格式的设置，例如由 toJson() 生成的 JSON 字符串。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 String json = "{\"ranges\":[{\"row\":0,\"col\":1,\"rowCount\":5,\"colCount\":1}],\"priority\":1,\"ruleType\":8,\"type\":0}";
 IAboveAverage format = worksheet.getRange("B1:B5").getFormatConditions().addAboveAverage();
 format.fromJson(json);
 format.getInterior().setColor(Color.GetYellow());

Parameters:: json - 定义条件格式的 JSON 字符串。

toJson

String toJson()

生成一个从条件格式转换而来的 json 字符串。

返回的字符串包含此 IAboveAveragerule 的序列化状态，并且可与 fromJson(String) 一起使用以恢复条件格式。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {20}, {30}, {40}, {50}});
 IAboveAverage format = worksheet.getRange("A1:A5").getFormatConditions().addAboveAverage();
 format.getInterior().setColor(Color.GetYellow());
 format.setAboveBelow(AboveBelow.AboveAverage);
 String json = format.toJson();

Returns:: 条件格式的 json 字符串。