组件
Dataframe

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

ColorPicker

Dataset

Dataframe

gradio.Dataframe(···)

import gradio as gr with gr.Blocks() as demo: gr.Dataframe(value= [ [0, 1, True], [1, 0, False] ] , interactive=True) demo.launch()

描述

此组件显示一个类似电子表格的值表格组件。可用作输出组件显示数据，或用作输入组件从用户收集数据。

行为

作为输入组件: 将上传的电子表格数据作为 `pandas.DataFrame`、`numpy.array`、`polars.DataFrame` 或原生 2D Python `list[list]` 传递，具体取决于 `type`

您的函数应接受这些类型之一

def predict(
	value: pd.DataFrame | np.ndarray | pl.DataFrame | list[list]
)
	...

作为输出组件: 期望以下格式的数据：`pandas.DataFrame`、`pandas.Styler`、`numpy.array`、`polars.DataFrame`、`list[list]`、`list` 或带有键 'data'（和可选的 'headers'）的 `dict`，或 `str` csv 文件的路径，该路径将呈现为电子表格。

您的函数应返回这些类型之一

def predict(···) -> pd.DataFrame | Styler | np.ndarray | pl.DataFrame | list | list[list] | dict | str | None
	...	
	return value

初始化

🔗

value: pd.DataFrame | Styler | np.ndarray | pl.DataFrame | list | list[list] | dict | str | Callable | None

默认 = None

要在 DataFrame 中显示的默认值。支持 pandas、numpy、polars 和列表的列表。如果提供了 Styler，并且 `interactive` 为 False，则将使用它来设置 DataFrame 中显示的值（例如，设置数字精度）。如果提供了 Callable 函数，则将在应用加载时调用该函数以设置组件的初始值。

🔗

headers: list[str] | None

默认 = None

字符串标题名称列表。如果值没有标题，则这些名称用于设置数据框的列标题。如果为 None，则不显示标题。

🔗

row_count: int | tuple[int, str]

默认 = (1, 'dynamic')

限制输入的行数，并决定用户是否可以创建新行或删除现有行。元组的第一个元素是 `int`，即行数；第二个元素应为 'fixed' 或 'dynamic'，即新行行为。如果传递了 `int`，则行默认为 'dynamic'

🔗

col_count: int | tuple[int, str] | None

默认 = None

限制输入的列数，并决定用户是否可以创建新列或删除现有列。元组的第一个元素是 `int`，即列数；第二个元素应为 'fixed' 或 'dynamic'，即新列行为。如果传递了 `int`，则列默认为 'dynamic'

🔗

datatype: Literal['str', 'number', 'bool', 'date', 'markdown', 'html', 'image'] | list[Literal['str', 'number', 'bool', 'date', 'markdown', 'html']]

默认 = "str"

工作表中值的数据类型。可以为每列提供字符串列表，或者为整个工作表提供单个字符串。有效的数据类型为 "str"、"number"、"bool"、"date" 和 "markdown"。

🔗

type: Literal['pandas', 'numpy', 'array', 'polars']

默认 = "pandas"

组件返回的值的类型。"pandas" 表示 pandas 数据框，"numpy" 表示 numpy 数组，"polars" 表示 polars 数据框，或 "array" 表示 Python 列表的列表。

🔗

latex_delimiters: list[dict[str, str | bool]] | None

默认 = None

字典列表，格式为 {"left": 左分隔符 (str), "right": 右分隔符 (str), "display": 是否在新行中显示 (bool)}，将用于渲染 LaTeX 表达式。如果未提供，则 `latex_delimiters` 设置为 `[{ "left": "$$", "right": "$$", "display": True }]`，因此只有用 $$ 分隔符括起来的表达式将渲染为 LaTeX，并且在新行中显示。传入空列表以禁用 LaTeX 渲染。有关更多信息，请参阅 KaTeX 文档。仅适用于数据类型为 "markdown" 的列。

🔗

label: str | None

默认 = None

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

🔗

show_label: bool | None

默认 = None

如果为 True，将显示标签。

🔗

every: Timer | float | None

默认 = None

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

🔗

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

默认 = None

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

🔗

max_height: int | str

默认 = 500

数据框的最大高度，如果传递数字，则以像素为单位指定，如果传递字符串，则以 CSS 单位指定。如果创建的行数超过高度可以容纳的行数，则会出现滚动条。

