Document class

At the root of every File is a Document node, and from that Document node stems any Canvas nodes.

Inheritance
Available Extensions
Annotations
  • @JsonSerializable()
  • @CopyWith()

Constructors

Document({required String id, String? name, required bool visible, dynamic pluginData, dynamic sharedPluginData, List<Node?>? children})
Document.fromJson(Map<String, dynamic> json)
factory

Properties

children → List<Node?>?
An array of canvases attached to the document
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
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sharedPluginData → dynamic
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