Gradio 的月活用户达到 100 万啦！

阅读更多
Gradio logo
  1. 组件
  2. LinePlot

Gradio 新手？从这里开始： 入门指南

查看发布历史

←

Label

LoginButton

→

LinePlot

gradio.LinePlot(···)
import gradio as gr import pandas as pd import numpy as np simple = pd.DataFrame(np.array( [ [1, 28], [2, 55], [3, 43], [4, 91], [5, 81], [6, 53], [7, 19], [8, 87], [9, 52], ] ), columns=["week", "price"]) with gr.Blocks() as demo: gr.LinePlot( value=simple, x="week", y="price", title="Stock Price Chart", container=True, width=400 ) demo.launch()pandas numpy

描述

创建一个折线图组件，用于显示来自 pandas DataFrame 的数据。

行为

作为输入组件: 要在折线图中显示的数据。

您的函数应接受以下类型之一
def predict(
	value: AltairPlotData | None
)
	...

作为输出组件: 期望一个 pandas DataFrame，其中包含要在折线图中显示的数据。DataFrame 应至少包含两列，一列用于 x 轴（对应于此组件的 x 参数），另一列用于 y 轴（对应于 y）。

您的函数应返回以下类型之一
def predict(···) -> pd.DataFrame | dict | None
	...	
	return value

初始化

参数
🔗 
value: pd.DataFrame | Callable | None
default = None

包含要在图中显示的数据的 pandas 数据帧。

🔗 
x: str | None
default = None

对应于 x 轴的列。列可以是数值、日期时间或字符串/类别。

🔗 
y: str | None
default = None

对应于 y 轴的列。列必须是数值。

🔗 
color: str | None
default = None

对应于系列的列，通过颜色可视化。列必须是字符串/类别。

🔗 
title: str | None
default = None

显示在图表顶部的标题。

🔗 
x_title: str | None
default = None

赋予 x 轴的标题。默认情况下，使用 x 参数的值。

🔗 
y_title: str | None
default = None

赋予 y 轴的标题。默认情况下，使用 y 参数的值。

🔗 
color_title: str | None
default = None

赋予颜色图例的标题。默认情况下，使用 color 参数的值。

🔗 
x_bin: str | float | None
default = None

用于聚类 x 值的分组。如果 x 列是数值，则应该是对 x 值进行分箱的数字。如果 x 列是日期时间，则应该是字符串，例如 "1h"、"15m"、"10s"，使用 "s"、"m"、"h"、"d" 后缀。

🔗 
y_aggregate: Literal['sum', 'mean', 'median', 'min', 'max', 'count'] | None
default = None

用于聚合 y 值的聚合函数，如果提供了 x_bin 或 x 是字符串/类别，则使用该函数。必须是 "sum"、"mean"、"median"、"min"、"max" 之一。

🔗 
color_map: dict[str, str] | None
default = None

系列到颜色名称或代码的映射。例如，{"success": "green", "fail": "#FF8888"}。

🔗 
x_lim: list[float] | None
default = None

包含 x 轴限制的元组或列表，指定为 [x_min, x_max]。如果 x 列是日期时间类型，则 x_lim 应该是时间戳。

🔗 
y_lim: list[float] | None
default = None

包含 y 轴限制的元组或列表，指定为 [y_min, y_max]。

🔗 
x_label_angle: float
default = 0

x 轴标签以度为单位顺时针偏移的角度。

🔗 
y_label_angle: float
default = 0

y 轴标签以度为单位顺时针偏移的角度。

🔗 
x_axis_labels_visible: bool
default = True

x 轴标签是否应该可见。当存在许多 x 轴标签时可以隐藏。

🔗 
caption: str | None
default = None

显示在图表下方的（可选）标题。

🔗 
sort: Literal['x', 'y', '-x', '-y'] | list[str] | None
default = None

x 值的排序顺序，如果 x 列是字符串/类别类型。可以是 "x"、"y"、"-x"、"-y"，或表示类别顺序的字符串列表。

🔗 
tooltip: Literal['axis', 'none', 'all'] | list[str]
default = "axis"

当悬停在点上时显示的工具提示。"axis" 显示轴列的值，"all" 显示所有列值，"none" 不显示工具提示。也可以提供表示要在工具提示中显示的列的字符串列表，这些列将与轴值一起显示。

