IconSet
IconSet class
Describe the IconSet conditional formatting rule. This conditional formatting rule applies icons to cells according to their values.
class IconSet;
Example
const { Workbook, CellArea, FormatConditionType, IconSetType } = require("aspose.cells.node");
//Instantiating a Workbook object
var workbook = new Workbook();
var sheet = workbook.worksheets.get(0);
//Adds an empty conditional formatting
var index = sheet.conditionalFormattings.add();
var fcs = sheet.conditionalFormattings.get(index);
//Sets the conditional format range.
var ca = new CellArea();
ca.startRow = 0;
ca.endRow = 2;
ca.startColumn = 0;
ca.endColumn = 0;
fcs.addArea(ca);
//Adds condition.
var idx = fcs.addCondition(FormatConditionType.IconSet);
fcs.addArea(ca);
var cond = fcs.get(idx);
//Get Icon Set
var iconSet = cond.iconSet;
//Set Icon Type
iconSet.type = IconSetType.Arrows3;
//Put Cell Values
var cell1 = sheet.cells.get("A1");
cell1.putValue(10);
var cell2 = sheet.cells.get("A2");
cell2.putValue(120);
var cell3 = sheet.cells.get("A3");
cell3.putValue(260);
//Saving the Excel file
workbook.save("output/IconSet.xlsx");
Properties
| Property | Type | Description |
|---|---|---|
| cfIcons | ConditionalFormattingIconCollection | Readonly. Get theConditionalFormattingIcon from the collection |
| cfvos | ConditionalFormattingValueCollection | Readonly. Get the CFValueObjects instance. |
| type | 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 | boolean | Readonly. Indicates whether the icon set is custom. Default value is false. |
| showValue | 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. |
| reverse | boolean | Get or set the flag indicating whether to reverses the default order of the icons in this icon set. Default value is false. |
Methods
| Method | Description |
|---|---|
| getCfIcons() | @deprecated. Please use the ‘cfIcons’ property instead. Get theConditionalFormattingIcon from the collection |
| getCfvos() | @deprecated. Please use the ‘cfvos’ property instead. Get the CFValueObjects instance. |
| getType() | @deprecated. Please use the ’type’ property instead. 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) | @deprecated. Please use the ’type’ property instead. 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() | @deprecated. Please use the ‘isCustom’ property instead. Indicates whether the icon set is custom. Default value is false. |
| getShowValue() | @deprecated. Please use the ‘showValue’ property instead. 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) | @deprecated. Please use the ‘showValue’ property instead. 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() | @deprecated. Please use the ‘reverse’ property instead. 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) | @deprecated. Please use the ‘reverse’ property instead. Get or set the flag indicating whether to reverses the default order of the icons in this icon set. Default value is false. |
| isNull() | Checks whether the implementation object is null. |
cfIcons
Readonly. Get theConditionalFormattingIcon from the collection
cfIcons : ConditionalFormattingIconCollection;
cfvos
Readonly. Get the CFValueObjects instance.
cfvos : ConditionalFormattingValueCollection;
type
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.
type : IconSetType;
isCustom
Readonly. Indicates whether the icon set is custom. Default value is false.
isCustom : boolean;
showValue
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.
showValue : boolean;
reverse
Get or set the flag indicating whether to reverses the default order of the icons in this icon set. Default value is false.
reverse : boolean;
getCfIcons()
@deprecated. Please use the ‘cfIcons’ property instead. Get theConditionalFormattingIcon from the collection
getCfIcons() : ConditionalFormattingIconCollection;
Returns
ConditionalFormattingIconCollection
getCfvos()
@deprecated. Please use the ‘cfvos’ property instead. Get the CFValueObjects instance.
getCfvos() : ConditionalFormattingValueCollection;
Returns
ConditionalFormattingValueCollection
getType()
@deprecated. Please use the ’type’ property instead. 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)
@deprecated. Please use the ’type’ property instead. 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()
@deprecated. Please use the ‘isCustom’ property instead. Indicates whether the icon set is custom. Default value is false.
isCustom() : boolean;
getShowValue()
@deprecated. Please use the ‘showValue’ property instead. 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)
@deprecated. Please use the ‘showValue’ property instead. 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()
@deprecated. Please use the ‘reverse’ property instead. 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)
@deprecated. Please use the ‘reverse’ property instead. 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. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;