组件
定时器

Gradio 新手？从这里开始：快速入门

Textbox

UploadButton

定时器

gradio.Timer(···)

描述

特殊的组件，激活时会定期触发。它不可见，仅用于通过 `tick` 事件监听器以固定间隔触发事件。

行为

作为输入组件: 定时器的时间间隔，以浮点数表示。

你的函数应该接受以下类型之一

def predict(
	value: float | None
)
	...

作为输出组件: 定时器的时间间隔，以浮点数或 None 表示。

你的函数应该返回以下类型之一

def predict(···) -> float | None
	...	
	return value

初始化

🔗

value: float

默认值 = 1

每次触发之间的时间间隔，以秒为单位。

🔗

active: bool

默认值 = True

定时器是否激活。

🔗

render: bool

默认值 = True

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

快捷方式

类	Interface 字符串快捷方式	初始化
`gradio.Timer`	"timer"	使用默认值

事件监听器

描述

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

支持的事件监听器

Timer 组件支持以下事件监听器。每个事件监听器都采用相同的参数，这些参数在下面的事件参数表中列出。

监听器	描述
`Timer.tick(fn, ···)`	此监听器在 Timer 定义的固定时间间隔触发。

事件参数

🔗

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 | Literal[False]

默认值 = None

定义端点在 API 文档中的显示方式。可以是字符串、None 或 False。如果设置为字符串，则端点将以给定的名称在 API 文档中公开。如果为 None（默认值），则函数的名称将用作 API 端点。如果为 False，则端点将不会在 API 文档中公开，下游应用（包括 `gr.load` 此应用的应用）将无法使用此事件。

🔗

scroll_to_output: bool

默认值 = False

如果为 True，则在完成时滚动到输出组件

🔗

show_progress: Literal['full', 'minimal', 'hidden']

默认值 = "hidden"

事件运行时如何显示进度动画：“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 表示没有 concurrency_limit（可以同时运行任意数量的此事件）。设置为 "default" 以使用默认并发限制（由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义，该参数本身默认为 1）。

🔗

concurrency_id: str | None

默认值 = None

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

🔗

show_api: bool

默认值 = True

是否在 Gradio 应用的 "view API" 页面或 Gradio 客户端的 ".view_api()" 方法中显示此事件。与将 api_name 设置为 False 不同，将 show_api 设置为 False 仍然允许下游应用以及客户端使用此事件。如果 fn 为 None，则 show_api 将自动设置为 False。

🔗