1. 组件
  2. 数据框

刚开始使用 Gradio？ 从这里开始： 入门指南

查看 发布历史

←

颜色选择器

数据集

→

数据框

gradio.Dataframe(···)

描述

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

行为

作为输入组件: 根据 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 和 list of lists。如果提供了 Styler，它将被用于设置 DataFrame 中显示的值（例如，设置数字的精度），前提是 `interactive` 为 False。如果提供了 Callable 函数，则该函数将在每次应用加载时被调用以设置组件的初始值。

🔗 
headers: list[str] | None
默认 = None

字符串列表，包含列名。如果值没有列标题，将使用它们来设置数据框的列标题。如果为 None，则不显示任何标题。

🔗 
row_count: int | None
默认 = None

在数据框中初始显示的行数。如果为 None，则行数将根据 `value` 自动确定。

🔗 
row_limits: tuple[int | None, int | None] | None
默认 = None

一个包含两个整数的元组，指定可以通过 UI 在数据框中创建的最小和最大行数。如果第一个元素为 None，则没有最小行数。如果第二个元素为 None，则没有最大行数。仅在 `interactive` 为 True 时适用。

🔗 
col_count: None
默认 = None

此参数已弃用。请使用 `column_count` 代替。

🔗 
column_count: int | None
默认 = None

在数据框中初始显示的列数。如果为 None，则列数将根据 `value` 自动确定。

🔗 
column_limits: tuple[int | None, int | None] | None
默认 = None

一个包含两个整数的元组，指定可以通过 UI 在数据框中创建的最小和最大列数。如果第一个元素为 None，则没有最小列数。如果第二个元素为 None，则没有最大列数。仅在 `interactive` 为 True 时适用。

🔗 
datatype: Literal['str', 'number', 'bool', 'date', 'markdown', 'html', 'image', 'auto'] | list[Literal['str', 'number', 'bool', 'date', 'markdown', 'html']]
默认 = "str"

表格中的值的数据类型。可以按列提供字符串列表，或作为单个字符串为整个表格提供。有效数据类型为 "str"、"number"、"bool"、"date" 和 "markdown"。布尔列将显示为复选框。如果使用 "auto" 数据类型，则根据值输入自动选择列数据类型（如果可能）。

🔗 
type: Literal['pandas', 'numpy', 'array', 'polars']
默认 = "pandas"

组件返回的值的类型。"pandas" 表示 pandas DataFrame，"numpy" 表示 numpy 数组，"polars" 表示 polars DataFrame，"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 在一个 Row 中，A 的 scale 为 2，B 的 scale 为 1，则 A 的宽度将是 B 的两倍。应为整数。scale 适用于 Rows，以及 Blocks 中 fill_height=True 的顶级组件。

🔗 
min_width: int
默认 = 160

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

🔗 
interactive: bool | None
默认 = None

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

🔗 
visible: bool | Literal['hidden']
默认 = True

如果为 False，则组件将隐藏。如果为“hidden”，则组件将视觉上隐藏并且不会在布局中占用空间，但仍存在于 DOM 中。

🔗 
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` 中，跨重渲染具有相同键的组件被视为同一个组件，而不是一个新组件。在 `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（默认），将在聊天机器人消息中启用 GitHub 风味的 Markdown 换行。如果为 False，将忽略单换行。仅适用于 "markdown" 类型的列。

🔗 
column_widths: list[str | int] | None
默认 = None

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

🔗 
buttons: list[Literal['fullscreen', 'copy']] | None
默认 = None

要在组件右上角显示的按钮列表。有效选项为 "fullscreen"（全屏）和 "copy"（复制）。"fullscreen" 按钮允许用户以全屏模式查看表格。"copy" 按钮允许用户将表格数据复制到剪贴板。默认情况下，所有按钮都显示。

🔗 
show_row_numbers: bool
默认 = False

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

🔗 
max_chars: int | None
默认 = None

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

🔗 
pinned_columns: int | None
默认 = None

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

🔗 
static_columns: list[int] | None
默认 = None

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

快捷方式

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

演示

事件监听器

描述

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

支持的事件监听器

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

监听器
Dataframe.change(fn, ···)

当 DataFrame 的值发生变化时触发，无论是由于用户输入（例如，用户在文本框中键入）还是由于函数更新（例如，一个图像从事件触发器的输出接收到一个值）。请参阅 .input() 以获取仅由用户输入触发的监听器。

Dataframe.input(fn, ···)

当用户更改 DataFrame 的值时触发此监听器。

Dataframe.select(fn, ···)

用户选择或取消选择 DataFrame 时的事件监听器。使用事件数据 gradio.SelectData 来传递引用 DataFrame 标签的 value，以及引用 DataFrame 状态的 selected。有关更多详细信息，请参阅 https://gradio.org.cn/docs/gradio/eventdata。

Dataframe.edit(fn, ···)

当用户使用内置编辑器编辑 DataFrame（例如图像）时触发此监听器。

事件参数

参数
🔗 
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
默认 = None

定义该端点在 API 文档中如何显示。可以是字符串或 None。如果设置为字符串，则该端点将在 API 文档中以给定名称显示。如果为 None（默认），则使用函数的名称作为 API 端点。

🔗 
api_description: str | None | Literal[False]
默认 = None

API 端点的描述。可以是字符串、None 或 False。如果设置为字符串，则该端点将在 API 文档中以给定描述显示。如果为 None，则使用函数的 docstring 作为 API 端点描述。如果为 False，则 API 文档中不会显示任何描述。

🔗 
scroll_to_output: bool
默认 = False

完成后是否滚动到输出组件

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

🔗 
concurrency_id: str | None
默认 = None

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

🔗 
api_visibility: Literal['public', 'private', 'undocumented']
默认 = "public"

控制此端点的可见性和可访问性。可以是 "public"（在 API 文档中显示并可由客户端调用）、"private"（在 API 文档中隐藏，不可由客户端调用）或 "undocumented"（在 API 文档中隐藏，但可由客户端通过 gr.load 调用）。如果 fn 为 None，则 api_visibility 将自动设置为 "private"。

🔗 
time_limit: int | None
默认 = None
🔗 
stream_every: float
默认 = 0.5
🔗 
key: int | str | tuple[int | str, ...] | None
默认 = None

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

🔗 
validator: Callable | None
默认 = None

可选的验证函数，在主函数运行之前执行。如果提供，此函数将首先使用 queue=False 执行，只有在成功完成后才会调用主函数。验证器接收与主函数相同的输入，并应为每个输入值返回一个 `gr.validate()`。

←

颜色选择器

数据集

→
gradio