TextOptions

TextOptions class

Represents the text options.

class TextOptions extends Font;

Constructors

Constructor	Description
constructor(Font)	Constructs from a parent object convertible to this.

Properties

Property	Type	Description
languageCode	CountryCode	Gets and sets the user interface language.
latinName	string	Gets and sets the latin name.
farEastName	string	Gets and sets the FarEast name.
fill	FillFormat	Readonly. Represents the fill format of the text.
outline	LineFormat	Readonly. Represents the outline format of the text.
shadow	ShadowEffect	Readonly. Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
underlineColor	CellsColor	Gets or sets the color of underline.
kerning	number	Specifies the minimum font size at which character kerning will occur for this text run.
spacing	number	Specifies the spacing between characters within a text run.
charset	number	Represent the character set.
isItalic	boolean	Gets or sets a value indicating whether the font is italic.
isBold	boolean	Gets or sets a value indicating whether the font is bold.
capsType	TextCapsType	Gets and sets the text caps type.
strikeType	TextStrikeType	Gets the strike type of the text.
isStrikeout	boolean	Gets or sets a value indicating whether the font is single strikeout.
scriptOffset	number	Gets and sets the script offset,in unit of percentage
isSuperscript	boolean	Gets or sets a value indicating whether the font is super script.
isSubscript	boolean	Gets or sets a value indicating whether the font is subscript.
underline	FontUnderlineType	Gets or sets the font underline type.
doubleSize	number	Gets and sets the double size of the font.
size	number	Gets or sets the size of the font.
themeColor	ThemeColor	Gets and sets the theme color.
color	Color	Gets or sets the Color of the font.
argbColor	number	Gets and sets the color with a 32-bit ARGB value.
isNormalizeHeights	boolean	Indicates whether the normalization of height that is to be applied to the text run.
schemeType	FontSchemeType	Gets and sets the scheme type of the font.

Methods

Method	Description
getLanguageCode()	@deprecated. Please use the ’languageCode’ property instead. Gets and sets the user interface language.
setLanguageCode(CountryCode)	@deprecated. Please use the ’languageCode’ property instead. Gets and sets the user interface language.
getLatinName()	@deprecated. Please use the ’latinName’ property instead. Gets and sets the latin name.
setLatinName(string)	@deprecated. Please use the ’latinName’ property instead. Gets and sets the latin name.
getFarEastName()	@deprecated. Please use the ‘farEastName’ property instead. Gets and sets the FarEast name.
setFarEastName(string)	@deprecated. Please use the ‘farEastName’ property instead. Gets and sets the FarEast name.
getFill()	@deprecated. Please use the ‘fill’ property instead. Represents the fill format of the text.
getOutline()	@deprecated. Please use the ‘outline’ property instead. Represents the outline format of the text.
getShadow()	@deprecated. Please use the ‘shadow’ property instead. Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
getUnderlineColor()	@deprecated. Please use the ‘underlineColor’ property instead. Gets or sets the color of underline.
setUnderlineColor(CellsColor)	@deprecated. Please use the ‘underlineColor’ property instead. Gets or sets the color of underline.
getKerning()	@deprecated. Please use the ‘kerning’ property instead. Specifies the minimum font size at which character kerning will occur for this text run.
setKerning(number)	@deprecated. Please use the ‘kerning’ property instead. Specifies the minimum font size at which character kerning will occur for this text run.
getSpacing()	@deprecated. Please use the ‘spacing’ property instead. Specifies the spacing between characters within a text run.
setSpacing(number)	@deprecated. Please use the ‘spacing’ property instead. Specifies the spacing between characters within a text run.
isNull()	Checks whether the implementation object is null.
getCharset()	@deprecated. Please use the ‘charset’ property instead. Represent the character set.
setCharset(number)	@deprecated. Please use the ‘charset’ property instead. Represent the character set.
isItalic()	@deprecated. Please use the ‘isItalic’ property instead. Gets or sets a value indicating whether the font is italic.
setIsItalic(boolean)	@deprecated. Please use the ‘isItalic’ property instead. Gets or sets a value indicating whether the font is italic.
isBold()	@deprecated. Please use the ‘isBold’ property instead. Gets or sets a value indicating whether the font is bold.
setIsBold(boolean)	@deprecated. Please use the ‘isBold’ property instead. Gets or sets a value indicating whether the font is bold.
getCapsType()	@deprecated. Please use the ‘capsType’ property instead. Gets and sets the text caps type.
setCapsType(TextCapsType)	@deprecated. Please use the ‘capsType’ property instead. Gets and sets the text caps type.
getStrikeType()	@deprecated. Please use the ‘strikeType’ property instead. Gets the strike type of the text.
setStrikeType(TextStrikeType)	@deprecated. Please use the ‘strikeType’ property instead. Gets the strike type of the text.
isStrikeout()	@deprecated. Please use the ‘isStrikeout’ property instead. Gets or sets a value indicating whether the font is single strikeout.
setIsStrikeout(boolean)	@deprecated. Please use the ‘isStrikeout’ property instead. Gets or sets a value indicating whether the font is single strikeout.
getScriptOffset()	@deprecated. Please use the ‘scriptOffset’ property instead. Gets and sets the script offset,in unit of percentage
setScriptOffset(number)	@deprecated. Please use the ‘scriptOffset’ property instead. Gets and sets the script offset,in unit of percentage
isSuperscript()	@deprecated. Please use the ‘isSuperscript’ property instead. Gets or sets a value indicating whether the font is super script.
setIsSuperscript(boolean)	@deprecated. Please use the ‘isSuperscript’ property instead. Gets or sets a value indicating whether the font is super script.
isSubscript()	@deprecated. Please use the ‘isSubscript’ property instead. Gets or sets a value indicating whether the font is subscript.
setIsSubscript(boolean)	@deprecated. Please use the ‘isSubscript’ property instead. Gets or sets a value indicating whether the font is subscript.
getUnderline()	@deprecated. Please use the ‘underline’ property instead. Gets or sets the font underline type.
setUnderline(FontUnderlineType)	@deprecated. Please use the ‘underline’ property instead. Gets or sets the font underline type.
getDoubleSize()	@deprecated. Please use the ‘doubleSize’ property instead. Gets and sets the double size of the font.
setDoubleSize(number)	@deprecated. Please use the ‘doubleSize’ property instead. Gets and sets the double size of the font.
getSize()	@deprecated. Please use the ‘size’ property instead. Gets or sets the size of the font.
setSize(number)	@deprecated. Please use the ‘size’ property instead. Gets or sets the size of the font.
getThemeColor()	@deprecated. Please use the ’themeColor’ property instead. Gets and sets the theme color.
setThemeColor(ThemeColor)	@deprecated. Please use the ’themeColor’ property instead. Gets and sets the theme color.
getColor()	@deprecated. Please use the ‘color’ property instead. Gets or sets the Color of the font.
setColor(Color)	@deprecated. Please use the ‘color’ property instead. Gets or sets the Color of the font.
getArgbColor()	@deprecated. Please use the ‘argbColor’ property instead. Gets and sets the color with a 32-bit ARGB value.
setArgbColor(number)	@deprecated. Please use the ‘argbColor’ property instead. Gets and sets the color with a 32-bit ARGB value.
isNormalizeHeights()	@deprecated. Please use the ‘isNormalizeHeights’ property instead. Indicates whether the normalization of height that is to be applied to the text run.
setIsNormalizeHeights(boolean)	@deprecated. Please use the ‘isNormalizeHeights’ property instead. Indicates whether the normalization of height that is to be applied to the text run.
getSchemeType()	@deprecated. Please use the ‘schemeType’ property instead. Gets and sets the scheme type of the font.
setSchemeType(FontSchemeType)	@deprecated. Please use the ‘schemeType’ property instead. Gets and sets the scheme type of the font.
equals(Font)	Checks if two fonts are equals.
getName()	Gets and sets the name of the shape.
setName(string)	Gets and sets the name of the shape.
toString()	Returns a string represents the current Cell object.

constructor(Font)

Constructs from a parent object convertible to this.

constructor(obj: Font);

Parameters:

Parameter	Type	Description
obj	Font	The parent object.

languageCode

Gets and sets the user interface language.

languageCode : CountryCode;

latinName

Gets and sets the latin name.

latinName : string;

farEastName

Gets and sets the FarEast name.

farEastName : string;

fill

Readonly. Represents the fill format of the text.

fill : FillFormat;

outline

Readonly. Represents the outline format of the text.

outline : LineFormat;

shadow

Readonly. Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.

shadow : ShadowEffect;

underlineColor

Gets or sets the color of underline.

underlineColor : CellsColor;

kerning

Specifies the minimum font size at which character kerning will occur for this text run.

kerning : number;

spacing

Specifies the spacing between characters within a text run.

spacing : number;

charset

Represent the character set.

charset : number;

isItalic

Gets or sets a value indicating whether the font is italic.

isItalic : boolean;

isBold

Gets or sets a value indicating whether the font is bold.

isBold : boolean;

capsType

Gets and sets the text caps type.

capsType : TextCapsType;

strikeType

Gets the strike type of the text.

strikeType : TextStrikeType;

isStrikeout

Gets or sets a value indicating whether the font is single strikeout.

isStrikeout : boolean;

scriptOffset

Gets and sets the script offset,in unit of percentage

scriptOffset : number;

isSuperscript

