FilterEditor class

The FilterEditor widget allows users to apply filters to images.

You can create a FilterEditor using one of the factory methods provided:

  • FilterEditor.file: Loads an image from a file.
  • FilterEditor.asset: Loads an image from an asset.
  • FilterEditor.network: Loads an image from a network URL.
  • FilterEditor.memory: Loads an image from memory as a Uint8List.
  • FilterEditor.autoSource: Automatically selects the source based on provided parameters.
Inheritance

Constructors

FilterEditor.asset(String assetPath, {Key? key, required ThemeData theme, ImageEditorDesignModeE designMode = ImageEditorDesignModeE.material, I18n i18n = const I18n(), ImageEditorCustomWidgets customWidgets = const ImageEditorCustomWidgets(), ImageEditorIcons icons = const ImageEditorIcons(), ImageEditorTheme imageEditorTheme = const ImageEditorTheme(), FilterEditorConfigs configs = const FilterEditorConfigs(), required String heroTag})
Create a FilterEditor widget with an image loaded from an asset.
factory
FilterEditor.autoSource({Key? key, required ThemeData theme, ImageEditorDesignModeE designMode = ImageEditorDesignModeE.material, I18n i18n = const I18n(), ImageEditorCustomWidgets customWidgets = const ImageEditorCustomWidgets(), ImageEditorIcons icons = const ImageEditorIcons(), ImageEditorTheme imageEditorTheme = const ImageEditorTheme(), FilterEditorConfigs configs = const FilterEditorConfigs(), required String heroTag, Uint8List? byteArray, File? file, String? assetPath, String? networkUrl})
Create a FilterEditor widget with automatic image source detection.
factory
FilterEditor.file(File file, {Key? key, required ThemeData theme, ImageEditorDesignModeE designMode = ImageEditorDesignModeE.material, I18n i18n = const I18n(), ImageEditorCustomWidgets customWidgets = const ImageEditorCustomWidgets(), ImageEditorIcons icons = const ImageEditorIcons(), ImageEditorTheme imageEditorTheme = const ImageEditorTheme(), FilterEditorConfigs configs = const FilterEditorConfigs(), required String heroTag})
Create a FilterEditor widget with an image loaded from a File.
factory
FilterEditor.memory(Uint8List byteArray, {Key? key, required ThemeData theme, ImageEditorDesignModeE designMode = ImageEditorDesignModeE.material, I18n i18n = const I18n(), ImageEditorCustomWidgets customWidgets = const ImageEditorCustomWidgets(), ImageEditorIcons icons = const ImageEditorIcons(), ImageEditorTheme imageEditorTheme = const ImageEditorTheme(), FilterEditorConfigs configs = const FilterEditorConfigs(), required String heroTag})
Create a FilterEditor widget with an in-memory image represented as a Uint8List.
factory
FilterEditor.network(String networkUrl, {Key? key, required ThemeData theme, ImageEditorDesignModeE designMode = ImageEditorDesignModeE.material, I18n i18n = const I18n(), ImageEditorCustomWidgets customWidgets = const ImageEditorCustomWidgets(), ImageEditorIcons icons = const ImageEditorIcons(), ImageEditorTheme imageEditorTheme = const ImageEditorTheme(), FilterEditorConfigs configs = const FilterEditorConfigs(), required String heroTag})
Create a FilterEditor widget with an image loaded from a network URL.
factory

Properties

assetPath → String?
The asset path of the image.
final
byteArray → Uint8List?
A byte array representing the image data.
final
configs → FilterEditorConfigs
Configuration settings for the FilterEditor.
final
customWidgets → ImageEditorCustomWidgets
Custom widgets configuration for the editor.
final
designMode → ImageEditorDesignModeE
The design mode of the editor.
final
file → File?
The file representing the image.
final
hashCode → int
The hash code for this object.
no setterinherited
heroTag → String
A hero tag to enable hero transitions between screens.
final
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
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
networkUrl → String?
The network URL of the image.
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() → State<StatefulWidget>
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