PageNode

The page node is always a descendent of the DocumentNode. Most plugins only need to access the current page accessed via figma.currentPage.

Page properties

type: "PAGE" [readonly]

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

clone(): PageNode

Create a clone of this page, parented under figma.root

guides: ReadonlyArray<Guide>

The guides on this page. [Read more]

selection: ReadonlyArray<SceneNode>

The selected nodes on this page. Each page stores its own selection separately. The ordering of nodes in the selection is not guaranteed -- you should assume that it is random, like a Set<SceneNode>. [Read more]

Base node properties

id: string [readonly]

An internal identifier for a node. Plugins typically don't need to use this since you can usually just access a node directly. [Read more]

parent: (BaseNode & ChildrenMixin) | null [readonly]

Returns the parent of this node, if any. This property is not meant to be directly edited. To reparent, see appendChild. [Read more]

removed: boolean [readonly]

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. [Read more]

name: string

The name of the layer that appears in the layers panel. This may update automatically for text layers. [Read more]

toString(): string

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

remove(): void

Removes this node and all of its children from the document. [Read more]

getPluginData(key: string): string

Retrieves custom information that was stored on this node using setPluginData.

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

Lets you store custom information on any node, private to your plugin. [Read more]

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

Retrieves custom information that was stored on this node using setSharedPluginData.

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

Lets you store custom information on any node, public to all plugins. [Read more]

Scene node properties

visible: boolean

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

locked: boolean

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. [Read more]

Children-related properties

children: ReadonlyArray<PageNode> [readonly]

The list of children. For DocumentNodes, children are always PageNodes.

appendChild(child: PageNode): void

Adds a new page to the end of the children array.

insertChild(index: number, child: PageNode): void

Adds a new page at the specified index in the children array.

findAll(callback?: (node: PageNode) => boolean): ReadonlyArray<PageNode>

Searches the entire document, i.e. the contents of every page. Returns all nodes for which callback returns true. [Read more]

findOne(callback: (node: PageNode) => boolean): PageNode | null

this node's children, its children's children, etc. Returns the first node for which callback returns true. [Read more]

Export-related properties

exportSettings: ReadonlyArray<ExportSettings>

List of export settings stored on the node. For help on how to change this value, see Editing Properties.

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

List of export settings stored on the node. [Read more]