1. 组件
  2. 条形图

刚开始使用 Gradio? 从这里开始: 入门指南

查看 发布历史

条形图

gradio.BarPlot(···)

描述

创建一个条形图组件,用于显示 pandas DataFrame 中的数据。

行为

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

您的函数应接受其中一种类型
def predict(
	value: AltairPlotData
)
	...

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

您的函数应返回其中一种类型
def predict(···) -> pd.DataFrame | None
	...	
	return value

初始化

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

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

🔗
x: str | None
默认 = None

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

🔗
y: str | None
默认 = None

对应 y 轴的列。列必须是数字。

🔗
color: str | None
默认 = None

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

🔗
title: str | None
默认 = None

要显示在图表顶部的标题。

🔗
x_title: str | None
默认 = None

为 x 轴提供的标题。默认情况下,使用 x 参数的值。

🔗
y_title: str | None
默认 = None

为 y 轴提供的标题。默认情况下,使用 y 参数的值。

🔗
color_title: str | None
默认 = None

为颜色图例提供的标题。默认情况下,使用 color 参数的值。

🔗
x_bin: str | float | None
默认 = None

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

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

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

🔗
color_map: dict[str, str] | None
默认 = None

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

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

包含要在图例中显示的系列的列名列表。默认情况下,显示所有系列。

🔗
x_lim: list[float | None] | None
默认 = None

一个元组或列表,包含 x 轴的限制,指定为 [x_min, x_max]。要仅固定其中一个值,请将另一个设置为 None,例如 [0, None] 从 0 缩放到最大值。如果 x 列是日期时间类型,x_lim 应该是时间戳。

🔗
y_lim: list[float | None]
默认 = None

一个元组或列表,包含 y 轴的限制,指定为 [y_min, y_max]。要仅固定其中一个值,请将另一个设置为 None,例如 [0, None] 从 0 缩放到最大值。

🔗
x_label_angle: float
默认 = 0

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

🔗
y_label_angle: float
默认 = 0

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

🔗
x_axis_format: str | None
默认 = None

x 轴标签的 d3 格式字符串(例如,“.2e”表示科学计数法,“~g”表示通用格式)。如果为 None,则使用 Vega-Lite 的默认格式。

🔗
y_axis_format: str | None
默认 = None

y 轴标签的 d3 格式字符串(例如,“.2e”表示科学计数法,“~g”表示通用格式)。如果为 None,则使用 Vega-Lite 的默认格式。

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

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

🔗
caption: str | I18nData | None
默认 = None

显示在图表下方的(可选)标题。

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

x 值(如果 x 列为字符串/类别类型)的排序顺序。可以是“x”、“y”、“-x”、“-y”,或代表类别顺序的字符串列表。

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

悬停在某点时显示的工具提示。“axis”显示轴列的值,“all”显示所有列的值,“none”显示无工具提示。也可以提供一个字符串列表,表示要在工具提示中显示的列,这些列将与轴值一起显示。

🔗
height: int | None
默认 = None

图的高度(以像素为单位)。

🔗
label: str | I18nData | None
默认 = None

显示在图表左上角的(可选)标签。

🔗
show_label: bool | None
默认 = None

是否显示标签。

🔗
container: bool
默认 = True

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

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

🔗
every: Timer | float | None
默认 = None

持续调用 `value` 来重新计算它(如果 `value` 是一个函数,否则无效)。可以提供一个 Timer,其滴答声会重置 `value`,或者提供一个浮点数来为重置 Timer 提供常规间隔。

🔗
inputs: Component | list[Component] | Set[Component] | None
默认 = None

用作计算 `value` 的输入的组件(如果 `value` 是一个函数,否则无效)。`value` 在输入更改时会重新计算。

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

图是否可见。

🔗
elem_id: str | None
默认 = None

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

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

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

🔗
render: bool
默认 = True

如果为 False,则组件不会在 Blocks 上下文中渲染。如果打算现在分配事件监听器,但稍后渲染组件,则应使用此选项。

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

要为组件显示的按钮列表。有效选项为“fullscreen”、“export”,或 gr.Button() 实例。“fullscreen”按钮允许用户全屏查看图表。“export”按钮允许用户将当前图表视图导出并下载为 PNG 图像。自定义的 gr.Button() 实例将显示在工具栏中,并带有其配置的图标和/或标签,单击它们将触发在按钮上注册的任何 .click() 事件。默认情况下,不显示任何按钮。

🔗
key: int | str | tuple[int | str, ...] | None
默认 = None

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

🔗
preserved_by_key: list[str] | str | None
默认 = "value"

此组件构造函数中的参数列表。在 `gr.render()` 函数内部,如果一个组件使用相同的键进行重渲染,则这些(也是唯一的)参数将在 UI 中被保留(如果它们已被用户或事件监听器更改),而不是根据构造函数中提供的值进行重渲染。

快捷方式

快捷方式
gradio.BarPlot
界面字符串快捷方式 "barplot"
初始化 使用默认值

演示

事件监听器

描述

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

支持的事件监听器

BarPlot 组件支持以下事件监听器。每个事件监听器都接受相同的参数,这些参数在下表 事件参数 中列出。

监听器
BarPlot.select(fn, ···)

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

BarPlot.double_click(fn, ···)

NativePlot 双击时触发。

事件参数

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