Gets or sets a value indicating whether the font is super script.

isSuperscript : boolean;

isSubscript

Gets or sets a value indicating whether the font is subscript.

isSubscript : boolean;

underline

Gets or sets the font underline type.

underline : FontUnderlineType;

doubleSize

Gets and sets the double size of the font.

doubleSize : number;

size

Gets or sets the size of the font.

size : number;

themeColor

Gets and sets the theme color.

themeColor : ThemeColor;

Remarks

If the font color is not a theme color, NULL will be returned.

color

Gets or sets the Color of the font.

color : Color;

argbColor

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

argbColor : number;

isNormalizeHeights

Indicates whether the normalization of height that is to be applied to the text run.

isNormalizeHeights : boolean;

schemeType

Gets and sets the scheme type of the font.

schemeType : FontSchemeType;

getLanguageCode()

@deprecated. Please use the ’languageCode’ property instead. Gets and sets the user interface language.

getLanguageCode() : CountryCode;

Returns

CountryCode

setLanguageCode(CountryCode)

@deprecated. Please use the ’languageCode’ property instead. Gets and sets the user interface language.

setLanguageCode(value: CountryCode) : void;

Parameters:

Parameter	Type	Description
value	CountryCode	The value to set.

getLatinName()

@deprecated. Please use the ’latinName’ property instead. Gets and sets the latin name.

getLatinName() : string;

setLatinName(string)

@deprecated. Please use the ’latinName’ property instead. Gets and sets the latin name.

setLatinName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getFarEastName()

@deprecated. Please use the ‘farEastName’ property instead. Gets and sets the FarEast name.

getFarEastName() : string;

setFarEastName(string)

@deprecated. Please use the ‘farEastName’ property instead. Gets and sets the FarEast name.

setFarEastName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getFill()

@deprecated. Please use the ‘fill’ property instead. Represents the fill format of the text.

getFill() : FillFormat;

Returns

FillFormat

getOutline()

@deprecated. Please use the ‘outline’ property instead. Represents the outline format of the text.

getOutline() : LineFormat;

Returns

LineFormat

getShadow()

@deprecated. Please use the ‘shadow’ property instead. Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.

getShadow() : ShadowEffect;

Returns

ShadowEffect

getUnderlineColor()

@deprecated. Please use the ‘underlineColor’ property instead. Gets or sets the color of underline.

getUnderlineColor() : CellsColor;

Returns

CellsColor

setUnderlineColor(CellsColor)

@deprecated. Please use the ‘underlineColor’ property instead. Gets or sets the color of underline.

setUnderlineColor(value: CellsColor) : void;

Parameters:

Parameter	Type	Description
value	CellsColor	The value to set.

getKerning()

@deprecated. Please use the ‘kerning’ property instead. Specifies the minimum font size at which character kerning will occur for this text run.

getKerning() : number;

setKerning(number)

@deprecated. Please use the ‘kerning’ property instead. Specifies the minimum font size at which character kerning will occur for this text run.

