Overview

The API reference includes the resources and materials to navigate the Plugin API.

You can explore the Plugin API using any of the entry points in the sidebar.

Global objects

You can access most of the plugin API through the global object and its sub-objects. You will find properties and functions that allow you to view, create and update the contents of your files.

Node types

In Pixso, nodes are the way we represent the contents of a file. Every layer in a Pixso file corresponds to a node.

Each node supports a range of properties. Some properties are universal, some are shared between nodes and some are unique to specific node types.

Select a Node type to see which properties are supported on that node.

• BooleanOperationNode
• ComponentNode
• ComponentSetNode
• DocumentNode
• EllipseNode
• FrameNode
• GroupNode
• InstanceNode
• LineNode
• PageNode
• PolygonNode
• RectangleNode
• SectionNode
• SliceNode
• StarNode
• TextNode
• VectorNode

In the Typings File, each node type is represented with an interface. The most general BaseNode is always one of those interfaces:

type BaseNode = DocumentNode | FolderNode | PageNode | SceneNode;

Most often, you will work with nodes contained within a page, also referred to as SceneNode.

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