Skip to content

概述

根据插件 API 的功能特性我们分了几种类型,您可以通过边栏中的任何入口来探索插件 API。

如果您是 pixso 或插件的新手,我们在下面概述了一些涉及的关键资源。请务必阅读我们的开发指南以获取提示和最佳实践!

全局对象

pixso 您可以通过全局对象及其子对象访问大部分插件 API 。您将找到允许您查看、创建和更新文件内容的属性和函数。

节点类型

Pixso 中,节点是我们表示文件内容的方式。每一个图层都由一个节点对象来表示。编辑器上有多种类型的图层,因此也有多种类型的节点对象,每种节点都有自己的一组属性。

有些属性是通用的,在节点之间共享,有些是特定节点类型所独有的。

选择一个节点类型以查看该节点支持哪些属性。

BaseNode

在类型声明文件中,每个节点类型都用一个接口表示。最通用的 BaseNode 是如下几个接口之一:

typescript
type BaseNode = DocumentNode | PageNode | SceneNode;

SceneNode

大多数情况下,插件都在操作页面中的图层节点,在类型声明文件中用 SceneNode 进行表示。

typescript
type SceneNode =
  | BooleanOperationNode
  | ComponentNode
  | ComponentSetNode
  | EllipseNode
  | FrameNode
  | GroupNode
  | InstanceNode
  | LineNode
  | PolygonNode
  | PageNode
  | RectangleNode
  | SectionNode
  | SliceNode
  | StarNode
  | TextNode
  | VectorNode;

NodeType

每个节点上都有一个类型属性,表示当前节点的类型。 NodeType 中声明了所有节点的类型,插件中可以使用 node.type 判断节点的类型。

typescript
type NodeType =
  | "BOOLEAN_OPERATION"
  | "COMPONENT"
  | "COMPONENT_SET"
  | "DOCUMENT"
  | "ELLIPSE"
  | "FOLDER"
  | "FRAME"
  | "GROUP"
  | "INSTANCE"
  | "LINE"
  | "PAGE"
  | "POLYGON"
  | "RECTANGLE"
  | "SECTION"
  | "SLICE"
  | "STAR"
  | "TEXT"
  | "VECTOR";