PaintingCanvas class

A widget for creating a canvas for painting on images.

This widget allows you to create a canvas for painting on images loaded from various sources, including network URLs, asset paths, files, or memory (Uint8List). It provides customization options for appearance and behavior.

Inheritance

Constructors

PaintingCanvas.asset(String path, {required Key key, bool? scalable, bool? showColorPicker, Widget? placeholderWidget, Function? save, List<Color>? colors, VoidCallback? onUpdate, Widget? undoIcon, Widget? colorIcon, required Size imageSize, required ThemeData theme, required I18n i18n, required ImageEditorTheme imageEditorTheme, required ImageEditorIcons icons, required ImageEditorDesignModeE designMode, required PaintEditorConfigs configs})
Create a PaintingCanvas widget with an image loaded from an asset.
factory
PaintingCanvas.autoSource({required Key key, VoidCallback? onUpdate, required Size imageSize, required ThemeData theme, required I18n i18n, required ImageEditorTheme imageEditorTheme, required ImageEditorIcons icons, required ImageEditorDesignModeE designMode, required PaintEditorConfigs configs, Uint8List? byteArray, File? file, String? assetPath, String? networkUrl})
Create a PaintingCanvas widget with automatic image source detection.
factory
PaintingCanvas.file(File file, {required Key key, Function? save, bool? scalable, bool? showColorPicker, Widget? placeholderWidget, List<Color>? colors, VoidCallback? onUpdate, Widget? undoIcon, Widget? colorIcon, required Size imageSize, required ThemeData theme, required I18n i18n, required ImageEditorTheme imageEditorTheme, required ImageEditorIcons icons, required ImageEditorDesignModeE designMode, required PaintEditorConfigs configs})
Create a PaintingCanvas widget with an image loaded from a File.
factory
PaintingCanvas.memory(Uint8List byteArray, {required Key key, bool? scalable, bool? showColorPicker, Function? save, Widget? placeholderWidget, List<Color>? colors, VoidCallback? onUpdate, Widget? undoIcon, Widget? colorIcon, required Size imageSize, required ThemeData theme, required I18n i18n, required ImageEditorTheme imageEditorTheme, required ImageEditorIcons icons, required ImageEditorDesignModeE designMode, required PaintEditorConfigs configs})
Create a PaintingCanvas widget with an image loaded from a Uint8List (memory).
factory
PaintingCanvas.network(String networkUrl, {required Key key, Widget? placeholderWidget, bool? scalable, bool? showColorPicker, List<Color>? colors, Function? save, VoidCallback? onUpdate, Widget? undoIcon, Widget? colorIcon, required Size imageSize, required ThemeData theme, required I18n i18n, required ImageEditorTheme imageEditorTheme, required ImageEditorIcons icons, required ImageEditorDesignModeE designMode, required PaintEditorConfigs configs})
Create a PaintingCanvas widget with an image loaded from a network URL.
factory

Properties

assetPath → String?
The asset path of the image (if loading from assets).
final
byteArray → Uint8List?
A byte array representing the image data (if loading from memory).
final
configs → PaintEditorConfigs
The configuration options for the paint editor.
final
designMode → ImageEditorDesignModeE
The design mode of the editor (material or custom).
final
file → File?
The file representing the image (if loading from a file).
final
hashCode → int
The hash code for this object.
no setterinherited
i18n → I18n
The internationalization (i18n) configuration for the editor.
final
icons → ImageEditorIcons
Icons used in the editor.
final
imageEditorTheme → ImageEditorTheme
The theme configuration specific to the image editor.
final
imageSize → Size
The size of the image.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
networkUrl → String?
The network URL of the image (if loading from a network).
final
onUpdate → VoidCallback?
A callback function called when the painting is updated.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
theme → ThemeData
The theme configuration for the editor.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → PaintingCanvasState
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited