IconSet
IconSet class
Describe the IconSet conditional formatting rule. This conditional formatting rule applies icons to cells according to their values.
class IconSet;
Methods
| Method | Description |
|---|---|
| getCfIcons() | Get theConditionalFormattingIcon from the collection |
| getCfvos() | Get the CFValueObjects instance. |
| getType() | Get or Set the icon set type to display. Setting the type will auto check if the current Cfvos’s count is accord with the new type. If not accord, old Cfvos will be cleaned and default Cfvos will be added. |
| setType(IconSetType) | Get or Set the icon set type to display. Setting the type will auto check if the current Cfvos’s count is accord with the new type. If not accord, old Cfvos will be cleaned and default Cfvos will be added. |
| isCustom() | Indicates whether the icon set is custom. Default value is false. |
| getShowValue() | Get or set the flag indicating whether to show the values of the cells on which this icon set is applied. Default value is true. |
| setShowValue(boolean) | Get or set the flag indicating whether to show the values of the cells on which this icon set is applied. Default value is true. |
| getReverse() | Get or set the flag indicating whether to reverses the default order of the icons in this icon set. Default value is false. |
| setReverse(boolean) | Get or set the flag indicating whether to reverses the default order of the icons in this icon set. Default value is false. |
getCfIcons()
Get theConditionalFormattingIcon from the collection
getCfIcons() : ConditionalFormattingIconCollection;
Returns
ConditionalFormattingIconCollection
getCfvos()
Get the CFValueObjects instance.
getCfvos() : ConditionalFormattingValueCollection;
Returns
ConditionalFormattingValueCollection
getType()
Get or Set the icon set type to display. Setting the type will auto check if the current Cfvos’s count is accord with the new type. If not accord, old Cfvos will be cleaned and default Cfvos will be added.
getType() : IconSetType;
Returns
setType(IconSetType)
Get or Set the icon set type to display. Setting the type will auto check if the current Cfvos’s count is accord with the new type. If not accord, old Cfvos will be cleaned and default Cfvos will be added.
setType(value: IconSetType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IconSetType | The value to set. |
isCustom()
Indicates whether the icon set is custom. Default value is false.
isCustom() : boolean;
getShowValue()
Get or set the flag indicating whether to show the values of the cells on which this icon set is applied. Default value is true.
getShowValue() : boolean;
setShowValue(boolean)
Get or set the flag indicating whether to show the values of the cells on which this icon set is applied. Default value is true.
setShowValue(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getReverse()
Get or set the flag indicating whether to reverses the default order of the icons in this icon set. Default value is false.
getReverse() : boolean;
setReverse(boolean)
Get or set the flag indicating whether to reverses the default order of the icons in this icon set. Default value is false.
setReverse(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |