ThemeColor

ThemeColor class

Represents a theme color.

class ThemeColor;

Example

const { Workbook, ThemeColor, ThemeColorType, BackgroundType } = require("aspose.cells.node");

//Instantiating a Workbook object
var workbook = new Workbook();
var cells = workbook.worksheets.get(0).cells;
cells.get("A1").putValue("Hello World");
var style = cells.get("A1").getStyle();
//Set ThemeColorType.Text2 color type with 40% lighten as the font color.
style.font.themeColor = new ThemeColor(ThemeColorType.Text2, 0.4);
style.pattern = BackgroundType.Solid;
//Set ThemeColorType.Background2 color type with 75% darken as the foreground color
style.foregroundThemeColor = new ThemeColor(ThemeColorType.Background2, -0.75);
cells.get("A1").setStyle(style);
//Saving the Excel file
workbook.save("output/ThemeColor.xlsx");

Constructors

ConstructorDescription
constructor(ThemeColorType, number)

Properties

PropertyTypeDescription
colorTypeThemeColorTypeGets and sets the theme type.
tintnumberGets and sets the tint value.

Methods

MethodDescription
getColorType()@deprecated. Please use the ‘colorType’ property instead. Gets and sets the theme type.
setColorType(ThemeColorType)@deprecated. Please use the ‘colorType’ property instead. Gets and sets the theme type.
getTint()@deprecated. Please use the ’tint’ property instead. Gets and sets the tint value.
setTint(number)@deprecated. Please use the ’tint’ property instead. Gets and sets the tint value.
isNull()Checks whether the implementation object is null.

constructor(ThemeColorType, number)

constructor(type: ThemeColorType, tint: number);

Parameters:

ParameterTypeDescription
typeThemeColorTypeThe theme type.
tintnumberThe tint value.

colorType

Gets and sets the theme type.

colorType : ThemeColorType;

tint

Gets and sets the tint value.

tint : number;

Remarks

The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and 1.0 means 100% lighten. Also, 0.0 means no change.

getColorType()

@deprecated. Please use the ‘colorType’ property instead. Gets and sets the theme type.

getColorType() : ThemeColorType;

Returns

ThemeColorType

setColorType(ThemeColorType)

@deprecated. Please use the ‘colorType’ property instead. Gets and sets the theme type.

setColorType(value: ThemeColorType) : void;

Parameters:

ParameterTypeDescription
valueThemeColorTypeThe value to set.

getTint()

@deprecated. Please use the ’tint’ property instead. Gets and sets the tint value.

getTint() : number;

Remarks

The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and 1.0 means 100% lighten. Also, 0.0 means no change.

setTint(number)

@deprecated. Please use the ’tint’ property instead. Gets and sets the tint value.

setTint(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

Remarks

The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and 1.0 means 100% lighten. Also, 0.0 means no change.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;