BooleanOperationNode #

BooleanOperationNode 代表布尔组图层节点。布尔操作通过四个公式组合任意一组图层：联集（Union）、减去顶层（Subtract）、交集（Intersect）、差集（Exclude）。被组合的图层将作为布尔组图层的子节点。

Base node properties #

type #

• Readonly: true
• Type: 'BOOLEAN_OPERATION'

节点类型，对于 BooleanOperationNode 节点来说，其值为字符串 'BOOLEAN_OPERATION'。

clone #

• Type: () => BooleanOperationNode

复制该布尔组节点。默认情况下，复制的新节点的父级节点为 mg.document.currentPage。

id #

• Readonly: true
• Type: string

BooleanOperationNode 节点的 ID。

remove #

• Type: remove():void

将当前节点从parent节点中移除。

removed #

• Type: boolean

如果节点被移除了，则值为 true。如果插件保持运行状态，并且插件代码对某个节点存在引用，那么您应该始终检查节点的 removed 属性，在对节点进行操作之前先确保它没有被移除。

parent #

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

获取当前节点的父节点。

name #

• Type: string

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

getPluginData #

• Type: getPluginData(key: string): string

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

setPluginData #

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

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

getPluginDataKeys #

• Type: getPluginDataKeys(): string[]

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

removePluginData #

• Type: removePluginData(key: string): void

移除当前插件存储的自定义信息。

clearPluginData #

• Type: clearPluginData(): void

清除当前插件所有存储的自定义信息。

getSharedPluginData #

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

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

setSharedPluginData #

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

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

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

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

getSharedPluginDataKeys #

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

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

removeSharedPluginData #

• Type: removeSharedPluginData(namespace: string, key: string): void

移除存储在特定命名空间中的自定义信息。

clearSharedPluginData #

• Type: clearSharedPluginData(namespace: string): void

清除存储在特定命名空间上的所有数据。

booleanOperation #

• Type: 'UNION' | 'INTERSECT' | 'SUBTRACT' | 'EXCLUDE'

布尔组组合节点的操作类型。

Scene node properties #

isVisible #

• Type: boolean

节点是否可见。无论节点是否可见，都不影响插件对节点的访问。节点的 .isVisible 属性独立于它的父代节点。这意味着：即使该节点的 .isVisible === true，它也未必可见（父代节点中，任何一个节点不可见，那么该节点都不可见）。所以判断节点是否真的可见的正确方法是：确保该节点以及它的所有父代节点都满足条件 .isVisible === true。

isLocked #

• Type: boolean

节点是否被锁定。锁定的节点会组织用户在画布上对其进行特定的交互，例如拖动、选中图层。但无论图层节点是否被选中，都不影响插件代码对图层节点属性的读写操作。与判断节点是否可见的方式类似，判断节点是否真的被锁定正确方法是：只要该节点或任何一个它的父代节点满足条件 .isVisible === true，则认为该节点被锁定。

attachedConnectors #

• Readonly: true
• Type: ConnectorNode[]

吸附到节点的连接线节点数组。

componentPropertyReferences #

• Type: { [nodeProperty in 'visible' | 'characters' | 'mainComponent']: string } | null, ComponentPropertyReferences

此节点上附加的所有组件属性。仅当节点是组件子图层且未嵌套在实例节点中时，该节点才能具有组件属性引用。否则为空。键值对中的值是组件或组件集上的组件属性定义返回的组件属性id。

Blend-related properties #

opacity #

• Type: number

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

blendMode #

• Type: BlendMode

图层的混合模式。

isMask #

• Type: boolean

图层是否是蒙版。

isMaskOutline #

• Type: boolean

图层是否是轮廓蒙版，值为false时为透明蒙层。只有当isMask为true时设置才能生效。

isMaskVisible #

• Type: boolean

图层是否显示蒙版。只有当isMask为true时设置才能生效，只有为轮廓蒙层的时候，才会在画布中显示蒙层。

effects #

• Type: ReadonlyArray<Effect>, Effect

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

effectStyleId #

• Type: string

当前节点所链接的特效样式的 id。即当前节点的 effects 属性所链接的 EffectStyle 对象的 id。

Geometry-related properties #

fills #

• Type: ReadonlyArray<Paint>

图层的填充。

strokes #

• Type: ReadonlyArray<Paint>

图层的描边。

strokeStyle #

• Type: 'SOLID' | 'DASH' | 'CUSTOM'

描边类型。

• 'SOLID': 实线。
• 'DASH': 虚线。
• 'CUSTOM': 自定义。

strokeWeight #

• Type: number

四个方向描边的粗细，以像素为单位。必须是非负数，可以是小数。

strokeAlign #

• Type: 'CENTER' | 'INSIDE' | 'OUTSIDE'

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

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

strokeCap #

• Type: 'NONE' | 'ROUND' | 'SQUARE' | 'LINE_ARROW' | 'TRIANGLE_ARROW' | 'ROUND_ARROW' | 'RING' | 'DIAMOND' | 'LINE'

端点的装饰。

• 'NONE': 正常。
• 'ROUND': 圆角。
• 'SQUARE': 方型。
• 'LINE_ARROW': 普通箭头。
• 'TRIANGLE_ARROW': 三角箭头。
• 'ROUND_ARROW' 圆箭头。
• 'RING' 圆环。
• 'DIAMOND' 方块。
• 'LINE'直线。

strokeJoin #

• Type: 'MITER' | 'BEVEL' | 'ROUND'

边角的装饰。

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

strokeDashes #

• Type: ReadonlyArray<[number, number]>

包含数字的数组。数组偶数下标元素代表虚线的长度，奇数下标元素代表虚线的间距。

dashCap #

• Type: 'NONE' | 'ROUND' | 'SQUARE'

虚线端点装饰。

• 'NONE': 正常。
• 'ROUND': 圆角。
• 'SQUARE': 方型。

fillStyleId #

• Type: string

当前节点所链接的填充样式的 id。即当前节点的 fills 属性所链接的 PaintStyle 对象的 id。

strokeStyleId #

• Type: string

当前节点所链接的描边样式的 id。即当前节点的 strokes 属性所链接的 PaintStyle 对象的 id。

outlineStroke #

• Type: () => BooleanOperationNode | null

该方法执行的动作与右键菜单中的“轮廓化”功能相同。如果该节点存在描边则该方法创建并返回描边的 BooleanOperationNode 节点，否则返回 null。

Corner-related properties #

cornerSmooth #

• Type: number

控制角的平滑程度，值域为 [0, 1]。

cornerRadius #

• Type: number | PluginAPI['mixed']

圆角。

Children-related properties #

children #

• Readonly: true
• Type: ReadonlyArray<SceneNode>

当前 BooleanOperationNode 节点的直接子节点。

appendChild #

• Type: appendChild(child: SceneNode): void

将给定的节点 child 添加为当前 BooleanOperationNode 节点的直接子节点。

insertChild #

• Type: insertChild(index: number, child: SceneNode): void

在指定的位置 index 处插入子节点 child。假设一个组有三个子节点 A、B、C，现在调用 insertChild 方法将插入图层节点 D：

• insertChild(0, D)，子节点顺序为：D、A、B、C。
• insertChild(1, D)，子节点顺序为：A、D、B、C。
• insertChild(2, D)，子节点顺序为：A、B、D、C。
• insertChild(3, D)，子节点顺序为：A、B、C、D。

findAll #

• Type: findAll(callback?: (node: SceneNode) => boolean): ReadonlyArray<SceneNode>

从当前 BooleanOperationNode 节点开始查找整个子树，对每个节点调用 callback 函数，并返回所有对于 callback 函数的返回值为 true 的节点。

findOne #

• Type: findOne(callback: (node: SceneNode) => boolean): SceneNode | null

从当前 BooleanOperationNode 节点开始查找整个节点树，对每个节点调用 callback 函数，并返回第一个对于 callback 函数的返回值为 true 的节点。

findChildren #

• Type: findChildren(callback?: (node: SceneNode) => boolean): ReadonlyArray<SceneNode>

与 findAll 类似，不同之处在于，findChildren 仅会在当前 BooleanOperationNode 节点的直接子节点（不包括子节点的子节点）中进行查找。

findChild #

• Type: findChild(callback: (node: SceneNode) => boolean): SceneNode | null

与 findOne 类似，不同之处在于，findChild 仅会在当前 BooleanOperationNode 节点的直接子节点（不包括子节点的子节点）中进行查找。

findAllWithCriteria #

• Type: findAllWithCriteria<T extends NodeType[]>(criteria: { types: T }): Array<{ type: T[number] } & SceneNode>

查找当前节点的所有子节点，返回所有类型符合的节点。

const nodes = node.findAllWithCriteria({types: ['FRAME', 'COMPONENT']})

Frame-related properties #

flexMode #

• Type: 'NONE' | 'HORIZONTAL' | 'VERTICAL'

表示该 Frame 是否采用自动布局：

• 'NONE': 没有采用自动布局。
• 'HORIZONTAL': 自动布局，水平方向。
• 'VERTICAL': 自动布局，垂直方向。

