显示一个多选小部件。

多选小部件开始时为空。

函数签名[source]

st.multiselect(label, 选项, 默认=None, format_func=special_internal_function, key=None, 帮助=None, on_change=None, args=None, kwargs=None, *, max_selections=None, placeholder="选择一个选项", disabled=False, label_visibility="visible")

参数

label (str)

一个简短的标签,向用户解释这个选择小部件的用途。 标签可以选择性地包含以下类型的GitHub风格的Markdown:粗体、斜体、删除线、内联代码、链接和图片。图片显示为图标,最大高度等于字体高度。

不支持的Markdown元素会被解包,因此只有它们的子元素(文本内容)会呈现。通过反斜杠转义不支持的元素,将其显示为字面字符。例如, "1\. 不是一个有序列表"

有关其他支持的Markdown指令,请参见st.markdownbody参数。

出于可访问性原因,您永远不应设置空标签,但如有需要,可以使用label_visibility隐藏它。将来,我们可能会通过引发异常来禁止空标签。

options (Iterable)

选择选项的标签在Iterable中。这可以是listset,或任何st.dataframe支持的内容。如果options类似于数据框,将使用第一列。默认情况下,每个标签将在内部转换为str

default (Iterable of V, V, or None)

默认值列表。也可以是单个值。

format_func (function)

用于修改选项显示的函数。它接收原始选项作为参数,并应输出该选项显示的标签。这对命令的返回值没有影响。

key (str or int)

一个可选的字符串或整数,用作小部件的唯一键。 如果省略,将根据小部件的内容生成一个键。 任何两个小部件都不能有相同的键。

help (str)

一个可选的小提示,显示在小部件标签旁边。 只有当label_visibility="visible"时,Streamlit才会显示这个小提示。

on_change (callable)

当此小部件的值发生变化时调用的可选回调函数。

args (tuple)

传递给回调函数的可选参数元组。

kwargs (dict)

一个可选的字典,用于传递给回调函数。

max_selections (int)

一次可以选择的最大选择数。

placeholder (str)

当没有选择任何选项时显示的字符串。 默认为“选择一个选项。”

disabled (bool)

一个可选的布尔值,如果设置为True,则禁用多选小部件。默认值为False

label_visibility ("visible", "hidden", or "collapsed")

标签的可见性。默认是"visible"。如果这是"hidden",Streamlit会显示一个空白的间隔符而不是标签,这有助于保持小部件与其他小部件对齐。如果这是"collapsed",Streamlit不会显示标签或间隔符。

返回

(list)

包含所选选项的列表

示例

import streamlit as st

options = st.multiselect(
    "What are your favorite colors",
    ["Green", "Yellow", "Red", "Blue"],
    ["Yellow", "Red"],
)

st.write("You selected:", options)
forum

还有问题吗?

我们的 论坛 充满了有用的信息和Streamlit专家。