TextSublayerNode

Interface: TextSublayerNode

Defined in: figmaPluginTypes.ts:8119

See

https://www.figma.com/plugin-docs/api/TextNode

Extends

NonResizableTextMixin.MinimalFillsMixin

Properties

characters

characters: string

Defined in: figmaPluginTypes.ts:7648

The raw characters in the text node. Setting this property requires the font the be loaded.

Remarks

Setting this property will reset styles applied to character ranges.

Setting the characters property can change the BaseNodeMixin.name of the node if autoRename === true.

Inherited from

NonResizableTextMixin.characters

fills

fills: typeof mixed | readonly Paint[]

Defined in: figmaPluginTypes.ts:6658

The paints used to fill the area of the shape. For help on how to change this value, see Editing Properties.

Remarks

This property can return PluginAPI.mixed if the node has multiple sets of fills. Text nodes can have multiple sets of fills if some characters are colored differently than others.

Use UtilAPI.solidPaint to create solid paint fills with CSS color strings.

Page nodes have a backgrounds property instead of a fills property.

Inherited from

MinimalFillsMixin.fills

fillStyleId

fillStyleId: string | typeof mixed

Defined in: figmaPluginTypes.ts:6668

The id of the PaintStyle object that the MinimalFillsMixin.fills property of this node is linked to.

If the manifest contains"documentAccess": "dynamic-page", this property is read-only. Use setFillStyleIdAsync to update the style.

Remarks

This property can return PluginAPI.mixed if the node has multiple fills.properties. Text nodes can have multiple fills if some characters are colored differently than others.

Inherited from

MinimalFillsMixin.fillStyleId

fontName

fontName: typeof mixed | FontName

Defined in: figmaPluginTypes.ts:7592

The font family (e.g. "Inter"), and font style (e.g. "Regular"). Setting this property to a different value requires the new font to be loaded.

Inherited from

NonResizableTextMixin.fontName

fontWeight

readonly fontWeight: number | typeof mixed

Defined in: figmaPluginTypes.ts:7596

The weight of the font (e.g. 400 for "Regular", 700 for "Bold").

Inherited from

NonResizableTextMixin.fontWeight

hangingList

hangingList: boolean

Defined in: figmaPluginTypes.ts:7970

Whether numbered list counters or unordered list bullets hang outside the text box.

Inherited from

NonResizableTextMixin.hangingList

hangingPunctuation

hangingPunctuation: boolean

Defined in: figmaPluginTypes.ts:7966

Whether punctuation, like quotation marks, hangs outside the text box.

Inherited from

NonResizableTextMixin.hangingPunctuation

hasMissingFont

readonly hasMissingFont: boolean

Defined in: figmaPluginTypes.ts:7584

Returns whether the text uses a font currently not available to the document.

Inherited from

NonResizableTextMixin.hasMissingFont

hyperlink

hyperlink: null | typeof mixed | HyperlinkTarget

Defined in: figmaPluginTypes.ts:7638

A HyperlinkTarget if the text node has exactly one hyperlink, or null if the node has none.

Inherited from

NonResizableTextMixin.hyperlink

leadingTrim

leadingTrim: typeof mixed | LeadingTrim

Defined in: figmaPluginTypes.ts:8002

The removal of the vertical space above and below text glyphs. Requires the font to be loaded.

Inherited from

NonResizableTextMixin.leadingTrim

letterSpacing

letterSpacing: typeof mixed | LetterSpacing

Defined in: figmaPluginTypes.ts:7634

The spacing between the individual characters. Requires the font to be loaded.

Inherited from

NonResizableTextMixin.letterSpacing

lineHeight

lineHeight: typeof mixed | LineHeight

Defined in: figmaPluginTypes.ts:7998

The spacing between the lines in a paragraph of text. Requires the font to be loaded.

Inherited from

NonResizableTextMixin.lineHeight

listSpacing

listSpacing: number

Defined in: figmaPluginTypes.ts:7962

The vertical distance between lines of a list.

Inherited from

NonResizableTextMixin.listSpacing

openTypeFeatures