🔗

scale: int | None

默认 = None

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

🔗

min_width: int

默认 = 160

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

🔗

interactive: bool | None

默认 = None

如果为 True，则允许用户编辑数据框；如果为 False，则只能用于显示数据。如果未提供，则根据组件是用作输入还是输出进行推断。

🔗

visible: bool

默认 = True

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

🔗

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 | None

默认 = None

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

🔗

wrap: bool

默认 = False

如果为 True，则表格单元格中的文本将在适当的时候换行。如果为 False 且未设置 `column_width` 参数，则列宽将根据单元格内容扩展，并且可能需要水平滚动表格。如果设置了 `column_width`，则任何溢出文本都将被隐藏。

🔗

line_breaks: bool

默认 = True

如果为 True（默认），则在聊天机器人消息中启用 Github 风格的 Markdown 换行符。如果为 False，则将忽略单个新行。仅适用于类型为 "markdown" 的列。

🔗

column_widths: list[str | int] | None

默认 = None

一个可选列表，表示每列的宽度。列表的元素应为 "100px" 格式（整数也被接受并转换为像素值）或 "10%"。百分比宽度根据表格的视口宽度计算。如果未提供，则列宽将根据单元格的内容自动确定。

🔗

show_fullscreen_button: bool

默认 = False

如果为 True，将显示一个按钮，以全屏模式查看表格中的值。

🔗

show_copy_button: bool

默认 = False

如果为 True，将显示一个按钮，将表格数据复制到剪贴板。

🔗

show_row_numbers: bool

默认 = False

如果为 True，将在单独的列中显示行号。

🔗

max_chars: int | None

默认 = None

在截断之前，每个单元格中显示的最大字符数（单击单元格值仍将显示完整内容）。如果为 None，则不应用截断。

🔗

show_search: Literal['none', 'search', 'filter']

默认 = "none"

在工具栏中显示搜索输入框。如果为 "search"，则显示搜索输入框。如果为 "filter"，则显示搜索输入框和过滤器按钮。如果为 "none"，则不显示搜索输入框。

🔗

pinned_columns: int | None

默认 = None

如果提供，将从左侧固定指定数量的列。

🔗

static_columns: list[int] | None

默认 = None

不应可编辑的列索引（int）列表。仅当 interactive=True 时适用。指定后，col_count 将自动设置为 "fixed"，并且无法插入或删除列。

快捷方式

类	Interface 字符串快捷方式	初始化
`gradio.Dataframe`	"dataframe"	使用默认值
`gradio.Numpy`	"numpy"	使用 type="numpy"
`gradio.Matrix`	"matrix"	使用 type="array"
`gradio.List`	"list"	使用 type="array", col_count=1

演示

import gradio as gr def filter_records(records, gender): return records[records["gender"] == gender] demo = gr.Interface( filter_records, [ gr.Dataframe( headers=["name", "age", "gender"], datatype=["str", "number", "str"], row_count=5, col_count=(3, "fixed"), ), gr.Dropdown(["M", "F", "O"]), ], "dataframe", description="输入性别，如 'M'、'F' 或 'O' 表示其他。", ) if __name__ == "__main__": demo.launch()

import gradio as gr

def filter_records(records, gender):
    return records[records["gender"] == gender]

demo = gr.Interface(
    filter_records,
    [
        gr.Dataframe(
            headers=["name", "age", "gender"],
            datatype=["str", "number", "str"],
            row_count=5,
            col_count=(3, "fixed"),
        ),
        gr.Dropdown(["M", "F", "O"]),
    ],
    "dataframe",
    description="Enter gender as 'M', 'F', or 'O' for other.",
)

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

import numpy as np import gradio as gr def transpose(matrix): return matrix.T demo = gr.Interface( transpose, gr.Dataframe(type="numpy", datatype="number", row_count=5, col_count=3, show_fullscreen_button=True), "numpy", examples=[ [np.zeros((30, 30)).tolist()], [np.ones((2, 2)).tolist()], [np.random.randint(0, 10, (3, 10)).tolist()], [np.random.randint(0, 10, (10, 3)).tolist()], [np.random.randint(0, 10, (10, 10)).tolist()], ], cache_examples=False ) if __name__ == "__main__": demo.launch()

