组件
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()

描述

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

行为

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

您的函数应接受其中一种类型

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`，或者 CSV 文件的 `str` 路径，该路径会渲染为电子表格。

您的函数应返回其中一种类型

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 中显示的值（例如设置数字的精度）。如果提供了可调用函数，该函数将在应用程序加载时被调用，以设置组件的初始值。

🔗

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"

表格中值的D数据类型。可以作为字符串列表按列提供，或者作为单个字符串用于整个表格。有效的数据类型有 "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 | I18nData | 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

最小像素宽度，如果屏幕空间不足以满足此值，则会换行。如果某个比例值导致此组件窄于 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 | tuple[int | str, ...] | None

默认值 = None

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

🔗

preserved_by_key: list[str] | str | None

默认值 = "value"

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

🔗

wrap: bool

默认值 = False

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

🔗

line_breaks: bool

默认值 = True

如果为 True（默认），将启用 chatbot 消息中的 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="Enter gender as 'M', 'F', or 'O' for other.", ) 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="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 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="Sort by Quantity" ) 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 来携带指向 Dataframe 标签的 `value`，以及指向 Dataframe 状态的 `selected`。有关如何使用此事件数据，请参阅 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

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

🔗

show_api: bool

默认值 = True

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

🔗

time_limit: int | None

默认值 = None

🔗

stream_every: float

默认值 = 0.5

🔗

like_user_message: bool

默认值 = False

🔗

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

默认值 = None

此事件监听器的唯一键，用于 @gr.render()。如果设置，当 key 相同，此值将标识为跨重新渲染的相同事件。

←

ColorPicker

Dataset

→

Dataframe

描述

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

行为

作为输入组件: 根据 type 的设置，将上传的电子表格数据作为 pandas.DataFrame、numpy.array、polars.DataFrame 或原生的 2D Python list[list] 传递。

您的函数应接受其中一种类型

作为输出组件: 期望的数据格式包括：pandas.DataFrame、pandas.Styler、numpy.array、polars.DataFrame、list[list]、list，或带有 'data'（以及可选 'headers'）键的 dict，或者 CSV 文件的 str 路径，该路径会渲染为电子表格。

您的函数应返回其中一种类型

初始化

快捷方式

演示

事件监听器

描述

支持的事件监听器

事件参数

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

作为输出组件: 期望的数据格式包括：`pandas.DataFrame`、`pandas.Styler`、`numpy.array`、`polars.DataFrame`、`list[list]`、`list`，或带有 'data'（以及可选 'headers'）键的 `dict`，或者 CSV 文件的 `str` 路径，该路径会渲染为电子表格。