readonly openTypeFeatures: typeof mixed | { AALT: boolean; ABRV: boolean; ABVM: boolean; ABVS: boolean; AFRC: boolean; AKHN: boolean; BLWF: boolean; BLWM: boolean; BLWS: boolean; C2PC: boolean; CALT: boolean; CASE: boolean; CCMP: boolean; CFAR: boolean; CJCT: boolean; CLIG: boolean; CPCT: boolean; CPSP: boolean; CSWH: boolean; CURS: boolean; CV01: boolean; CV02: boolean; CV03: boolean; CV04: boolean; CV05: boolean; CV06: boolean; CV07: boolean; CV08: boolean; CV09: boolean; CV10: boolean; CV11: boolean; CV12: boolean; CV13: boolean; CV14: boolean; CV15: boolean; CV16: boolean; CV17: boolean; CV18: boolean; CV19: boolean; CV20: boolean; CV21: boolean; CV22: boolean; CV23: boolean; CV24: boolean; CV25: boolean; CV26: boolean; CV27: boolean; CV28: boolean; CV29: boolean; CV30: boolean; CV31: boolean; CV32: boolean; CV33: boolean; CV34: boolean; CV35: boolean; CV36: boolean; CV37: boolean; CV38: boolean; CV39: boolean; CV40: boolean; CV41: boolean; CV42: boolean; CV43: boolean; CV44: boolean; CV45: boolean; CV46: boolean; CV47: boolean; CV48: boolean; CV49: boolean; CV50: boolean; CV51: boolean; CV52: boolean; CV53: boolean; CV54: boolean; CV55: boolean; CV56: boolean; CV57: boolean; CV58: boolean; CV59: boolean; CV60: boolean; CV61: boolean; CV62: boolean; CV63: boolean; CV64: boolean; CV65: boolean; CV66: boolean; CV67: boolean; CV68: boolean; CV69: boolean; CV70: boolean; CV71: boolean; CV72: boolean; CV73: boolean; CV74: boolean; CV75: boolean; CV76: boolean; CV77: boolean; CV78: boolean; CV79: boolean; CV80: boolean; CV81: boolean; CV82: boolean; CV83: boolean; CV84: boolean; CV85: boolean; CV86: boolean; CV87: boolean; CV88: boolean; CV89: boolean; CV90: boolean; CV91: boolean; CV92: boolean; CV93: boolean; CV94: boolean; CV95: boolean; CV96: boolean; CV97: boolean; CV98: boolean; CV99: boolean; DIST: boolean; DLIG: boolean; DNOM: boolean; DTLS: boolean; EXPT: boolean; FALT: boolean; FIN2: boolean; FIN3: boolean; FINA: boolean; FLAC: boolean; FWID: boolean; HALF: boolean; HALN: boolean; HALT: boolean; HIST: boolean; HKNA: boolean; HLIG: boolean; HNGL: boolean; HOJO: boolean; HWID: boolean; INIT: boolean; ISOL: boolean; ITAL: boolean; JP04: boolean; JP78: boolean; JP83: boolean; JP90: boolean; JUST: boolean; KERN: boolean; LFBD: boolean; LIGA: boolean; LJMO: boolean; LOCL: boolean; LTRA: boolean; LTRM: boolean; MARK: boolean; MED2: boolean; MEDI: boolean; MGRK: boolean; MKMK: boolean; NALT: boolean; NLCK: boolean; NUKT: boolean; NUMR: boolean; OPBD: boolean; ORDN: boolean; ORNM: boolean; PALT: boolean; PCAP: boolean; PKNA: boolean; PREF: boolean; PRES: boolean; PSTF: boolean; PSTS: boolean; PWID: boolean; QWID: boolean; RAND: boolean; RCLT: boolean; RKRF: boolean; RLIG: boolean; RPHF: boolean; RTBD: boolean; RTLA: boolean; RTLM: boolean; RUBY: boolean; RVRN: boolean; SALT: boolean; SINF: boolean; SIZE: boolean; SMPL: boolean; SS01: boolean; SS02: boolean; SS03: boolean; SS04: boolean; SS05: boolean; SS06: boolean; SS07: boolean; SS08: boolean; SS09: boolean; SS10: boolean; SS11: boolean; SS12: boolean; SS13: boolean; SS14: boolean; SS15: boolean; SS16: boolean; SS17: boolean; SS18: boolean; SS19: boolean; SS20: boolean; SSTY: boolean; STCH: boolean; SWSH: boolean; TITL: boolean; TJMO: boolean; TNAM: boolean; TRAD: boolean; TWID: boolean; UNIC: boolean; VALT: boolean; VATU: boolean; VERT: boolean; VHAL: boolean; VJMO: boolean; VKNA: boolean; VKRN: boolean; VPAL: boolean; VRT2: boolean; VRTR: boolean; ZERO: boolean; }

Defined in: figmaPluginTypes.ts:7626

OpenType features that have been explicitly enabled or disabled.

Remarks

The Details tab in the Type settings panel shows all the OpenType features that are available for the current font.

This property gives you a map of four-character OpenType features to booleans indicating whether the features are explicitly enabled or disabled. For example, if the map contains { CALT: false }, then the "Contextual alternates" feature is disabled.

Note: This map only contains features that diverge from their default values. Some OpenType features are enabled by default and some are disabled by default. For example CLIG and LIGA are on by default, whereas LNUM and TNUM are disabled by default.

Here are some useful resources for learning about OpenType features:

// For a node that uses the Inter font with
// "Contextual alternates" disabled (shows -> instead of ➔):
// { CALT: false }
console.log(figma.currentPage.selection[0].openTypeFeatures);

Inherited from

NonResizableTextMixin.openTypeFeatures

paragraphIndent

paragraphIndent: number

Defined in: figmaPluginTypes.ts:7954

The indentation of paragraphs (offset of the first line from the left). Setting this property requires the font the be loaded.

Inherited from

NonResizableTextMixin.paragraphIndent

paragraphSpacing

paragraphSpacing: number

Defined in: figmaPluginTypes.ts:7958

The vertical distance between paragraphs. Setting this property requires the font to be loaded.

Inherited from

NonResizableTextMixin.paragraphSpacing

textCase

textCase: typeof mixed | TextCase

Defined in: figmaPluginTypes.ts:7600

Overrides the case of the raw characters in the text node. Requires the font to be loaded.

Inherited from

NonResizableTextMixin.textCase

textDecoration

textDecoration: typeof mixed | TextDecoration

Defined in: figmaPluginTypes.ts:7974

Whether the text is underlined or has a strikethrough. Requires the font to be loaded.

Inherited from

NonResizableTextMixin.textDecoration

textDecorationColor

textDecorationColor: null | typeof mixed | TextDecorationColor

Defined in: figmaPluginTypes.ts:7990

The text decoration color. If the text is not underlined, this value will be null. Requires the font to be loaded.

Inherited from

NonResizableTextMixin.textDecorationColor

textDecorationOffset

textDecorationOffset: null | typeof mixed | TextDecorationOffset

Defined in: figmaPluginTypes.ts:7982