import numpy as np

import gradio as gr

def transpose(matrix):
    return matrix.T

demo = gr.Interface(
    transpose,
    gr.Dataframe(type="numpy", datatype="number", row_count=5, col_count=3, show_fullscreen_button=True),
    "numpy",
    examples=[
        [np.zeros((30, 30)).tolist()],
        [np.ones((2, 2)).tolist()],
        [np.random.randint(0, 10, (3, 10)).tolist()],
        [np.random.randint(0, 10, (10, 3)).tolist()],
        [np.random.randint(0, 10, (10, 10)).tolist()],
    ],
    cache_examples=False
)

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

import gradio as gr def tax_calculator(income, marital_status, assets): tax_brackets = [(10, 0), (25, 8), (60, 12), (120, 20), (250, 30)] total_deductible = sum(assets["Cost"]) taxable_income = income - total_deductible total_tax = 0 for bracket, rate in tax_brackets: if taxable_income > bracket: total_tax += (taxable_income - bracket) * rate / 100 if marital_status == "Married": total_tax *= 0.75 elif marital_status == "Divorced": total_tax *= 0.8 return round(total_tax) demo = gr.Interface( tax_calculator, [ "number", gr.Radio(["Single", "Married", "Divorced"]), gr.Dataframe( headers=["Item", "Cost"], datatype=["str", "number"], label="今年购买的资产", ), ], "number", examples=[ [10000, "Married", [["Suit", 5000], ["Laptop", 800], ["Car", 1800]]], [80000, "Single", [["Suit", 800], ["Watch", 1800], ["Car", 800]]], ], ) demo.launch()

import gradio as gr

def tax_calculator(income, marital_status, assets):
    tax_brackets = [(10, 0), (25, 8), (60, 12), (120, 20), (250, 30)]
    total_deductible = sum(assets["Cost"])
    taxable_income = income - total_deductible

    total_tax = 0
    for bracket, rate in tax_brackets:
        if taxable_income > bracket:
            total_tax += (taxable_income - bracket) * rate / 100

    if marital_status == "Married":
        total_tax *= 0.75
    elif marital_status == "Divorced":
        total_tax *= 0.8

    return round(total_tax)

demo = gr.Interface(
    tax_calculator,
    [
        "number",
        gr.Radio(["Single", "Married", "Divorced"]),
        gr.Dataframe(
            headers=["Item", "Cost"],
            datatype=["str", "number"],
            label="Assets Purchased this Year",
        ),
    ],
    "number",
    examples=[
        [10000, "Married", [["Suit", 5000], ["Laptop", 800], ["Car", 1800]]],
        [80000, "Single", [["Suit", 800], ["Watch", 1800], ["Car", 800]]],
    ],
)

demo.launch()

import gradio as gr def sort_records(records): return records.sort("Quantity") demo = gr.Interface( sort_records, gr.Dataframe( headers=["Item", "Quantity"], datatype=["str", "number"], row_count=3, col_count=(2, "fixed"), type="polars" ), "dataframe", description="按数量排序" ) if __name__ == "__main__": demo.launch()

import gradio as gr

def sort_records(records):
    return records.sort("Quantity")

demo = gr.Interface(
    sort_records,
    gr.Dataframe(
        headers=["Item", "Quantity"],
        datatype=["str", "number"],
        row_count=3,
        col_count=(2, "fixed"),
        type="polars"
    ),
    "dataframe",
    description="Sort by Quantity"
)

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

事件侦听器

描述

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

支持的事件侦听器

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

侦听器	描述
`Dataframe.change(fn, ···)`	当 Dataframe 的值由于用户输入（例如，用户在文本框中键入内容）或函数更新（例如，图像从事件触发器的输出接收值）而更改时触发。有关仅由用户输入触发的侦听器，请参阅 `.input()`。
`Dataframe.input(fn, ···)`	当用户更改 Dataframe 的值时，将触发此侦听器。
`Dataframe.select(fn, ···)`	用户选择或取消选择 Dataframe 时的事件侦听器。使用事件数据 gradio.SelectData 来携带 `value`，指的是 Dataframe 的标签，以及 `selected`，指的是 Dataframe 的状态。请参阅 EventData 文档，了解如何使用此事件数据

事件参数

🔗

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']

默认 = "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，表示没有 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。

🔗