可以通过修改 node.flexMode 属性来改变 Frame 图层的布局方式：

const booleanNode = document.children[0].children[0] as BooleanOperationNode
booleanNode.flexMode = 'HORIZONTAL' // 水平方向自动布局
booleanNode.flexMode = 'NONE' // 移除自动布局

改变 flexMode 属性会导致 Frame 图层的子节点的位置发生改变，同时也可能使得 Frame 图层本身的尺寸发生改变。

flexWrap #

• Type: 'NO_WRAP' | 'WRAP'

此属性只能在 flexMode === “HORIZONTAL” 的图层上设置。在没有此属性的图层上设置它将引发错误。 此属性必须设置为'WRAP'，才能使 crossAxisSpacing 和 crossAxisAlignContent 属性生效。

itemSpacing #

• Type: number

仅适用于采用自动布局的 Frame 图层节点。代表该 Frame 节点的子节点间的间距。

crossAxisSpacing #

• Type: number | null

仅适用于 flexWrap 设置为 WRAP 的自动布局图层。表达换行的行之间的距离。该值必须为正数。

mainAxisAlignItems #

• Type: 'FLEX_START' | 'FLEX_END' | 'CENTER' | 'SPACING_BETWEEN'

仅适用于采用自动布局的 Frame 图层节点。用于决定自动布局容器的子节点在主轴上的对齐方式。改变该属性值可能会间接地更新其子节点的 x 属性值和 y 属性值。

• 当 flexMode 为 'HORIZONTAL'，即水平方向自动布局时。'FLEX_START' 相当于容器的左边，'FLEX_END' 相当于容器的右边。
• 当 flexMode 为 'VERTICAL'，即垂直方向自动布局时。'FLEX_START' 相当于容器的上边，'FLEX_END' 相当于容器的下边。
• 'SPACING_BETWEEN' 会使得子节点在主轴方向上均匀的排列，并且仅在子节点之间放置空白。

crossAxisAlignItems #

• Type: 'FLEX_START' | 'FLEX_END' | 'CENTER'

仅适用于采用自动布局的 Frame 图层节点。用于决定自动布局容器的子节点在交叉轴上的对齐方式。改变该属性值可能会间接地更新其子节点的 x 属性值和 y 属性值。

• 当 flexMode 为 'HORIZONTAL'，即水平方向自动布局时。'FLEX_START' 相当于容器的上边，'FLEX_END' 相当于容器的下边。
• 当 flexMode 为 'VERTICAL'，即垂直方向自动布局时。'FLEX_START' 相当于容器的左边，'FLEX_END' 相当于容器的右边。

mainAxisSizingMode #

• Type: 'FIXED' | 'AUTO'

仅适用于采用自动布局的 Frame 图层节点。代表当前容器主轴方向上的长度：

• 'FIXED': 固定长度，即由用户决定容器的主轴长度。直接设置主轴长度，也会改成'FIXED'。
• 'AUTO': 自动长度，即由自动布局引擎自动计算的长度。

crossAxisSizingMode #

• Type: 'FIXED' | 'AUTO'

仅适用于采用自动布局的 Frame 图层节点。代表当前容器交叉轴方向上的长度：

• 'FIXED': 固定长度，即由用户决定容器的交叉轴长度。直接设置交叉轴长度，也会改成'FIXED'。
• 'AUTO': 自动长度，即由自动布局引擎自动计算的长度。

crossAxisAlignContent #

• Type: 'AUTO' | 'SPACE_BETWEEN'

仅适用于自动布局模式为为"WRAP"的自动布局图层。确定不同的行在自动布局图层内的分布方式。

itemReverseZIndex #

• Type: boolean

仅适用于采用自动布局的容器图层。用于决定此容器中图层的画布堆叠顺序。当为true时，则第一层将在顶部绘制。

strokesIncludedInLayout #

• Type: boolean

仅适用于采用自动布局的容器图层。用于决定描边是否包含在布局计算中。当为true时，自动布局容器的行为类似于 css box-sizing:border-box。

paddingTop #

• Type: number

仅适用于采用自动布局的 Frame 图层节点。Frame 容器的上内边距。

paddingRight #

• Type: number

仅适用于采用自动布局的 Frame 图层节点。Frame 容器的右内边距。

paddingBottom #

• Type: number

仅适用于采用自动布局的 Frame 图层节点。Frame 容器的下内边距。

paddingLeft #

• Type: number

仅适用于采用自动布局的 Frame 图层节点。Frame 容器的左内边距。

Container-related properties #

expanded #

• Type: boolean

此容器是否在图层面板中显示为展开。

Layout-related properties #

