1. 组件
  2. ImageSlider

刚开始使用 Gradio？ 从这里开始： 入门指南

查看 发布历史

←

ImageEditor

JSON

→

ImageSlider

gradio.ImageSlider(···)

描述

创建一个图像组件，可用于上传图像（作为输入）或显示图像（作为输出）。

行为

作为输入组件: 根据 `type`，将上传的图像作为 numpy.array、PIL.Image 或 str 文件路径的元组传递。

您的函数应接受其中一种类型
def predict(
	value: tuple[
    str | PIL.Image.Image | np.ndarray | None, str | PIL.Image.Image | np.ndarray | None
]
)
	...

作为输出组件: 期望一个元组，包含 numpy.array、PIL.Image 或指向图像的 str 或 pathlib.Path 文件路径，这些将被显示。

您的函数应返回其中一种类型
def predict(···) -> np.ndarray | PIL.Image.Image | str | Path | None
	...	
	return value

初始化

参数
🔗 
value: image_tuple | Callable | None
默认 = None

PIL Image、numpy 数组、路径或 URL 的元组，作为 ImageSlider 组件将接收的默认值，此图像对应相等的大小。如果提供了函数，则每次加载应用时都会调用该函数来设置此组件的初始值。

🔗 
format: str
默认 = "webp"

文件格式（例如，“png”或“gif”）。如果图像尚未具有有效格式（例如，当图像作为 numpy 数组或 PIL Image 返回到前端时），则用于保存图像。该格式应受 PIL 库支持。此参数在组件用作输入或输出时均有效。此参数对 SVG 文件无效。

🔗 
height: int | str | None
默认 = None

组件的高度，如果传入数字则以像素为单位指定，如果传入字符串则以 CSS 单位指定。这不会影响图像文件或 numpy 数组的预处理元组，但会影响显示的图像。

🔗 
width: int | str | None
默认 = None

组件的宽度，如果传入数字则以像素为单位指定，如果传入字符串则以 CSS 单位指定。这不会影响图像文件或 numpy 数组的预处理元组，但会影响显示的图像。

🔗 
image_mode: Literal['1', 'L', 'P', 'RGB', 'RGBA', 'CMYK', 'YCbCr', 'LAB', 'HSV', 'I', 'F'] | None
默认 = "RGB"

图像应加载和预处理的像素格式和颜色深度。“RGB”将图像加载为彩色图像，或“L”作为黑白图像。请参阅 https://pillow.ac.cn/en/stable/handbook/concepts.html 以了解其他支持的图像模式及其含义。此参数对 SVG 或 GIF 文件无效。如果设置为 None，则图像模式将从图像文件类型推断（例如，对于 .png 图像为“RGBA”，在大多数其他情况下为“RGB”）。

🔗 
type: Literal['numpy', 'pil', 'filepath']
默认 = "numpy"

在将图像传递到预测函数之前，将其转换成的格式。“numpy”将图像转换为形状为 (height, width, 3) 且值为 0 到 255 的 numpy 数组，“pil”将图像转换为 PIL 图像对象，“filepath”将包含图像的临时文件的字符串路径传递。要支持输入的动画 GIF，`type` 应设置为“filepath”或“pil”。要支持 SVG，`type` 应设置为“filepath”。

🔗 
label: str | None
默认 = None

此组件的标签。显示在组件上方，如果该组件有示例表格，也用作标题。如果为 None 且在 `gr.Interface` 中使用，则标签将是此组件分配到的参数名称。

🔗 
every: Timer | float | None
默认 = None

持续调用 `value` 来重新计算它（如果 `value` 是一个函数，否则无效）。可以提供一个 Timer，其滴答声会重置 `value`，或者提供一个浮点数来为重置 Timer 提供常规间隔。

🔗 
inputs: Component | list[Component] | set[Component] | None
默认 = None

用作计算 `value` 的输入的组件（如果 `value` 是一个函数，否则无效）。`value` 在输入更改时会重新计算。

🔗 
show_label: bool | None
默认 = None

如果为 True，将显示标签。

🔗 
buttons: list[Literal['download', 'fullscreen'] | Button] | None
默认 = None

显示在组件右上角的按钮列表。有效选项包括“download”、“fullscreen”或 `gr.Button()` 实例。“download”按钮允许用户下载图像。“fullscreen”按钮允许用户以全屏模式查看图像。自定义的 `gr.Button()` 实例将出现在工具栏中，并带有其配置的图标和/或标签，点击它们将触发在该按钮上注册的任何 `.click()` 事件。默认情况下，所有内置按钮都会显示。