The text decoration offset. If the text is not underlined, this value will be null. Requires the font to be loaded.

Inherited from

NonResizableTextMixin.textDecorationOffset

textDecorationSkipInk

textDecorationSkipInk: null | boolean | typeof mixed

Defined in: figmaPluginTypes.ts:7994

Whether the text decoration skips descenders. If the text is not underlined, this value will be null. Requires the font to be loaded.

Inherited from

NonResizableTextMixin.textDecorationSkipInk

textDecorationStyle

textDecorationStyle: null | typeof mixed | TextDecorationStyle

Defined in: figmaPluginTypes.ts:7978

The text decoration style (e.g. "SOLID"). If the text is not underlined, this value will be null. Requires the font to be loaded.

Inherited from

NonResizableTextMixin.textDecorationStyle

textDecorationThickness

textDecorationThickness: null | typeof mixed | TextDecorationThickness

Defined in: figmaPluginTypes.ts:7986

The text decoration thickness. If the text is not underlined, this value will be null. Requires the font to be loaded.

Inherited from

NonResizableTextMixin.textDecorationThickness

Methods

deleteCharacters()

deleteCharacters(start, end): void

Defined in: figmaPluginTypes.ts:7670

Remove characters in the text from start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

void

Remarks

This API allows you to remove characters in a text node while preserving the styles of the existing characters. However, you still need to call PluginAPI.loadFontAsync before using this API.

Caution: ⚠ Did you know: not all glyphs that you might think as a "character" are actually stored as a single character in JavaScript string? JavaScript strings are UTF-16 encoded. Some characters like "👍" are stored using two characters! Try it in the JavaScript console: "👍".length is 2! The two characters are called "surrogate pairs". Even more mindblowing: some characters are made of multiple emojis. For example, "👨‍👧", which you should see in your browser as a single character, has length 5. "👨‍👧".substring(0, 2) is "👨" and "👨‍👧".substring(3, 5) is "👧".

Inherited from

NonResizableTextMixin.deleteCharacters

getRangeAllFontNames()

getRangeAllFontNames(start, end): FontName[]

Defined in: figmaPluginTypes.ts:7694

Get the fontNames from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

FontName[]

Inherited from

NonResizableTextMixin.getRangeAllFontNames

getRangeBoundVariable()

getRangeBoundVariable(start, end, field): null | typeof mixed | VariableAlias

Defined in: figmaPluginTypes.ts:7771

Get the boundVariable for a given field from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

getRangeFills()

getRangeFills(start, end): typeof mixed | Paint[]

Defined in: figmaPluginTypes.ts:7733

Get the fills from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

typeof mixed | Paint[]

Inherited from

NonResizableTextMixin.getRangeFills

getRangeFillStyleId()

getRangeFillStyleId(start, end): string | typeof mixed

Defined in: figmaPluginTypes.ts:7757

Get the fillStyleId from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

string | typeof mixed

Inherited from

NonResizableTextMixin.getRangeFillStyleId

getRangeFontName()

getRangeFontName(start, end): typeof mixed | FontName

Defined in: figmaPluginTypes.ts:7682

Get the fontName from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

typeof mixed | FontName

Inherited from

NonResizableTextMixin.getRangeFontName

getRangeFontSize()

getRangeFontSize(start, end): number | typeof mixed

Defined in: figmaPluginTypes.ts:7674

Get the fontSize from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

number | typeof mixed

Inherited from

NonResizableTextMixin.getRangeFontSize

getRangeFontWeight()

getRangeFontWeight(start, end): number | typeof mixed

Defined in: figmaPluginTypes.ts:7690

Get the fontWeight from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

number | typeof mixed

Inherited from

NonResizableTextMixin.getRangeFontWeight

getRangeHyperlink()

getRangeHyperlink(start, end): null | typeof mixed | HyperlinkTarget

Defined in: figmaPluginTypes.ts:7725

Get the hyperlink from characters in range start (inclusive) to end (exclusive). Returns a HyperlinkTarget if the range contains exactly one hyperlink, or null if the range contains none.

Parameters

start

number

end

number

Returns

null | typeof mixed | HyperlinkTarget

Inherited from

NonResizableTextMixin.getRangeHyperlink

getRangeIndentation()

getRangeIndentation(start, end): number | typeof mixed

Defined in: figmaPluginTypes.ts:8090

Get the indentation from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

number | typeof mixed

Inherited from

NonResizableTextMixin.getRangeIndentation

getRangeLetterSpacing()

getRangeLetterSpacing(start, end): typeof mixed | LetterSpacing

Defined in: figmaPluginTypes.ts:7717

Get the letterSpacing from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

typeof mixed | LetterSpacing

Inherited from

NonResizableTextMixin.getRangeLetterSpacing

getRangeLineHeight()

getRangeLineHeight(start, end): typeof mixed | LineHeight

Defined in: figmaPluginTypes.ts:8066

Get the lineHeight from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

typeof mixed | LineHeight

Inherited from

NonResizableTextMixin.getRangeLineHeight

getRangeListOptions()

getRangeListOptions(start, end): typeof mixed | TextListOptions

Defined in: figmaPluginTypes.ts:8074

Get the textListOptions from characters in range start (inclusive) to end (exclusive). Returns a TextListOptions

Parameters

start

number

end

number

Returns

typeof mixed | TextListOptions

Inherited from

NonResizableTextMixin.getRangeListOptions

getRangeListSpacing()

getRangeListSpacing(start, end): number | typeof mixed

Defined in: figmaPluginTypes.ts:8082

Get the listSpacing from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

number | typeof mixed

Inherited from

