TextOptions

TextOptions class

Represents the text options.

class TextOptions extends Font;

Constructors

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

Properties

PropertyTypeDescription
languageCodeCountryCodeGets and sets the user interface language.
latinNamestringGets and sets the latin name.
farEastNamestringGets and sets the FarEast name.
fillFillFormatReadonly. Represents the fill format of the text.
outlineLineFormatReadonly. Represents the outline format of the text.
shadowShadowEffectReadonly. Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
underlineColorCellsColorGets or sets the color of underline.
kerningnumberSpecifies the minimum font size at which character kerning will occur for this text run.
spacingnumberSpecifies the spacing between characters within a text run.
charsetnumberRepresent the character set.
isItalicbooleanGets or sets a value indicating whether the font is italic.
isBoldbooleanGets or sets a value indicating whether the font is bold.
capsTypeTextCapsTypeGets and sets the text caps type.
strikeTypeTextStrikeTypeGets the strike type of the text.
isStrikeoutbooleanGets or sets a value indicating whether the font is single strikeout.
scriptOffsetnumberGets and sets the script offset,in unit of percentage
isSuperscriptbooleanGets or sets a value indicating whether the font is super script.
isSubscriptbooleanGets or sets a value indicating whether the font is subscript.
underlineFontUnderlineTypeGets or sets the font underline type.
doubleSizenumberGets and sets the double size of the font.
sizenumberGets or sets the size of the font.
themeColorThemeColorGets and sets the theme color.
colorColorGets or sets the Color of the font.
argbColornumberGets and sets the color with a 32-bit ARGB value.
isNormalizeHeightsbooleanIndicates whether the normalization of height that is to be applied to the text run.
schemeTypeFontSchemeTypeGets and sets the scheme type of the font.

Methods

MethodDescription
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:

ParameterTypeDescription
objFontThe 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;

equals(Font)

Checks if two fonts are equals.

equals(font: Font) : boolean;

Parameters:

ParameterTypeDescription
fontFontCompared 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:

ParameterTypeDescription
valuestringThe value to set.

toString()

Returns a string represents the current Cell object.

toString() : string;