Canvas class

A Canvas node represents a Page in a Figma File. A Canvas node can then have any number of nodes as its children. Each subtree stemming from a Canvas node will represent a layer (e.g an object) on the Canvas.

Inheritance

• Object
• Node
• Canvas

Available Extensions

• $CanvasCopyWith
• $NodeCopyWith

Annotations

• @JsonSerializable()
• @CopyWith()

Constructors

Canvas({required String id, required bool visible, Map<String, String>? componentPropertyReferences, String? name, double? rotation, dynamic pluginData, dynamic sharedPluginData, String? type, required PrototypeDevice prototypeDevice, required List<FlowStartingPoint> flowStartingPoints, required List<ExportSetting> exportSettings, List<Node?>? children, Color? backgroundColor})

Canvas.fromJson(Map<String, dynamic> json)

factory

Properties

backgroundColor → Color?

Background color of the canvas.

final

children → List<Node?>?

An array of top level layers on the canvas.

final

componentPropertyReferences → Map<String, String>?

A mapping of a layer's property to component property name of component properties attached to this node. The component property name can be used to look up more information on the corresponding component's or component set's componentPropertyDefinitions.

final, inherited

exportSettings → List<ExportSetting>

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

final

flowStartingPoints → List<FlowStartingPoint>

An array of starting points for flows attached to the canvas.

final

hashCode → int

The hash code for this object.

no setter, inherited

id → String

A string uniquely identifying this node within the document.

final, inherited

name → String?

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

final, inherited

pluginData → dynamic

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

final, inherited

props → List<Object?>

The list of properties that will be used to determine whether two instances are equal.

no setter, override

prototypeDevice → PrototypeDevice

The device that this canvas is a prototype for.

final

rotation → double?

The rotation of the node, if not 0.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sharedPluginData → dynamic

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

final, inherited

stringify → bool?

If set to true, the toString method will be overridden to output this instance's props.

no setter, inherited

type → String?

The type of the node. This is usually the same as the Node subtype classes (e.g. Frame, Component etc.), but can be different in the case of foreign nodes.

final, inherited

visible → bool

Whether or not the node is visible on the canvas.

final, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited