TextNode.md

---

TextNode

# Interface: TextNode

Defined in: figmaPluginTypes.ts:8625

## See

https://www.figma.com/plugin-docs/api/node-properties

## Extends

- [`DefaultShapeMixin`](DefaultShapeMixin.md).[`ConstraintMixin`](ConstraintMixin.md).[`NonResizableTextMixin`](NonResizableTextMixin.md).[`AnnotationsMixin`](AnnotationsMixin.md).[`AspectRatioLockMixin`](AspectRatioLockMixin.md)

## Properties

### absoluteBoundingBox

> `readonly` **absoluteBoundingBox**: `null` \| [`Rect`](Rect.md)

Defined in: figmaPluginTypes.ts:5712

The bounds of the node that does not include rendered properties like drop shadows or strokes. The `x` and `y` inside this property represent the absolute position of the node on the page.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`absoluteBoundingBox`](DefaultShapeMixin.md#absoluteboundingbox)

---

### absoluteRenderBounds

> `readonly` **absoluteRenderBounds**: `null` \| [`Rect`](Rect.md)

Defined in: figmaPluginTypes.ts:5721

The actual bounds of a node accounting for drop shadows, thick strokes, and anything else that may fall outside the node's regular bounding box defined in `x`, `y`, `width`, and `height`. The `x` and `y` inside this property represent the absolute position of the node on the page. This value will be `null` if the node is invisible.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`absoluteRenderBounds`](DefaultShapeMixin.md#absoluterenderbounds)

---

### absoluteTransform

> `readonly` **absoluteTransform**: [`Transform`](../type-aliases/Transform.md)

Defined in: figmaPluginTypes.ts:5708

The position of a node relative to its **containing page** as a [Transform](../type-aliases/Transform.md) matrix.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`absoluteTransform`](DefaultShapeMixin.md#absolutetransform)

---

### annotations

> **annotations**: readonly [`Annotation`](Annotation.md)[]

Defined in: figmaPluginTypes.ts:7226

Annotations on the node.

Learn more about annotations in the [Help Center](https://help.figma.com/hc/en-us/articles/20774752502935) or see the [Annotation type](https://www.figma.com/plugin-docs/api/Annotation) for usage examples.

#### Inherited from

[`AnnotationsMixin`](AnnotationsMixin.md).[`annotations`](AnnotationsMixin.md#annotations)

---

### attachedConnectors

> `readonly` **attachedConnectors**: [`ConnectorNode`](ConnectorNode.md)[]

Defined in: figmaPluginTypes.ts:5183

An array of `ConnectorNode`s that are attached to a node.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`attachedConnectors`](DefaultShapeMixin.md#attachedconnectors)

---

### autoRename

> **autoRename**: `boolean`

Defined in: figmaPluginTypes.ts:8680

Whether updating the characters in the text node should update the name of the node. If this is set to true, `name` will be auto-derived from `characters`.

#### Remarks

This is automatically reset to false if `name` is modified in order to allow the node to keep the new name.

---

### blendMode

> **blendMode**: [`BlendMode`](../type-aliases/BlendMode.md)

Defined in: figmaPluginTypes.ts:7182

Blend mode of this node, as shown in the Layer panel. In addition to the blend modes that paints & effects support, the layer blend mode can also have the value PASS_THROUGH.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`blendMode`](DefaultShapeMixin.md#blendmode)

---

### boundVariables?

> `readonly` `optional` **boundVariables**: `object` & `object` & `object`

Defined in: figmaPluginTypes.ts:5195

The variables bound to a particular field on this node. Please see the [Working with Variables](https://www.figma.com/plugin-docs/working-with-variables) guide for how to get and set variable bindings.

#### Type declaration

##### bottomLeftRadius?

> `optional` **bottomLeftRadius**: [`VariableAlias`](VariableAlias.md)

##### bottomRightRadius?

> `optional` **bottomRightRadius**: [`VariableAlias`](VariableAlias.md)

##### characters?

> `optional` **characters**: [`VariableAlias`](VariableAlias.md)

##### counterAxisSpacing?

> `optional` **counterAxisSpacing**: [`VariableAlias`](VariableAlias.md)

##### height?

> `optional` **height**: [`VariableAlias`](VariableAlias.md)

##### itemSpacing?

> `optional` **itemSpacing**: [`VariableAlias`](VariableAlias.md)

##### maxHeight?

> `optional` **maxHeight**: [`VariableAlias`](VariableAlias.md)

##### maxWidth?

> `optional` **maxWidth**: [`VariableAlias`](VariableAlias.md)

##### minHeight?

> `optional` **minHeight**: [`VariableAlias`](VariableAlias.md)

##### minWidth?

> `optional` **minWidth**: [`VariableAlias`](VariableAlias.md)

##### opacity?

> `optional` **opacity**: [`VariableAlias`](VariableAlias.md)

##### paddingBottom?

> `optional` **paddingBottom**: [`VariableAlias`](VariableAlias.md)

##### paddingLeft?

> `optional` **paddingLeft**: [`VariableAlias`](VariableAlias.md)

##### paddingRight?

> `optional` **paddingRight**: [`VariableAlias`](VariableAlias.md)

##### paddingTop?

> `optional` **paddingTop**: [`VariableAlias`](VariableAlias.md)

##### strokeBottomWeight?

> `optional` **strokeBottomWeight**: [`VariableAlias`](VariableAlias.md)

##### strokeLeftWeight?

> `optional` **strokeLeftWeight**: [`VariableAlias`](VariableAlias.md)

##### strokeRightWeight?

> `optional` **strokeRightWeight**: [`VariableAlias`](VariableAlias.md)

##### strokeTopWeight?

> `optional` **strokeTopWeight**: [`VariableAlias`](VariableAlias.md)

##### strokeWeight?

> `optional` **strokeWeight**: [`VariableAlias`](VariableAlias.md)

##### topLeftRadius?

> `optional` **topLeftRadius**: [`VariableAlias`](VariableAlias.md)

##### topRightRadius?

> `optional` **topRightRadius**: [`VariableAlias`](VariableAlias.md)

##### visible?

> `optional` **visible**: [`VariableAlias`](VariableAlias.md)

##### width?

> `optional` **width**: [`VariableAlias`](VariableAlias.md)

#### Type declaration

##### fontFamily?

> `optional` **fontFamily**: [`VariableAlias`](VariableAlias.md)[]

##### fontSize?

> `optional` **fontSize**: [`VariableAlias`](VariableAlias.md)[]

##### fontStyle?

> `optional` **fontStyle**: [`VariableAlias`](VariableAlias.md)[]

##### fontWeight?

> `optional` **fontWeight**: [`VariableAlias`](VariableAlias.md)[]

##### letterSpacing?

> `optional` **letterSpacing**: [`VariableAlias`](VariableAlias.md)[]

##### lineHeight?

> `optional` **lineHeight**: [`VariableAlias`](VariableAlias.md)[]

##### paragraphIndent?

> `optional` **paragraphIndent**: [`VariableAlias`](VariableAlias.md)[]

##### paragraphSpacing?

> `optional` **paragraphSpacing**: [`VariableAlias`](VariableAlias.md)[]

#### Type declaration

##### componentProperties?

> `readonly` `optional` **componentProperties**: `object`

###### Index Signature

\[`propertyName`: `string`\]: [`VariableAlias`](VariableAlias.md)

##### effects?

> `readonly` `optional` **effects**: [`VariableAlias`](VariableAlias.md)[]

##### fills?

> `readonly` `optional` **fills**: [`VariableAlias`](VariableAlias.md)[]

##### layoutGrids?

> `readonly` `optional` **layoutGrids**: [`VariableAlias`](VariableAlias.md)[]

##### strokes?

> `readonly` `optional` **strokes**: [`VariableAlias`](VariableAlias.md)[]

##### textRangeFills?

> `readonly` `optional` **textRangeFills**: [`VariableAlias`](VariableAlias.md)[]

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`boundVariables`](DefaultShapeMixin.md#boundvariables)

---

### 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](BaseNodeMixin.md#name) of the node if `autoRename === true`.

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`characters`](NonResizableTextMixin.md#characters)

---

### componentPropertyReferences

> **componentPropertyReferences**: `null` \| \{ `characters?`: `string`; `mainComponent?`: `string`; `visible?`: `string`; \}

Defined in: figmaPluginTypes.ts:5187

All component properties that are attached on this node. A node can only have `componentPropertyReferences` if it is a component sublayer or an instance sublayer. It will be `null` otherwise. The value in the key-value pair refers to the component property name as returned by `componentPropertyDefinitions` on the containing component, component set or main component (for instances).

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`componentPropertyReferences`](DefaultShapeMixin.md#componentpropertyreferences)

---

### ~~constrainProportions~~

> **constrainProportions**: `boolean`

Defined in: figmaPluginTypes.ts:5727

When toggled, causes the layer to keep its proportions when the user resizes it via the properties panel.

#### Deprecated

Use `targetAspectRatio`, `lockAspectRatio`, and `unlockAspectRatio` instead.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`constrainProportions`](DefaultShapeMixin.md#constrainproportions)

---

### constraints

> **constraints**: [`Constraints`](Constraints.md)

Defined in: figmaPluginTypes.ts:5613

Constraints of this node relative to its containing [FrameNode](FrameNode.md), if any.

#### Remarks

Not all node types have a constraint property. In particular, Group and BooleanOperation nodes do not have a constraint property themselves. Instead, resizing a frame applies the constraints on the children of those nodes.

#### Inherited from

[`ConstraintMixin`](ConstraintMixin.md).[`constraints`](ConstraintMixin.md#constraints)

---

### dashPattern

> **dashPattern**: readonly `number`[]

Defined in: figmaPluginTypes.ts:6623

A list of numbers specifying alternating dash and gap lengths, in pixels.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`dashPattern`](DefaultShapeMixin.md#dashpattern)

---

### effects

> **effects**: readonly [`Effect`](../type-aliases/Effect.md)[]

Defined in: figmaPluginTypes.ts:5967

Array of effects. See [Effect](../type-aliases/Effect.md) type. For help on how to change this value, see [Editing Properties](https://www.figma.com/plugin-docs/editing-properties).

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`effects`](DefaultShapeMixin.md#effects)

---

### effectStyleId

> **effectStyleId**: `string`

Defined in: figmaPluginTypes.ts:5973

The id of the [EffectStyle](EffectStyle.md) object that the properties of this node are linked to.

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

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`effectStyleId`](DefaultShapeMixin.md#effectstyleid)

---

### explicitVariableModes

> **explicitVariableModes**: `object`

Defined in: figmaPluginTypes.ts:8250

The explicitly set modes for this node.
For `SceneNodes`, represents a subset of [SceneNodeMixin.resolvedVariableModes](SceneNodeMixin.md#resolvedvariablemodes).
Note that this does not include [workspace and team-default modes](https://help.figma.com/hc/en-us/articles/12611253730071).

#### Index Signature

\[`collectionId`: `string`\]: `string`

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`explicitVariableModes`](DefaultShapeMixin.md#explicitvariablemodes)

---

### exportSettings

> **exportSettings**: readonly [`ExportSettings`](../type-aliases/ExportSettings.md)[]

Defined in: figmaPluginTypes.ts:6748

List of export settings stored on the node. For help on how to change this value, see [Editing Properties](https://www.figma.com/plugin-docs/editing-properties).

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`exportSettings`](DefaultShapeMixin.md#exportsettings)

---

### fillGeometry

> `readonly` **fillGeometry**: [`VectorPaths`](../type-aliases/VectorPaths.md)

Defined in: figmaPluginTypes.ts:6699

An array of paths representing the object fills relative to the node.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`fillGeometry`](DefaultShapeMixin.md#fillgeometry)

---

### fills

> **fills**: _typeof_ [`mixed`](PluginAPI.md#mixed) \| readonly [`Paint`](../type-aliases/Paint.md)[]

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](https://www.figma.com/plugin-docs/editing-properties).

#### Remarks

This property can return [PluginAPI.mixed](PluginAPI.md#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](UtilAPI.md#solidpaint) to create solid paint fills with CSS color strings.

Page nodes have a [`backgrounds`](https://www.figma.com/plugin-docs/api/PageNode/#backgrounds) property instead of a `fills` property.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`fills`](DefaultShapeMixin.md#fills)

---

### fillStyleId

> **fillStyleId**: `string` \| _typeof_ [`mixed`](PluginAPI.md#mixed)

Defined in: figmaPluginTypes.ts:6668

The id of the [PaintStyle](PaintStyle.md) object that the [MinimalFillsMixin.fills](MinimalFillsMixin.md#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](PluginAPI.md#mixed) if the node has multiple fills.properties. Text nodes can have multiple fills if some characters are colored differently than others.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`fillStyleId`](DefaultShapeMixin.md#fillstyleid)

---

### fontName

> **fontName**: _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`FontName`](FontName.md)

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`](NonResizableTextMixin.md).[`fontName`](NonResizableTextMixin.md#fontname)

---

### fontSize

> **fontSize**: `number` \| _typeof_ [`mixed`](PluginAPI.md#mixed)

Defined in: figmaPluginTypes.ts:7588

The size of the font. Has minimum value of 1.

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`fontSize`](NonResizableTextMixin.md#fontsize)

---

### fontWeight

> `readonly` **fontWeight**: `number` \| _typeof_ [`mixed`](PluginAPI.md#mixed)

Defined in: figmaPluginTypes.ts:7596

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

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`fontWeight`](NonResizableTextMixin.md#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`](NonResizableTextMixin.md).[`hangingList`](NonResizableTextMixin.md#hanginglist)

---

### hangingPunctuation

> **hangingPunctuation**: `boolean`

Defined in: figmaPluginTypes.ts:7966

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

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`hangingPunctuation`](NonResizableTextMixin.md#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`](NonResizableTextMixin.md).[`hasMissingFont`](NonResizableTextMixin.md#hasmissingfont)

---

### height

> `readonly` **height**: `number`

Defined in: figmaPluginTypes.ts:5642

The height of the node. Use a resizing method to change this value.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`height`](DefaultShapeMixin.md#height)

---

### hyperlink

> **hyperlink**: `null` \| _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`HyperlinkTarget`](../type-aliases/HyperlinkTarget.md)

Defined in: figmaPluginTypes.ts:7638

A [HyperlinkTarget](../type-aliases/HyperlinkTarget.md) if the text node has exactly one hyperlink, or `null` if the node has none.

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`hyperlink`](NonResizableTextMixin.md#hyperlink)

---

### id

> `readonly` **id**: `string`

Defined in: figmaPluginTypes.ts:4878

The unique identifier of a node. For example, `1:3`. The node id can be used with methods such as [PluginAPI.getNodeByIdAsync](PluginAPI.md#getnodebyidasync), but plugins typically don't need to use this since you can usually just access a node directly.

#### Remarks

One possible use case for using the `id` is to have a serializable representation of a Figma node. To "deserialize" an id back into a node, pass it to [PluginAPI.getNodeByIdAsync](PluginAPI.md#getnodebyidasync). This will return null if the node is no longer present in the document.

In the URLs for Figma files, node ids are hyphenated. However, for use with the API, node ids must use colons. For example, if a Figma file URL has the node id `1-3`, you must convert it to `1:3`.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`id`](DefaultShapeMixin.md#id)

---

### inferredVariables?

> `readonly` `optional` **inferredVariables**: `object` & `object`

Defined in: figmaPluginTypes.ts:5248

An object, keyed by field, returning any variables that match the raw value of that field for the mode of the node (or the default variable value if no mode is set)

#### Type declaration

##### bottomLeftRadius?

> `optional` **bottomLeftRadius**: [`VariableAlias`](VariableAlias.md)[]

##### bottomRightRadius?

> `optional` **bottomRightRadius**: [`VariableAlias`](VariableAlias.md)[]

##### characters?

> `optional` **characters**: [`VariableAlias`](VariableAlias.md)[]

##### counterAxisSpacing?

> `optional` **counterAxisSpacing**: [`VariableAlias`](VariableAlias.md)[]

##### height?

> `optional` **height**: [`VariableAlias`](VariableAlias.md)[]

##### itemSpacing?

> `optional` **itemSpacing**: [`VariableAlias`](VariableAlias.md)[]

##### maxHeight?

> `optional` **maxHeight**: [`VariableAlias`](VariableAlias.md)[]

##### maxWidth?

> `optional` **maxWidth**: [`VariableAlias`](VariableAlias.md)[]

##### minHeight?

> `optional` **minHeight**: [`VariableAlias`](VariableAlias.md)[]

##### minWidth?

> `optional` **minWidth**: [`VariableAlias`](VariableAlias.md)[]

##### opacity?

> `optional` **opacity**: [`VariableAlias`](VariableAlias.md)[]

##### paddingBottom?

> `optional` **paddingBottom**: [`VariableAlias`](VariableAlias.md)[]

##### paddingLeft?

> `optional` **paddingLeft**: [`VariableAlias`](VariableAlias.md)[]

##### paddingRight?

> `optional` **paddingRight**: [`VariableAlias`](VariableAlias.md)[]

##### paddingTop?

> `optional` **paddingTop**: [`VariableAlias`](VariableAlias.md)[]

##### strokeBottomWeight?

> `optional` **strokeBottomWeight**: [`VariableAlias`](VariableAlias.md)[]

##### strokeLeftWeight?

> `optional` **strokeLeftWeight**: [`VariableAlias`](VariableAlias.md)[]

##### strokeRightWeight?

> `optional` **strokeRightWeight**: [`VariableAlias`](VariableAlias.md)[]

##### strokeTopWeight?

> `optional` **strokeTopWeight**: [`VariableAlias`](VariableAlias.md)[]

##### strokeWeight?

> `optional` **strokeWeight**: [`VariableAlias`](VariableAlias.md)[]

##### topLeftRadius?

> `optional` **topLeftRadius**: [`VariableAlias`](VariableAlias.md)[]

##### topRightRadius?

> `optional` **topRightRadius**: [`VariableAlias`](VariableAlias.md)[]

##### visible?

> `optional` **visible**: [`VariableAlias`](VariableAlias.md)[]

##### width?

> `optional` **width**: [`VariableAlias`](VariableAlias.md)[]

#### Type declaration

##### fills?

> `readonly` `optional` **fills**: [`VariableAlias`](VariableAlias.md)[][]

##### strokes?

> `readonly` `optional` **strokes**: [`VariableAlias`](VariableAlias.md)[][]

#### Remarks

Inferred variables are only returned for a field when it is not using a [bound variable](https://www.figma.com/plugin-docs/api/node-properties/#boundvariables).

Variables can be inferred from:

- The collections of variables used in the file
- Variables from subscribed libraries, provided the variable is used in the file

Variables can only be inferred when there is a single variable that matches the raw value used for the scope of the variable.

- i.e. For a property set to width: 100px, where there are two variables set to a value of 100 with the default scope, a value cannot be inferred as there are two matches.
- i.e. For a property set to width: 100px, where there is a variable set to 100 with a scope of "Width and height" and a variable set to 100 with a scope of "Corner radius", a value can be inferred as there is a single match for the given scope.

Inferred variables for fills and strokes return a list of results where the index matches that of node.fills and node.strokes.

- i.e. node.inferredVariables.fills[0] holds the inferred variables for node.fills[0]

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`inferredVariables`](DefaultShapeMixin.md#inferredvariables)

---

### isAsset

> `readonly` **isAsset**: `boolean`

Defined in: figmaPluginTypes.ts:5010

Returns true if Figma detects that a node is an asset, otherwise returns false. An asset is is either an icon or a raster image.

This property is useful if you’re building a [plugin for code generation](https://www.figma.com/plugin-docs/codegen-plugins).

Note: This property uses a set of heuristics to determine if a node is an asset. At a high level an icon is a small vector graphic and an image is a node with an image fill.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`isAsset`](DefaultShapeMixin.md#isasset)

---

### isMask

> **isMask**: `boolean`

Defined in: figmaPluginTypes.ts:5959

Whether this node is a mask. A mask node masks its subsequent siblings.

#### Remarks

Since a mask node masks all of its subsequent siblings, enabling `isMask` on a node that is not in a group-like container designed to stop mask propagation can have unintented consequences — that is, it may "mask" (often in practice, hide) more siblings than you intend. When enabling `isMask`, ensure you have contained its propagation propertly. ("Subsequent siblings" are siblings listed _after_ this node in a `children` array in the plugin API; this corresponds to layers shown _above_ this node in the layers panel.)

Example:

```ts
const rect = figma.createRectangle();
const circleToMask = figma.createEllipse();
const otherCircle1 = figma.createEllipse();
const otherCircle2 = figma.createEllipse();

// In the layers panel, this would look something like:
// - otherCircle2
// - otherCircle1
// - circleToMask
// - rect
//
// So if I enable `rect.isMask`, the rect will mask ALL other nodes,
// because they are all siblings.
//
// If I only want `rect` to mask `circleToMask`, I should group
// them first.
figma.group(
  [rect, circleToMask],
  figma.currentPage,
  figma.currentPage.children.indexOf(circleToMask)
);
rect.isMask = true;

// Now `rect` only masks its siblings above it in its group
// (`circleToMask`) but not the circles outside of the group.
// In the layers panel this would look like:
// - otherCircle2
// - otherCircle1
// - Group
//   - circleToMask [this is the only node masked by rect]
//   - rect (isMask)
```

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`isMask`](DefaultShapeMixin.md#ismask)

---

### layoutAlign

> **layoutAlign**: `"MIN"` \| `"CENTER"` \| `"MAX"` \| `"STRETCH"` \| `"INHERIT"`

Defined in: figmaPluginTypes.ts:6507

Applicable only on direct children of auto-layout frames. Determines if the layer should stretch along the parent’s counter axis. Defaults to `“INHERIT”`.

#### Remarks

Changing this property will cause the `x`, `y`, `size`, and `relativeTransform` properties on this node to change, if applicable (inside an auto-layout frame).

- Setting `"STRETCH"` will make the node "stretch" to fill the width of the parent vertical auto-layout frame, or the height of the parent horizontal auto-layout frame excluding the frame's padding.
- If the current node is an auto layout frame (e.g. an auto layout frame inside a parent auto layout frame) if you set layoutAlign to `“STRETCH”` you should set the corresponding axis – either [AutoLayoutMixin.primaryAxisSizingMode](AutoLayoutMixin.md#primaryaxissizingmode) or [AutoLayoutMixin.counterAxisSizingMode](AutoLayoutMixin.md#counteraxissizingmode) – to be`“FIXED”`. This is because an auto-layout frame cannot simultaneously stretch to fill its parent and shrink to hug its children.
- Setting `"INHERIT"` does not "stretch" the node.

Caution: ⚠️ Previously, layoutAlign also determined counter axis alignment of auto-layout frame children. Counter axis alignment is now set on the auto-layout frame itself through [AutoLayoutMixin.counterAxisAlignItems](AutoLayoutMixin.md#counteraxisalignitems). Note that this means all layers in an auto-layout frame must now have the same counter axis alignment. This means `"MIN"`, `"CENTER"`, and `"MAX"` are now deprecated values of `layoutAlign`.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`layoutAlign`](DefaultShapeMixin.md#layoutalign)

---

### layoutGrow

> **layoutGrow**: `number`

Defined in: figmaPluginTypes.ts:6517

This property is applicable only for direct children of auto-layout frames. Determines whether a layer should stretch along the parent’s primary axis. 0 corresponds to a fixed size and 1 corresponds to stretch.

#### Remarks

0 and 1 are currently the only supported values.

Note: If the current node is an auto-layout frame (e.g. an auto-layout frame inside a parent auto-layout frame) if you set `layoutGrow` to 1 you should set the corresponding axis – either [AutoLayoutMixin.primaryAxisSizingMode](AutoLayoutMixin.md#primaryaxissizingmode) or [AutoLayoutMixin.counterAxisSizingMode](AutoLayoutMixin.md#counteraxissizingmode) – to be `“FIXED”`. This is because an auto-layout frame cannot simultaneously stretch to fill its parent and shrink to hug its children.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`layoutGrow`](DefaultShapeMixin.md#layoutgrow)

---

### layoutPositioning

> **layoutPositioning**: `"AUTO"` \| `"ABSOLUTE"`

Defined in: figmaPluginTypes.ts:6551

This property is applicable only for direct children of auto-layout frames. Determines whether a layer's size and position should be dermined by auto-layout settings or manually adjustable.

#### Remarks

Changing this property may cause the parent layer's size to change, since it will recalculate as if this child did not exist. It will also change this node's `x`, `y`, and `relativeTransform` properties.

- The default value of `"AUTO"` will layout this child according to auto-layout rules.
- Setting `"ABSOLUTE"` will take this child out of auto-layout flow, while still nesting inside the auto-layout frame. This allows explicitly setting `x`, `y`, `width`, and `height`. `"ABSOLUTE"` positioned nodes respect constraint settings.

```ts title="Auto-layout frame absolutely positioned red circle at the top-right corner"
const parentFrame = figma.createFrame();
parentFrame.appendChild(figma.createFrame());

// Create a small red circle
const ellipse = figma.createEllipse();
ellipse.resize(20, 20);
ellipse.fills = [{ type: "SOLID", color: { r: 1, g: 0, b: 0 } }];
parentFrame.appendChild(ellipse);
parentFrame.clipsContent = false;
parentFrame.layoutMode = "HORIZONTAL";

// Enable absolute positioning so we can move the circle
ellipse.layoutPositioning = "ABSOLUTE";

// Center the circle on the top-right corner of the frame
ellipse.x = 90;
ellipse.y = -10;

// Make the circle stick to the top-right corner of the frame
ellipse.constraints = { horizontal: "MAX", vertical: "MIN" };
```

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`layoutPositioning`](DefaultShapeMixin.md#layoutpositioning)

---

### layoutSizingHorizontal

> **layoutSizingHorizontal**: `"FILL"` \| `"FIXED"` \| `"HUG"`

Defined in: figmaPluginTypes.ts:5813

Applicable only on auto-layout frames, their children, and text nodes. This is a shorthand for setting [AutoLayoutChildrenMixin.layoutGrow](AutoLayoutChildrenMixin.md#layoutgrow), [AutoLayoutChildrenMixin.layoutAlign](AutoLayoutChildrenMixin.md#layoutalign), [AutoLayoutMixin.primaryAxisSizingMode](AutoLayoutMixin.md#primaryaxissizingmode), and [AutoLayoutMixin.counterAxisSizingMode](AutoLayoutMixin.md#counteraxissizingmode). This field maps directly to the "Horizontal sizing" dropdown in the Figma UI.

#### Remarks

`"HUG"` is only valid on auto-layout frames and text nodes. `"FILL"` is only valid on auto-layout children. Setting these values when they don't apply will throw an error.

```ts title="Setting layoutSizingHorizontal on an auto-layout frame"
const parentFrame = figma.createFrame();
const child2 = figma.createFrame();
parentFrame.appendChild(figma.createFrame());
parentFrame.appendChild(child2);
parentFrame.layoutMode = "VERTICAL";
// Make the second child twice as wide as the first
child2.resize(200, 100);

// Parent frame (child 2 is clipped)
// +-------------+
// |+-----------+|
// ||           ||
// ||  Child 1  ||
// ||           ||
// |+-----------+|
// |+------------|
// ||            |
// ||  Child 2   |
// ||            |
// |+------------|
// +-------------+

parentFrame.layoutSizingHorizontal = "FIXED";

// Parent frame (child 2 is not clipped)
// +------------------------+
// |+-----------+           |
// ||           |           |
// ||  Child 1  |           |
// ||           |           |
// |+-----------+           |
// |+----------------------+|
// ||                      ||
// ||       Child 2        ||
// ||                      ||
// |+----------------------+|
// +------------------------+
parentFrame.layoutSizingHorizontal = "HUG";
```

```ts title="Setting layoutSizingHorizontal on an auto-layout child"
const parentFrame = figma.createFrame();
const child2 = figma.createFrame();
parentFrame.appendChild(figma.createFrame());
parentFrame.appendChild(child2);
parentFrame.layoutMode = "HORIZONTAL";
parentFrame.resize(300, 100);

// Parent frame
// +-------------------------------------+
// |+-----------++-----------+           |
// ||           ||           |           |
// ||  Child 1  ||  Child 2  |           |
// ||           ||           |           |
// |+-----------++-----------+           |
// +-------------------------------------+
child2.layoutSizingHorizontal = "FIXED";

// Parent frame
// +-------------------------------------+
// |+-----------++----------------------+|
// ||           ||                      ||
// ||  Child 1  ||       Child 2        ||
// ||           ||                      ||
// |+-----------++----------------------+|
// +-------------------------------------+
child2.layoutSizingHorizontal = "FILL";
```

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`layoutSizingHorizontal`](DefaultShapeMixin.md#layoutsizinghorizontal)

---

### layoutSizingVertical

> **layoutSizingVertical**: `"FILL"` \| `"FIXED"` \| `"HUG"`

Defined in: figmaPluginTypes.ts:5821

Applicable only on auto-layout frames, their children, and text nodes. This is a shorthand for setting [AutoLayoutChildrenMixin.layoutGrow](AutoLayoutChildrenMixin.md#layoutgrow), [AutoLayoutChildrenMixin.layoutAlign](AutoLayoutChildrenMixin.md#layoutalign), [AutoLayoutMixin.primaryAxisSizingMode](AutoLayoutMixin.md#primaryaxissizingmode), and [AutoLayoutMixin.counterAxisSizingMode](AutoLayoutMixin.md#counteraxissizingmode). This field maps directly to the "Vertical sizing" dropdown in the Figma UI.

#### Remarks

`"HUG"` is only valid on auto-layout frames and text nodes. `"FILL"` is only valid on auto-layout children. Setting these values when they don't apply will throw an error.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`layoutSizingVertical`](DefaultShapeMixin.md#layoutsizingvertical)

---

### leadingTrim

> **leadingTrim**: _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`LeadingTrim`](../type-aliases/LeadingTrim.md)

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`](NonResizableTextMixin.md).[`leadingTrim`](NonResizableTextMixin.md#leadingtrim)

---

### letterSpacing

> **letterSpacing**: _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`LetterSpacing`](LetterSpacing.md)

Defined in: figmaPluginTypes.ts:7634

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

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`letterSpacing`](NonResizableTextMixin.md#letterspacing)

---

### lineHeight

> **lineHeight**: _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`LineHeight`](../type-aliases/LineHeight.md)

Defined in: figmaPluginTypes.ts:7998

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

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`lineHeight`](NonResizableTextMixin.md#lineheight)

---

### listSpacing

> **listSpacing**: `number`

Defined in: figmaPluginTypes.ts:7962

The vertical distance between lines of a list.

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`listSpacing`](NonResizableTextMixin.md#listspacing)

---

### locked

> **locked**: `boolean`

Defined in: figmaPluginTypes.ts:5167

Whether the node is locked or not, preventing certain user interactions on the canvas such as selecting and dragging. Does not affect a plugin's ability to write to those properties.

#### Remarks

The value that this property returns is independent from the node's parent. i.e.

- The node isn't necessarily locked if this is `.locked === true`.
- The node isn't necessarily unlocked if this is `.locked === false`.
- An object is locked if `.locked == true` for itself or **any** of its parents.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`locked`](DefaultShapeMixin.md#locked)

---

### maskType

> **maskType**: [`MaskType`](../type-aliases/MaskType.md)

Defined in: figmaPluginTypes.ts:5963

Type of masking to use if this node is a mask. Defaults to `"ALPHA"`. You must check `isMask` to verify that this is a mask; changing `maskType` does not automatically turn on `isMask`, and a node that is not a mask can still have a `maskType`.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`maskType`](DefaultShapeMixin.md#masktype)

---

### maxHeight

> **maxHeight**: `null` \| `number`

Defined in: figmaPluginTypes.ts:5658

Applicable only to auto-layout frames and their direct children. Value must be positive. Set to `null` to remove `maxHeight`.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`maxHeight`](DefaultShapeMixin.md#maxheight)

---

### maxLines

> **maxLines**: `null` \| `number`

Defined in: figmaPluginTypes.ts:8672

The maximum number of lines a text node can reach before it truncates. Only applicable when [TextNode.textTruncation](#texttruncation) is set to `"ENDING"`.

#### Remarks

The value must be >= 1. To disable truncation at a maximum number of lines, set to `null`.

---

### maxWidth

> **maxWidth**: `null` \| `number`

Defined in: figmaPluginTypes.ts:5650

Applicable only to auto-layout frames and their direct children. Value must be positive. Set to `null` to remove `maxWidth`.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`maxWidth`](DefaultShapeMixin.md#maxwidth)

---

### minHeight

> **minHeight**: `null` \| `number`

Defined in: figmaPluginTypes.ts:5654

Applicable only to auto-layout frames and their direct children. Value must be positive. Set to null to remove `minHeight`.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`minHeight`](DefaultShapeMixin.md#minheight)

---

### minWidth

> **minWidth**: `null` \| `number`

Defined in: figmaPluginTypes.ts:5646

Applicable only to auto-layout frames and their direct children. Value must be positive. Set to `null` to remove `minWidth`.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`minWidth`](DefaultShapeMixin.md#minwidth)

---

### name

> **name**: `string`

Defined in: figmaPluginTypes.ts:4898

The name of the layer that appears in the layers panel. Calling `figma.root.name` will return the name, read-only, of the current file.

#### Remarks

If the node is a TextNode, the name will update automatically by default based on the `characters` property (`autoRename` is true). If you manually override the text node's name, it will set `autoRename` to false. This matches the behavior in the editor.

If the node is a [PageNode](PageNode.md) with no children and the name is a page divider name, it will set `isPageDivider` to true. A page divider name consists of all asterisks, all en dashes, all em dashes, or all spaces.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`name`](DefaultShapeMixin.md#name)

---

### opacity

> **opacity**: `number`

Defined in: figmaPluginTypes.ts:7178

Opacity of the node, as shown in the Layer panel. Must be between 0 and 1.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`opacity`](DefaultShapeMixin.md#opacity)

---

### openTypeFeatures

> `readonly` **openTypeFeatures**: _typeof_ [`mixed`](PluginAPI.md#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](https://help.figma.com/hc/en-us/articles/4913951097367) that have been explicitly enabled or disabled.

#### Remarks

The **Details** tab in the [Type settings panel](https://help.figma.com/hc/en-us/articles/360039956634-Explore-text-properties#type-settings) 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:

- [An ode to OpenType [Figma blog]](https://www.figma.com/blog/opentype-font-features/)
- [OpenType feature tags [Microsoft]](https://learn.microsoft.com/en-us/typography/opentype/spec/featuretags)
- [OpenType font features guide [MDN]](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Fonts/OpenType_fonts_guide)
- [OpenType Features in CSS [Sparanoid]](https://sparanoid.com/lab/opentype-features/)

```ts title="Getting OpenType features from the currently-selected text node"
// 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`](NonResizableTextMixin.md).[`openTypeFeatures`](NonResizableTextMixin.md#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`](NonResizableTextMixin.md).[`paragraphIndent`](NonResizableTextMixin.md#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`](NonResizableTextMixin.md).[`paragraphSpacing`](NonResizableTextMixin.md#paragraphspacing)

---

### parent

> `readonly` **parent**: `null` \| BaseNode & ChildrenMixin

Defined in: figmaPluginTypes.ts:4888

Returns the parent of this node, if any. This property is not meant to be directly edited. To reparent, see [ChildrenMixin.appendChild](ChildrenMixin.md#appendchild).

#### Remarks

The root node (i.e. `figma.root`) doesn't have a parent.

Components accessed via [instance.getMainComponentAsync()](InstanceNode.md#getmaincomponentasync) or [instance.mainComponent](InstanceNode.md#maincomponent) do not always have a parent. They could be remote components or soft-deleted components.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`parent`](DefaultShapeMixin.md#parent)

---

### reactions

> **reactions**: readonly [`Reaction`](../type-aliases/Reaction.md)[]

Defined in: figmaPluginTypes.ts:7027

List of [Reactions](https://www.figma.com/plugin-docs/api/Reaction) on this node, which includes both the method of interaction with this node in a prototype, and the behavior of that interaction. For help on how to change this value, see [Editing Properties](https://www.figma.com/plugin-docs/editing-properties).

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

#### Remarks

[Prototyping](https://help.figma.com/hc/en-us/articles/360040314193-Guide-to-prototyping-in-Figma) in Figma lets users create connections between nodes that consist of a trigger (click, hover, etc...) and a corresponding list of actions, such as navigating to another frame or setting a variable. The `reactions` property lets you read and modify prototyping reactions on the node.

```ts title="Changing the transition duration in a prototyping action"
const node = figma.currentPage.selection[0];
console.log(node.reactions);

/*
Output:

[{
  action: {
    type: 'NODE',
    destinationId: '4:1539',
    navigation: 'NAVIGATE',
    transition: {
      type:'SMART_ANIMATE',
      easing: { type: 'EASE_OUT' },
      duration: 0.20000000298023224
    },
    preserveScrollPosition: false
  },
  actions: [{
    type: 'NODE',
    destinationId: '4:1539',
    navigation: 'NAVIGATE',
    transition: {
      type:'SMART_ANIMATE',
      easing: { type: 'EASE_OUT' },
      duration: 0.20000000298023224
    },
    preserveScrollPosition: false
  }],
  trigger: { type: 'ON_CLICK' }
}]
*/

// See clone() implementation from the Editing Properties page
const newReactions = clone(node.reactions);
// highlight-start
newReactions[0].actions[0].transition.duration = 0.5;
// highlight-end
await node.setReactionsAsync(newReactions);
```

It is also possible to add Advanced Prototyping action types through the Plugin API: [Set Variable](https://help.figma.com/hc/en-us/articles/14506587589399-Use-variables-in-prototypes) and [Conditional](https://help.figma.com/hc/en-us/articles/15253220891799-Multiple-actions-and-conditionals).
Moreover, Reactions now include the ability to execute multiple actions by updating the `actions` field on a `Reaction`.

```ts title="Create a button with a Reaction object that updates the visibility of another Frame."
(async () => {
  // Create collection with "show" variable inside
  const collection = figma.variables.createVariableCollection("prototyping");
  const modeId = collection.modes[0].modeId;
  const showVariable = figma.variables.createVariable(
    "show",
    collection,
    "BOOLEAN"
  );

  // Initialize "show" variable to true
  showVariable.setValueForMode(modeId, true);

  const parentFrame = figma.createFrame();
  parentFrame.resize(350, 200);

  // Green "Click me" button
  const toggleButton = figma.createFrame();
  parentFrame.appendChild(toggleButton);
  toggleButton.x = 50;
  toggleButton.y = 50;
  toggleButton.layoutMode = "HORIZONTAL";
  toggleButton.layoutSizingHorizontal = "HUG";
  toggleButton.layoutSizingVertical = "HUG";
  toggleButton.fills = [{ type: "SOLID", color: { r: 0, g: 1, b: 0 } }];
  const text = figma.createText();
  await figma.loadFontAsync(text.fontName);
  text.characters = "Click me";
  toggleButton.appendChild(text);

  // Red square
  const frame = figma.createFrame();
  parentFrame.appendChild(frame);
  frame.x = 200;
  frame.y = 50;
  frame.fills = [{ type: "SOLID", color: { r: 1, g: 0, b: 0 } }];

  // The "show" variable will now control the visibility of the frame
  frame.setBoundVariable("visible", showVariable);

  await toggleButton.setReactionsAsync([
    {
      trigger: { type: "ON_CLICK" },
      actions: [
        {
          type: "CONDITIONAL",
          conditionalBlocks: [
            {
              condition: {
                // Conditional: if "show" variable == true
                type: "EXPRESSION",
                resolvedType: "BOOLEAN",
                value: {
                  expressionArguments: [
                    {
                      type: "VARIABLE_ALIAS",
                      resolvedType: "BOOLEAN",
                      value: {
                        type: "VARIABLE_ALIAS",
                        id: showVariable.id,
                      },
                    },
                    {
                      type: "BOOLEAN",
                      resolvedType: "BOOLEAN",
                      value: true,
                    },
                  ],
                  expressionFunction: "EQUALS",
                },
              },
              actions: [
                // then set "show" variable to false
                {
                  type: "SET_VARIABLE",
                  variableId: showVariable.id,
                  variableValue: {
                    resolvedType: "BOOLEAN",
                    type: "BOOLEAN",
                    value: false,
                  },
                },
              ],
            },
            {
              actions: [
                // else set "show" variable to true
                {
                  type: "SET_VARIABLE",
                  variableId: showVariable.id,
                  variableValue: {
                    resolvedType: "BOOLEAN",
                    type: "BOOLEAN",
                    value: true,
                  },
                },
              ],
            },
          ],
        },
      ],
    },
  ]);
})();
```

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`reactions`](DefaultShapeMixin.md#reactions)

---

### relativeTransform

> **relativeTransform**: [`Transform`](../type-aliases/Transform.md)

Defined in: figmaPluginTypes.ts:5704

The position of a node relative to its **containing parent** as a [Transform](../type-aliases/Transform.md) matrix. Not used for scaling, see `width` and `height` instead. Read the details page to understand the nuances of this property.

#### Remarks

### Scale

The `relativeTransform` is **not** used for scaling a node. The transform always has unit axes. That is, `sqrt(m00^2 + m10^2) == sqrt(m01^2 + m11^2) == 1`. In order to set the size of a node, use [LayoutMixin.resize](LayoutMixin.md#resize) or [LayoutMixin.resizeWithoutConstraints](LayoutMixin.md#resizewithoutconstraints).

Note: If you have a background in computer graphics, you may find it odd that we use the transform matrix in such a manner. This is because in 2D UI design, it's rare that you would want to scale the children when resizing a frame. And even if you did, it would be through more nuanced constraint settings that aren't captured by a transformation matrix.

Also, if nodes had both a `width` and a separate `m00` scale property, it would be confusing to the users which one they're changing, especially during interactions like dragging.

### Container parent

The relative transform of a node is shown relative to its container parent, which includes canvas nodes, frame nodes, component nodes, and instance nodes. Just like in the properties panel, it is **not** relative to its direct parent if the parent is a group or a boolean operation.

Example 1: In the following hierarchy, the relative transform of `rectangle` is relative to `page` (which is just its position on the canvas).

```text
page
  group
    rectangle
```

Example 2: In the following hierarchy, the relative transform of `rectangle` is relative to `frame`.

```text
page
  frame
    boolean operation
      rectangle
```

One implication is that to calculate the absolute position of a node, you have to either use the [DimensionAndPositionMixin.absoluteTransform](DimensionAndPositionMixin.md#absolutetransform) property or multiply relative transform matrices while traversing up the node hierarchy while ignoring groups and boolean operations.

Note: Why this complication? We do it this way because groups and boolean operations automatically resize to fit their children. While you _can_ set the relative transform of a group to move it, it's a property derived from the position and size of its children.
If the relative transform was always relative to it’s immediate parent, you could get into confusing situations where moving a layer inside a group by setting the relative transform changes the position of the parent, which then requires changing the relative transform of the child in order to preserve its on-screen position!

### Skew

While it is possible to skew a layer by setting `m00`, `m01`, `m10`, `m11` to the right values, be aware that the skew will not be surfaced in the properties panel and may be confusing to the user dealing with a skewed node.

### Auto-layout frames

The translation components `m02` and `m12` of the transform matrix is automatically computed in children of auto-layout frames. Setting `relativeTransform` on those layers will ignore the translation components, but do keep the rotation components.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`relativeTransform`](DefaultShapeMixin.md#relativetransform)

---

### removed

> `readonly` **removed**: `boolean`

Defined in: figmaPluginTypes.ts:4911

Returns true if this node has been removed since it was first accessed. If your plugin stays open for a while and stores references to nodes, you should write your code defensively and check that the nodes haven't been removed by the user.

#### Remarks

A node can be removed for any number of reasons. Some examples:

- Your plugin called node.remove() on it
- Someone else deleted the node using multiplayer
- The user triggered an undo action and the node was removed
- The user simply deleted the node
- You removed all children out of a group, and the group auto-deleted itself

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`removed`](DefaultShapeMixin.md#removed)

---

### resolvedVariableModes

> **resolvedVariableModes**: `object`

Defined in: figmaPluginTypes.ts:5292

The resolved mode for this node for each variable collection in this file.

#### Index Signature

\[`collectionId`: `string`\]: `string`

#### Remarks

The set of resolved modes on a node includes the explicitly set modes on the node, as well as the explicitly set modes on ancestors of the node. By default, nodes [automatically inherit](https://help.figma.com/hc/en-us/articles/15343816063383-Modes-for-variables#Auto_mode) the modes of their parents.

```ts title="explicitVariableModes vs resolvedVariableModes"
// Create two collections with two modes each
const collection1 = figma.variables.createVariableCollection("Collection 1");
const collection1Mode1Id = collection1.modes[0].modeId;
const collection1Mode2Id = collection1.addMode("Mode 2");
const collection2 = figma.variables.createVariableCollection("Collection 2");
const collection2Mode1Id = collection2.modes[0].modeId;
const collection2Mode2Id = collection2.addMode("Mode 2");

const parentFrame = figma.createFrame();
const childFrame = figma.createFrame();
parentFrame.appendChild(childFrame);

parentFrame.setExplicitVariableModeForCollection(
  collection1,
  collection1Mode2Id
);
childFrame.setExplicitVariableModeForCollection(
  collection2,
  collection2Mode1Id
);

// Example output (only collection2 is present):
// { 'VariableCollectionId:1:3': '1:2' }
console.log(childFrame.explicitVariableModes);

// Example output (both collections are present):
// { 'VariableCollectionId:1:2': '1:1', 'VariableCollectionId:1:3': '1:2' }
console.log(childFrame.resolvedVariableModes);
```

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`resolvedVariableModes`](DefaultShapeMixin.md#resolvedvariablemodes)

---

### rotation

> **rotation**: `number`

Defined in: figmaPluginTypes.ts:5735

The rotation of the node in degrees. Returns values from -180 to 180. Identical to `Math.atan2(-m10, m00)` in the [DimensionAndPositionMixin.relativeTransform](DimensionAndPositionMixin.md#relativetransform) matrix. When setting `rotation`, it will also set `m00`, `m01`, `m10`, `m11`.

#### Remarks

The rotation is with respect to the top-left of the object. Therefore, it is independent from the position of the object. If you want to rotate with respect to the center (or any arbitrary point), you can do so via matrix transformations and [DimensionAndPositionMixin.relativeTransform](DimensionAndPositionMixin.md#relativetransform).

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`rotation`](DefaultShapeMixin.md#rotation)

---

### strokeAlign

> **strokeAlign**: `"CENTER"` \| `"INSIDE"` \| `"OUTSIDE"`

Defined in: figmaPluginTypes.ts:6619

The alignment of the stroke with respect to the boundaries of the shape.

#### Remarks

Center-aligned stroke means the center of the stroke falls exactly on the geometry. Inside-aligned stroke shifts the stroke so it lies completely inside the shape, and outside-aligned stroke is vice versa.

Note: Inside and outside stroke are actually implemented by doubling the stroke weight and masking the stroke by the fill. This means inside-aligned stroke will never draw strokes outside the fill and outside-aligned stroke will never draw strokes inside the fill.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`strokeAlign`](DefaultShapeMixin.md#strokealign)

---

### strokeCap

> **strokeCap**: _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`StrokeCap`](../type-aliases/StrokeCap.md)

Defined in: figmaPluginTypes.ts:6687

The decoration applied to vertices which have only one connected segment.

#### Remarks

On a vector network, the value is set on the whole vector network. Use the vector network API to set it on individual vertices.

This property can return [PluginAPI.mixed](PluginAPI.md#mixed) if different vertices have different values.properties.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`strokeCap`](DefaultShapeMixin.md#strokecap)

---

### strokeGeometry

> `readonly` **strokeGeometry**: [`VectorPaths`](../type-aliases/VectorPaths.md)

Defined in: figmaPluginTypes.ts:6628

An array of paths representing the object strokes relative to the node.
StrokeGeometry is always from the center regardless of the nodes `strokeAlign`.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`strokeGeometry`](DefaultShapeMixin.md#strokegeometry)

---

### strokeJoin

> **strokeJoin**: _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`StrokeJoin`](../type-aliases/StrokeJoin.md)

Defined in: figmaPluginTypes.ts:6609

The decoration applied to vertices which have two or more connected segments.

#### Remarks

On a vector network, the value is set on the whole vector network. Use the vector network API to set it on individual vertices.

This property can return [PluginAPI.mixed](PluginAPI.md#mixed) if different vertices have different values.properties.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`strokeJoin`](DefaultShapeMixin.md#strokejoin)

---

### strokeMiterLimit

> **strokeMiterLimit**: `number`

Defined in: figmaPluginTypes.ts:6691

The miter limit on the stroke. This is the same as the [SVG miter limit](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-miterlimit).

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`strokeMiterLimit`](DefaultShapeMixin.md#strokemiterlimit)

---

### strokes

> **strokes**: readonly [`Paint`](../type-aliases/Paint.md)[]

Defined in: figmaPluginTypes.ts:6576

The paints used to fill the area of the shape's strokes. For help on how to change this value, see [Editing Properties](https://www.figma.com/plugin-docs/editing-properties).

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`strokes`](DefaultShapeMixin.md#strokes)

---

### strokeStyleId

> **strokeStyleId**: `string`

Defined in: figmaPluginTypes.ts:6582

The id of the [PaintStyle](PaintStyle.md) object that the [MinimalStrokesMixin.strokes](MinimalStrokesMixin.md#strokes) property of this node is linked to.

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

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`strokeStyleId`](DefaultShapeMixin.md#strokestyleid)

---

### strokeWeight

> **strokeWeight**: `number` \| _typeof_ [`mixed`](PluginAPI.md#mixed)

Defined in: figmaPluginTypes.ts:6599

The thickness of the stroke, in pixels. This value must be non-negative and can be fractional.

Caution: For rectangle nodes or frame-like nodes using different individual stroke weights, this property will return [PluginAPI.mixed](PluginAPI.md#mixed).

Note: For rectangle nodes or frame-like nodes, individual stroke weights can be set for each side using the following properties:

- [IndividualStrokesMixin.strokeTopWeight](IndividualStrokesMixin.md#stroketopweight)
- [IndividualStrokesMixin.strokeBottomWeight](IndividualStrokesMixin.md#strokebottomweight)
- [IndividualStrokesMixin.strokeLeftWeight](IndividualStrokesMixin.md#strokeleftweight)
- [IndividualStrokesMixin.strokeRightWeight](IndividualStrokesMixin.md#strokerightweight)

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`strokeWeight`](DefaultShapeMixin.md#strokeweight)

---

### stuckNodes

> `readonly` **stuckNodes**: [`SceneNode`](../type-aliases/SceneNode.md)[]

Defined in: figmaPluginTypes.ts:5179

An array of nodes that are "stuck" to this node. In FigJam, stamps, highlights, and some widgets can "stick"
to other nodes if they are dragged on top of another node.

#### Remarks

This property is only available in FigJam.

In FigJam a stickable host that means that stickables, like `'STAMP'` nodes, are allowed to attach themselves to the node. If the stickable host moves all nodes that are in `stuckNodes` move along with it.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`stuckNodes`](DefaultShapeMixin.md#stucknodes)

---

### targetAspectRatio

> `readonly` **targetAspectRatio**: `null` \| [`Vector`](Vector.md)

Defined in: figmaPluginTypes.ts:5905

When toggled, causes the layer to keep its proportions when the user resizes it via auto layout, constraints, the properties panel, or on-canvas.
If not set, the node does NOT resize toward a specific targetAspectRatio.

#### Remarks

Use `lockAspectRatio` and `unlockAspectRatio` to set targetAspectRatio.

```ts
const parentFrame = figma.createFrame();
const image = await figma.createNodeFromJSXAsync(
  <figma.widget.Image
    src="https://picsum.photos/200/300"
    width={200}
    height={300}
  />
);
parentFrame.appendChild(image);

image.lockAspectRatio(); // set to 2:3 ratio, implicit from the size

// Add autolayout to parent, which defaults to Hug x Hug
parentFrame.layoutMode = "HORIZONTAL";

// Set child to fill-width
image.layoutGrow = 1;

// Resize parent to be much larger
parentFrame.resize(500, 1000);

// Since the child is fill-width, it will expand to the available space
image.width == 500;
image.height == 750;
// Image maintains the 2:3 ratio even as it grew with auto layout!
```

Caution: ⚠️ `targetAspectRatio` cannot be used with auto-resizing text (TextNodes where textAutoResize !== NONE).

#### Inherited from

[`AspectRatioLockMixin`](AspectRatioLockMixin.md).[`targetAspectRatio`](AspectRatioLockMixin.md#targetaspectratio)

---

### textAlignHorizontal

> **textAlignHorizontal**: `"CENTER"` \| `"LEFT"` \| `"RIGHT"` \| `"JUSTIFIED"`

Defined in: figmaPluginTypes.ts:8642

The horizontal alignment of the text with respect to the textbox. Setting this property requires the font the be loaded.

---

### textAlignVertical

> **textAlignVertical**: `"CENTER"` \| `"TOP"` \| `"BOTTOM"`

Defined in: figmaPluginTypes.ts:8646

The vertical alignment of the text with respect to the textbox. Setting this property requires the font the be loaded.

---

### textAutoResize

> **textAutoResize**: `"NONE"` \| `"HEIGHT"` \| `"WIDTH_AND_HEIGHT"` \| `"TRUNCATE"`

Defined in: figmaPluginTypes.ts:8656

The behavior of how the size of the text box adjusts to fit the characters. Setting this property requires the font the be loaded.

#### Remarks

- "NONE": The size of the textbox is fixed and is independent of its content.
- "HEIGHT": The width of the textbox is fixed. Characters wrap to fit in the textbox. The height of the textbox automatically adjusts to fit its content.
- "WIDTH_AND_HEIGHT": Both the width and height of the textbox automatically adjusts to fit its content. Characters do not wrap.
- [DEPRECATED] "TRUNCATE": Like "NONE", but text that overflows the bounds of the text node will be truncated with an ellipsis. This value will be removed in the future - prefer reading from [TextNode.textTruncation](#texttruncation) instead.

---

### textCase

> **textCase**: _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`TextCase`](../type-aliases/TextCase.md)

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`](NonResizableTextMixin.md).[`textCase`](NonResizableTextMixin.md#textcase)

---

### textDecoration

> **textDecoration**: _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`TextDecoration`](../type-aliases/TextDecoration.md)

Defined in: figmaPluginTypes.ts:7974

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

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`textDecoration`](NonResizableTextMixin.md#textdecoration)

---

### textDecorationColor

> **textDecorationColor**: `null` \| _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`TextDecorationColor`](../type-aliases/TextDecorationColor.md)

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`](NonResizableTextMixin.md).[`textDecorationColor`](NonResizableTextMixin.md#textdecorationcolor)

---

### textDecorationOffset

> **textDecorationOffset**: `null` \| _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`TextDecorationOffset`](../type-aliases/TextDecorationOffset.md)

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`](NonResizableTextMixin.md).[`textDecorationOffset`](NonResizableTextMixin.md#textdecorationoffset)

---

### textDecorationSkipInk

> **textDecorationSkipInk**: `null` \| `boolean` \| _typeof_ [`mixed`](PluginAPI.md#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`](NonResizableTextMixin.md).[`textDecorationSkipInk`](NonResizableTextMixin.md#textdecorationskipink)

---

### textDecorationStyle

> **textDecorationStyle**: `null` \| _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`TextDecorationStyle`](../type-aliases/TextDecorationStyle.md)

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`](NonResizableTextMixin.md).[`textDecorationStyle`](NonResizableTextMixin.md#textdecorationstyle)

---

### textDecorationThickness

> **textDecorationThickness**: `null` \| _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`TextDecorationThickness`](../type-aliases/TextDecorationThickness.md)

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`](NonResizableTextMixin.md).[`textDecorationThickness`](NonResizableTextMixin.md#textdecorationthickness)

---

### textStyleId

> **textStyleId**: `string` \| _typeof_ [`mixed`](PluginAPI.md#mixed)

Defined in: figmaPluginTypes.ts:8686

The id of the [TextStyle](TextStyle.md) object that the text properties of this node are linked to. Requires the font to be loaded.

If the manifest contains`"documentAccess": "dynamic-page"`, this property is read-only. Use [TextNode.setTextStyleIdAsync](#settextstyleidasync) to update the style.

---

### textTruncation

> **textTruncation**: `"DISABLED"` \| `"ENDING"`

Defined in: figmaPluginTypes.ts:8664

Whether this text node will truncate with an ellipsis when the text node size is smaller than the text inside.

#### Remarks

When [TextNode.textAutoResize](#textautoresize) is set to `"NONE"`, the text will truncate when the fixed size is smaller than the text inside. When it is `"HEIGHT"` or `"WIDTH_AND_HEIGHT"`, truncation will only occur if used in conjunction with [DimensionAndPositionMixin.maxHeight](DimensionAndPositionMixin.md#maxheight) or [TextNode.maxLines](#maxlines).

---

### type

> `readonly` **type**: `"TEXT"`

Defined in: figmaPluginTypes.ts:8634

The type of this node, represented by the string literal "TEXT"

---

### visible

> **visible**: `boolean`

Defined in: figmaPluginTypes.ts:5156

Whether the node is visible or not. Does not affect a plugin's ability to access the node.

#### Remarks

The value that this property returns is independent from the node's parent. i.e.

- The node isn't necessarily visible if this is `.visible === true`.
- The node isn't necessarily invisible if this is `.visible === false`.
- An object is visible if `.visible == true` for itself and **all** its parents.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`visible`](DefaultShapeMixin.md#visible)

---

### width

> `readonly` **width**: `number`

Defined in: figmaPluginTypes.ts:5638

The width of the node. Use a resizing method to change this value.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`width`](DefaultShapeMixin.md#width)

---

### x

> **x**: `number`

Defined in: figmaPluginTypes.ts:5626

The position of the node. Identical to `relativeTransform[0][2]`.

#### Remarks

This value is automatically computed in children of auto-layout frames. Setting this property for these auto-layout children will no-op.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`x`](DefaultShapeMixin.md#x)

---

### y

> **y**: `number`

Defined in: figmaPluginTypes.ts:5634

The position of the node. Identical to `relativeTransform[1][2]`.

#### Remarks

This value is automatically computed in children of auto-layout frames. Setting this property for these auto-layout children will no-op.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`y`](DefaultShapeMixin.md#y)

## Methods

### addDevResourceAsync()

> **addDevResourceAsync**(`url`, `name?`): `Promise`\<`void`\>

Defined in: figmaPluginTypes.ts:5100

Adds a dev resource to a node. This will fail if the node already has a dev resource with the same url.

#### Parameters

##### url

`string`

The url of the dev resource.

##### name?

`string`

The name of the dev resource. If not provided, Figma will get the name from the url.

#### Returns

`Promise`\<`void`\>

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`addDevResourceAsync`](DefaultShapeMixin.md#adddevresourceasync)

---

### clearExplicitVariableModeForCollection()

#### Call Signature

> **clearExplicitVariableModeForCollection**(`collectionId`): `void`

Defined in: figmaPluginTypes.ts:8258

Clears an explicit mode for the given collection on this node

##### Parameters

###### collectionId

`string`

##### Returns

`void`

##### Deprecated

Use `clearExplicitVariableModeForCollection(VariableCollection)` instead. This function will throw an exception if the plugin manifest contains `"documentAccess": "dynamic-page"`.

##### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`clearExplicitVariableModeForCollection`](DefaultShapeMixin.md#clearexplicitvariablemodeforcollection)

#### Call Signature

> **clearExplicitVariableModeForCollection**(`collection`): `void`

Defined in: figmaPluginTypes.ts:8264

Clears an explicit mode for the given collection on this node

##### Parameters

###### collection

[`VariableCollection`](VariableCollection.md)

A variable collection. Make sure to pass a collection object here; passing a variable collection ID is deprecated.

##### Returns

`void`

##### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`clearExplicitVariableModeForCollection`](DefaultShapeMixin.md#clearexplicitvariablemodeforcollection)

---

### clone()

> **clone**(): `TextNode`

Defined in: figmaPluginTypes.ts:8638

Duplicates the text node. By default, the duplicate will be parented under `figma.currentPage`.

#### Returns

`TextNode`

---

### 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](PluginAPI.md#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`](NonResizableTextMixin.md).[`deleteCharacters`](NonResizableTextMixin.md#deletecharacters)

---

### deleteDevResourceAsync()

> **deleteDevResourceAsync**(`url`): `Promise`\<`void`\>

Defined in: figmaPluginTypes.ts:5122

Deletes a dev resource on a node. This will fail if the node does not have a dev resource with the same url.

#### Parameters

##### url

`string`

The url of the dev resource.

#### Returns

`Promise`\<`void`\>

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`deleteDevResourceAsync`](DefaultShapeMixin.md#deletedevresourceasync)

---

### editDevResourceAsync()

> **editDevResourceAsync**(`currentUrl`, `newValue`): `Promise`\<`void`\>

Defined in: figmaPluginTypes.ts:5109

Edits a dev resource on a node. This will fail if the node does not have a dev resource with the same url.

#### Parameters

##### currentUrl

`string`

The current url of the dev resource.

##### newValue

The new name and/or url of the dev resource.

###### name?

`string`

###### url?

`string`

#### Returns

`Promise`\<`void`\>

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`editDevResourceAsync`](DefaultShapeMixin.md#editdevresourceasync)

---

### exportAsync()

#### Call Signature

> **exportAsync**(`settings?`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>

Defined in: figmaPluginTypes.ts:6811

Exports the node as an encoded image.

If the manifest contains `"documentAccess": "dynamic-page"`, **and** the node is a [PageNode](PageNode.md), you must first call [PageNode.loadAsync](PageNode.md#loadasync) to access this function.

##### Parameters

###### settings?

[`ExportSettings`](../type-aliases/ExportSettings.md)

When this parameter is absent, this function defaults to exporting as a PNG at 1x resolution.

Note that the result is a Uint8Array, representing the bytes of the image file (encoded in the specified format).

```ts title="Create a hexagon, export as PNG, and place on canvas"
(async () => {
  const polygon = figma.createPolygon();
  polygon.pointCount = 6;
  polygon.fills = [{ type: "SOLID", color: { r: 1, g: 0, b: 0 } }];

  // highlight-start
  // Export a 2x resolution PNG of the node
  const bytes = await polygon.exportAsync({
    format: "PNG",
    constraint: { type: "SCALE", value: 2 },
  });
  // highlight-end

  // Add the image onto the canvas as an image fill in a frame
  const image = figma.createImage(bytes);
  const frame = figma.createFrame();
  frame.x = 200;
  frame.resize(200, 230);
  frame.fills = [
    {
      imageHash: image.hash,
      scaleMode: "FILL",
      scalingFactor: 1,
      type: "IMAGE",
    },
  ];
})();
```

```ts title="Export a VectorNode as an SVG string"
(async () => {
  // Create a triangle using the VectorPath API
  const vector = figma.createVector();
  vector.vectorPaths = [
    {
      windingRule: "EVENODD",
      data: "M 0 100 L 100 100 L 50 0 Z",
    },
  ];

  // highlight-start
  // Export the vector to SVG
  const svg = await vector.exportAsync({ format: "SVG_STRING" });
  // highlight-end
  console.log(svg);
})();
```

```ts title="Export a node as a JSON object"
(async () => {
  const json = await figma.currentPage.selection[0].exportAsync({
    format: "JSON_REST_V1",
  });
  // Return a JSON object in the same format as the Figma REST API response
  console.log(json.document);
})();
```

##### Returns

`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>

##### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`exportAsync`](DefaultShapeMixin.md#exportasync)

#### Call Signature

> **exportAsync**(`settings`): `Promise`\<`string`\>

Defined in: figmaPluginTypes.ts:6812

##### Parameters

###### settings

[`ExportSettingsSVGString`](ExportSettingsSVGString.md)

##### Returns

`Promise`\<`string`\>

##### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`exportAsync`](DefaultShapeMixin.md#exportasync)

#### Call Signature

> **exportAsync**(`settings`): `Promise`\<`Object`\>

Defined in: figmaPluginTypes.ts:6813

##### Parameters

###### settings

[`ExportSettingsREST`](ExportSettingsREST.md)

##### Returns

`Promise`\<`Object`\>

##### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`exportAsync`](DefaultShapeMixin.md#exportasync)

---

### getCSSAsync()

> **getCSSAsync**(): `Promise`\<\{[`key`: `string`]: `string`; \}\>

Defined in: figmaPluginTypes.ts:5014

Resolves to a JSON object of CSS properties of the node. This is the same CSS that Figma shows in the inspect panel and is helpful if you are building a [plugin for code generation](https://www.figma.com/plugin-docs/codegen-plugins).

#### Returns

`Promise`\<\{[`key`: `string`]: `string`; \}\>

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`getCSSAsync`](DefaultShapeMixin.md#getcssasync)

---

### getDevResourcesAsync()

> **getDevResourcesAsync**(`options?`): `Promise`\<[`DevResourceWithNodeId`](DevResourceWithNodeId.md)[]\>

Defined in: figmaPluginTypes.ts:5091

Gets all of the dev resources on a node. This includes any inherited dev resources from components and component sets.

#### Parameters

##### options?

An optional parameter to include getting all of the dev resources on the children of the node. Defaults to false.

###### includeChildren?

`boolean`

#### Returns

`Promise`\<[`DevResourceWithNodeId`](DevResourceWithNodeId.md)[]\>

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`getDevResourcesAsync`](DefaultShapeMixin.md#getdevresourcesasync)

---

### getPluginData()

> **getPluginData**(`key`): `string`

Defined in: figmaPluginTypes.ts:5031

Retrieves custom information that was stored on this node or style using [PluginDataMixin.setPluginData](PluginDataMixin.md#setplugindata). If there is no data stored for the provided key, an empty string is returned.

#### Parameters

##### key

`string`

#### Returns

`string`

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`getPluginData`](DefaultShapeMixin.md#getplugindata)

---

### getPluginDataKeys()

> **getPluginDataKeys**(): `string`[]

Defined in: figmaPluginTypes.ts:5053

Retrieves a list of all keys stored on this node or style using using [PluginDataMixin.setPluginData](PluginDataMixin.md#setplugindata). This enables iterating through all data stored privately on a node or style by your plugin.

#### Returns

`string`[]

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`getPluginDataKeys`](DefaultShapeMixin.md#getplugindatakeys)

---

### getRangeAllFontNames()

> **getRangeAllFontNames**(`start`, `end`): [`FontName`](FontName.md)[]

Defined in: figmaPluginTypes.ts:7694

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

#### Parameters

##### start

`number`

##### end

`number`

#### Returns

[`FontName`](FontName.md)[]

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeAllFontNames`](NonResizableTextMixin.md#getrangeallfontnames)

---

### getRangeBoundVariable()

> **getRangeBoundVariable**(`start`, `end`, `field`): `null` \| _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`VariableAlias`](VariableAlias.md)

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`

##### field

[`VariableBindableTextField`](../type-aliases/VariableBindableTextField.md)

#### Returns

`null` \| _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`VariableAlias`](VariableAlias.md)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeBoundVariable`](NonResizableTextMixin.md#getrangeboundvariable)

---

### getRangeFills()

> **getRangeFills**(`start`, `end`): _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`Paint`](../type-aliases/Paint.md)[]

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`](PluginAPI.md#mixed) \| [`Paint`](../type-aliases/Paint.md)[]

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeFills`](NonResizableTextMixin.md#getrangefills)

---

### getRangeFillStyleId()

> **getRangeFillStyleId**(`start`, `end`): `string` \| _typeof_ [`mixed`](PluginAPI.md#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`](PluginAPI.md#mixed)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeFillStyleId`](NonResizableTextMixin.md#getrangefillstyleid)

---

### getRangeFontName()

> **getRangeFontName**(`start`, `end`): _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`FontName`](FontName.md)

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`](PluginAPI.md#mixed) \| [`FontName`](FontName.md)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeFontName`](NonResizableTextMixin.md#getrangefontname)

---

### getRangeFontSize()

> **getRangeFontSize**(`start`, `end`): `number` \| _typeof_ [`mixed`](PluginAPI.md#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`](PluginAPI.md#mixed)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeFontSize`](NonResizableTextMixin.md#getrangefontsize)

---

### getRangeFontWeight()

> **getRangeFontWeight**(`start`, `end`): `number` \| _typeof_ [`mixed`](PluginAPI.md#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`](PluginAPI.md#mixed)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeFontWeight`](NonResizableTextMixin.md#getrangefontweight)

---

### getRangeHyperlink()

> **getRangeHyperlink**(`start`, `end`): `null` \| _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`HyperlinkTarget`](../type-aliases/HyperlinkTarget.md)

Defined in: figmaPluginTypes.ts:7725

Get the `hyperlink` from characters in range `start` (inclusive) to `end` (exclusive). Returns a [HyperlinkTarget](../type-aliases/HyperlinkTarget.md) if the range contains exactly one hyperlink, or `null` if the range contains none.

#### Parameters

##### start

`number`

##### end

`number`

#### Returns

`null` \| _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`HyperlinkTarget`](../type-aliases/HyperlinkTarget.md)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeHyperlink`](NonResizableTextMixin.md#getrangehyperlink)

---

### getRangeIndentation()

> **getRangeIndentation**(`start`, `end`): `number` \| _typeof_ [`mixed`](PluginAPI.md#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`](PluginAPI.md#mixed)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeIndentation`](NonResizableTextMixin.md#getrangeindentation)

---

### getRangeLetterSpacing()

> **getRangeLetterSpacing**(`start`, `end`): _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`LetterSpacing`](LetterSpacing.md)

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`](PluginAPI.md#mixed) \| [`LetterSpacing`](LetterSpacing.md)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeLetterSpacing`](NonResizableTextMixin.md#getrangeletterspacing)

---

### getRangeLineHeight()

> **getRangeLineHeight**(`start`, `end`): _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`LineHeight`](../type-aliases/LineHeight.md)

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`](PluginAPI.md#mixed) \| [`LineHeight`](../type-aliases/LineHeight.md)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeLineHeight`](NonResizableTextMixin.md#getrangelineheight)

---

### getRangeListOptions()

> **getRangeListOptions**(`start`, `end`): _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`TextListOptions`](../type-aliases/TextListOptions.md)

Defined in: figmaPluginTypes.ts:8074

Get the `textListOptions` from characters in range `start` (inclusive) to `end` (exclusive). Returns a [TextListOptions](../type-aliases/TextListOptions.md)

#### Parameters

##### start

`number`

##### end

`number`

#### Returns

_typeof_ [`mixed`](PluginAPI.md#mixed) \| [`TextListOptions`](../type-aliases/TextListOptions.md)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeListOptions`](NonResizableTextMixin.md#getrangelistoptions)

---

### getRangeListSpacing()

> **getRangeListSpacing**(`start`, `end`): `number` \| _typeof_ [`mixed`](PluginAPI.md#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`](PluginAPI.md#mixed)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeListSpacing`](NonResizableTextMixin.md#getrangelistspacing)

---

### getRangeOpenTypeFeatures()

> **getRangeOpenTypeFeatures**(`start`, `end`): _typeof_ [`mixed`](PluginAPI.md#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](BaseNonResizableTextMixin.md#opentypefeatures) from characters in range `start` (inclusive) to `end` (exclusive).

#### Parameters

##### start

`number`

##### end

`number`

#### Returns

_typeof_ [`mixed`](PluginAPI.md#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`](NonResizableTextMixin.md).[`getRangeOpenTypeFeatures`](NonResizableTextMixin.md#getrangeopentypefeatures)

---

### getRangeParagraphIndent()

> **getRangeParagraphIndent**(`start`, `end`): `number` \| _typeof_ [`mixed`](PluginAPI.md#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`](PluginAPI.md#mixed)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeParagraphIndent`](NonResizableTextMixin.md#getrangeparagraphindent)

---

### getRangeParagraphSpacing()

> **getRangeParagraphSpacing**(`start`, `end`): `number` \| _typeof_ [`mixed`](PluginAPI.md#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`](PluginAPI.md#mixed)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeParagraphSpacing`](NonResizableTextMixin.md#getrangeparagraphspacing)

---

### getRangeTextCase()

> **getRangeTextCase**(`start`, `end`): _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`TextCase`](../type-aliases/TextCase.md)

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`](PluginAPI.md#mixed) \| [`TextCase`](../type-aliases/TextCase.md)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeTextCase`](NonResizableTextMixin.md#getrangetextcase)

---

### getRangeTextDecoration()

> **getRangeTextDecoration**(`start`, `end`): _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`TextDecoration`](../type-aliases/TextDecoration.md)

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`](PluginAPI.md#mixed) \| [`TextDecoration`](../type-aliases/TextDecoration.md)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeTextDecoration`](NonResizableTextMixin.md#getrangetextdecoration)

---

### getRangeTextDecorationColor()

> **getRangeTextDecorationColor**(`start`, `end`): `null` \| _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`TextDecorationColor`](../type-aliases/TextDecorationColor.md)

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`](PluginAPI.md#mixed) \| [`TextDecorationColor`](../type-aliases/TextDecorationColor.md)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeTextDecorationColor`](NonResizableTextMixin.md#getrangetextdecorationcolor)

---

### getRangeTextDecorationOffset()

> **getRangeTextDecorationOffset**(`start`, `end`): `null` \| _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`TextDecorationOffset`](../type-aliases/TextDecorationOffset.md)

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`](PluginAPI.md#mixed) \| [`TextDecorationOffset`](../type-aliases/TextDecorationOffset.md)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeTextDecorationOffset`](NonResizableTextMixin.md#getrangetextdecorationoffset)

---

### getRangeTextDecorationSkipInk()

> **getRangeTextDecorationSkipInk**(`start`, `end`): `null` \| `boolean` \| _typeof_ [`mixed`](PluginAPI.md#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`](PluginAPI.md#mixed)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeTextDecorationSkipInk`](NonResizableTextMixin.md#getrangetextdecorationskipink)

---

### getRangeTextDecorationStyle()

> **getRangeTextDecorationStyle**(`start`, `end`): `null` \| _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`TextDecorationStyle`](../type-aliases/TextDecorationStyle.md)

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`](PluginAPI.md#mixed) \| [`TextDecorationStyle`](../type-aliases/TextDecorationStyle.md)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeTextDecorationStyle`](NonResizableTextMixin.md#getrangetextdecorationstyle)

---

### getRangeTextDecorationThickness()

> **getRangeTextDecorationThickness**(`start`, `end`): `null` \| _typeof_ [`mixed`](PluginAPI.md#mixed) \| [`TextDecorationThickness`](../type-aliases/TextDecorationThickness.md)

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`](PluginAPI.md#mixed) \| [`TextDecorationThickness`](../type-aliases/TextDecorationThickness.md)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeTextDecorationThickness`](NonResizableTextMixin.md#getrangetextdecorationthickness)

---

### getRangeTextStyleId()

> **getRangeTextStyleId**(`start`, `end`): `string` \| _typeof_ [`mixed`](PluginAPI.md#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`](PluginAPI.md#mixed)

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getRangeTextStyleId`](NonResizableTextMixin.md#getrangetextstyleid)

---

### getRelaunchData()

> **getRelaunchData**(): `object`

Defined in: figmaPluginTypes.ts:5000

Retreives the reluanch data stored on this node using [BaseNodeMixin.setRelaunchData](BaseNodeMixin.md#setrelaunchdata)

#### Returns

`object`

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`getRelaunchData`](DefaultShapeMixin.md#getrelaunchdata)

---

### getSharedPluginData()

> **getSharedPluginData**(`namespace`, `key`): `string`

Defined in: figmaPluginTypes.ts:5057

Retrieves custom information that was stored on this node or style using [PluginDataMixin.setSharedPluginData](PluginDataMixin.md#setsharedplugindata). If there is no data stored for the provided namespace and key, an empty string is returned.

#### Parameters

##### namespace

`string`

##### key

`string`

#### Returns

`string`

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`getSharedPluginData`](DefaultShapeMixin.md#getsharedplugindata)

---

### getSharedPluginDataKeys()

> **getSharedPluginDataKeys**(`namespace`): `string`[]

Defined in: figmaPluginTypes.ts:5079

Retrieves a list of all keys stored on this node or style using [PluginDataMixin.setSharedPluginData](PluginDataMixin.md#setsharedplugindata). This enables iterating through all data stored in a given namespace.

#### Parameters

##### namespace

`string`

#### Returns

`string`[]

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`getSharedPluginDataKeys`](DefaultShapeMixin.md#getsharedplugindatakeys)

---

### getStyledTextSegments()

> **getStyledTextSegments**\<`StyledTextSegmentFields`\>(`fields`, `start?`, `end?`): `Pick`\<[`StyledTextSegment`](StyledTextSegment.md), `"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

`StyledTextSegmentFields` _extends_ (`"openTypeFeatures"` \| `"fontName"` \| `"fontSize"` \| `"lineHeight"` \| `"paragraphIndent"` \| `"paragraphSpacing"` \| `"listSpacing"` \| `"letterSpacing"` \| `"textCase"` \| `"textDecoration"` \| `"fills"` \| `"fillStyleId"` \| `"textStyleId"` \| `"hyperlink"` \| `"fontWeight"` \| `"textDecorationStyle"` \| `"textDecorationOffset"` \| `"textDecorationThickness"` \| `"textDecorationColor"` \| `"textDecorationSkipInk"` \| `"listOptions"` \| `"indentation"` \| `"boundVariables"` \| `"textStyleOverrides"`)[]

#### 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`](StyledTextSegment.md), `"characters"` \| `"start"` \| `"end"` \| `StyledTextSegmentFields`\[`number`\]\>[]

#### Remarks

This function provides an easy and performant way to get multiple text properties which may have [mixed values](https://www.figma.com/plugin-docs/working-with-text#mixed-styles), along with which characters these values apply to.
It will return an array of [StyledTextSegment](StyledTextSegment.md)s 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":

```js
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

```js
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 "😁 😭 😅😂😳😎":

```js
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](BaseNonResizableTextMixin.md#insertcharacters) for more information on surrogate pairs.

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`getStyledTextSegments`](NonResizableTextMixin.md#getstyledtextsegments)

---

### getTopLevelFrame()

> **getTopLevelFrame**(): `undefined` \| [`FrameNode`](FrameNode.md)

Defined in: figmaPluginTypes.ts:5022

Returns the top-most frame that contains this node. If the node is not inside a frame, this will return undefined.

Note: This function will only work in Figma Design and will throw an error if called in FigJam or Slides.

#### Returns

`undefined` \| [`FrameNode`](FrameNode.md)

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`getTopLevelFrame`](DefaultShapeMixin.md#gettoplevelframe)

---

### 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](PluginAPI.md#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.

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`](NonResizableTextMixin.md).[`insertCharacters`](NonResizableTextMixin.md#insertcharacters)

---

### lockAspectRatio()

> **lockAspectRatio**(): `void`

Defined in: figmaPluginTypes.ts:5909

Locks the node's `targetAspectRatio` to the current ratio of its width and height.

#### Returns

`void`

#### Inherited from

[`AspectRatioLockMixin`](AspectRatioLockMixin.md).[`lockAspectRatio`](AspectRatioLockMixin.md#lockaspectratio)

---

### outlineStroke()

> **outlineStroke**(): `null` \| [`VectorNode`](VectorNode.md)

Defined in: figmaPluginTypes.ts:6695

This method performs an action similar to using the "Outline Stroke" function in the editor from the right-click menu. However, this method creates and returns a new node while leaving the original intact. Returns `null` if the node has no strokes.

#### Returns

`null` \| [`VectorNode`](VectorNode.md)

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`outlineStroke`](DefaultShapeMixin.md#outlinestroke)

---

### remove()

> **remove**(): `void`

Defined in: figmaPluginTypes.ts:4933

Removes this node and **all of its children** from the document.

#### Returns

`void`

#### Remarks

If you want to only remove this node but not its children, you will have to first move them to another node before calling `remove()`.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`remove`](DefaultShapeMixin.md#remove)

---

### rescale()

> **rescale**(`scale`): `void`

Defined in: figmaPluginTypes.ts:5861

Rescales the node. This API function is the equivalent of using the Scale Tool from the toolbar.

#### Parameters

##### scale

`number`

The scale by which to resize the node from the top-left corner.

#### Returns

`void`

#### Remarks

The scale factor must be >= 0.01

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`rescale`](DefaultShapeMixin.md#rescale)

---

### resize()

> **resize**(`width`, `height`): `void`

Defined in: figmaPluginTypes.ts:5836

Resizes the node. If the node contains children with constraints, it applies those constraints during resizing. If the parent has auto-layout, causes the parent to be resized.

#### Parameters

##### width

`number`

New width of the node. Must be >= 0.01

##### height

`number`

New height of the node. Must be >= 0.01, except for [LineNode](LineNode.md) which must always be given a height of exactly 0.

#### Returns

`void`

#### Remarks

Since this function applies constraints recursively (when there are multiple levels of nested frames with constraints), calls to this function could be expensive. Use [LayoutMixin.resizeWithoutConstraints](LayoutMixin.md#resizewithoutconstraints) if you don't need to apply constraints.

Caution: ⚠️ If this node is a text node with a missing font or contains a text node with a missing font, the text node will be resized but the text will not re-layout until the next time the text node is opened on a machine that _has_ the font. This can cause the text node to re-layout immediately and be surprising to your user. Consider checking if the document [PluginAPI.hasMissingFont](PluginAPI.md#hasmissingfont) before using this function.

Ignores `targetAspectRatio`. If `targetAspectRatio` has been set, it will be updated to correspond to the post-resize value.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`resize`](DefaultShapeMixin.md#resize)

---

### resizeWithoutConstraints()

> **resizeWithoutConstraints**(`width`, `height`): `void`

Defined in: figmaPluginTypes.ts:5851

Resizes the node. Children of the node are never resized, even if those children have constraints. If the parent has auto-layout, causes the parent to be resized (this constraint cannot be ignored).

#### Parameters

##### width

`number`

New width of the node. Must be >= 0.01

##### height

`number`

New height of the node. Must be >= 0.01, except for [LineNode](LineNode.md) which must always be given a height of exactly 0.

#### Returns

`void`

#### Remarks

This function will not cause its children to resize. Use [LayoutMixin.resize](LayoutMixin.md#resize) if you need to apply constraints.

Caution: ⚠️ If this node is a text node with a missing font, the text node will be resized but the text will not re-layout until the next time the text node is opened on a machine that _has_ the font. This can cause the text node to re-layout immediately and be surprising to your user. Consider checking the text node property [`hasMissingFont`](https://www.figma.com/plugin-docs/api/TextNode#hasmissingfont) before using this function.

Ignores `targetAspectRatio`. If `targetAspectRatio` has been set, it will be updated to correspond to the post-resize value.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`resizeWithoutConstraints`](DefaultShapeMixin.md#resizewithoutconstraints)

---

### setBoundVariable()

#### Call Signature

> **setBoundVariable**(`field`, `variableId`): `void`

Defined in: figmaPluginTypes.ts:5214

Binds the provided `field` on this node to the given variable. Please see the [Working with Variables](https://www.figma.com/plugin-docs/working-with-variables) guide for how to get and set variable bindings.

##### Parameters

###### field

[`VariableBindableTextField`](../type-aliases/VariableBindableTextField.md) | [`VariableBindableNodeField`](../type-aliases/VariableBindableNodeField.md)

###### variableId

`null` | `string`

##### Returns

`void`

##### Deprecated

Use `setBoundVariable(VariableBindableNodeField, Variable)` instead. This function will throw an exception if the plugin manifest contains `"documentAccess": "dynamic-page"`.

##### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`setBoundVariable`](DefaultShapeMixin.md#setboundvariable)

#### Call Signature

> **setBoundVariable**(`field`, `variable`): `void`

Defined in: figmaPluginTypes.ts:5226

Binds the provided `field` on this node to the given variable. Please see the [Working with Variables](https://www.figma.com/plugin-docs/working-with-variables) guide for how to get and set variable bindings.

If `null` is provided as the variable, the given `field` will be unbound from any variables.

##### Parameters

###### field

The field to bind the variable to.

[`VariableBindableTextField`](../type-aliases/VariableBindableTextField.md) | [`VariableBindableNodeField`](../type-aliases/VariableBindableNodeField.md)

###### variable

The variable to bind to the field. If `null` is provided, the field will be unbound from any variables. Make sure to pass a Variable object or null; passing a variable ID is deprecated.

`null` | [`Variable`](Variable.md)

##### Returns

`void`

##### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`setBoundVariable`](DefaultShapeMixin.md#setboundvariable)

---

### setDevResourcePreviewAsync()

> **setDevResourcePreviewAsync**(`url`, `preview`): `Promise`\<`void`\>

Defined in: figmaPluginTypes.ts:5127

Caution: This is a private API only available to [Figma partners](https://www.figma.com/partners/)

#### Parameters

##### url

`string`

##### preview

[`PlainTextElement`](../type-aliases/PlainTextElement.md)

#### Returns

`Promise`\<`void`\>

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`setDevResourcePreviewAsync`](DefaultShapeMixin.md#setdevresourcepreviewasync)

---

### setEffectStyleIdAsync()

> **setEffectStyleIdAsync**(`styleId`): `Promise`\<`void`\>

Defined in: figmaPluginTypes.ts:5977

Set the [EffectStyle](EffectStyle.md) that the properties of this node are linked to.

#### Parameters

##### styleId

`string`

#### Returns

`Promise`\<`void`\>

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`setEffectStyleIdAsync`](DefaultShapeMixin.md#seteffectstyleidasync)

---

### setExplicitVariableModeForCollection()

#### Call Signature

> **setExplicitVariableModeForCollection**(`collectionId`, `modeId`): `void`

Defined in: figmaPluginTypes.ts:8270

Sets an explicit mode for the given collection on this node

##### Parameters

###### collectionId

`string`

###### modeId

`string`

##### Returns

`void`

##### Deprecated

Use `setExplicitVariableModeForCollection(VariableCollection, Variable)` instead. This function will throw an exception if the plugin manifest contains `"documentAccess": "dynamic-page"`.

##### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`setExplicitVariableModeForCollection`](DefaultShapeMixin.md#setexplicitvariablemodeforcollection)

#### Call Signature

> **setExplicitVariableModeForCollection**(`collection`, `modeId`): `void`

Defined in: figmaPluginTypes.ts:8277

Sets an explicit mode for the given collection on this node

##### Parameters

###### collection

[`VariableCollection`](VariableCollection.md)

A variable collection. Make sure to pass a collection object here; passing a variable collection ID is deprecated.

###### modeId

`string`

A variable mode ID.

##### Returns

`void`

##### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`setExplicitVariableModeForCollection`](DefaultShapeMixin.md#setexplicitvariablemodeforcollection)

---

### setFillStyleIdAsync()

> **setFillStyleIdAsync**(`styleId`): `Promise`\<`void`\>

Defined in: figmaPluginTypes.ts:6672

Sets the [PaintStyle](PaintStyle.md) that the [MinimalFillsMixin.fills](MinimalFillsMixin.md#fills) property of this node is linked to.

#### Parameters

##### styleId

`string`

#### Returns

`Promise`\<`void`\>

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`setFillStyleIdAsync`](DefaultShapeMixin.md#setfillstyleidasync)

---

### setPluginData()

> **setPluginData**(`key`, `value`): `void`

Defined in: figmaPluginTypes.ts:5049

Lets you store custom information on any node or style, **private** to your plugin. The total size of your entry (`pluginId`, `key`, `value`) cannot exceed 100 kB.

#### Parameters

##### key

`string`

The key under which to store the data. This is similar to writing to a plain object via `obj[key] = value`.

##### value

`string`

The data you want to store. If you want to store a value type other than a string, encode it as a JSON string first via `JSON.stringify` and `JSON.parse`. If you set the value to the empty string (""), the key/value pair is removed.

#### Returns

`void`

#### Remarks

The data is specific to your plugin ID. Plugins with other IDs won't be able to read this data. You can retrieve it later by calling `getPluginData` with the same key. To find all data stored on a node or style by your plugin use `getPluginDataKeys`.

Caution: ⚠ The data is stored privately for **stability**, not **security**. It prevents other plugins from accessing with your data. It does not, however, prevent users from seeing the data given sufficient effort. For example, they could export the document as a .fig file and try to decode it.

Caution: ⚠ Data will become inaccessible if your plugin ID changes.

Caution: ⚠ Total entry size cannot exceed 100 kB.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`setPluginData`](DefaultShapeMixin.md#setplugindata)

---

### 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`](../type-aliases/VariableBindableTextField.md)

##### variable

`null` | [`Variable`](Variable.md)

#### Returns

`void`

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`setRangeBoundVariable`](NonResizableTextMixin.md#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](VariablesAPI.md#setboundvariableforpaint) on one or more of the provided `Paint`s

#### Parameters

##### start

`number`

##### end

`number`

##### value

[`Paint`](../type-aliases/Paint.md)[]

#### Returns

`void`

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`setRangeFills`](NonResizableTextMixin.md#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`](NonResizableTextMixin.md).[`setRangeFillStyleId`](NonResizableTextMixin.md#setrangefillstyleid)

---

### setRangeFillStyleIdAsync()

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

Defined in: figmaPluginTypes.ts:7761

Set the provided [PaintStyle](PaintStyle.md) 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`](NonResizableTextMixin.md).[`setRangeFillStyleIdAsync`](NonResizableTextMixin.md#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`](FontName.md)

#### Returns

`void`

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`setRangeFontName`](NonResizableTextMixin.md#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`](NonResizableTextMixin.md).[`setRangeFontSize`](NonResizableTextMixin.md#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`](../type-aliases/HyperlinkTarget.md)

#### Returns

`void`

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`setRangeHyperlink`](NonResizableTextMixin.md#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`](NonResizableTextMixin.md).[`setRangeIndentation`](NonResizableTextMixin.md#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`](LetterSpacing.md)

#### Returns

`void`

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`setRangeLetterSpacing`](NonResizableTextMixin.md#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`](../type-aliases/LineHeight.md)

#### Returns

`void`

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`setRangeLineHeight`](NonResizableTextMixin.md#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`](../type-aliases/TextListOptions.md)

#### Returns

`void`

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`setRangeListOptions`](NonResizableTextMixin.md#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`](NonResizableTextMixin.md).[`setRangeListSpacing`](NonResizableTextMixin.md#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`](NonResizableTextMixin.md).[`setRangeParagraphIndent`](NonResizableTextMixin.md#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`](NonResizableTextMixin.md).[`setRangeParagraphSpacing`](NonResizableTextMixin.md#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`](../type-aliases/TextCase.md)

#### Returns

`void`

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`setRangeTextCase`](NonResizableTextMixin.md#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`](../type-aliases/TextDecoration.md)

#### Returns

`void`

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`setRangeTextDecoration`](NonResizableTextMixin.md#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`](../type-aliases/TextDecorationColor.md)

#### Returns

`void`

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`setRangeTextDecorationColor`](NonResizableTextMixin.md#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`](../type-aliases/TextDecorationOffset.md)

#### Returns

`void`

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`setRangeTextDecorationOffset`](NonResizableTextMixin.md#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`](NonResizableTextMixin.md).[`setRangeTextDecorationSkipInk`](NonResizableTextMixin.md#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`](../type-aliases/TextDecorationStyle.md)

#### Returns

`void`

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`setRangeTextDecorationStyle`](NonResizableTextMixin.md#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`](../type-aliases/TextDecorationThickness.md)

#### Returns

`void`

#### Inherited from

[`NonResizableTextMixin`](NonResizableTextMixin.md).[`setRangeTextDecorationThickness`](NonResizableTextMixin.md#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`](NonResizableTextMixin.md).[`setRangeTextStyleId`](NonResizableTextMixin.md#setrangetextstyleid)

---

### setRangeTextStyleIdAsync()

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

Defined in: figmaPluginTypes.ts:7747

Set the provided [TextStyle](TextStyle.md) 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`](NonResizableTextMixin.md).[`setRangeTextStyleIdAsync`](NonResizableTextMixin.md#setrangetextstyleidasync)

---

### setReactionsAsync()

> **setReactionsAsync**(`reactions`): `Promise`\<`void`\>

Defined in: figmaPluginTypes.ts:7031

Updates the reactions on this node. See [ReactionMixin.reactions](ReactionMixin.md#reactions) for a usage example.

#### Parameters

##### reactions

[`Reaction`](../type-aliases/Reaction.md)[]

#### Returns

`Promise`\<`void`\>

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`setReactionsAsync`](DefaultShapeMixin.md#setreactionsasync)

---

### setRelaunchData()

> **setRelaunchData**(`data`): `void`

Defined in: figmaPluginTypes.ts:4996

Sets state on the node to show a button and description when the node is selected. Clears the button and description when `relaunchData` is `{}`.

Note: In Figma and Dev Mode, this shows up in the properties panel. In FigJam, this shows up in the property menu. See [here](https://www.figma.com/plugin-docs/api/properties/nodes-setrelaunchdata#example-figma-design-ui) for examples.

#### Parameters

##### data

```ts
{
  [command: string]: string // description
}
```

e.g. `data = { myCommand: 'Short description' }`

#### Returns

`void`

#### Remarks

Each call to this method sets entirely new relaunch data, removing any relaunch data and associated buttons/descriptions from before. To maintain buttons from a previous call one can store the button information using [setPluginData](https://www.figma.com/plugin-docs/api/properties/nodes-setplugindata/) and later fetch it with [getPluginData](https://www.figma.com/plugin-docs/api/PageNode/#getplugindata) before passing it on to `setRelaunchData`.

To use this API, the plugin manifest must include a `relaunchButtons` section: see the [manifest guide](https://www.figma.com/plugin-docs/manifest#relaunchbuttons) for more information.

Note: Note that if the `command` passed to this method does not match a command in the manifest, nothing will be displayed. Similarly if the name of a command in the manifest changes or is removed, then all buttons with that command will disappear. This behavior can be used to remove buttons when a particular action is no longer supported by the plugin.

In Figma design, the relaunch data can also be placed on the [PageNode](PageNode.md) or [DocumentNode](DocumentNode.md), to show a button and description when nothing is selected. Relaunch buttons added to the [PageNode](PageNode.md) will be displayed on that page, combined with buttons from the [DocumentNode](DocumentNode.md) that show on every page. This is not supported in FigJam.

## Examples

```ts title="manifest.json"
// With the following in the manifest:
"relaunchButtons": [
  {"command": "edit", "name": "Edit shape"},
  {"command": "open", "name": "Open Shaper", "multipleSelection": true}
]
```

```ts title="code.ts"
// Add two buttons (ordered by the above array from the manifest):
// * an "Edit shape" button with a description of "Edit this trapezoid
//   with Shaper" that runs the plugin with `figma.command === 'edit'`.
// * an "Open Shaper" button with no description that runs the plugin with
//   `figma.command === 'open'`.
node.setRelaunchData({ edit: 'Edit this trapezoid with Shaper', open: '' })

// With the following in the manifest:
"relaunchButtons": [
  {"command": "relaunch", "name": "Run again", "multipleSelection": true}
]

// Pass an empty description to show only a button
node.setRelaunchData({ relaunch: '' })

// Remove the button and description
node.setRelaunchData({})
```

### Example Figma Design UI

![Relaunch UI in Figma Design](https://www.figma.com/plugin-docs/img/relaunch_ui_design.png)

### Example FigJam UI

![Relaunch UI in FigJam](https://www.figma.com/plugin-docs/img/relaunch_ui_figjam.png)

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`setRelaunchData`](DefaultShapeMixin.md#setrelaunchdata)

---

### setSharedPluginData()

> **setSharedPluginData**(`namespace`, `key`, `value`): `void`

Defined in: figmaPluginTypes.ts:5075

Lets you store custom information on any node or style, **public** to all plugins. The total size of your entry (`namespace`, `key`, `value`) cannot exceed 100 kB.

#### Parameters

##### namespace

`string`

A unique string to identify your plugin and avoid key collisions with other plugins. The namespace must be at least 3 alphanumeric characters.

##### key

`string`

The key under which to store the data. This is similar to writing to a plain object via `obj[key] = value`.

##### value

`string`

The data you want to store. If you want to store a value type other than a string, encode it as a JSON string first via `JSON.stringify` and `JSON.parse`. If you set the value to the empty string (""), the key/value pair is removed.

#### Returns

`void`

#### Remarks

This lets you store custom information on any node or style. You can retrieve it later by calling [PluginDataMixin.getSharedPluginData](PluginDataMixin.md#getsharedplugindata) with the same namespace and key. To find all data stored on a node or style in a particular namespace, use [PluginDataMixin.getSharedPluginDataKeys](PluginDataMixin.md#getsharedplugindatakeys).

Any data you write using this API will be readable by any plugin. The intent is to allow plugins to interoperate with each other. Use [PluginDataMixin.setPluginData](PluginDataMixin.md#setplugindata) instead if you don't want other plugins to be able to read your data.

You must also provide a `namespace` argument to avoid key collisions with other plugins. This argument is mandatory to prevent multiple plugins from using generic key names like `data` and overwriting one another. We recommend passing a value that identifies your plugin. This namespace can be given to authors of other plugins so that they can read data from your plugin.

Caution: ⚠ Total entry size cannot exceed 100 kB.

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`setSharedPluginData`](DefaultShapeMixin.md#setsharedplugindata)

---

### setStrokeStyleIdAsync()

> **setStrokeStyleIdAsync**(`styleId`): `Promise`\<`void`\>

Defined in: figmaPluginTypes.ts:6586

Set the [PaintStyle](PaintStyle.md) that the [MinimalStrokesMixin.strokes](MinimalStrokesMixin.md#strokes) property of this node is linked to.

#### Parameters

##### styleId

`string`

#### Returns

`Promise`\<`void`\>

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`setStrokeStyleIdAsync`](DefaultShapeMixin.md#setstrokestyleidasync)

---

### setTextStyleIdAsync()

> **setTextStyleIdAsync**(`styleId`): `Promise`\<`void`\>

Defined in: figmaPluginTypes.ts:8690

Set the [TextStyle](TextStyle.md) that the text properties of this node are linked to. Requires the font to be loaded.

#### Parameters

##### styleId

`string`

#### Returns

`Promise`\<`void`\>

---

### toString()

> **toString**(): `string`

Defined in: figmaPluginTypes.ts:4925

Returns a string representation of the node. For debugging purposes only, do not rely on the exact output of this string in production code.

#### Returns

`string`

#### Remarks

This currently returns a string of the form `[Node ID]` where `ID` is the id of the node. This is just for debugging convenience so the node displays something useful when converted to a string. We recommend not relying on this in production.

Example:

```ts
// e.g. [Node 0:5]
console.log(`Current selected node ${figma.currentPage.selection[0]}`);
```

#### Inherited from

[`DefaultShapeMixin`](DefaultShapeMixin.md).[`toString`](DefaultShapeMixin.md#tostring)

---

### unlockAspectRatio()

> **unlockAspectRatio**(): `void`

Defined in: figmaPluginTypes.ts:5913

Unlocks the node's `targetAspectRatio`.

#### Returns

`void`

#### Inherited from

[`AspectRatioLockMixin`](AspectRatioLockMixin.md).[`unlockAspectRatio`](AspectRatioLockMixin.md#unlockaspectratio)