TextNode

TextNode 表示文本，其中整个节点或单个字符范围都可以具有颜色（填充）、字体大小、字体名称等属性。

使用文本节点时，需要考虑很多事情，包括混合样式、加载字体和缺少字体。

Text node properties

`type`

Readonly: true
Type: TEXT

此节点的类型，由字符串 TEXT 表示

`clone`

Type: clone(): TextNode

复制文本节点。

`hasMissingFont`

Readonly: true
Type: boolean

返回文本是否使用文档当前不可用的字体。

`textAlignHorizontal`

Type: "LEFT" | "CENTER" | "RIGHT" | "JUSTIFIED"

文本相对于文本框的水平对齐方式。设置此属性需要加载字体。

`textAlignVertical`

Type: "TOP" | "CENTER" | "BOTTOM"

文本相对于文本框的垂直对齐方式。设置此属性需要加载字体。

`textAutoResize`

Type: "NONE" | "WIDTH_AND_HEIGHT" | "HEIGHT" | "TRUNCATE"

文本框大小如何调整以适应字符的行为。设置此属性需要加载字体。

`paragraphSpacing`

Type: number

段落之间的垂直距离。设置此属性需要加载字体。

`autoRename`

Type: boolean

更新文本节点中的字符是否应该更新节点的名称。

Text content

`characters`

Type: string

文本节点的原始字符。设置该属性需要确保字体加载完成。

`insertCharacters`

Type: insertCharacters(start: number,characters: string,useStyle?: "BEFORE" | "AFTER"): void

在原文本的 start 位置处插入字符，文本中第一个字符的索引为 0。插入字符的样式将与该位置的前一个字符的样式保持一致。如果在第 0 个位置插入字符，由于该位置的前面没有其他字符，所以插入字符的样式将于该位置的后一个字符的样式一致。设置该属性需要确保字体加载完成。

`deleteCharacters`

Type: deleteCharacters(start: number, end: number): void

删除文本中出于位置 [start, end) 处的字符，文本中第一个字符的索引为 0。设置该属性需要确保字体加载完成。

Text range properties

`fontSize`

Type: number | pixso.mixed

字体的大小。最小值为 1。

`fontName`

Type: FontName | pixso.mixed
Type Declaration: FontName

字体系列（例如“Inter”）和字体样式（例如“Regular”）。将此属性设置为不同的值需要加载新字体。

`textCase`

Type: TextCase | pixso.mixed
Type Declaration: TextCase

覆盖文本节点中原始字符的大小写。需要加载字体。

`textDecoration`

Type: TextDecoration | pixso.mixed
Type Declaration: TextDecoration

设置文本带下划线或带删除线。需要加载字体。

`letterSpacing`

Type: LetterSpacing | pixso.mixed
Type Declaration: LetterSpacing

单个字符之间的间距。需要加载字体。

`lineHeight`

Type: LineHeight | pixso.mixed
Type Declaration: LineHeight

一段文本中的行间距。需要加载字体。

`textStyleId`

Type: sring | pixso.mixed

此节点的文本属性链接到的 TextStyle 对象的 id。需要加载字体。赋值为空即解绑样式。

`hyperlink`

Type: HyperlinkTarget | null | pixso.mixed
Type Declaration: HyperlinkTarget

如果文本节点只有一个超链接，则为 HyperlinkTarget，如果节点没有超链接，则为 null。

Text range functions

`getRangeFontSize`

Type: getRangeFontSize(start: number, end: number): number | pixso.mixed

获取范围开始（包括）到结束（不包括）范围内的字体大小。

`setRangeFontSize`

Type: setRangeFontSize(start: number, end: number, value: number): void

对范围开始（包括）到结束（不包括）中的字符设置字体大小。需要先加载字体。

`getRangeFontName`

Type: getRangeFontName(start: number,end: number): FontName | pixso.mixed

获取范围开始（包括）到结束（不包括）范围内的字体名称。

`setRangeFontName`

Type: setRangeFontName(start: number, end: number, value: FontName): void

对范围开始（包括）到结束（不包括）中的字符设置字体名称。需要先加载字体。

`getRangeAllFontNames`

Type: getRangeAllFontNames(start: number, end: number): FontName[]

获取范围开始（包括）到结束（不包括）范围内用到的所有字体名称。