setKerning(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getSpacing()

@deprecated. Please use the ‘spacing’ property instead. Specifies the spacing between characters within a text run.

getSpacing() : number;

setSpacing(number)

@deprecated. Please use the ‘spacing’ property instead. Specifies the spacing between characters within a text run.

setSpacing(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getCharset()

@deprecated. Please use the ‘charset’ property instead. Represent the character set.

getCharset() : number;

setCharset(number)

@deprecated. Please use the ‘charset’ property instead. Represent the character set.

setCharset(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isItalic()

@deprecated. Please use the ‘isItalic’ property instead. Gets or sets a value indicating whether the font is italic.

isItalic() : boolean;

setIsItalic(boolean)

@deprecated. Please use the ‘isItalic’ property instead. Gets or sets a value indicating whether the font is italic.

setIsItalic(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isBold()

@deprecated. Please use the ‘isBold’ property instead. Gets or sets a value indicating whether the font is bold.

isBold() : boolean;

setIsBold(boolean)

@deprecated. Please use the ‘isBold’ property instead. Gets or sets a value indicating whether the font is bold.

setIsBold(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCapsType()

@deprecated. Please use the ‘capsType’ property instead. Gets and sets the text caps type.

getCapsType() : TextCapsType;

Returns

TextCapsType

setCapsType(TextCapsType)

@deprecated. Please use the ‘capsType’ property instead. Gets and sets the text caps type.

setCapsType(value: TextCapsType) : void;

Parameters:

Parameter	Type	Description
value	TextCapsType	The value to set.

getStrikeType()

@deprecated. Please use the ‘strikeType’ property instead. Gets the strike type of the text.

getStrikeType() : TextStrikeType;

Returns

TextStrikeType

setStrikeType(TextStrikeType)

@deprecated. Please use the ‘strikeType’ property instead. Gets the strike type of the text.

setStrikeType(value: TextStrikeType) : void;

Parameters:

Parameter	Type	Description
value	TextStrikeType	The value to set.

isStrikeout()

@deprecated. Please use the ‘isStrikeout’ property instead. Gets or sets a value indicating whether the font is single strikeout.

isStrikeout() : boolean;

setIsStrikeout(boolean)

@deprecated. Please use the ‘isStrikeout’ property instead. Gets or sets a value indicating whether the font is single strikeout.

setIsStrikeout(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getScriptOffset()

@deprecated. Please use the ‘scriptOffset’ property instead. Gets and sets the script offset,in unit of percentage

getScriptOffset() : number;

setScriptOffset(number)

@deprecated. Please use the ‘scriptOffset’ property instead. Gets and sets the script offset,in unit of percentage

setScriptOffset(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isSuperscript()

@deprecated. Please use the ‘isSuperscript’ property instead. Gets or sets a value indicating whether the font is super script.

isSuperscript() : boolean;

setIsSuperscript(boolean)

@deprecated. Please use the ‘isSuperscript’ property instead. Gets or sets a value indicating whether the font is super script.

setIsSuperscript(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isSubscript()

@deprecated. Please use the ‘isSubscript’ property instead. Gets or sets a value indicating whether the font is subscript.

isSubscript() : boolean;

setIsSubscript(boolean)

@deprecated. Please use the ‘isSubscript’ property instead. Gets or sets a value indicating whether the font is subscript.

setIsSubscript(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getUnderline()

@deprecated. Please use the ‘underline’ property instead. Gets or sets the font underline type.

getUnderline() : FontUnderlineType;

Returns

FontUnderlineType

setUnderline(FontUnderlineType)

@deprecated. Please use the ‘underline’ property instead. Gets or sets the font underline type.

setUnderline(value: FontUnderlineType) : void;

Parameters:

Parameter	Type	Description
value	FontUnderlineType	The value to set.

getDoubleSize()

@deprecated. Please use the ‘doubleSize’ property instead. Gets and sets the double size of the font.

getDoubleSize() : number;

setDoubleSize(number)

@deprecated. Please use the ‘doubleSize’ property instead. Gets and sets the double size of the font.

setDoubleSize(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getSize()

@deprecated. Please use the ‘size’ property instead. Gets or sets the size of the font.

getSize() : number;

setSize(number)

@deprecated. Please use the ‘size’ property instead. Gets or sets the size of the font.

setSize(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getThemeColor()

@deprecated. Please use the ’themeColor’ property instead. Gets and sets the theme color.

getThemeColor() : ThemeColor;

Returns

ThemeColor

Remarks

If the font color is not a theme color, NULL will be returned.

setThemeColor(ThemeColor)

@deprecated. Please use the ’themeColor’ property instead. Gets and sets the theme color.

setThemeColor(value: ThemeColor) : void;

Parameters:

Parameter	Type	Description
value	ThemeColor	The value to set.

Remarks

If the font color is not a theme color, NULL will be returned.

getColor()

@deprecated. Please use the ‘color’ property instead. Gets or sets the Color of the font.

getColor() : Color;

Returns

Color

setColor(Color)

@deprecated. Please use the ‘color’ property instead. Gets or sets the Color of the font.

setColor(value: Color) : void;

Parameters:

Parameter	Type	Description
value	Color	The value to set.

getArgbColor()

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

getArgbColor() : number;

setArgbColor(number)

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

setArgbColor(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isNormalizeHeights()

@deprecated. Please use the ‘isNormalizeHeights’ property instead. Indicates whether the normalization of height that is to be applied to the text run.

isNormalizeHeights() : boolean;

setIsNormalizeHeights(boolean)

@deprecated. Please use the ‘isNormalizeHeights’ property instead. Indicates whether the normalization of height that is to be applied to the text run.

setIsNormalizeHeights(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getSchemeType()

@deprecated. Please use the ‘schemeType’ property instead. Gets and sets the scheme type of the font.

getSchemeType() : FontSchemeType;

Returns

FontSchemeType

setSchemeType(FontSchemeType)

@deprecated. Please use the ‘schemeType’ property instead. Gets and sets the scheme type of the font.

setSchemeType(value: FontSchemeType) : void;

Parameters:

Parameter	Type	Description
value	FontSchemeType	The value to set.

equals(Font)

Checks if two fonts are equals.

equals(font: Font) : boolean;

Parameters:

Parameter	Type	Description
font	Font	Compared font object.

Returns

True if equal to the compared font object.

getName()

Gets and sets the name of the shape.

getName() : string;

setName(string)

Gets and sets the name of the shape.

setName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

toString()

Returns a string represents the current Cell object.

toString() : string;