组件
Plot

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

ParamViewer

Radio

Plot

gradio.Plot(···)

import gradio as gr import matplotlib.pyplot as plt import numpy as np Fs = 8000 f = 5 sample = 8000 x = np.arange(sample) y = np.sin(2 * np.pi * f * x / Fs) plt.plot(x, y) with gr.Blocks() as demo: gr.Plot(value=plt, format="png") demo.launch()matplotlib numpy

描述

创建一个绘图组件来显示各种类型的图表（支持 matplotlib, plotly, altair 或 bokeh 图表）。由于此组件不接受用户输入，因此很少用作输入组件。

行为

作为输入组件: （很少使用）将图中显示的数据作为 PlotData 数据类传递，其中包含图表信息（JSON 字符串形式），以及图表类型和绘图库。

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

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

作为输出组件: 期望以下格式的图表数据：matplotlib.Figure、bokeh.Model、plotly.Figure 或 altair.Chart 对象。

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

def predict(···) -> Any
	...	
	return value

初始化

🔗

value: Any | None

default = None

可选地，提供一个要显示的默认图表对象，必须是 matplotlib、plotly、altair 或 bokeh 图形，或者是一个可调用对象。如果提供了函数，则每次应用程序加载时都会调用该函数以设置此组件的初始值。

🔗

format: str

default = "webp"

将 matplotlib 图表发送到前端的文件格式，例如“jpg”或“png”。

🔗

label: str | I18nData | None

default = None

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

🔗

every: Timer | float | None

default = None

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

🔗

inputs: Component | list[Component] | set[Component] | None

default = None

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

🔗

show_label: bool | None

default = None

如果为 True，将显示标签。

🔗

container: bool

default = True

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

🔗

scale: int | None

default = None

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

🔗

min_width: int

default = 160

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

🔗

visible: bool

default = True

如果为 False，组件将被隐藏。

🔗

elem_id: str | None

default = None

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

🔗

elem_classes: list[str] | str | None

default = None

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

🔗

render: bool

default = True

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

🔗

key: int | str | tuple[int | str, ...] | None

default = None

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

🔗

preserved_by_key: list[str] | str | None

default = "value"

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

快捷方式

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

演示

import pandas as pd import numpy as np import gradio as gr def plot(v, a): g = 9.81 theta = a / 180 * 3.14 tmax = ((2 * v) * np.sin(theta)) / g timemat = tmax * np.linspace(0, 1, 40) x = (v * timemat) * np.cos(theta) y = ((v * timemat) * np.sin(theta)) - ((0.5 * g) * (timemat**2)) df = pd.DataFrame({"x": x, "y": y}) return df demo = gr.Blocks() with demo: gr.Markdown( r"让我们做一些运动学！选择速度和角度以查看轨迹。记住射程 $R = v_0^2 \cdot \frac{\sin(2\theta)}{g}$" ) with gr.Row(): speed = gr.Slider(1, 30, 25, label="速度") angle = gr.Slider(0, 90, 45, label="角度") output = gr.LinePlot( x="x", y="y", overlay_point=True, tooltip=["x", "y"], x_lim=[0, 100], y_lim=[0, 60], width=350, height=300, ) btn = gr.Button(value="运行") btn.click(plot, [speed, angle], output) if __name__ == "__main__": demo.launch()

import pandas as pd
import numpy as np

import gradio as gr

def plot(v, a):
    g = 9.81
    theta = a / 180 * 3.14
    tmax = ((2 * v) * np.sin(theta)) / g
    timemat = tmax * np.linspace(0, 1, 40)

    x = (v * timemat) * np.cos(theta)
    y = ((v * timemat) * np.sin(theta)) - ((0.5 * g) * (timemat**2))
    df = pd.DataFrame({"x": x, "y": y})
    return df

demo = gr.Blocks()

with demo:
    gr.Markdown(
        r"Let's do some kinematics! Choose the speed and angle to see the trajectory. Remember that the range $R = v_0^2 \cdot \frac{\sin(2\theta)}{g}$"
    )

    with gr.Row():
        speed = gr.Slider(1, 30, 25, label="Speed")
        angle = gr.Slider(0, 90, 45, label="Angle")
    output = gr.LinePlot(
        x="x",
        y="y",
        overlay_point=True,
        tooltip=["x", "y"],
        x_lim=[0, 100],
        y_lim=[0, 60],
        width=350,
        height=300,
    )
    btn = gr.Button(value="Run")
    btn.click(plot, [speed, angle], output)

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