`getRangeTextCase`

Type: getRangeTextCase(start: number,end: number): TextCase | pixso.mixed
Type Declaration: TextCase

获取范围开始（包括）到结束（不包括）范围内的字体大小写。

`setRangeTextCase`

Type: setRangeTextCase(start: number, end: number, value: TextCase): void

对范围开始（包括）到结束（不包括）中的字符设置字体大小写。需要先加载字体。

`getRangeTextDecoration`

Type: getRangeTextDecoration(start: number,end: number): TextDecoration | pixso.mixed
Type Declaration: TextDecoration

获取范围开始（包括）到结束（不包括）范围内的字体修饰。

`setRangeTextDecoration`

Type: setRangeTextDecoration(start: number,end: number,value: TextDecoration): void

对范围开始（包括）到结束（不包括）中的字符设置字体修饰。需要先加载字体。

`getRangeLetterSpacing`

Type: getRangeLetterSpacing(start: number,end: number): LetterSpacing | pixso.mixed
Type Declaration: LetterSpacing

获取范围开始（包括）到结束（不包括）范围内的文本间距。

`setRangeLetterSpacing`

Type: setRangeLetterSpacing(start: number,end: number,value: LetterSpacing): void

对范围开始（包括）到结束（不包括）中的字符设置文本间距。需要先加载字体。

`getRangeLineHeight`

Type: getRangeLineHeight(start: number,end: number): LineHeight | pixso.mixed
Type Declaration: LineHeight

获取范围开始（包括）到结束（不包括）范围内的行高。

`setRangeLineHeight`

Type: setRangeLineHeight(start: number, end: number, value: LineHeight): void

对范围开始（包括）到结束（不包括）中的字符设置行高。需要先加载字体。

`getRangeHyperlink`

Type: getRangeHyperlink(start: number,end: number): HyperlinkTarget | null | pixso.mixed
Type Declaration: HyperlinkTarget

获取范围开始（包括）到结束（不包括）范围内的字符的超链接。如果范围正好包含一个超链接，则返回 HyperlinkTarget；如果范围不包含任何超链接，则返回 null。

`setRangeHyperlink`

Type: setRangeHyperlink(start: number,end: number,value: HyperlinkTarget | null): void

对范围开始（包括）到结束（不包括）中的字符设置超链接。如果值为 null，则删除范围内的超链接。

`getRangeFills`

Type: getRangeFills(start: number, end: number): Paint[] | pixso.mixed
Type Declaration: Paint

获取范围开始（包括）到结束（不包括）范围内的填充。

`setRangeFills`

Type: setRangeFills(start: number, end: number, value: Paint[]): void

对范围开始（包括）到结束（不包括）中的字符设置填充。

`getRangeTextStyleId`

Type: getRangeTextStyleId(start: number,end: number): string | pixso.mixed

获取范围开始（包括）到结束（不包括）的 textStyleId。

`setRangeTextStyleId`

Type: setRangeTextStyleId(start: number, end: number, value: string): void

对从范围开始（包括）到结束（不包括）范围内的字符设置 textStyleId。需要加载字体。

`getRangeFillStyleId`

Type: getRangeFillStyleId(start: number,end: number): string | pixso.mixed

获取范围开始（包括）到结束（不包括）范围内的 fillStyleId。

`setRangeFillStyleId`

Type: setRangeFillStyleId(start: number, end: number, value: string): void

对范围开始（包括）到结束（不包括）中的字符设置 fillStyleId。

Base node properties

`id`

Readonly: true
Type: string

当前节点的 ID。

`parent`

Readonly: true
Type: (BaseNode & ChildrenMixin) | null

获取当前节点的父节点。

`index`

Readonly: true
Type: number

获取当前节点在同一层级下的顺序索引。

`name`

Type: string

读取或设置组件的名字，即图层面板中所展示的图层名称。

`removed`

Readonly: true
Type: boolean

如果节点被移除了，则返回 true。如果插件保持打开一段时间并存储对节点的引用，您应该防御性地编写代码并检查节点是否未被用户删除。

`remove`

Type: remove():void

从文档中删除此节点及其所有子节点。

`toString`

Type: string

返回节点的字符串表示形式。

`setRelaunchData`

Type: data: {[command: string]: string}): void

在节点上设置状态以在选择节点时显示按钮和描述。

