CellsColor

CellsColor class

Represents all types of color.

class CellsColor;

Properties

Property	Type	Description
isShapeColor	boolean	Gets and set the color which should apply to cell or shape.
type	ColorType	Readonly. The color type.
themeColor	ThemeColor	Gets the theme color. Only applies for theme color type.
colorIndex	number	Gets and sets the color index in the color palette. Only applies of indexed color.
color	Color	Gets and sets the RGB color.
argb	number	Gets and sets the color from a 32-bit ARGB value.
transparency	number	Gets and sets transparency as a value from 0.0 (opaque) through 1.0 (clear).

Methods

Method	Description
isShapeColor()	@deprecated. Please use the ‘isShapeColor’ property instead. Gets and set the color which should apply to cell or shape.
setIsShapeColor(boolean)	@deprecated. Please use the ‘isShapeColor’ property instead. Gets and set the color which should apply to cell or shape.
getType()	@deprecated. Please use the ’type’ property instead. The color type.
getThemeColor()	@deprecated. Please use the ’themeColor’ property instead. Gets the theme color. Only applies for theme color type.
setThemeColor(ThemeColor)	@deprecated. Please use the ’themeColor’ property instead. Gets the theme color. Only applies for theme color type.
getColorIndex()	@deprecated. Please use the ‘colorIndex’ property instead. Gets and sets the color index in the color palette. Only applies of indexed color.
setColorIndex(number)	@deprecated. Please use the ‘colorIndex’ property instead. Gets and sets the color index in the color palette. Only applies of indexed color.
getColor()	@deprecated. Please use the ‘color’ property instead. Gets and sets the RGB color.
setColor(Color)	@deprecated. Please use the ‘color’ property instead. Gets and sets the RGB color.
getArgb()	@deprecated. Please use the ‘argb’ property instead. Gets and sets the color from a 32-bit ARGB value.
setArgb(number)	@deprecated. Please use the ‘argb’ property instead. Gets and sets the color from a 32-bit ARGB value.
getTransparency()	@deprecated. Please use the ’transparency’ property instead. Gets and sets transparency as a value from 0.0 (opaque) through 1.0 (clear).
setTransparency(number)	@deprecated. Please use the ’transparency’ property instead. 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.

type

Readonly. The color type.

type : ColorType;

themeColor

Gets the theme color. Only applies for theme color type.

themeColor : ThemeColor;

colorIndex

Gets and sets the color index in the color palette. Only applies of indexed color.

colorIndex : number;

color

Gets and sets the RGB color.

color : Color;

argb

Gets and sets the color from a 32-bit ARGB value.

argb : number;

transparency

Gets and sets transparency as a value from 0.0 (opaque) through 1.0 (clear).

transparency : number;

isShapeColor()

@deprecated. Please use the ‘isShapeColor’ property instead. 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)

@deprecated. Please use the ‘isShapeColor’ property instead. 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()

@deprecated. Please use the ’type’ property instead. The color type.

getType() : ColorType;

Returns

ColorType

getThemeColor()

@deprecated. Please use the ’themeColor’ property instead. Gets the theme color. Only applies for theme color type.

getThemeColor() : ThemeColor;

Returns

ThemeColor

setThemeColor(ThemeColor)

@deprecated. Please use the ’themeColor’ property instead. 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()

@deprecated. Please use the ‘colorIndex’ property instead. Gets and sets the color index in the color palette. Only applies of indexed color.

getColorIndex() : number;

setColorIndex(number)

@deprecated. Please use the ‘colorIndex’ property instead. 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()

@deprecated. Please use the ‘color’ property instead. Gets and sets the RGB color.

getColor() : Color;

Returns

Color

setColor(Color)

@deprecated. Please use the ‘color’ property instead. Gets and sets the RGB color.

setColor(value: Color) : void;

Parameters:

Parameter	Type	Description
value	Color	The value to set.

getArgb()

@deprecated. Please use the ‘argb’ property instead. Gets and sets the color from a 32-bit ARGB value.

getArgb() : number;

setArgb(number)

@deprecated. Please use the ‘argb’ property instead. 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()

@deprecated. Please use the ’transparency’ property instead. Gets and sets transparency as a value from 0.0 (opaque) through 1.0 (clear).

getTransparency() : number;

setTransparency(number)

@deprecated. Please use the ’transparency’ property instead. 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;