NonResizableTextMixin.getRangeListSpacing

getRangeOpenTypeFeatures()

getRangeOpenTypeFeatures(start, end): typeof mixed | { AALT: boolean; ABRV: boolean; ABVM: boolean; ABVS: boolean; AFRC: boolean; AKHN: boolean; BLWF: boolean; BLWM: boolean; BLWS: boolean; C2PC: boolean; CALT: boolean; CASE: boolean; CCMP: boolean; CFAR: boolean; CJCT: boolean; CLIG: boolean; CPCT: boolean; CPSP: boolean; CSWH: boolean; CURS: boolean; CV01: boolean; CV02: boolean; CV03: boolean; CV04: boolean; CV05: boolean; CV06: boolean; CV07: boolean; CV08: boolean; CV09: boolean; CV10: boolean; CV11: boolean; CV12: boolean; CV13: boolean; CV14: boolean; CV15: boolean; CV16: boolean; CV17: boolean; CV18: boolean; CV19: boolean; CV20: boolean; CV21: boolean; CV22: boolean; CV23: boolean; CV24: boolean; CV25: boolean; CV26: boolean; CV27: boolean; CV28: boolean; CV29: boolean; CV30: boolean; CV31: boolean; CV32: boolean; CV33: boolean; CV34: boolean; CV35: boolean; CV36: boolean; CV37: boolean; CV38: boolean; CV39: boolean; CV40: boolean; CV41: boolean; CV42: boolean; CV43: boolean; CV44: boolean; CV45: boolean; CV46: boolean; CV47: boolean; CV48: boolean; CV49: boolean; CV50: boolean; CV51: boolean; CV52: boolean; CV53: boolean; CV54: boolean; CV55: boolean; CV56: boolean; CV57: boolean; CV58: boolean; CV59: boolean; CV60: boolean; CV61: boolean; CV62: boolean; CV63: boolean; CV64: boolean; CV65: boolean; CV66: boolean; CV67: boolean; CV68: boolean; CV69: boolean; CV70: boolean; CV71: boolean; CV72: boolean; CV73: boolean; CV74: boolean; CV75: boolean; CV76: boolean; CV77: boolean; CV78: boolean; CV79: boolean; CV80: boolean; CV81: boolean; CV82: boolean; CV83: boolean; CV84: boolean; CV85: boolean; CV86: boolean; CV87: boolean; CV88: boolean; CV89: boolean; CV90: boolean; CV91: boolean; CV92: boolean; CV93: boolean; CV94: boolean; CV95: boolean; CV96: boolean; CV97: boolean; CV98: boolean; CV99: boolean; DIST: boolean; DLIG: boolean; DNOM: boolean; DTLS: boolean; EXPT: boolean; FALT: boolean; FIN2: boolean; FIN3: boolean; FINA: boolean; FLAC: boolean; FWID: boolean; HALF: boolean; HALN: boolean; HALT: boolean; HIST: boolean; HKNA: boolean; HLIG: boolean; HNGL: boolean; HOJO: boolean; HWID: boolean; INIT: boolean; ISOL: boolean; ITAL: boolean; JP04: boolean; JP78: boolean; JP83: boolean; JP90: boolean; JUST: boolean; KERN: boolean; LFBD: boolean; LIGA: boolean; LJMO: boolean; LOCL: boolean; LTRA: boolean; LTRM: boolean; MARK: boolean; MED2: boolean; MEDI: boolean; MGRK: boolean; MKMK: boolean; NALT: boolean; NLCK: boolean; NUKT: boolean; NUMR: boolean; OPBD: boolean; ORDN: boolean; ORNM: boolean; PALT: boolean; PCAP: boolean; PKNA: boolean; PREF: boolean; PRES: boolean; PSTF: boolean; PSTS: boolean; PWID: boolean; QWID: boolean; RAND: boolean; RCLT: boolean; RKRF: boolean; RLIG: boolean; RPHF: boolean; RTBD: boolean; RTLA: boolean; RTLM: boolean; RUBY: boolean; RVRN: boolean; SALT: boolean; SINF: boolean; SIZE: boolean; SMPL: boolean; SS01: boolean; SS02: boolean; SS03: boolean; SS04: boolean; SS05: boolean; SS06: boolean; SS07: boolean; SS08: boolean; SS09: boolean; SS10: boolean; SS11: boolean; SS12: boolean; SS13: boolean; SS14: boolean; SS15: boolean; SS16: boolean; SS17: boolean; SS18: boolean; SS19: boolean; SS20: boolean; SSTY: boolean; STCH: boolean; SWSH: boolean; TITL: boolean; TJMO: boolean; TNAM: boolean; TRAD: boolean; TWID: boolean; UNIC: boolean; VALT: boolean; VATU: boolean; VERT: boolean; VHAL: boolean; VJMO: boolean; VKNA: boolean; VKRN: boolean; VPAL: boolean; VRT2: boolean; VRTR: boolean; ZERO: boolean; }

Defined in: figmaPluginTypes.ts:7706

Get the BaseNonResizableTextMixin.openTypeFeatures from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

