# ImageEditor

```python
gradio.ImageEditor(···)
```

### Description

Creates an image component that, as an input, can be used to upload and edit images using simple editing tools such as brushes, strokes, cropping, and layers. Or, as an output, this component can be used to display images.

### Behavior

### Initialization

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `value` | `EditorValue \| ImageType \| None` | `None` | Optional initial image(s) to populate the image editor. Should be a dictionary with keys: `background`, `layers`, and `composite`. The values corresponding to `background` and `composite` should be images or None, while `layers` should be a list of images. Images can be of type PIL.Image, np.array, or str filepath/URL. Or, the value can be a callable, in which case the function will be called whenever the app loads to set the initial value of the component. |
| `height` | `int \| str \| None` | `None` | The height of the component, specified in pixels if a number is passed, or in CSS units if a string is passed. This has no effect on the preprocessed image files or numpy arrays, but will affect the displayed images. Beware of conflicting values with the canvas_size parameter. If the canvas_size is larger than the height, the editing canvas will not fit in the component. |
| `width` | `int \| str \| None` | `None` | The width of the component, specified in pixels if a number is passed, or in CSS units if a string is passed. This has no effect on the preprocessed image files or numpy arrays, but will affect the displayed images. Beware of conflicting values with the canvas_size parameter. If the canvas_size is larger than the height, the editing canvas will not fit in the component. |
| `image_mode` | `Literal['1', 'L', 'P', 'RGB', 'RGBA', 'CMYK', 'YCbCr', 'LAB', 'HSV', 'I', 'F']` | `"RGBA"` | "RGB" if color, or "L" if black and white. See https://pillow.readthedocs.io/en/stable/handbook/concepts.html for other supported image modes and their meaning. |
| `sources` | `Iterable[Literal['upload', 'webcam', 'clipboard']] \| Literal['upload', 'webcam', 'clipboard'] \| None` | `('upload', 'webcam', 'clipboard')` | List of sources that can be used to set the background image. "upload" creates a box where user can drop an image file, "webcam" allows user to take snapshot from their webcam, "clipboard" allows users to paste an image from the clipboard. |
| `type` | `Literal['numpy', 'pil', 'filepath']` | `"numpy"` | The format the images are converted to before being passed into the prediction function. "numpy" converts the images to numpy arrays with shape (height, width, 3) and values from 0 to 255, "pil" converts the images to PIL image objects, "filepath" passes images as str filepaths to temporary copies of the images. |
| `label` | `str \| I18nData \| None` | `None` | the label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to. |
| `every` | `Timer \| float \| None` | `None` | Continously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer. |
| `inputs` | `Component \| list[Component] \| set[Component] \| None` | `None` | Components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change. |
| `show_label` | `bool \| None` | `None` | if True, will display label. |
| `buttons` | `list[Literal['download', 'share', 'fullscreen']] \| None` | `None` | A list of buttons to show in the corner of the component. Valid options are "download" to download the image, "share" to share to Hugging Face Spaces Discussions, and "fullscreen" to view in fullscreen mode. By default, all buttons are shown. |
| `container` | `bool` | `True` | If True, will place the component in a container - providing some extra padding around the border. |
| `scale` | `int \| None` | `None` | relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True. |
| `min_width` | `int` | `160` | minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first. |
| `interactive` | `bool \| None` | `None` | if True, will allow users to upload and edit an image; if False, can only be used to display images. If not provided, this is inferred based on whether the component is used as an input or output. |
| `visible` | `bool \| Literal['hidden']` | `True` | If False, component will be hidden. If "hidden", component will be visually hidden and not take up space in the layout but still exist in the DOM |
| `elem_id` | `str \| None` | `None` | An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles. |
| `elem_classes` | `list[str] \| str \| None` | `None` | An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles. |
| `render` | `bool` | `True` | If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later. |
| `key` | `int \| str \| tuple[int \| str, ...] \| None` | `None` | in a gr.render, Components with the same key across re-renders are treated as the same component, not a new component. Properties set in 'preserved_by_key' are not reset across a re-render. |
| `preserved_by_key` | `list[str] \| str \| None` | `"value"` | A list of parameters from this component's constructor. Inside a gr.render() function, if a component is re-rendered with the same key, these (and only these) parameters will be preserved in the UI (if they have been changed by the user or an event listener) instead of re-rendered based on the values provided during constructor. |
| `placeholder` | `str \| None` | `None` | Custom text for the upload area. Overrides default upload messages when provided. Accepts new lines and `#` to designate a heading. |
| `transforms` | `Iterable[Literal['crop', 'resize']] \| None` | `('crop', 'resize')` | The transforms tools to make available to users. "crop" allows the user to crop the image. |
| `eraser` | `Eraser \| None \| Literal[False]` | `None` | The options for the eraser tool in the image editor. Should be an instance of the `gr.Eraser` class, or None to use the default settings. Can also be False to hide the eraser tool. [See `gr.Eraser` docs](#eraser). |
| `brush` | `Brush \| None \| Literal[False]` | `None` | The options for the brush tool in the image editor. Should be an instance of the `gr.Brush` class, or None to use the default settings. Can also be False to hide the brush tool, which will also hide the eraser tool. [See `gr.Brush` docs](#brush). |
| `format` | `str` | `"webp"` | Format to save image if it does not already have a valid format (e.g. if the image is being returned to the frontend as a numpy array or PIL Image).  The format should be supported by the PIL library. This parameter has no effect on SVG files. |
| `layers` | `bool \| LayerOptions` | `True` | The options for the layer tool in the image editor. Can be a boolean     or an instance of the `gr.LayerOptions` class. If True, will allow users to add layers to the image. If False, the layers option will be hidden. If an instance of `gr.LayerOptions`, it will be used to configure the layer tool. [See `gr.LayerOptions` docs](#layer-options). |
| `canvas_size` | `tuple[int, int]` | `(800, 800)` | The initial size of the canvas in pixels. The first value is the width and the second value is the height. If `fixed_canvas` is `True`, uploaded images will be rescaled to fit the canvas size while preserving the aspect ratio. Otherwise, the canvas size will change to match the size of an uploaded image. |
| `fixed_canvas` | `bool` | `False` | If True, the canvas size will not change based on the size of the background image and the image will be rescaled to fit (while preserving the aspect ratio) and placed in the center of the canvas. |
| `webcam_options` | `WebcamOptions \| None` | `None` | The options for the webcam tool in the image editor. Can be an instance of the `gr.WebcamOptions` class, or None to use the default settings. [See `gr.WebcamOptions` docs](#webcam-options). |
### Shortcuts

| Class | Interface String Shortcut | Initialization |
|-------|--------------------------|----------------|
| `gradio.ImageEditor` | `"imageeditor"` | Uses default values |
| `gradio.Sketchpad` | `"sketchpad"` | Uses sources=(), brush=Brush(colors=["#000000"], color_mode="fixed") |
| `gradio.Paint` | `"paint"` | Uses sources=() |
| `gradio.ImageMask` | `"imagemask"` | Uses brush=Brush(colors=["#000000"], color_mode="fixed") |
### Demos

**image_editor**

[See demo on Hugging Face Spaces](https://huggingface.co/spaces/gradio/image_editor)

```python
import gradio as gr
import time


def sleep(im):
    time.sleep(5)
    return [im["background"], im["layers"][0], im["layers"][1], im["composite"]]


def predict(im):
    return im["composite"]


with gr.Blocks() as demo:
    with gr.Row():
        im = gr.ImageEditor(
            type="numpy",
        )
        im_preview = gr.Image()
    n_upload = gr.Number(0, label="Number of upload events", step=1)
    n_change = gr.Number(0, label="Number of change events", step=1)
    n_input = gr.Number(0, label="Number of input events", step=1)

    im.upload(lambda x: x + 1, outputs=n_upload, inputs=n_upload)
    im.change(lambda x: x + 1, outputs=n_change, inputs=n_change)
    im.input(lambda x: x + 1, outputs=n_input, inputs=n_input)
    im.change(predict, outputs=im_preview, inputs=im, show_progress="hidden")

if __name__ == "__main__":
    demo.launch()
```

### Event Listeners

#### Description

Event listeners allow you to respond to user interactions with the UI components you've defined in a Gradio Blocks app. When a user interacts with an element, such as changing a slider value or uploading an image, a function is called.

#### Supported Event Listeners

The `ImageEditor` component supports the following event listeners:

- `ImageEditor.clear(fn, ...)`: This listener is triggered when the user clears the ImageEditor using the clear button for the component.
- `ImageEditor.change(fn, ...)`: Triggered when the value of the ImageEditor changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See `.input()` for a listener that is only triggered by user input.
- `ImageEditor.input(fn, ...)`: This listener is triggered when the user changes the value of the ImageEditor.
- `ImageEditor.select(fn, ...)`: Event listener for when the user selects or deselects the ImageEditor. Uses event data gradio.SelectData to carry `value` referring to the label of the ImageEditor, and `selected` to refer to state of the ImageEditor. See https://www.gradio.app/main/docs/gradio/eventdata for more details.
- `ImageEditor.upload(fn, ...)`: This listener is triggered when the user uploads a file into the ImageEditor.
- `ImageEditor.apply(fn, ...)`: This listener is triggered when the user applies changes to the ImageEditor through an integrated UI action.

#### Event Parameters

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `fn` | `Callable \| None \| Literal['decorator']` | `"decorator"` | the function to call when this event is triggered. Often a machine learning model's prediction function. Each parameter of the function corresponds to one input component, and the function should return a single value or a tuple of values, with each element in the tuple corresponding to one output component. |
| `inputs` | `Component \| BlockContext \| list[Component \| BlockContext] \| Set[Component \| BlockContext] \| None` | `None` | List of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list. |
| `outputs` | `Component \| BlockContext \| list[Component \| BlockContext] \| Set[Component \| BlockContext] \| None` | `None` | List of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list. |
| `api_name` | `str \| None` | `None` | defines how the endpoint appears in the API docs. Can be a string or None. If set to a string, the endpoint will be exposed in the API docs with the given name. If None (default), the name of the function will be used as the API endpoint. |
| `api_description` | `str \| None \| Literal[False]` | `None` | Description of the API endpoint. Can be a string, None, or False. If set to a string, the endpoint will be exposed in the API docs with the given description. If None, the function's docstring will be used as the API endpoint description. If False, then no description will be displayed in the API docs. |
| `scroll_to_output` | `bool` | `False` | If True, will scroll to output component on completion |
| `show_progress` | `Literal['full', 'minimal', 'hidden']` | `"full"` | how to show the progress animation while event is running: "full" shows a spinner which covers the output component area as well as a runtime display in the upper right corner, "minimal" only shows the runtime display, "hidden" shows no progress animation at all |
| `show_progress_on` | `Component \| list[Component] \| None` | `None` | Component or list of components to show the progress animation on. If None, will show the progress animation on all of the output components. |
| `queue` | `bool` | `True` | If True, will place the request on the queue, if the queue has been enabled. If False, will not put this event on the queue, even if the queue has been enabled. If None, will use the queue setting of the gradio app. |
| `batch` | `bool` | `False` | If True, then the function should process a batch of inputs, meaning that it should accept a list of input values for each parameter. The lists should be of equal length (and be up to length `max_batch_size`). The function is then *required* to return a tuple of lists (even if there is only 1 output component), with each list in the tuple corresponding to one output component. |
| `max_batch_size` | `int` | `4` | Maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) |
| `preprocess` | `bool` | `True` | If False, will not run preprocessing of component data before running 'fn' (e.g. leaving it as a base64 string if this method is called with the `Image` component). |
| `postprocess` | `bool` | `True` | If False, will not run postprocessing of component data before returning 'fn' output to the browser. |
| `cancels` | `dict[str, Any] \| list[dict[str, Any]] \| None` | `None` | A list of other events to cancel when this listener is triggered. For example, setting cancels=[click_event] will cancel the click_event, where click_event is the return value of another components .click method. Functions that have not yet run (or generators that are iterating) will be cancelled, but functions that are currently running will be allowed to finish. |
| `trigger_mode` | `Literal['once', 'multiple', 'always_last'] \| None` | `None` | If "once" (default for all events except `.change()`) would not allow any submissions while an event is pending. If set to "multiple", unlimited submissions are allowed while pending, and "always_last" (default for `.change()` and `.key_up()` events) would allow a second submission after the pending event is complete. |
| `js` | `str \| Literal[True] \| None` | `None` | Optional frontend js method to run before running 'fn'. Input arguments for js method are values of 'inputs' and 'outputs', return should be a list of values for output components. |
| `concurrency_limit` | `int \| None \| Literal['default']` | `"default"` | If set, this is the maximum number of this event that can be running simultaneously. Can be set to None to mean no concurrency_limit (any number of this event can be running simultaneously). Set to "default" to use the default concurrency limit (defined by the `default_concurrency_limit` parameter in `Blocks.queue()`, which itself is 1 by default). |
| `concurrency_id` | `str \| None` | `None` | If set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit. |
| `api_visibility` | `Literal['public', 'private', 'undocumented']` | `"public"` | controls the visibility and accessibility of this endpoint. Can be "public" (shown in API docs and callable by clients), "private" (hidden from API docs and not callable by the Gradio client libraries), or "undocumented" (hidden from API docs but callable by clients and via gr.load). If fn is None, api_visibility will automatically be set to "private". |
| `time_limit` | `int \| None` | `None` |  |
| `stream_every` | `float` | `0.5` |  |
| `key` | `int \| str \| tuple[int \| str, ...] \| None` | `None` | A unique key for this event listener to be used in @gr.render(). If set, this value identifies an event as identical across re-renders when the key is identical. |
| `validator` | `Callable \| None` | `None` | Optional validation function to run before the main function. If provided, this function will be executed first with queue=False, and only if it completes successfully will the main function be called. The validator receives the same inputs as the main function and should return a `gr.validate()` for each input value. |
### Helper Classes

### Brush

```python
gradio.Brush(···)
```

#### Description

A dataclass for specifying options for the brush tool in the ImageEditor component. An instance of this class can be passed to the `brush` parameter of `gr.ImageEditor`.

#### Initialization

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `default_size` | `int \| Literal['auto']` | `"auto"` | The default radius, in pixels, of the brush tool. Defaults to "auto" in which case the radius is automatically determined based on the size of the image (generally 1/50th of smaller dimension). |
| `colors` | `list[str \| tuple[str, float]] \| str \| tuple[str, float] \| None` | `None` | A list of colors to make available to the user when using the brush. Defaults to a list of 5 colors. |
| `default_color` | `str \| tuple[str, float] \| None` | `None` | The default color of the brush. Defaults to the first color in the `colors` list. |
| `color_mode` | `Literal['fixed', 'defaults']` | `"defaults"` | If set to "fixed", user can only select from among the colors in `colors`. If "defaults", the colors in `colors` are provided as a default palette, but the user can also select any color using a color picker. |
### Eraser

```python
gradio.Eraser(···)
```

#### Description

A dataclass for specifying options for the eraser tool in the ImageEditor component. An instance of this class can be passed to the `eraser` parameter of `gr.ImageEditor`.

#### Initialization

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `default_size` | `int \| Literal['auto']` | `"auto"` | The default radius, in pixels, of the eraser tool. Defaults to "auto" in which case the radius is automatically determined based on the size of the image (generally 1/50th of smaller dimension). |
### Layer Options

```python
gradio.LayerOptions(···)
```

#### Description

A dataclass for specifying options for the layer tool in the ImageEditor component. An instance of this class can be passed to the `layers` parameter of `gr.ImageEditor`.

#### Initialization

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `allow_additional_layers` | `bool` | `True` | If True, users can add additional layers to the image. If False, the add layer button will not be shown. |
| `layers` | `list[str] \| None` | `None` | A list of layers to make available to the user when using the layer tool. One layer must be provided, if the length of the list is 0 then a layer will be generated automatically. |
| `disabled` | `bool` | `False` |  |
### Webcam Options

```python
gradio.WebcamOptions(···)
```

#### Description

A dataclass for specifying options for the webcam tool in the ImageEditor component. An instance of this class can be passed to the `webcam_options` parameter of `gr.ImageEditor`.

#### Initialization

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `mirror` | `bool` | `True` | If True, the webcam will be mirrored. |
| `constraints` | `dict[str, Any] \| None` | `None` | A dictionary of constraints for the webcam. |