`getRelaunchData`

Type: getRelaunchData(): { [command: string]: string }

检索存储在此节点上的重新启动数据，使用 setRelaunchData。

`getPluginData`

Type: getPluginData(key: string): string

获取节点上存储自定义信息，对您的插件来说是私有的。如果要获取字符串以外的值类型，请先通过 JSON.parse 将其解码。

`setPluginData`

Type: setPluginData(key: string, value: string): void

允许您在任何节点上存储自定义信息，对您的插件来说是私有的。如果要存储字符串以外的值类型，请先通过 JSON.stringify 将其编码。

`getPluginDataKeys`

Type: getPluginDataKeys(): string[]

获取当前插件存储信息的所有键名。

`getSharedPluginData`

Type: getSharedPluginData(namespace: string, key: string): string

获取存储在特定命名空间上的共享数据。

`setSharedPluginData`

Type: setSharedPluginData(namespace: string, key: string, value: string): void

这使您可以在任何节点上存储自定义信息。您可以稍后通过使用相同的命名空间和键调用 getSharedPluginData 来检索它。要查找存储在特定命名空间中的节点上的所有数据，请使用 getSharpedPluginDataKeys。

您使用此 API 编写的任何数据都可以被任何插件读取。目的是允许插件相互操作。如果您不希望其他插件能够读取您的数据，请改用 setPluginData。

您还必须提供命名空间参数以避免与其他插件的键冲突。此参数是强制性的，以防止多个插件使用通用键名（如数据）并相互覆盖。我们建议传递一个标识您的插件的值。可以将此命名空间提供给其他插件的作者，以便他们可以从您的插件中读取数据。

namespace 用于标识您的插件并避免与其他插件发生键冲突的唯一字符串。命名空间必须至少包含 3 个字母数字字符。

`getSharedPluginDataKeys`

Type: getSharedPluginDataKeys(namespace: string): string[]

查找存储在特定命名空间中的节点上的所有数据的键名。

Scene node properties

`visible`

Type: boolean

节点是否可见。该属性不影响插件访问节点的能力。

`locked`

Type: boolean

节点是否被锁定，防止在画布上进行某些用户交互，例如选择和拖动。该属性不影响插件写入这些属性的能力。

`componentPropertyReferences`

Type: { [nodeProperty in 'visible' | 'characters' | 'mainComponent']?: string} | null

获取应用在当前节点上的所有组件属性。键值对当中的值会对应组件或组件集节点上通过 componentPropertyDefinitions 获取到的组件属性名称。

只有组件或实例节点的子节点才具有 componentPropertyReferences 属性。

`opacity`

Type: number

读取或设置图层的透明度，其值必须在 [0, 1] 区间。

`blendMode`

Type: BlendMode
Type Declaration: BlendMode

图层的混合模式。

`isMask`

Type: boolean

图层是否是蒙版。

`effects`

Type: ReadonlyArray<Effect>

返回一个特效数组，具体数据结构可以查看 Effect。

`effectStyleId`

Type: string

当前节点所链接的特效样式的 id。即当前节点的 effects 属性所链接的 EffectStyle 对象的 id。赋值为空即解绑样式。

`x`

Type: number

图层节点的位置，等价于 relativeTransform[0][2]。

`y`

Type: number

图层节点的位置，等价于 relativeTransform[1][2]。

`width`

Readonly: true
Type: number

图层节点的宽度。

`height`

Readonly: true
Type: number

图层节点的高度。

`relativeTransform`

Type: Transform
Type Declaration: Transform

图层节点相对于其父节点的位置，以变换矩阵的方式呈现。注意：relativeTransform 对自动布局普通子图层不生效，带有绝对定位的子图层依然生效。

`absoluteTransform`

Readonly: true
Type: Transform
Type Declaration: Transform

图层节点相对于包含它的页面的位置，以变换矩阵的方式呈现。

`absoluteBoundingBox`

Readonly: true
Type: Rect | null
Type Declaration: Rect

不包括阴影或笔触等渲染属性的节点边界。

`getNestedBoundaryBox`

Type：getNestedBoundaryBox(): NestedBoundaryBox
Type Declaration: NestedBoundaryBox

获取当前图层及其所有子图层的 boundaryBox 信息

`absoluteRenderBounds`

