Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Canvas

Represents a single page

Hierarchy

Index

Properties

Readonly backgroundColor

backgroundColor: Color

Background color of the canvas

Readonly children

children: ReadonlyArray<Node>

An array of top level layers on the canvas

Optional Readonly exportSettings

exportSettings: ReadonlyArray<ExportSetting>

An array of export settings representing images to export from the canvas

Readonly id

id: string

a string uniquely identifying this node within the document

Readonly name

name: string

the name given to the node by the user in the tool.

Optional Readonly pluginData

pluginData: any

data written by plugins that is visible only to the plugin that wrote it. Requires the pluginData to include the ID of the plugin.

Readonly prototypeStartNodeID

prototypeStartNodeID: string | null

Node ID that corresponds to the start frame for prototypes

Optional Readonly sharedPluginData

sharedPluginData: any

data written by plugins that is visible to all plugins. Requires the pluginData parameter to include the string "shared".

Readonly type

type: "CANVAS"

Optional Readonly visible

visible: undefined | false | true

whether or not the node is visible on the canvas

Generated using TypeDoc