IIconSetCondition

Interface IIconSetCondition

public interface IIconSetCondition

表示图标集条件格式规则。

IIconSetCondition 将基于图标的条件格式应用于区域，并允许配置规则的图标集、条件阈值、显示顺序和目标区域。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 condition.setIconSet(workbook.getIconSets().get(IconSetType.Icon3Symbols));
 condition.getIconCriteria().get(1).setValue(50);
 condition.getIconCriteria().get(2).setValue(70);

Method Summary

Modifier and Type

Method

Description

void

delete()

删除此条件格式。

void

fromJson(String json)

从 JSON 将图标集条件格式规则加载到当前对象中。

IRange

getAppliesTo()

获取此图标集条件格式规则应用到的 IRange。

boolean

getCustom()

获取这是否为自定义图标集规则。

IIconCriteria

getIconCriteria()

获取一个 IIconCriteria 集合，该集合表示图标集条件格式规则的条件集。

IIconSet

getIconSet()

获取条件格式中使用的图标集。

boolean

getPercentileValues()

返回布尔值，指示图标集条件格式的阈值是否使用百分位数确定。

int

getPriority()

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

boolean

getReverseOrder()

返回布尔值，指示图标集的图标顺序是否反转。

boolean

getShowIconOnly()

获取一个布尔值，指示图标集条件格式是否仅显示图标。

boolean

getStopIfTrue()

获取当前规则计算结果为 true 时是否跳过后续条件格式规则。

FormatConditionType

getType()

返回此条件格式的类型。

void

setAppliesTo(IRange value)

设置此图标集条件格式规则应用到的 IRange。

void

setFirstPriority()

将此规则移到优先级 1。

void

setIconSet(IIconSet value)

设置此条件格式规则使用的单个 IIconSet。

void

setLastPriority()

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

void

setPercentileValues(boolean value)

设置一个布尔值，指示图标集条件格式的阈值是否使用百分位数确定。

void

setPriority(int value)

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

void

setReverseOrder(boolean value)

设置一个布尔值，指示图标集的图标顺序是否反转。

void

setShowIconOnly(boolean value)

设置一个布尔值，指示图标集条件格式是否仅显示图标。

String

toJson()

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

Method Details

getAppliesTo

IRange getAppliesTo()

获取此图标集条件格式规则应用到的 IRange。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 condition.setAppliesTo(worksheet.getRange("B1:B5"));
 IRange appliesTo = condition.getAppliesTo();

Returns:: 目标 IRange。

setAppliesTo

void setAppliesTo(IRange value)

设置此图标集条件格式规则应用到的 IRange。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 condition.setAppliesTo(worksheet.getRange("B1:B5"));

Parameters:: value - 目标 IRange。

getIconCriteria

IIconCriteria getIconCriteria()

获取一个 IIconCriteria 集合，该集合表示图标集条件格式规则的条件集。

返回集合中的每一项都表示当前图标集中一个图标的阈值设置。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 condition.setIconSet(workbook.getIconSets().get(IconSetType.Icon3Symbols));
 IIconCriteria criteria = condition.getIconCriteria();

Returns:: 图标集条件格式规则的 IIconCriteria 集合。

getIconSet

IIconSet getIconSet()

获取条件格式中使用的图标集。

返回当前应用于此图标集条件格式规则的 IIconSet。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 condition.setIconSet(workbook.getIconSets().get(IconSetType.Icon3TrafficLights1));
 IIconSet iconSet = condition.getIconSet();

Returns:: 条件格式中使用的 IIconSet。

setIconSet

void setIconSet(IIconSet value)

设置此条件格式规则使用的单个 IIconSet。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 condition.setIconSet(workbook.getIconSets().get(IconSetType.Icon3TrafficLights1));

Parameters:: value - 要使用的 IIconSet。

getPercentileValues

boolean getPercentileValues()
返回布尔值，指示图标集条件格式的阈值是否使用百分位数确定。
如果并非每个阈值都设置为百分位，则此属性返回 false。使用 setPercentileValues(boolean) 可以一次性将所有阈值类型更改为百分位。
```
 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 condition.setPercentileValues(true);
 boolean percentileValues = condition.getPercentileValues();
 
```
Returns:

如果图标集条件格式的阈值使用百分位数确定，则为 true；否则为 false。
setPercentileValues

void setPercentileValues(boolean value)
设置一个布尔值，指示图标集条件格式的阈值是否使用百分位数确定。
```
 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 condition.setPercentileValues(true);
 
```
Parameters:

value - 如果图标集条件格式的阈值使用百分位数确定，则为 true；否则为 false。

getPriority

int getPriority()

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

当工作表中存在多个条件格式规则时，优先级决定求值顺序。优先级值在工作表内是唯一的，因此更改一个规则的优先级可能会使其他规则的优先级值发生移动。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition firstRule = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 IIconSetCondition secondRule = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 secondRule.setPriority(1);
 int priority = secondRule.getPriority();

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

setPriority

void setPriority(int value)
设置条件格式规则的优先级值。
当工作表中存在多个条件格式规则时，优先级决定求值顺序。优先级值在工作表内是唯一的，因此更改一个规则的优先级可能会使其他规则的优先级值发生移动。
```
 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition firstRule = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 IIconSetCondition secondRule = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 secondRule.setPriority(1);
 
```
Parameters:

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