Readonly: true
Type: Rect | null
Type Declaration: Rect

节点的实际边界，包括阴影、粗笔画和任何其他可能落在节点常规边界框之外的内容，这些边界框在 x、y、width 和中定义 height。这个属性里面的 x和y 代表节点在页面上的绝对位置。如果节点不可见，此值将为 null。

`constrainProportions`

Type: boolean

切换后，当用户通过属性面板调整图层大小时，使图层保持其比例。

`rotation`

Type: number

图层节点的旋转角度。值域为 [-180, 180]。其值等价于：

Math.atan2(-relativeTransform[1][0], relativeTransform[0][0]);

`layoutAlign`

Type: "STRETCH" | "INHERIT"

仅适用于自动布局画板的直接子级，否则忽略。确定图层是否应沿父级的反轴拉伸。默认为 INHERIT。

`layoutGrow`

Type: number

此属性仅适用于自动布局画板的直接子级，否则忽略。确定图层是否应沿父级的主轴拉伸。0 对应于固定大小，1 对应于拉伸。

`resize`

Type: resize(width: number, height: number): void

调整节点大小。如果节点包含具有约束的子节点，它会在调整大小期间应用这些约束。如果父级具有自动布局，则导致父级调整大小。

`resizeWithoutConstraints`

Type: resizeWithoutConstraints(width: number, height: number): void

调整节点大小。如果父级没有自动布局，则节点的子节点永远不会调整大小，即使这些子节点有约束。如果父级具有自动布局，则节点父级子节点和都会调整大小（不能忽略此约束）。

`rescale`

Type: rescale(scale: number): void

缩放图层节点，此 API 功能等同于使用工具栏中的缩放工具。

`constraints`

Type: Constraints
Type Declaration: Constraints

如果当前节点被包含在画板图层内，constraints表示约束的类型。

`fills`

Type: ReadonlyArray<Paint> | pixso.mixed
Type Declaration: Paint

图层的填充。

// 设置 fills
node.fills = newFills;

`fillStyleId`

Type: string | pixso.mixed

当前节点所链接的填充样式的 id。即当前节点的 fills 属性所链接的 PaintStyle 对象的 id。赋值为空即解绑样式。

`strokes`

Type: ReadonlyArray<Paint>
Type Declaration: Paint

图层的描边。

`strokeStyleId`

Type: string

当前节点所链接的描边样式的 id。即当前节点的 strokes 属性所链接的 PaintStyle 对象的 id。赋值为空即解绑样式。

`strokeWeight`

Type: number

四个方向描边的粗细，以像素为单位。必须是非负数，可以是小数。需要注意，若设置了单边描边如strokeTopWeight，则以单边描边为准；若设置了 strokeWeight，会同时设置了四个方向的单边描边。

`strokeJoin`

Type: StrokeJoin | pixso.mixed
Type Declaration: StrokeJoin

边角的装饰。

'MITER': 直角。
'BEVEL': 斜切。
'ROUND': 圆角。

`strokeAlign`

Type: "CENTER" | "INSIDE" | "OUTSIDE"

描边相对于图层边界的对齐方式。

'CENTER': 居中。
'INSIDE': 内部。
'OUTSIDE': 外部。

`dashPattern`

Type: ReadonlyArray<number>

指定交替短划线和间隙长度的数字列表，以像素为单位。

`strokeCap`

Type: StrokeCap | pixso.mixed
Type Declaration: StrokeCap

端点的装饰。

`strokeMiterLimit`

Type: number

行程的斜接限制。这与 SVG 斜接限制相同。

`reactions`

Type: ReadonlyArray<Reaction>

此节点上的反应列表，其中包括原型中与此节点交互的方法以及该交互的行为。

`exportSettings`

Type: exportSettings: ReadonlyArray<ExportSettings>
Type Declaration: ExportSettings

节点的导出设置。

`exportAsync`

Type: exportAsync(settings?: ExportSettings): Promise<Uint8Array>
Type Declaration: ExportSettings

将节点导出为编码图像。

HWDC

`exportJsonAsync`

Type: exportJsonAsync(): Promise<string>

导出节点的 JSON 数据，该数据中包括节点的所有信息。

`exportHexAsync`

Type: exportHexAsync(hex: string): Promise<string>

导出节点的 Hex 数据，该数据中包括节点的所有信息。