typeof mixed | { AALT: boolean; ABRV: boolean; ABVM: boolean; ABVS: boolean; AFRC: boolean; AKHN: boolean; BLWF: boolean; BLWM: boolean; BLWS: boolean; C2PC: boolean; CALT: boolean; CASE: boolean; CCMP: boolean; CFAR: boolean; CJCT: boolean; CLIG: boolean; CPCT: boolean; CPSP: boolean; CSWH: boolean; CURS: boolean; CV01: boolean; CV02: boolean; CV03: boolean; CV04: boolean; CV05: boolean; CV06: boolean; CV07: boolean; CV08: boolean; CV09: boolean; CV10: boolean; CV11: boolean; CV12: boolean; CV13: boolean; CV14: boolean; CV15: boolean; CV16: boolean; CV17: boolean; CV18: boolean; CV19: boolean; CV20: boolean; CV21: boolean; CV22: boolean; CV23: boolean; CV24: boolean; CV25: boolean; CV26: boolean; CV27: boolean; CV28: boolean; CV29: boolean; CV30: boolean; CV31: boolean; CV32: boolean; CV33: boolean; CV34: boolean; CV35: boolean; CV36: boolean; CV37: boolean; CV38: boolean; CV39: boolean; CV40: boolean; CV41: boolean; CV42: boolean; CV43: boolean; CV44: boolean; CV45: boolean; CV46: boolean; CV47: boolean; CV48: boolean; CV49: boolean; CV50: boolean; CV51: boolean; CV52: boolean; CV53: boolean; CV54: boolean; CV55: boolean; CV56: boolean; CV57: boolean; CV58: boolean; CV59: boolean; CV60: boolean; CV61: boolean; CV62: boolean; CV63: boolean; CV64: boolean; CV65: boolean; CV66: boolean; CV67: boolean; CV68: boolean; CV69: boolean; CV70: boolean; CV71: boolean; CV72: boolean; CV73: boolean; CV74: boolean; CV75: boolean; CV76: boolean; CV77: boolean; CV78: boolean; CV79: boolean; CV80: boolean; CV81: boolean; CV82: boolean; CV83: boolean; CV84: boolean; CV85: boolean; CV86: boolean; CV87: boolean; CV88: boolean; CV89: boolean; CV90: boolean; CV91: boolean; CV92: boolean; CV93: boolean; CV94: boolean; CV95: boolean; CV96: boolean; CV97: boolean; CV98: boolean; CV99: boolean; DIST: boolean; DLIG: boolean; DNOM: boolean; DTLS: boolean; EXPT: boolean; FALT: boolean; FIN2: boolean; FIN3: boolean; FINA: boolean; FLAC: boolean; FWID: boolean; HALF: boolean; HALN: boolean; HALT: boolean; HIST: boolean; HKNA: boolean; HLIG: boolean; HNGL: boolean; HOJO: boolean; HWID: boolean; INIT: boolean; ISOL: boolean; ITAL: boolean; JP04: boolean; JP78: boolean; JP83: boolean; JP90: boolean; JUST: boolean; KERN: boolean; LFBD: boolean; LIGA: boolean; LJMO: boolean; LOCL: boolean; LTRA: boolean; LTRM: boolean; MARK: boolean; MED2: boolean; MEDI: boolean; MGRK: boolean; MKMK: boolean; NALT: boolean; NLCK: boolean; NUKT: boolean; NUMR: boolean; OPBD: boolean; ORDN: boolean; ORNM: boolean; PALT: boolean; PCAP: boolean; PKNA: boolean; PREF: boolean; PRES: boolean; PSTF: boolean; PSTS: boolean; PWID: boolean; QWID: boolean; RAND: boolean; RCLT: boolean; RKRF: boolean; RLIG: boolean; RPHF: boolean; RTBD: boolean; RTLA: boolean; RTLM: boolean; RUBY: boolean; RVRN: boolean; SALT: boolean; SINF: boolean; SIZE: boolean; SMPL: boolean; SS01: boolean; SS02: boolean; SS03: boolean; SS04: boolean; SS05: boolean; SS06: boolean; SS07: boolean; SS08: boolean; SS09: boolean; SS10: boolean; SS11: boolean; SS12: boolean; SS13: boolean; SS14: boolean; SS15: boolean; SS16: boolean; SS17: boolean; SS18: boolean; SS19: boolean; SS20: boolean; SSTY: boolean; STCH: boolean; SWSH: boolean; TITL: boolean; TJMO: boolean; TNAM: boolean; TRAD: boolean; TWID: boolean; UNIC: boolean; VALT: boolean; VATU: boolean; VERT: boolean; VHAL: boolean; VJMO: boolean; VKNA: boolean; VKRN: boolean; VPAL: boolean; VRT2: boolean; VRTR: boolean; ZERO: boolean; }

Inherited from

NonResizableTextMixin.getRangeOpenTypeFeatures

getRangeParagraphIndent()

getRangeParagraphIndent(start, end): number | typeof mixed

Defined in: figmaPluginTypes.ts:8098

Get the paragraphIndent for a paragraph containing characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

number | typeof mixed

Inherited from

NonResizableTextMixin.getRangeParagraphIndent

getRangeParagraphSpacing()

getRangeParagraphSpacing(start, end): number | typeof mixed

Defined in: figmaPluginTypes.ts:8106

Get the paragraphSpacing for a paragraph containing characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

number | typeof mixed

Inherited from

NonResizableTextMixin.getRangeParagraphSpacing

getRangeTextCase()

getRangeTextCase(start, end): typeof mixed | TextCase

Defined in: figmaPluginTypes.ts:7698

Get the textCase from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

typeof mixed | TextCase

Inherited from

NonResizableTextMixin.getRangeTextCase

getRangeTextDecoration()

getRangeTextDecoration(start, end): typeof mixed | TextDecoration

Defined in: figmaPluginTypes.ts:8006

Get the textDecoration from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

typeof mixed | TextDecoration

Inherited from

NonResizableTextMixin.getRangeTextDecoration

getRangeTextDecorationColor()