boolean getReverseOrder()
返回布尔值，指示图标集的图标顺序是否反转。
当图标集条件格式以反向顺序显示图标时，返回 true。当使用默认图标顺序时，返回 false。
```
 IIconSetCondition condition = worksheet.getRange("A1:A3").getFormatConditions().addIconSetCondition();
 condition.setReverseOrder(true);
 boolean reverseOrder = condition.getReverseOrder();
 
```
Returns:

如果图标集的图标顺序已反转，则为 true；否则为 false。
setReverseOrder

void setReverseOrder(boolean value)
设置一个布尔值，指示图标集的图标顺序是否反转。
当图标集条件格式以反向顺序显示图标时，设置为 true。当使用默认图标顺序时，设置为 false。
```
 IIconSetCondition condition = worksheet.getRange("A1:A3").getFormatConditions().addIconSetCondition();
 condition.setReverseOrder(true);
 
```
Parameters:

value - 如果图标集的图标顺序已反转，则为 true；否则为 false。

getShowIconOnly

boolean getShowIconOnly()

获取一个布尔值，指示图标集条件格式是否仅显示图标。

当使用此图标集规则的单元格仅显示图标时，返回 true。当图标与单元格值一起显示时，返回 false。


 worksheet.getRange("A1:A3").setValue(new Object[][] {
     {10},
     {50},
     {90}
 });
 IIconSetCondition condition = worksheet.getRange("A1:A3").getFormatConditions().addIconSetCondition();
 condition.setIconSet(workbook.getIconSets().get(IconSetType.Icon3Symbols));
 condition.setShowIconOnly(true);
 boolean showIconOnly = condition.getShowIconOnly();

Returns:: 如果仅显示图标，则为 true；否则为 false。

setShowIconOnly

void setShowIconOnly(boolean value)
设置一个布尔值，指示图标集条件格式是否仅显示图标。
当使用此图标集规则的单元格仅显示图标时，设置为 true。当图标与单元格值一起显示时，设置为 false。
```
 worksheet.getRange("A1:A3").setValue(new Object[][] {
     {10},
     {50},
     {90}
 });
 IIconSetCondition condition = worksheet.getRange("A1:A3").getFormatConditions().addIconSetCondition();
 condition.setIconSet(workbook.getIconSets().get(IconSetType.Icon3Symbols));
 condition.setShowIconOnly(true);
 
```
Parameters:

value - 如果仅显示图标，则为 true；否则为 false。
getStopIfTrue

boolean getStopIfTrue()
获取当前规则计算结果为 true 时是否跳过后续条件格式规则。
如果为 true，则不再计算该单元格的后续规则；如果为 false，则可以继续计算。
```
 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 boolean stopIfTrue = condition.getStopIfTrue();
 
```
Returns:

如果跳过后续规则，则为 true；否则为 false。

getType

FormatConditionType getType()

返回此条件格式的类型。

对于图标集条件格式规则，此方法返回 FormatConditionType.IconSets。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 FormatConditionType type = condition.getType();

Returns:: 此条件格式的类型。

delete

void delete()

删除此条件格式。

使用此方法可以从工作表中移除当前图标集条件格式规则。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 condition.setIconSet(workbook.getIconSets().get(IconSetType.Icon3Symbols));
 condition.delete();

setFirstPriority

void setFirstPriority()

将此规则移到优先级 1。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition firstRule = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 IIconSetCondition secondRule = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 secondRule.setFirstPriority();
 int priority = secondRule.getPriority();

setLastPriority

void setLastPriority()

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

当同一工作表中存在多个条件格式规则时，使用此方法可以将该规则移至最低优先级。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition firstRule = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 IIconSetCondition secondRule = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 firstRule.setPriority(1);
 secondRule.setLastPriority();

getCustom

boolean getCustom()
获取这是否为自定义图标集规则。
当一个或多个条件使用不属于所选 IIconSet 的图标（包括 IconType.NoCellIcon）时，该规则为自定义规则。
```
 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 boolean custom = condition.getCustom();
 
```
Returns:

如果是自定义规则，则为 true；否则为 false。

fromJson

void fromJson(String json)

从 JSON 将图标集条件格式规则加载到当前对象中。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition source = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 source.setIconSet(workbook.getIconSets().get(IconSetType.Icon3TrafficLights1));
 String json = source.toJson();
 IIconSetCondition target = worksheet.getRange("B1:B5").getFormatConditions().addIconSetCondition();
 target.fromJson(json);

Parameters:: json - 由 toJson() 生成的 JSON。

toJson

String toJson()

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

返回的字符串包含此图标集条件格式规则的序列化定义。


 worksheet.getRange("A1:A5").setValue(new Object[][] {{10}, {30}, {50}, {70}, {90}});
 IIconSetCondition condition = worksheet.getRange("A1:A5").getFormatConditions().addIconSetCondition();
 condition.setIconSet(workbook.getIconSets().get(IconSetType.Icon3TrafficLights1));
 String json = condition.toJson();

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

IIconSetCondition

Interface IIconSetCondition

Method Summary

Method Details

getAppliesTo

setAppliesTo

getIconCriteria

getIconSet

setIconSet

getPercentileValues

setPercentileValues

getPriority

setPriority

getReverseOrder

setReverseOrder