🔗 
height: int | None
default = None

图表的高度，以像素为单位。

🔗 
label: str | None
default = None

显示在图表左上角的（可选）标签。

🔗 
show_label: bool | None
default = None

是否应显示标签。

🔗 
container: bool
default = True

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

🔗 
scale: int | None
default = None

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

🔗 
min_width: int
default = 160

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

🔗 
every: Timer | float | None
default = None

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

🔗 
inputs: Component | list[Component] | Set[Component] | None
default = None

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

🔗 
visible: bool
default = True

图表是否应该可见。

🔗 
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 | None
default = None

如果已分配，将用于在重新渲染中假定身份。在重新渲染中具有相同 key 的组件将保留其值。

快捷方式

类 Interface 字符串快捷方式 初始化

gradio.LinePlot

"lineplot"

 使用默认值

演示

import pandas as pd
from random import randint, random
import gradio as gr


temp_sensor_data = pd.DataFrame(
    {
        "time": pd.date_range("2021-01-01", end="2021-01-05", periods=200),
        "temperature": [randint(50 + 10 * (i % 2), 65 + 15 * (i % 2)) for i in range(200)],
        "humidity": [randint(50 + 10 * (i % 2), 65 + 15 * (i % 2)) for i in range(200)],
        "location": ["indoor", "outdoor"] * 100,
    }
)

food_rating_data = pd.DataFrame(
    {
        "cuisine": [["Italian", "Mexican", "Chinese"][i % 3] for i in range(100)],
        "rating": [random() * 4 + 0.5 * (i % 3) for i in range(100)],
        "price": [randint(10, 50) + 4 * (i % 3) for i in range(100)],
        "wait": [random() for i in range(100)],
    }
)

with gr.Blocks() as line_plots:
    with gr.Row():
        start = gr.DateTime("2021-01-01 00:00:00", label="Start")
        end = gr.DateTime("2021-01-05 00:00:00", label="End")
        apply_btn = gr.Button("Apply", scale=0)
    with gr.Row():
        group_by = gr.Radio(["None", "30m", "1h", "4h", "1d"], value="None", label="Group by")
        aggregate = gr.Radio(["sum", "mean", "median", "min", "max"], value="sum", label="Aggregation")

    temp_by_time = gr.LinePlot(
        temp_sensor_data,
        x="time",
        y="temperature",
    )
    temp_by_time_location = gr.LinePlot(
        temp_sensor_data,
        x="time",
        y="temperature",
        color="location",
    )

    time_graphs = [temp_by_time, temp_by_time_location]
    group_by.change(
        lambda group: [gr.LinePlot(x_bin=None if group == "None" else group)] * len(time_graphs),
        group_by,
        time_graphs
    )
    aggregate.change(
        lambda aggregate: [gr.LinePlot(y_aggregate=aggregate)] * len(time_graphs),
        aggregate,
        time_graphs
    )

    def rescale(select: gr.SelectData):
        return select.index
    rescale_evt = gr.on([plot.select for plot in time_graphs], rescale, None, [start, end])

    for trigger in [apply_btn.click, rescale_evt.then]:
        trigger(
            lambda start, end: [gr.LinePlot(x_lim=[start, end])] * len(time_graphs), [start, end], time_graphs
        )

    price_by_cuisine = gr.LinePlot(
        food_rating_data,
        x="cuisine",
        y="price",
    )
    with gr.Row():
        price_by_rating = gr.LinePlot(
            food_rating_data,
            x="rating",
            y="price",
        )
        price_by_rating_color = gr.LinePlot(
            food_rating_data,
            x="rating",
            y="price",
            color="cuisine",
            color_map={"Italian": "red", "Mexican": "green", "Chinese": "blue"},
        )

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

事件监听器

描述

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

支持的事件监听器

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

监听器 描述

LinePlot.select(fn, ···)

用户选择或取消选择 NativePlot 时的事件侦听器。使用事件数据 gradio.SelectData 来携带 value，指代 NativePlot 的标签，以及 selected，指代 NativePlot 的状态。请参阅 EventData 文档，了解如何使用此事件数据

LinePlot.double_click(fn, ···)

当双击 NativePlot 时触发。

事件参数

参数
🔗 
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

在运行 'fn' 之前要运行的可选前端 js 方法。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
←

Label

LoginButton

→