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
- Available Extensions
- Annotations
-
- @JsonSerializable()
- @CopyWith()
Constructors
Properties
- backgroundColor → Color?
-
Background color of the canvas.
final
-
children
→ List<
Node?> ? -
An array of top level layers on the canvas
final
-
exportSettings
→ List<
ExportSetting> ? -
An array of export settings representing images to export from the canvas
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
A string uniquely identifying this node within the document.
finalinherited
- name → String?
-
The name given to the node by the user in the tool.
finalinherited
- 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.finalinherited -
props
→ List<
Object?> -
The list of properties that will be used to determine whether
two instances are equal.
no setteroverride
- prototypeStartNodeID → String?
-
Node ID that corresponds to the start frame for prototypes
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Data written by plugins that is visible to all plugins. Requires the
pluginData
parameter to include the string "shared".finalinherited - stringify → bool?
-
If set to
true
, the toString method will be overridden to output this instance's props.no setterinherited - type → String?
-
The type of the node
finalinherited
- visible → bool
-
Whether or not the node is visible on the canvas.
finalinherited
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