getRangeTextDecorationColor(start, end): null | typeof mixed | TextDecorationColor

Defined in: figmaPluginTypes.ts:8047

Get the textDecorationColor from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

null | typeof mixed | TextDecorationColor

Inherited from

NonResizableTextMixin.getRangeTextDecorationColor

getRangeTextDecorationOffset()

getRangeTextDecorationOffset(start, end): null | typeof mixed | TextDecorationOffset

Defined in: figmaPluginTypes.ts:8025

Get the textDecorationOffset from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

null | typeof mixed | TextDecorationOffset

Inherited from

NonResizableTextMixin.getRangeTextDecorationOffset

getRangeTextDecorationSkipInk()

getRangeTextDecorationSkipInk(start, end): null | boolean | typeof mixed

Defined in: figmaPluginTypes.ts:8058

Get the textDecorationSkipInk from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

null | boolean | typeof mixed

Inherited from

NonResizableTextMixin.getRangeTextDecorationSkipInk

getRangeTextDecorationStyle()

getRangeTextDecorationStyle(start, end): null | typeof mixed | TextDecorationStyle

Defined in: figmaPluginTypes.ts:8014

Get the textDecorationStyle from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

null | typeof mixed | TextDecorationStyle

Inherited from

NonResizableTextMixin.getRangeTextDecorationStyle

getRangeTextDecorationThickness()

getRangeTextDecorationThickness(start, end): null | typeof mixed | TextDecorationThickness

Defined in: figmaPluginTypes.ts:8036

Get the textDecorationThickness from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

null | typeof mixed | TextDecorationThickness

Inherited from

NonResizableTextMixin.getRangeTextDecorationThickness

getRangeTextStyleId()

getRangeTextStyleId(start, end): string | typeof mixed

Defined in: figmaPluginTypes.ts:7743

Get the textStyleId from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

Returns

string | typeof mixed

Inherited from

NonResizableTextMixin.getRangeTextStyleId

getStyledTextSegments()

getStyledTextSegments<StyledTextSegmentFields>(fields, start?, end?): Pick<StyledTextSegment, "characters" | "start" | "end" | StyledTextSegmentFields[number]>[]

Defined in: figmaPluginTypes.ts:7934

Get text segments along with the desired text properties (font size, text case, etc...)

Type Parameters

StyledTextSegmentFields

Parameters

fields

StyledTextSegmentFields

An array of text properties. Any text property that can apply to specific character ranges is supported:

fontSize
fontName
fontWeight
textDecoration
textDecorationStyle
textDecorationOffset
textDecorationThickness
textDecorationColor
textDecorationSkipInk
textCase
lineHeight
letterSpacing
fills
textStyleId
fillStyleId
listOptions
listSpacing
indentation
paragraphIndent
paragraphSpacing
hyperlink
boundVariables
textStyleOverrides
openTypeFeatures

start?

number

An optional start index for the characters to retrieve

end?

number

An optional end index (required if start is provided)

Returns

Pick<StyledTextSegment, "characters" | "start" | "end" | StyledTextSegmentFields[number]>[]

Remarks

This function provides an easy and performant way to get multiple text properties which may have mixed values, along with which characters these values apply to. It will return an array of StyledTextSegments containing the desired fields, along with the characters and their start and end index.

To illustrate the behavior of this function, here are a few examples:

Node containing "hello world":

textNode.getStyledTextSegments(["fontName"])[
  // Output: contains 2 segments because the text is no longer bolded after "hello"
  ({
    characters: "hello",
    start: 0,
    end: 5,
    fontName: { family: "Inter", style: "Bold" },
  },
  {
    characters: " world",
    start: 5,
    end: 11,
    fontName: { family: "Inter", style: "Regular" },
  })
];

Node containing:

Item 1
- Item 1.1

textNode.getStyledTextSegments(["fontName", "indentation"])[
  // Output: contains 3 segments because the font / indentation changes
  // before and after the second "Item"
  ({
    characters: "Item 1\n",
    start: 0,
    end: 7,
    fontName: { family: "Inter", style: "Regular" },
    indentation: 1,
  },
  {
    characters: "Item",
    start: 7,
    end: 11,
    fontName: { family: "Inter", style: "Bold" },
    indentation: 2,
  },
  {
    characters: " 1.1",
    start: 11,
    end: 15,
    fontName: { family: "Inter", style: "Regular" },
    indentation: 2,
  })
];

Node containing "😁 😭 😅😂😳😎":

textNode.getStyledTextSegments(["letterSpacing"])[
  // Output: many emoji have length 2 in Javascript
  ({
    characters: "😁😭",
    start: 0,
    end: 4,
    letterSpacing: { unit: "PERCENT", value: 50 },
  },
  {
    characters: "😅😂😳😎",
    start: 4,
    end: 12,
    letterSpacing: { unit: "PERCENT", value: 0 },
  })
];

textNode.getStyledTextSegments(["letterSpacing"], 1, 3)[
  // Output: if the requested range starts or ends in the middle
  // of surrogate pairs, those pairs will be trimmed and you will
  // see raw Unicode code points
  {
    characters: "\uDE01\uD83D",
    start: 1,
    end: 3,
    letterSpacing: { unit: "PERCENT", value: 50 },
  }
];

textNode.getStyledTextSegments(["letterSpacing"], 3, 5)[
  // Output: similar to above, but Unicode code points span
  // a change in letter spacing
  ({
    characters: "\uDE2D",
    start: 3,
    end: 4,
    letterSpacing: { unit: "PERCENT", value: 50 },
  },
  {
    characters: "\uD83D",
    start: 4,
    end: 5,
    letterSpacing: { unit: "PERCENT", value: 0 },
  })
];

See BaseNonResizableTextMixin.insertCharacters for more information on surrogate pairs.

Inherited from

NonResizableTextMixin.getStyledTextSegments

insertCharacters()

insertCharacters(start, characters, useStyle?): void

Defined in: figmaPluginTypes.ts:7660

Insert characters at index start in the text.

Parameters

start

number

characters

string

useStyle?

"BEFORE" | "AFTER"

Returns

void

Remarks

This API allows you to insert characters in a text node while preserving the styles of the existing characters. However, you still need to call PluginAPI.loadFontAsync before using this API.

The style of the inserted characters will be copied from the preceding character if useStyle is "BEFORE" or not provided. Otherwise, the style of inserted characters will be copied from the following character. If there is no preceding or following character (i.e. start is at the boundary of the string), then the style will be copied from the closest existing character.

Inherited from

NonResizableTextMixin.insertCharacters

setFillStyleIdAsync()

setFillStyleIdAsync(styleId): Promise<void>

Defined in: figmaPluginTypes.ts:6672

Sets the PaintStyle that the MinimalFillsMixin.fills property of this node is linked to.

Parameters

styleId

string

Returns

Promise<void>

Inherited from

MinimalFillsMixin.setFillStyleIdAsync

setRangeBoundVariable()

setRangeBoundVariable(start, end, field, variable): void

Defined in: figmaPluginTypes.ts:7779

Set the boundVariable for a given field from characters in range start (inclusive) to end (exclusive). Requires any new fonts to be loaded.

Parameters

start

number

end

number

field

VariableBindableTextField

variable

null | Variable

Returns

void

Inherited from

NonResizableTextMixin.setRangeBoundVariable

setRangeFills()

setRangeFills(start, end, value): void

Defined in: figmaPluginTypes.ts:7739

Set the fills from characters in range start (inclusive) to end (exclusive). Requires font to be loaded.

Can be bound to color variables by using VariablesAPI.setBoundVariableForPaint on one or more of the provided Paints

Parameters

start

number

end

number

value

Paint[]

Returns

void

Inherited from

NonResizableTextMixin.setRangeFills

setRangeFillStyleId()

setRangeFillStyleId(start, end, value): void

Defined in: figmaPluginTypes.ts:7767

Set the fillStyleId from characters in range start (inclusive) to end (exclusive). Requires the font to be loaded.

Parameters

start

number

end

number

value

string

Returns

void

Deprecated

Use setRangeFillStyleIdAsync instead. This function will throw an exception if the plugin manifest contains "documentAccess": "dynamic-page".

Inherited from

NonResizableTextMixin.setRangeFillStyleId

setRangeFillStyleIdAsync()

setRangeFillStyleIdAsync(start, end, styleId): Promise<void>

Defined in: figmaPluginTypes.ts:7761

Set the provided PaintStyle as a fill to characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

styleId

string

Returns

Promise<void>

Inherited from

NonResizableTextMixin.setRangeFillStyleIdAsync

setRangeFontName()

setRangeFontName(start, end, value): void

Defined in: figmaPluginTypes.ts:7686

Set the fontName from characters in range start (inclusive) to end (exclusive). Requires the new font to be loaded.

Parameters

start

number

end

number

value

FontName

Returns

void

Inherited from

NonResizableTextMixin.setRangeFontName

setRangeFontSize()

setRangeFontSize(start, end, value): void

Defined in: figmaPluginTypes.ts:7678

Set the fontSize from characters in range start (inclusive) to end (exclusive). Requires the font to be loaded.

Parameters

start

number

end

number

value

number

Returns

void

Inherited from

NonResizableTextMixin.setRangeFontSize

setRangeHyperlink()

setRangeHyperlink(start, end, value): void

Defined in: figmaPluginTypes.ts:7729

Set the hyperlink from characters in range start (inclusive) to end (exclusive). Removes the hyperlink in range if value is null.

Parameters

start

number

end

number

value

null | HyperlinkTarget

Returns

void

Inherited from

NonResizableTextMixin.setRangeHyperlink

setRangeIndentation()

setRangeIndentation(start, end, value): void

Defined in: figmaPluginTypes.ts:8094

Set the indentation from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

value

number

Returns

void

Inherited from

NonResizableTextMixin.setRangeIndentation

setRangeLetterSpacing()

setRangeLetterSpacing(start, end, value): void

Defined in: figmaPluginTypes.ts:7721

Set the letterSpacing from characters in range start (inclusive) to end (exclusive). Requires the font to be loaded.

Parameters

start

number

end

number

value

LetterSpacing

Returns

void

Inherited from

NonResizableTextMixin.setRangeLetterSpacing

setRangeLineHeight()

setRangeLineHeight(start, end, value): void

Defined in: figmaPluginTypes.ts:8070

Set the lineHeight from characters in range start (inclusive) to end (exclusive). Requires the font to be loaded.

Parameters

start

number

end

number

value

LineHeight

Returns

void

Inherited from

NonResizableTextMixin.setRangeLineHeight

setRangeListOptions()

setRangeListOptions(start, end, value): void

Defined in: figmaPluginTypes.ts:8078

Set the textListOptions from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

value

TextListOptions

Returns

void

Inherited from

NonResizableTextMixin.setRangeListOptions

setRangeListSpacing()

setRangeListSpacing(start, end, value): void

Defined in: figmaPluginTypes.ts:8086

Set the listSpacing from characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

value

number

Returns

void

Inherited from

NonResizableTextMixin.setRangeListSpacing

