ConditionalFormattingIcon
ConditionalFormattingIcon class
Represents the custom icon of conditional formatting rule.
class ConditionalFormattingIcon;
Properties
| Property | Type | Description |
|---|---|---|
| imageData | Uint8Array | Readonly. Gets the icon set data. |
| type | IconSetType | Gets and sets the icon set type. |
| index | number | Gets and sets the icon’s index in the icon set. |
Methods
| Method | Description |
|---|---|
| getImageData() | @deprecated. Please use the ‘imageData’ property instead. Gets the icon set data. |
| getType() | @deprecated. Please use the ’type’ property instead. Gets and sets the icon set type. |
| setType(IconSetType) | @deprecated. Please use the ’type’ property instead. Gets and sets the icon set type. |
| getIndex() | @deprecated. Please use the ‘index’ property instead. Gets and sets the icon’s index in the icon set. |
| setIndex(number) | @deprecated. Please use the ‘index’ property instead. Gets and sets the icon’s index in the icon set. |
| getImageData(Cell) | Gets the image data with the setting of cell. |
| isNull() | Checks whether the implementation object is null. |
| static getIconImageData(IconSetType, number) | Get the icon set data |
imageData
Readonly. Gets the icon set data.
imageData : Uint8Array;
type
Gets and sets the icon set type.
type : IconSetType;
index
Gets and sets the icon’s index in the icon set.
index : number;
getImageData()
@deprecated. Please use the ‘imageData’ property instead. Gets the icon set data.
getImageData() : Uint8Array;
getType()
@deprecated. Please use the ’type’ property instead. Gets and sets the icon set type.
getType() : IconSetType;
Returns
setType(IconSetType)
@deprecated. Please use the ’type’ property instead. Gets and sets the icon set type.
setType(value: IconSetType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IconSetType | The value to set. |
getIndex()
@deprecated. Please use the ‘index’ property instead. Gets and sets the icon’s index in the icon set.
getIndex() : number;
setIndex(number)
@deprecated. Please use the ‘index’ property instead. Gets and sets the icon’s index in the icon set.
setIndex(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getImageData(Cell)
Gets the image data with the setting of cell.
getImageData(cell: Cell) : Uint8Array;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| cell | Cell | The setting of cell. |
Returns
Returns the image data of icon.
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
getIconImageData(IconSetType, number)
Get the icon set data
static getIconImageData(type: IconSetType, index: number) : Uint8Array;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | IconSetType | icon’s type |
| index | number | icon’s index |