Interface: CharacterStylesRangeInput

Variant of CharacterStylesRange with all style fields optional, along with the range of characters they apply to. Used for the characterStyleRanges setter. When invoking the setter, any fields not specified are reset to their defaults.

If specified, the font must be of the AvailableFont type – one that is guaranteed to be available for the current user to edit with.

Extends

CharacterStylesInput.StyleRange

Properties

Property

Type

Description

Inherited from

fontSize?

number

Size of the text in points.

CharacterStyles.fontSize

color?

Color

Text color.

CharacterStyles.color

letterSpacing?

number

Uniformly adjusts the letter spacing, aka character spacing. Specified as a delta relative to the font's default spacing, in units of 1/1000 em: positive values increase the spacing, negative values tighten the spacing, and 0 leaves spacing at its default.

CharacterStyles.letterSpacing

underline?

boolean

Adds an underline to text.

CharacterStyles.underline

link?

string

A URL hyperlink. Character ranges with a link are underlined by default, unless these styles explicitly specify underline: false. To remove a link from existing text, explicitly specify link: "" in TextContentModel.applyCharacterStyles.

CharacterStyles.link

baselineShift?

TextScriptStyle

Sets a superscript or subscript style.

CharacterStyles.baselineShift

font?

AvailableFont

CharacterStylesInput.font

length

number

The length or number of characters in which character styles will be applied. Note: since characters are represented as UTF-16 code units, some symbols such as emojis are considered to have a length of 2.

StyleRange.length