setRangeParagraphIndent()

setRangeParagraphIndent(start, end, value): void

Defined in: figmaPluginTypes.ts:8102

Set the paragraphIndent for a paragraph containing characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

value

number

Returns

void

Inherited from

NonResizableTextMixin.setRangeParagraphIndent

setRangeParagraphSpacing()

setRangeParagraphSpacing(start, end, value): void

Defined in: figmaPluginTypes.ts:8110

Set the paragraphSpacing for a paragraph containing characters in range start (inclusive) to end (exclusive).

Parameters

start

number

end

number

value

number

Returns

void

Inherited from

NonResizableTextMixin.setRangeParagraphSpacing

setRangeTextCase()

setRangeTextCase(start, end, value): void

Defined in: figmaPluginTypes.ts:7702

Set the textCase from characters in range start (inclusive) to end (exclusive). Requires the font to be loaded.

Parameters

start

number

end

number

value

TextCase

Returns

void

Inherited from

NonResizableTextMixin.setRangeTextCase

setRangeTextDecoration()

setRangeTextDecoration(start, end, value): void

Defined in: figmaPluginTypes.ts:8010

Set the textDecoration from characters in range start (inclusive) to end (exclusive). Requires the font to be loaded.

Parameters

start

number

end

number

value

TextDecoration

Returns

void

Inherited from

NonResizableTextMixin.setRangeTextDecoration

setRangeTextDecorationColor()

setRangeTextDecorationColor(start, end, value): void

Defined in: figmaPluginTypes.ts:8054

Set the textDecorationColor from characters in range start (inclusive) to end (exclusive). Requires the font to be loaded.

Parameters

start

number

end

number

value

TextDecorationColor

Returns

void

Inherited from

NonResizableTextMixin.setRangeTextDecorationColor

setRangeTextDecorationOffset()

setRangeTextDecorationOffset(start, end, value): void

Defined in: figmaPluginTypes.ts:8032

Set the textDecorationOffset from characters in range start (inclusive) to end (exclusive). Requires the font to be loaded.

Parameters

start

number

end

number

value

TextDecorationOffset

Returns

void

Inherited from

NonResizableTextMixin.setRangeTextDecorationOffset

setRangeTextDecorationSkipInk()

setRangeTextDecorationSkipInk(start, end, value): void

Defined in: figmaPluginTypes.ts:8062

Set the textDecorationSkipInk from characters in range start (inclusive) to end (exclusive). Requires the font to be loaded.

Parameters

start

number

end

number

value

boolean

Returns

void

Inherited from

NonResizableTextMixin.setRangeTextDecorationSkipInk

setRangeTextDecorationStyle()

setRangeTextDecorationStyle(start, end, value): void

Defined in: figmaPluginTypes.ts:8021

Set the textDecorationStyle from characters in range start (inclusive) to end (exclusive). Requires the font to be loaded.

Parameters

start

number

end

number

value

TextDecorationStyle

Returns

void

Inherited from

NonResizableTextMixin.setRangeTextDecorationStyle

setRangeTextDecorationThickness()

setRangeTextDecorationThickness(start, end, value): void

Defined in: figmaPluginTypes.ts:8043

Set the textDecorationThickness from characters in range start (inclusive) to end (exclusive). Requires the font to be loaded.

Parameters

start

number

end

number

value

TextDecorationThickness

Returns

void

Inherited from

NonResizableTextMixin.setRangeTextDecorationThickness

setRangeTextStyleId()

setRangeTextStyleId(start, end, value): void

Defined in: figmaPluginTypes.ts:7753

Set the textStyleId from characters in range start (inclusive) to end (exclusive). Requires the font to be loaded.

Parameters

start

number

end

number

value

string

Returns

void

Deprecated

Use setRangeTextStyleIdAsync instead. This function will throw an exception if the plugin manifest contains "documentAccess": "dynamic-page".

Inherited from

NonResizableTextMixin.setRangeTextStyleId

setRangeTextStyleIdAsync()

setRangeTextStyleIdAsync(start, end, styleId): Promise<void>

Defined in: figmaPluginTypes.ts:7747

Set the provided TextStyle to characters in range start (inclusive) to end (exclusive). Requires the font to be loaded.

Parameters

start

number

end

number

styleId

string

Returns

Promise<void>

Inherited from

NonResizableTextMixin.setRangeTextStyleIdAsync

FilesExpand file tree

TextSublayerNode.md

Latest commit

History

TextSublayerNode.md

File metadata and controls

Interface: TextSublayerNode

See

Extends

Properties

characters

Remarks

Inherited from

fills

Remarks

Inherited from

fillStyleId

Remarks

Inherited from

fontName

Inherited from

fontSize

Inherited from

fontWeight

Inherited from

hangingList

Inherited from

hangingPunctuation

Inherited from

hasMissingFont

Inherited from

hyperlink

Inherited from

leadingTrim

Inherited from

letterSpacing

Inherited from

lineHeight

Inherited from

listSpacing

Inherited from

openTypeFeatures

Remarks

Inherited from

paragraphIndent

Inherited from

paragraphSpacing

Inherited from

textCase

Inherited from

textDecoration

Inherited from

textDecorationColor

Inherited from

textDecorationOffset

Inherited from

textDecorationSkipInk

Inherited from

textDecorationStyle

Inherited from

textDecorationThickness

Inherited from

Methods

deleteCharacters()

Parameters

start

end

Returns

Remarks

Inherited from

getRangeAllFontNames()

Parameters

start

end

Returns

Inherited from

getRangeBoundVariable()

Parameters

start

end