CellsColor
CellsColor class
Represents all types of color.
class CellsColor;
Methods
| Method | Description |
|---|---|
| isShapeColor() | Gets and set the color which should apply to cell or shape. |
| setIsShapeColor(boolean) | Gets and set the color which should apply to cell or shape. |
| getType() | The color type. |
| getThemeColor() | Gets the theme color. Only applies for theme color type. |
| setThemeColor(ThemeColor) | Gets the theme color. Only applies for theme color type. |
| getColorIndex() | Gets and sets the color index in the color palette. Only applies of indexed color. |
| setColorIndex(number) | Gets and sets the color index in the color palette. Only applies of indexed color. |
| getColor() | Gets and sets the RGB color. |
| setColor(Color) | Gets and sets the RGB color. |
| getArgb() | Gets and sets the color from a 32-bit ARGB value. |
| setArgb(number) | Gets and sets the color from a 32-bit ARGB value. |
| getTransparency() | Gets and sets transparency as a value from 0.0 (opaque) through 1.0 (clear). |
| setTransparency(number) | Gets and sets transparency as a value from 0.0 (opaque) through 1.0 (clear). |
| setTintOfShapeColor(number) | Set the tint of the shape color |
| isNull() | Checks whether the implementation object is null. |
isShapeColor()
Gets and set the color which should apply to cell or shape.
isShapeColor() : boolean;
Remarks
The expression of the color of the cell and the shape is different. For example: the theme color with same tint value will be not same in the cell and the shape.
setIsShapeColor(boolean)
Gets and set the color which should apply to cell or shape.
setIsShapeColor(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
The expression of the color of the cell and the shape is different. For example: the theme color with same tint value will be not same in the cell and the shape.
getType()
The color type.
getType() : ColorType;
Returns
getThemeColor()
Gets the theme color. Only applies for theme color type.
getThemeColor() : ThemeColor;
Returns
setThemeColor(ThemeColor)
Gets the theme color. Only applies for theme color type.
setThemeColor(value: ThemeColor) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ThemeColor | The value to set. |
getColorIndex()
Gets and sets the color index in the color palette. Only applies of indexed color.
getColorIndex() : number;
setColorIndex(number)
Gets and sets the color index in the color palette. Only applies of indexed color.
setColorIndex(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getColor()
Gets and sets the RGB color.
getColor() : Color;
Returns
setColor(Color)
Gets and sets the RGB color.
setColor(value: Color) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The value to set. |
getArgb()
Gets and sets the color from a 32-bit ARGB value.
getArgb() : number;
setArgb(number)
Gets and sets the color from a 32-bit ARGB value.
setArgb(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getTransparency()
Gets and sets transparency as a value from 0.0 (opaque) through 1.0 (clear).
getTransparency() : number;
setTransparency(number)
Gets and sets transparency as a value from 0.0 (opaque) through 1.0 (clear).
setTransparency(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
setTintOfShapeColor(number)
Set the tint of the shape color
setTintOfShapeColor(tint: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| tint | number |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;