PESDK/Flutter/Guides
Configuration
The PhotoEditor SDK for Flutter can easily be tailored to meet your business needs. Learn how to swiftly create the editor your use-case requires.
You can easily configure the editor to disable specific tools, hide buttons, add specific assets etc. by adding a configuration object to the PESDK.openEditor method.
Configuration options#
The configuration has two types of options:
1. Global#
Global configuration options are applied globally in the entire editor. The main options are:
| Key | Type | Description |
|---|---|---|
Key forceCrop | Type bool | Description Defines whether the user is forced to crop the asset to one of the allowed crop ratios. |
Key mainCanvasActions | Type List<MainCanvasAction> | Description Defines all allowed actions for the main screen that are displayed as overlay buttons on the canvas. |
Key enableZoom | Type bool | Description Defines if the user is able to use the zoom feature. |
Key snapping | Type SnappingOptions | Description Options to change the snapping behavior of sprites in the Sticker, Text and Text Design tool. |
Key watermark | Type WatermarkOptions | Description Define a watermark for each image. |
Key tools | Type List<Tool> | Description Defines which tools are available and their order. |
Key export | Type ExportOptions | Description Configure the image export as well as the serialization. |
Key theme | Type ThemeOptions | Description Defines which theme is used for the editor. |
Key toolbarMode | Type ToolbarMode | Description Defines the toolbar position for the editor (iOS only). |
2. Tool-specific#
Furthermore, you have the option to configure specific tools. The tool options are:
| Key | Type | Description |
|---|---|---|
Key transform | Type TransformOptions | Description Configure the Transform tool. |
Key filter | Type FilterOptions | Description Configure the Filter tool. |
Key adjustment | Type AdjustmentOptions | Description Configure the Adjustment tool. |
Key focus | Type FocusOptions | Description Configure the Focus tool. |
Key sticker | Type StickerOptions | Description Configure the Sticker tool. |
Key text | Type TextOptions | Description Configure the Text tool. |
Key textdesign | Type TextDesignOptions | Description Configure the Text design tool. |
Key overlay | Type OverlayOptions | Description Configure the Overlay tool. |
Key frame | Type FrameOptions | Description Configure the Frame tool. |
Key brush | Type BrushOptions | Description Configure the Brush tool. |