- 组件
- ImageEditor
ImageEditor
gradio.ImageEditor(···)描述
创建一个图像组件，作为输入时，可用于使用画笔、笔触、裁剪和图层等简单编辑工具上传和编辑图像。作为输出时，此组件可用于显示图像。
行为
作为输入组件: 将上传的图像作为 EditorValue 实例传递，它只是一个具有键：'background'、'layers' 和 'composite' 的 dict。与 'background' 和 'composite' 对应的值是图像，而 'layers' 是一个图像 list。图像的类型为 PIL.Image、np.array 或 str 文件路径，具体取决于 type 参数。
您的函数应接受其中一种类型
def predict(
value: EditorValue | None
)
...作为输出组件: 需要一个 EditorValue，它只是一个具有键：'background'、'layers' 和 'composite' 的字典。与 'background' 和 'composite' 对应的值应该是图像或 None，而 layers 应该是一个图像列表。图像可以是 PIL.Image、np.array 或 str 文件路径/URL。或者，值可以只是单个图像 (ImageType)，在这种情况下，它将被用作背景。
您的函数应返回其中一种类型
def predict(···) -> EditorValue | ImageType | None
...
return value初始化
value: EditorValue | ImageType | None
value: EditorValue | ImageType | None= None可选的初始图像，用于填充图像编辑器。应该是一个具有键：`background`、`layers` 和 `composite` 的字典。与 `background` 和 `composite` 对应的值应该是图像或 None，而 `layers` 应该是一个图像列表。图像可以是 PIL.Image、np.array 或 str 文件路径/URL。或者，该值可以是一个可调用对象，在这种情况下，每当应用加载时，都会调用该函数来设置组件的初始值。
height: int | str | None
height: int | str | None= None组件的高度，如果传入数字，则以像素为单位指定；如果传入字符串，则以 CSS 单位指定。这对预处理的图像文件或 numpy 数组没有影响，但会影响显示的图像。请注意与 canvas_size 参数冲突的值。如果 canvas_size 大于高度，编辑画布将不适合组件。
width: int | str | None
width: int | str | None= None组件的宽度，如果传入数字，则以像素为单位指定；如果传入字符串，则以 CSS 单位指定。这对预处理的图像文件或 numpy 数组没有影响，但会影响显示的图像。请注意与 canvas_size 参数冲突的值。如果 canvas_size 大于高度，编辑画布将不适合组件。
image_mode: Literal['1', 'L', 'P', 'RGB', 'RGBA', 'CMYK', 'YCbCr', 'LAB', 'HSV', 'I', 'F']
image_mode: Literal['1', 'L', 'P', 'RGB', 'RGBA', 'CMYK', 'YCbCr', 'LAB', 'HSV', 'I', 'F']= "RGBA"如果彩色为 "RGB"，如果黑白为 "L"。有关其他支持的图像模式及其含义，请参阅 https://pillow.ac.cn/en/stable/handbook/concepts.html。
sources: Iterable[Literal['upload', 'webcam', 'clipboard']] | Literal['upload', 'webcam', 'clipboard'] | None
sources: Iterable[Literal['upload', 'webcam', 'clipboard']] | Literal['upload', 'webcam', 'clipboard'] | None= ('upload', 'webcam', 'clipboard')可用于设置背景图像的来源列表。"upload" 创建一个框，用户可以在其中拖放图像文件，"webcam" 允许用户从网络摄像头拍摄快照，"clipboard" 允许用户从剪贴板粘贴图像。
type: Literal['numpy', 'pil', 'filepath']
type: Literal['numpy', 'pil', 'filepath']= "numpy"在传入预测函数之前，图像被转换为的格式。"numpy" 将图像转换为形状为 (height, width, 3) 且值为 0 到 255 的 numpy 数组，"pil" 将图像转换为 PIL 图像对象，"filepath" 将图像作为 str 文件路径传递给图像的临时副本。
label: str | I18nData | None
label: str | I18nData | None= None此组件的标签。显示在组件上方，如果该组件有示例表格，也用作标题。如果为 None 且在 `gr.Interface` 中使用，则标签将是此组件分配到的参数名称。
every: Timer | float | None
every: Timer | float | None= None持续调用 `value` 来重新计算它（如果 `value` 是一个函数，否则无效）。可以提供一个 Timer，其滴答声会重置 `value`，或者提供一个浮点数来为重置 Timer 提供常规间隔。
inputs: Component | list[Component] | set[Component] | None
inputs: Component | list[Component] | set[Component] | None= None用作计算 `value` 的输入的组件（如果 `value` 是一个函数，否则无效）。`value` 在输入更改时会重新计算。
buttons: list[Literal['download', 'share', 'fullscreen']] | None
buttons: list[Literal['download', 'share', 'fullscreen']] | None= None要显示在组件角落的按钮列表。有效选项包括 "download"（下载图像）、"share"（分享到 Hugging Face Spaces Discussions）和 "fullscreen"（全屏查看）。默认情况下，所有按钮都显示。
scale: int | None
scale: int | None= None与相邻组件相比的相对大小。例如，如果组件 A 和 B 在一个 Row 中，A 的 scale 为 2，B 的 scale 为 1，则 A 的宽度将是 B 的两倍。应为整数。scale 适用于 Rows，以及 Blocks 中 fill_height=True 的顶级组件。
min_width: int
min_width: int= 160最小像素宽度，如果屏幕空间不足以满足此值，则会换行。如果某个 scale 值导致此组件比 min_width 窄，则将首先考虑 min_width 参数。
interactive: bool | None
interactive: bool | None= None如果为 True，则允许用户上传和编辑图像；如果为 False，则只能用于显示图像。如果未提供，则根据组件是用作输入还是输出来推断。
visible: bool | Literal['hidden']
visible: bool | Literal['hidden']= True如果为 False，则组件将隐藏。如果为“hidden”，则组件将视觉上隐藏并且不会在布局中占用空间，但仍存在于 DOM 中。
key: int | str | tuple[int | str, ...] | None
key: int | str | tuple[int | str, ...] | None= None在 `gr.render` 中，跨重渲染具有相同键的组件被视为同一个组件，而不是一个新组件。在 `preserved_by_key` 中设置的属性在重渲染时不会重置。
preserved_by_key: list[str] | str | None
preserved_by_key: list[str] | str | None= "value"此组件构造函数中的参数列表。在 `gr.render()` 函数内部，如果一个组件使用相同的键进行重渲染，则这些（也是唯一的）参数将在 UI 中被保留（如果它们已被用户或事件监听器更改），而不是根据构造函数中提供的值进行重渲染。
transforms: Iterable[Literal['crop', 'resize']] | None
transforms: Iterable[Literal['crop', 'resize']] | None= ('crop', 'resize')可供用户使用的转换工具。"crop" 允许用户裁剪图像。
eraser: Eraser | None | Literal[False]
eraser: Eraser | None | Literal[False]= None图像编辑器中橡皮擦工具的选项。应该是 `gr.Eraser` 类的实例，或者 None 使用默认设置。也可以是 False 以隐藏橡皮擦工具。请参阅 `gr.Eraser` 文档。
brush: Brush | None | Literal[False]
brush: Brush | None | Literal[False]= None图像编辑器中画笔工具的选项。应该是 `gr.Brush` 类的实例，或者 None 使用默认设置。也可以是 False 以隐藏画笔工具，这也会隐藏橡皮擦工具。请参阅 `gr.Brush` 文档。
format: str
format: str= "webp"如果图像没有有效的格式（例如，如果图像作为 numpy 数组或 PIL 图像返回到前端），则保存图像的格式。该格式应受 PIL 库支持。此参数对 SVG 文件没有影响。
layers: bool | LayerOptions
layers: bool | LayerOptions= True图像编辑器中图层工具的选项。可以是布尔值或 `gr.LayerOptions` 类的实例。如果为 True，将允许用户向图像添加图层。如果为 False，图层选项将被隐藏。如果是 `gr.LayerOptions` 的实例，它将用于配置图层工具。请参阅 `gr.LayerOptions` 文档。
canvas_size: tuple[int, int]
canvas_size: tuple[int, int]= (800, 800)画布的初始大小（以像素为单位）。第一个值是宽度，第二个值是高度。如果 `fixed_canvas` 为 `True`，上传的图像将按比例缩放以适应画布大小，同时保留纵横比。否则，画布大小将更改为与上传的图像大小匹配。
webcam_options: WebcamOptions | None
webcam_options: WebcamOptions | None= None图像编辑器中网络摄像头工具的选项。可以是 `gr.WebcamOptions` 类的实例，或者 None 使用默认设置。请参阅 `gr.WebcamOptions` 文档。
快捷方式
gradio.ImageEditor
gradio.ImageEditor"imageeditor"gradio.Sketchpad
gradio.Sketchpad"sketchpad"gradio.Paint
gradio.Paint"paint"gradio.ImageMask
gradio.ImageMask"imagemask"演示
事件监听器
描述
事件监听器允许您响应 Gradio Blocks 应用中定义的 UI 组件的用户交互。当用户与元素交互时（例如，更改滑块值或上传图像），会调用一个函数。
支持的事件监听器
ImageEditor 组件支持以下事件监听器。每个事件监听器都采用相同的参数，这些参数在下面的 事件参数 表中列出。
ImageEditor.clear(fn, ···)
ImageEditor.clear(fn, ···)当用户使用组件的清除按钮清除 ImageEditor 时触发此监听器。
ImageEditor.change(fn, ···)
ImageEditor.change(fn, ···)当 ImageEditor 的值发生更改时触发，原因可能是用户输入（例如用户在文本框中输入）或函数更新（例如图像从事件触发器的输出接收值）。请参阅 .input() 以了解仅由用户输入触发的监听器。
ImageEditor.input(fn, ···)
ImageEditor.input(fn, ···)当用户更改 ImageEditor 的值时触发此监听器。
ImageEditor.select(fn, ···)
ImageEditor.select(fn, ···)当用户选择或取消选择 ImageEditor 时触发的事件监听器。使用事件数据 gradio.SelectData 来携带 value（指 ImageEditor 的标签）和 selected（指 ImageEditor 的状态）。有关详细信息，请参阅 https://gradio.org.cn/docs/gradio/eventdata。
ImageEditor.upload(fn, ···)
ImageEditor.upload(fn, ···)当用户将文件上传到 ImageEditor 时触发此监听器。
ImageEditor.apply(fn, ···)
ImageEditor.apply(fn, ···)当用户通过集成的 UI 操作对 ImageEditor 应用更改时触发此监听器。
事件参数
fn: Callable | None | Literal['decorator']
fn: Callable | None | Literal['decorator']= "decorator"当此事件触发时调用的函数。通常是机器学习模型的预测函数。函数的每个参数对应一个输入组件，函数应返回一个单一值或一个值元组，元组中的每个元素对应一个输出组件。
inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None= None用作输入的 gradio.components 列表。如果函数不接受输入，则此列表应为空。
outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None= None用作输出的 gradio.components 列表。如果函数不返回输出，则此列表应为空。
api_name: str | None
api_name: str | None= None定义该端点在 API 文档中如何显示。可以是字符串或 None。如果设置为字符串，则该端点将在 API 文档中以给定名称显示。如果为 None（默认），则使用函数的名称作为 API 端点。
api_description: str | None | Literal[False]
api_description: str | None | Literal[False]= NoneAPI 端点的描述。可以是字符串、None 或 False。如果设置为字符串，则该端点将在 API 文档中以给定描述显示。如果为 None，则使用函数的 docstring 作为 API 端点描述。如果为 False，则 API 文档中不会显示任何描述。
show_progress: Literal['full', 'minimal', 'hidden']
show_progress: Literal['full', 'minimal', 'hidden']= "full"事件运行时如何显示进度动画：“full”显示一个覆盖输出组件区域的加载指示器，并在右上角显示运行时信息，“minimal”仅显示运行时信息，“hidden”不显示任何进度动画。
show_progress_on: Component | list[Component] | None
show_progress_on: Component | list[Component] | None= None用于显示进度动画的组件或组件列表。如果为 None，则进度动画将显示在所有输出组件上。
queue: bool
queue: bool= True如果为 True，则会将请求放在队列中（如果队列已启用）。如果为 False，则不会将此事件放入队列，即使队列已启用。如果为 None，则将使用 Gradio 应用的队列设置。
batch: bool
batch: bool= False如果为 True，则函数应处理一批输入，这意味着它应该为每个参数接受一个输入值列表。列表的长度应相同（最多为 `max_batch_size`）。然后，该函数*必须*返回一个元组的列表（即使只有一个输出组件），元组中的每个列表对应一个输出组件。
preprocess: bool
preprocess: bool= True如果为 False，则在运行 'fn' 之前不会进行组件数据预处理（例如，当使用 `Image` 组件调用此方法时，将其保留为 base64 字符串）。
cancels: dict[str, Any] | list[dict[str, Any]] | None
cancels: dict[str, Any] | list[dict[str, Any]] | None= None取消其他事件的列表，当此监听器触发时。例如，设置 cancels=[click_event] 将会取消 click_event，其中 click_event 是另一个组件的 .click 方法的返回值。尚未运行的函数（或正在迭代的生成器）将被取消，但正在运行的函数将被允许完成。
trigger_mode: Literal['once', 'multiple', 'always_last'] | None
trigger_mode: Literal['once', 'multiple', 'always_last'] | None= None如果设置为 "once"（除 `.change()` 之外所有事件的默认值），则在事件挂起时不允许任何提交。如果设置为 "multiple"，则在事件挂起时允许无限次提交，而 "always_last"（`.change()` 和 `.key_up()` 事件的默认值）则允许在挂起事件完成后进行第二次提交。
js: str | Literal[True] | None
js: str | Literal[True] | None= None在运行 'fn' 之前运行可选的前端 JS 方法。JS 方法的输入参数是 'inputs' 和 'outputs' 的值，返回值应为输出组件的值列表。
concurrency_limit: int | None | Literal['default']
concurrency_limit: int | None | Literal['default']= "default"如果设置，这是可以同时运行的此事件的最大数量。可以设置为 None，表示没有并发限制（此事件可以同时运行任意数量）。设置为 "default" 可使用 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义的默认并发限制（该参数本身默认为 1）。
concurrency_id: str | None
concurrency_id: str | None= None如果设置，这是并发组的 ID。具有相同 `concurrency_id` 的事件将受到最低设置的 `concurrency_limit` 的限制。
api_visibility: Literal['public', 'private', 'undocumented']
api_visibility: Literal['public', 'private', 'undocumented']= "public"控制此端点的可见性和可访问性。可以是 "public"（在 API 文档中显示并可由客户端调用）、"private"（在 API 文档中隐藏，不可由客户端调用）或 "undocumented"（在 API 文档中隐藏，但可由客户端通过 gr.load 调用）。如果 fn 为 None，则 api_visibility 将自动设置为 "private"。
辅助类
Brush
gradio.Brush(···)描述
用于指定 ImageEditor 组件中画笔工具选项的数据类。此类的实例可以传递给 gr.ImageEditor 的 brush 参数。
初始化
Eraser
gradio.Eraser(···)描述
用于指定 ImageEditor 组件中橡皮擦工具选项的数据类。此类的实例可以传递给 gr.ImageEditor 的 eraser 参数。
初始化
Layer Options
gradio.LayerOptions(···)描述
用于指定 ImageEditor 组件中图层工具选项的数据类。此类的实例可以传递给 gr.ImageEditor 的 layers 参数。
初始化
网络摄像头选项
gradio.WebcamOptions(···)