absoluteTransform #

• Type: Transform

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

relativeTransform #

• Type: Transform

图层节点相对于它的父级节点的位置，作为变换矩阵呈现。

absoluteBoundingBox #

• Readonly: true
• Type: Rect

图层节点相对于包含它的页面的位置，以Rect对象的方式呈现。

absoluteRenderBounds #

• Readonly: true
• Type: Rect | null

图层节点在画布中的实际渲染效果的定位和宽高，其值会受到该图层的旋转、填充、阴影、描边等效果影响，返回的坐标值为相对于画布的坐标，以Rect对象的方式呈现，当该图层不存在时，返回值为null。

x #

• Type: number

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

y #

• Type: number

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

bound #

• Type: Rect

图层节点的rect。

rotation #

• Type: number

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

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

width #

• Type: number

图层节点的宽度。

height #

• Type: number

图层节点的高度。

maxWidth #

• Type: number

图层节点的最大宽度，该图层必须设置为自动布局或者是一个自动布局图层的直接子节点。

minWidth #

• Type: number

图层节点的最小宽度，该图层必须设置为自动布局或者是一个自动布局图层的直接子节点。

maxHeight #

• Type: number

图层节点的最大高度，该图层必须设置为自动布局或者是一个自动布局图层的直接子节点。

minHeight #

• Type: number

图层节点的最小高度，该图层必须设置为自动布局或者是一个自动布局图层的直接子节点。

flip #

• Type: flip(direction: 'HORIZONTAL' | 'VERTICAL'): void

翻转图层。

• HORIZONTAL: 水平翻转。
• VERTICAL: 垂直翻转。

rescale #

• Type: rescale(scale: number, scaleOption?: ScaleOption): void

type ScaleCenter = 'TOPLEFT' | 'TOP' | 'TOPRIGHT' | 'LEFT' | 'CENTER' | 'RIGHT' | 'BOTTOMLEFT' | 'BOTTOM' | 'BOTTOMRIGHT'

interface ScaleOption {
  scaleCenter?: ScaleCenter
}

rescale方法用于等比缩放图层，且等比影响子图层的大小（width、height 或 fontSize）和相对定位，使其占百分比相等。

传入scale控制缩放系数，缩放后的宽高最小为0.01。设置scaleOption可设置缩放的行为，如设置scaleCenter控制缩放中心，默认为左上角TOPLEFT。

flexGrow #

• Type: 0 | 1

该属性仅适用于采用自动布局的容器的直接子节点。代表该图层节点是否撑满容器的主轴，行为与 CSS 的 flex-grow 属性一致。

• 0: 固定宽度。
• 1: 充满容器。

alignSelf #

• Type: "STRETCH" | "INHERIT"

该属性仅适用于采用自动布局的容器的直接子节点。代表该图层节点是否撑满容器的交叉轴，行为与 CSS 的 align-self 属性一致。

• "STRETCH": 撑满交叉轴。
• "INHERIT": 固定高度。

layoutPositioning #

• Type: "AUTO" | "ABSOLUTE"

该属性仅适用于采用自动布局的容器的直接子节点。代表该图层节点的大小和位置是否通过自动布局设置或手动调整。

constrainProportions #

• Type: boolean

锁定节点宽高比例。当为true时,修改节点的width或height会等比例修改height和width。

Export-related properties #

exportSettings #

• Type: ReadonlyArray<exportSettings>

节点的导出设置。

export #

• Type: export(settings?: ExportSettings): Uint8Array | string, ExportSettings

将节点导出为对应的编码图片。如果是 SVG 格式，则返回字符串；否则返回 Uint8Array。

function exportImage() {
  const svgString = node.export({ format: 'SVG' })
  const uint8arr = node.export({ format: 'PNG' })
}

exportAsync #

• Type: exportAsync(settings?: ExportSettings): Promise<Uint8Array | string>, ExportSettings

将节点异步导出为对应的编码图片。如果导出图层包含图片，该方法会加载原图，如果原图加载失败，会降级为预览图片。如果是 SVG 格式，则返回字符串；否则返回 Uint8Array。

async function exportImage() {
  const svgString = await node.exportAsync({ format: 'SVG' })
  const uint8arr = await node.exportAsync({ format: 'PNG' })
}

Reaction prototyping-related properties #

reactions #

• Type: Array<Reaction>

获取或设置该节点设置的原型属性，若该图层没有任何以此为起点的原型交互，则返回空数组。每次设置原型属性都会将原有原型覆盖，若想清空该图层的所有原型，赋值空数组即可；若需要添加某原型交互，在原有原型数组上，添加完整的原型设置即可。