🔗 
container: bool
默认 = True

如果为 True，则会将组件放置在容器中，在边框周围提供一些额外的填充。

🔗 
scale: int | None
默认 = None

与相邻组件相比的相对大小。例如，如果组件 A 和 B 在一个 Row 中，A 的 scale 为 2，B 的 scale 为 1，则 A 的宽度将是 B 的两倍。应为整数。scale 适用于 Rows，以及 Blocks 中 fill_height=True 的顶级组件。

🔗 
min_width: int
默认 = 160

最小像素宽度，如果屏幕空间不足以满足此值，则会换行。如果某个 scale 值导致此组件比 min_width 窄，则将首先考虑 min_width 参数。

🔗 
interactive: bool | None
默认 = None

如果为 True，则允许用户上传和编辑图像；如果为 False，则只能用于显示图像。如果未提供，则根据组件是用作输入还是输出来推断。

🔗 
visible: bool | Literal['hidden']
默认 = True

如果为 False，则组件将隐藏。如果为“hidden”，则组件将视觉上隐藏并且不会在布局中占用空间，但仍存在于 DOM 中。

🔗 
elem_id: str | None
默认 = None

一个可选字符串，用作此组件在 HTML DOM 中的 id。可用于定位 CSS 样式。

🔗 
elem_classes: list[str] | str | None
默认 = None

一个可选的字符串列表，用作此组件在 HTML DOM 中的类。可用于定位 CSS 样式。

🔗 
render: bool
默认 = True

如果为 False，则组件不会在 Blocks 上下文中渲染。如果打算现在分配事件监听器，但稍后渲染组件，则应使用此选项。

🔗 
key: int | str | tuple[int | str, ...] | None
默认 = None

在 `gr.render` 中，跨重渲染具有相同键的组件被视为同一个组件，而不是一个新组件。在 `preserved_by_key` 中设置的属性在重渲染时不会重置。

🔗 
preserved_by_key: list[str] | str | None
默认 = "value"

此组件构造函数中的参数列表。在 `gr.render()` 函数内部，如果一个组件使用相同的键进行重渲染，则这些（也是唯一的）参数将在 UI 中被保留（如果它们已被用户或事件监听器更改），而不是根据构造函数中提供的值进行重渲染。

🔗 
slider_position: float
默认 = 50

滑块在图像宽度中所占的百分比位置，介于 0 和 100 之间。

🔗 
max_height: int
默认 = 500

图像的最大高度。

快捷方式

快捷方式
gradio.ImageSlider
Interface 字符串快捷方式 "imageslider"
初始化 使用默认值

演示

事件监听器

描述

事件监听器允许您响应 Gradio Blocks 应用中定义的 UI 组件的用户交互。当用户与元素交互时（例如，更改滑块值或上传图像），会调用一个函数。

支持的事件监听器

该 ImageSlider 组件支持以下事件监听器。每个事件监听器接收相同的参数，这些参数在下方的 事件参数 表中列出。

监听器
ImageSlider.clear(fn, ···)

当用户使用组件的清除按钮清除 ImageSlider 时，会触发此监听器。

ImageSlider.change(fn, ···)

当 ImageSlider 的值发生变化时触发，无论是由于用户输入（例如，用户在文本框中键入）还是由于函数更新（例如，图像从事件触发器的输出接收值）。请参阅 .input() 以了解仅由用户输入触发的监听器。

ImageSlider.stream(fn, ···)

当用户流式传输 ImageSlider 时，会触发此监听器。

ImageSlider.select(fn, ···)

当用户选择或取消选择 ImageSlider 时的事件监听器。使用事件数据 gradio.SelectData 来传递引用 ImageSlider 标签的 `value`，以及引用 ImageSlider 状态的 `selected`。有关更多详细信息，请参阅 https://gradio.org.cn/docs/gradio/eventdata。

ImageSlider.upload(fn, ···)

当用户将文件上传到 ImageSlider 时，会触发此监听器。

ImageSlider.input(fn, ···)

当用户更改 ImageSlider 的值时，会触发此监听器。

事件参数

参数
🔗 
fn: Callable | None | Literal['decorator']
默认 = "decorator"

当此事件触发时调用的函数。通常是机器学习模型的预测函数。函数的每个参数对应一个输入组件，函数应返回一个单一值或一个值元组，元组中的每个元素对应一个输出组件。

🔗 
inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
默认 = None

用作输入的 gradio.components 列表。如果函数不接受输入，则此列表应为空。

