TextOptions
TextOptions class
Represents the text options.
class TextOptions extends Font;
Constructors
Name | 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 |
---|---|
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;
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;