import matplotlib.pyplot as plt import numpy as np import gradio as gr def plot_forecast(final_year, companies, noise, show_legend, point_style): start_year = 2020 x = np.arange(start_year, final_year + 1) year_count = x.shape[0] plt_format = ({"cross": "X", "line": "-", "circle": "o--"})[point_style] fig = plt.figure() ax = fig.add_subplot(111) for i, company in enumerate(companies): series = np.arange(0, year_count, dtype=float) series = series**2 * (i + 1) series += np.random.rand(year_count) * noise ax.plot(x, series, plt_format) if show_legend: plt.legend(companies) return fig demo = gr.Interface( plot_forecast, [ gr.Radio([2025, 2030, 2035, 2040], label="预测至:"), gr.CheckboxGroup(["Google", "Microsoft", "Gradio"], label="公司选择"), gr.Slider(1, 100, label="噪声水平"), gr.Checkbox(label="显示图例"), gr.Dropdown(["cross", "line", "circle"], label="样式"), ], gr.Plot(label="预测", format="png"), ) if __name__ == "__main__": demo.launch()

import matplotlib.pyplot as plt
import numpy as np

import gradio as gr

def plot_forecast(final_year, companies, noise, show_legend, point_style):
    start_year = 2020
    x = np.arange(start_year, final_year + 1)
    year_count = x.shape[0]
    plt_format = ({"cross": "X", "line": "-", "circle": "o--"})[point_style]
    fig = plt.figure()
    ax = fig.add_subplot(111)
    for i, company in enumerate(companies):
        series = np.arange(0, year_count, dtype=float)
        series = series**2 * (i + 1)
        series += np.random.rand(year_count) * noise
        ax.plot(x, series, plt_format)
    if show_legend:
        plt.legend(companies)
    return fig

demo = gr.Interface(
    plot_forecast,
    [
        gr.Radio([2025, 2030, 2035, 2040], label="Project to:"),
        gr.CheckboxGroup(["Google", "Microsoft", "Gradio"], label="Company Selection"),
        gr.Slider(1, 100, label="Noise Level"),
        gr.Checkbox(label="Show Legend"),
        gr.Dropdown(["cross", "line", "circle"], label="Style"),
    ],
    gr.Plot(label="forecast", format="png"),
)

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

事件监听器

描述

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

支持的事件监听器

Plot 组件支持以下事件监听器。每个事件监听器接受相同的参数，这些参数列在下面的事件参数表中。

监听器	描述
`Plot.change(fn, ···)`	当 Plot 的值因用户输入（例如用户在文本框中键入）或函数更新（例如图像从事件触发器的输出接收值）而改变时触发。有关仅由用户输入触发的监听器，请参阅 `.input()`。

事件参数

🔗

fn: Callable | None | Literal['decorator']

default = "decorator"

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

🔗

inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None

default = None

用作输入的 gradio.components 列表。如果函数没有输入，则应为空列表。

🔗

outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None

default = None

用作输出的 gradio.components 列表。如果函数没有输出，则应为空列表。

🔗

api_name: str | None | Literal[False]

default = None

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

🔗

scroll_to_output: bool

default = False

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

🔗

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

default = "full"

事件运行时如何显示进度动画：“full”显示一个覆盖输出组件区域和右上角运行时显示的旋转器，“minimal”仅显示运行时显示，“hidden”根本不显示进度动画。

🔗

show_progress_on: Component | list[Component] | None

default = None

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

🔗

queue: bool

default = True

如果为 True，并且已启用队列，则会将请求放入队列。如果为 False，即使队列已启用，也不会将此事件放入队列。如果为 None，将使用 gradio 应用程序的队列设置。

🔗

batch: bool

default = False

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

🔗

max_batch_size: int

default = 4

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

🔗

preprocess: bool

default = True

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

🔗

postprocess: bool

default = True

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

🔗

cancels: dict[str, Any] | list[dict[str, Any]] | None

default = None

当此监听器触发时要取消的其他事件列表。例如，设置 cancels=[click_event] 将取消 click_event，其中 click_event 是另一个组件的 .click 方法的返回值。尚未运行的函数（或正在迭代的生成器）将被取消，但当前正在运行的函数将被允许完成。

🔗

trigger_mode: Literal['once', 'multiple', 'always_last'] | None

default = None

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

🔗

js: str | Literal[True] | None

default = None

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

🔗

concurrency_limit: int | None | Literal['default']

default = "default"

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

🔗

concurrency_id: str | None

default = None

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

🔗

show_api: bool

default = True

是否在 Gradio 应用程序的“查看 API”页面或 Gradio 客户端的“.view_api()”方法中显示此事件。与将 api_name 设置为 False 不同，将 show_api 设置为 False 仍将允许下游应用程序和客户端使用此事件。如果 fn 为 None，show_api 将自动设置为 False。

🔗

time_limit: int | None

default = None

🔗

stream_every: float

default = 0.5

🔗

like_user_message: bool

default = False

🔗

key: int | str | tuple[int | str, ...] | None

default = None

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

指南

用于地图的 Plot 组件

←

ParamViewer

Radio

→