🔗 
outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
默认 = None

用作输出的 gradio.components 列表。如果函数不返回输出，则此列表应为空。

🔗 
api_name: str | None
默认 = None

定义该端点在 API 文档中如何显示。可以是字符串或 None。如果设置为字符串，则该端点将在 API 文档中以给定名称显示。如果为 None（默认），则使用函数的名称作为 API 端点。

🔗 
api_description: str | None | Literal[False]
默认 = None

API 端点的描述。可以是字符串、None 或 False。如果设置为字符串，则该端点将在 API 文档中以给定描述显示。如果为 None，则使用函数的 docstring 作为 API 端点描述。如果为 False，则 API 文档中不会显示任何描述。

🔗 
scroll_to_output: bool
默认 = False

完成后是否滚动到输出组件

🔗 
show_progress: Literal['full', 'minimal', 'hidden']
默认 = "full"

事件运行时如何显示进度动画：“full”显示一个覆盖输出组件区域的加载指示器，并在右上角显示运行时信息，“minimal”仅显示运行时信息，“hidden”不显示任何进度动画。

🔗 
show_progress_on: Component | list[Component] | None
默认 = None

用于显示进度动画的组件或组件列表。如果为 None，则进度动画将显示在所有输出组件上。

🔗 
queue: bool
默认 = True

如果为 True，则会将请求放在队列中（如果队列已启用）。如果为 False，则不会将此事件放入队列，即使队列已启用。如果为 None，则将使用 Gradio 应用的队列设置。

🔗 
batch: bool
默认 = False

如果为 True，则函数应处理一批输入，这意味着它应该为每个参数接受一个输入值列表。列表的长度应相同（最多为 `max_batch_size`）。然后，该函数*必须*返回一个元组的列表（即使只有一个输出组件），元组中的每个列表对应一个输出组件。

🔗 
max_batch_size: int
默认 = 4

如果从队列调用（仅在 batch=True 时相关），则要批处理的最大输入数量

🔗 
preprocess: bool
默认 = True

如果为 False，则在运行 'fn' 之前不会进行组件数据预处理（例如，当使用 `Image` 组件调用此方法时，将其保留为 base64 字符串）。

🔗 
postprocess: bool
默认 = True

如果为 False，则在将 'fn' 输出返回到浏览器之前，不会进行组件数据后处理。

🔗 
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
默认 = None

如果设置为 "once"（除 `.change()` 之外所有事件的默认值），则在事件挂起时不允许任何提交。如果设置为 "multiple"，则在事件挂起时允许无限次提交，而 "always_last"（`.change()` 和 `.key_up()` 事件的默认值）则允许在挂起事件完成后进行第二次提交。

🔗 
js: str | Literal[True] | None
默认 = None

在运行 'fn' 之前运行可选的前端 JS 方法。JS 方法的输入参数是 'inputs' 和 'outputs' 的值，返回值应为输出组件的值列表。

🔗 
concurrency_limit: int | None | Literal['default']
默认 = "default"

如果设置，这是可以同时运行的此事件的最大数量。可以设置为 None，表示没有并发限制（此事件可以同时运行任意数量）。设置为 "default" 可使用 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义的默认并发限制（该参数本身默认为 1）。

🔗 
concurrency_id: str | None
默认 = None

如果设置，这是并发组的 ID。具有相同 `concurrency_id` 的事件将受到最低设置的 `concurrency_limit` 的限制。

🔗 
api_visibility: Literal['public', 'private', 'undocumented']
默认 = "public"

控制此端点的可见性和可访问性。可以是 "public"（在 API 文档中显示并可由客户端调用）、"private"（在 API 文档中隐藏，不可由客户端调用）或 "undocumented"（在 API 文档中隐藏，但可由客户端通过 gr.load 调用）。如果 fn 为 None，则 api_visibility 将自动设置为 "private"。

🔗 
time_limit: int | None
默认 = None
🔗 
stream_every: float
默认 = 0.5
🔗 
key: int | str | tuple[int | str, ...] | None
默认 = None

此事件监听器的唯一键，用于 @gr.render()。如果设置，此值标识在重渲染时具有相同键的事件为相同的事件。

🔗 
validator: Callable | None
默认 = None

可选的验证函数，在主函数运行之前执行。如果提供，此函数将首先使用 queue=False 执行，只有在成功完成后才会调用主函数。验证器接收与主函数相同的输入，并应为每个输入值返回一个 `gr.validate()`。

←

ImageEditor

JSON

→
gradio