inputs

各种输入控件和表单控件。

class AutocompleteInput(*args: Any, id: ID | None = None, **kwargs: Any)

基类: TextInput

带自动完成功能的单行输入控件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "case_sensitive": true, 
  "completions": [], 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p66956", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_completions": null, 
  "max_height": null, 
  "max_length": null, 
  "max_width": null, 
  "min_characters": 2, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "placeholder": "", 
  "prefix": null, 
  "resizable": false, 
  "restrict": true, 
  "search_strategy": "starts_with", 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "suffix": null, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": "", 
  "value_input": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

case_sensitive = True

类型:

布尔型

启用或禁用大小写敏感性。

completions = []

类型:

列表

完成字符串的列表。这将用于在用户键入所需值的开头时引导用户。

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或工具提示，其中包含此控件功能的富 HTML 描述。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_completions = None

类型:

Nullable(Positive)

可选的最大显示补全数量。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_length = None

类型:

Nullable(Int)

字段中字符的最大计数

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_characters = 2

类型:

NonNegative

用户必须键入的字符数，之后才会显示补全项。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

name = None

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

placeholder = ''

类型:

String

空输入字段的占位符。

prefix = None

类型:

Nullable(String)

要在输入之前显示的可选字符串前缀。这对于指示例如输入值将分配给的变量很有用。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

restrict = True

类型:

布尔型

设置为 False 以允许用户输入列表中不存在的文本补全字符串。

search_strategy = 'starts_with'

类型:

Enum(Enumeration(starts_with, includes))

定义如何搜索补全字符串列表。默认选项 "starts_with" 表示用户的文本必须与补全字符串的开头匹配。使用 "includes" 表示用户的文本可以与补全字符串的任何子字符串匹配。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

suffix = None

类型:

Nullable(String)

要在输入之后显示的可选字符串后缀。这对于指示例如输入值的计量单位很有用。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

Widget 的标签。

value = ''

类型:

String

初始或输入的文本值。

每当按下 <enter> 键时，都会触发更改事件。

value_input = ''

类型:

String

初始或当前值。

每当发生任何更新时（即在每次按键时），都会触发更改事件。

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型所附加到的 Document（可以为 None）

class Checkbox(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: ToggleInput

一个复选框小部件。

JSON 原型

{
  "active": false, 
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p66998", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "label": "", 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

active = False

类型:

布尔型

小部件的状态。

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

label = ''

类型:

String

输入框旁边的标签。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

name = None

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

类方法 properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

类方法 properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

属性 document: Document | None

此模型所附加到的 Document（可以为 None）

class ColorPicker(*args: Any, id: ID | None = None, **kwargs: Any)

基类: InputWidget

颜色选择器小部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "color": "#000000", 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67028", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

color = '#000000'

类型:

ColorHex

所选颜色的初始颜色（命名颜色或十六进制颜色）

可接受的值包括

• 命名的 CSS 颜色中的任何一种，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如， '#FF0000', '#44444444'

• CSS4 颜色字符串，例如， 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)', 或 'hsl(60deg 100% 50% / 1.0)'

• 介于 0 到 255 之间的整数 3 元组 (r, g, b)

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是介于 0 到 255 之间的整数，a 介于 0 到 1 之间

• 使用 0xRRGGBBAA 字节顺序模式的 32 位无符号整数

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或工具提示，其中包含此控件功能的富 HTML 描述。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

name = None

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

Widget 的标签。

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None 类方法 查找

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None 当变更时

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None 当事件发生时

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter] 类方法 参数

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]] 类方法 属性

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]] 类方法 带引用的属性

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any] 带值的属性

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any] 查询带值的属性

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model] 引用

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None 移除当变更时

从此对象中移除一个回调

select(selector: SelectorType) → Iterable[Model] 选择

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None 选择一个

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None 从 JSON 设置

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None 设置选择

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型所附加到的 Document（可以为 None）

class FileInput(*args: Any, id: ID | None = None, **kwargs: Any)

基类: InputWidget

向用户呈现文件选择对话框，并返回所选文件的内容。

JSON 原型

{
  "accept": "", 
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "directory": false, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67059", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "multiple": false, 
  "name": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

accept = ''

类型:

Either(String, List)

逗号分隔的标准 HTML 文件输入过滤器列表，用于限制用户可以选择的文件类型。值可以是

<file extension>:

特定的文件扩展名（例如：.gif、.jpg、.png、.doc）是可选择的

audio/*:

所有声音文件都是可选择的

video/*:

所有视频文件都是可选择的

image/*:

所有图像文件都是可选择的

<media type>:

有效的 IANA 媒体类型，不带参数。

注意

macOS Big Sur 上某些版本的 Chrome 中的一个错误可能会限制您为这些用户设置文件输入过滤器的方式。 在这些情况下，无法将用户的选择限制为特定的文件扩展名 - 相反，浏览器会将用户限制为预定义的文件类型集，例如 Text/* 或 Image/*。 有关更多信息，请参阅 #10888。

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或工具提示，其中包含此控件功能的富 HTML 描述。

directory = False

类型:

布尔型

是否允许选择目录而不是文件。

文件名将是相对于上传目录的相对路径。

注意

当上传目录时，它将添加一个确认弹出窗口。确认弹出窗口无法禁用，因为这是浏览器中的一项安全功能。

注意

accept 参数仅适用于文件扩展名。 将 accept 与 directory 结合使用时，报告的文件数将是文件总数，而不是筛选后的文件数。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

filename = Undefined

类型:

只读

已加载的文件名。

如果 multiple 设置为 False（默认），则此值为包含所选单个文件名称的单个字符串。

如果 multiple 设置为 True，则此值为字符串列表，每个字符串包含所选多个文件之一的名称。

此列表为 value 和 mime-type 中的相应列表提供文件序列

注意

完整文件路径不包含在内，因为出于安全原因，浏览器不会提供对该信息的访问权限。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

mime_type = Undefined

类型:

只读

已加载的文件或文件的 mime 类型。

如果 multiple 设置为 False（默认），则此值为包含所选单个文件 mime 类型的单个字符串。

如果 multiple 设置为 True，则此值为字符串列表，每个字符串包含所选多个文件之一的 mime 类型。

文件序列由文件名列表给出（见下文）

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

multiple = False

类型:

布尔型

设置 multiple=False（默认）进行单文件选择，如果应可以一次选择多个文件，则设置 multiple=True。

name = None

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

Widget 的标签。

value = Undefined

类型:

只读

已加载的文件或文件的 base64 编码内容。

如果 multiple 设置为 False（默认），则此值为包含所选单个文件内容的单个字符串。

如果 multiple 设置为 True，则此值为字符串列表，每个字符串包含所选多个文件之一的内容。

文件序列由文件名列表给出（见下文）

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

clear() → None

清除此文件输入部件的内容。

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any]], None]) → None

从此对象中移除一个回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型所附加到的 Document（可以为 None）

类 InputWidget(*args: Any, id: ID | None = None, **kwargs: Any)

基类： Widget

输入控件的抽象基类。

注意

这是一个抽象基类，用于帮助组织 Bokeh 模型类型的层次结构。 它本身实例化是没有用的。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67095", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = '自动'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或工具提示，其中包含此控件功能的富 HTML 描述。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

flow_mode = '块状'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = '自动'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

name = None

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

Widget 的标签。

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = '自动'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

类方法 lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

类方法 parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

类方法 properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

类方法 properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型所附加到的 Document（可以为 None）

class MultiChoice(*args: Any, id: ID | None = None, **kwargs: Any)

基类: InputWidget

MultiChoice 部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "delete_button": true, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67125", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_items": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "option_limit": null, 
  "options": [], 
  "placeholder": null, 
  "resizable": false, 
  "search_option_limit": null, 
  "sizing_mode": null, 
  "solid": true, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": [], 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

delete_button = True

类型:

布尔型

是否添加一个按钮来移除已选择的选项。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或工具提示，其中包含此控件功能的富 HTML 描述。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_items = None

类型:

Nullable(Int)

可以选择的最大项目数。

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

name = None

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

option_limit = None

类型:

Nullable(Int)

下拉列表中将呈现的选择数量。

options = []

类型:

列表

可用的选择选项。选项可以作为可能的字符串值列表提供，也可以作为元组列表提供，每个元组的形式为 (value, label)。在后一种情况下，每个值的可见部件文本将是相应的给定标签。

placeholder = None

类型:

Nullable(String)

如果没有添加任何项目时显示的字符串。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

search_option_limit = None

类型:

Nullable(Int)

当输入搜索字符串时，下拉列表中将呈现的选择数量。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

solid = True

类型:

布尔型

指定选择是否应以实体填充。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

Widget 的标签。

value = []

类型:

列表

初始值或已选值。

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型所附加到的 Document（可以为 None）

class MultiSelect(*args: Any, id: ID | None = None, **kwargs: Any)

基类: InputWidget

多选部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67163", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "options": [], 
  "resizable": false, 
  "size": 4, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": [], 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或工具提示，其中包含此控件功能的富 HTML 描述。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

name = None

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

options = []

类型:

列表

可用的选择选项。选项可以作为可能的字符串值列表提供，也可以作为元组列表提供，每个元组的形式为 (value, label)。在后一种情况下，每个值的可见部件文本将是相应的给定标签。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

size = 4

类型:

整数

下拉列表中可见选项的数量。(这使用了 select HTML元素的 size 属性。某些浏览器可能不会显示少于 3 个选项。)

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

Widget 的标签。

value = []

类型:

列表

初始值或已选值。

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: 包含默认值 : bool = True, include_undefined: 包含未定义值 : bool = False) → dict[str, Any]

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: 查询条件 : Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: 包含默认值 : bool = True, include_undefined: 包含未定义值 : bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: 属性名 : str, *callbacks: 回调函数 : Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调

select(selector: 选择器 : SelectorType) → Iterable[Model]

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: 选择器 : SelectorType) → Model | None

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: 名称 ,: str, value: 值 : Any, *, setter: 设置器 : Setter | None = None)

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: 选择器 : type[Model] | SelectorType, updates: 更新 : dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: 序列化器 : Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: 属性名 : str, old: 旧值 : Any, new: 新值 : Any, hint: 提示 : DocumentPatchedEvent | None = None, setter: 设置器 : Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型所附加到的 Document（可以为 None）

类 NumericInput(*args: Any, id: ID | None = None, **kwargs: Any)

基类: InputWidget

数值输入部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "format": null, 
  "height": null, 
  "height_policy": "auto", 
  "high": null, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67196", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "low": null, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "mode": "int", 
  "name": null, 
  "placeholder": "", 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": null, 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或工具提示，其中包含此控件功能的富 HTML 描述。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

format = None

类型:

Either(Null, String, Instance(TickFormatter))

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

high = None

类型:

Either(Null, Float, Int)

可选的最高允许值。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

low = None

类型:

Either(Null, Float, Int)

可选的最低允许值。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

mode = 'int'

类型:

Enum(Enumeration(int, float))

定义可以在输入框中输入的数字类型

示例模式 int: 1, -1, 156 模式 float: 1, -1.2, 1.1e-25

name = None

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

placeholder = ''

类型:

String

空输入字段的占位符。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

Widget 的标签。

value = None

类型:

Either(Null, Float, Int)

初始值或已输入的值。

每当按下 <enter> 键时，都会触发更改事件。

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

类方法 lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: 字符串 | 类型[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

类方法 parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

类方法 properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

类方法 properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, 任意类型]

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[字符串, 任意类型]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[模型]

返回此对象引用的所有 Models。

remove_on_change(attr: 字符串, *callbacks: Callable[[字符串, 任意类型, 任意类型], None]) → None

从此对象中移除一个回调

select(selector: 选择器类型) → 可迭代对象[模型]

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: 选择器类型) → 模型 | None

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict\[str, Any\] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型所附加到的 Document（可以为 None）

class PaletteSelect(*args: Any, id: ID | None = None, **kwargs: Any)

基类: InputWidget

颜色调色板选择部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67232", 
  "items": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "ncols": 1, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "swatch_height": "auto", 
  "swatch_width": 100, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或工具提示，其中包含此控件功能的富 HTML 描述。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

items = Undefined

类型:

Required(Seq(Tuple(String, Seq(Color))))

可供选择的命名颜色调色板集合。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

name = None

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

ncols = 1

类型:

正数

将调色板显示拆分为的列数。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

swatch_height = 'auto'

类型:

Either(Auto, NonNegative)

显示调色板预览的 UI 元素的高度，单位可以是像素或自动调整。

swatch_width = 100

类型:

NonNegative

显示调色板预览的 UI 元素的宽度，单位为像素。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

Widget 的标签。

value = Undefined

类型:

Required(String)

初始或选定的颜色调色板的名称。

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[[str, Any, Any], None]) → None

从此对象中移除一个回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型所附加到的 Document（可以为 None）

class PasswordInput(*args: Any, id: ID | None = None, **kwargs: Any)

基类: TextInput

单行密码输入组件。

此组件隐藏输入值，使其在浏览器中不可见。

警告

为了安全地将密码传输到 Bokeh 服务器应用程序代码，需要配置服务器以进行 SSL（即 HTTPS）终端处理。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67267", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_length": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "placeholder": "", 
  "prefix": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "suffix": null, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": "", 
  "value_input": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或工具提示，其中包含此控件功能的富 HTML 描述。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_length = None

类型:

Nullable(Int)

字段中字符的最大计数

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

name = None

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

placeholder = ''

类型:

String

空输入字段的占位符。

prefix = None

类型:

Nullable(String)

要在输入之前显示的可选字符串前缀。这对于指示例如输入值将分配给的变量很有用。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

suffix = None

类型:

Nullable(String)

要在输入之后显示的可选字符串后缀。这对于指示例如输入值的计量单位很有用。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

Widget 的标签。

value = ''

类型:

String

初始或输入的文本值。

每当按下 <enter> 键时，都会触发更改事件。

value_input = ''

类型:

String

初始或当前值。

每当发生任何更新时（即在每次按键时），都会触发更改事件。

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: 字符串, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: 字符串 | 类型[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → 列表[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: 布尔值 = False) → 集合[字符串] | 字典[字符串, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → 字典[字符串, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: 布尔值 = True, include_undefined: 布尔值 = False) → 字典[字符串, Any]

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], 布尔值], *, include_defaults: 布尔值 = True, include_undefined: 布尔值 = False) → 字典[字符串, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → 集合[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: 字符串, *callbacks: Callable[[字符串, Any, Any], None]) → None

从此对象中移除一个回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: 字符串, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: 类型[Model] | SelectorType, updates: 字典[字符串, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → 字典[字符串, Any] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型所附加到的 Document（可以为 None）

class Select(*args: Any, id: ID | None = None, **kwargs: Any)

基类: InputWidget

单选部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67303", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "options": [], 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或工具提示，其中包含此控件功能的富 HTML 描述。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

name = None

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

options = []

类型:

Either(List, Dict(String, List))

可用的选择选项。

选项可以以字符串值列表的形式提供，这些字符串值也充当选项的标签；或者以元组列表的形式提供，每个元组的形式为 (value, label)，其中 value 可以是任何类型，不一定是字符串。在后一种情况下，每个值的可见部件文本将是相应的给定标签。

选项分组可以通过提供字典对象来完成，字典对象的值采用上述列表格式。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

Widget 的标签。

value = ''

类型:

AnyRef

初始值或选定值。

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: 字符串, other: 模型, other_attr: 字符串, attr_selector: 整数 | 字符串 | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: 字符串, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: 字符串, *, raises: 布尔值 = True) → PropertyDescriptor[Any] | None

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: 字符串, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: 字符串 | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → 列表[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: 布尔值 = False) → 集合[字符串] | 字典[字符串, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → 字典[字符串, Property][Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: 布尔值 = True, include_undefined: 布尔值 = False) → 字典[字符串, Any]

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor][Any]], 布尔值], *, include_defaults: 布尔值 = True, include_undefined: 布尔值 = False) → 字典[字符串, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → 集合[模型]

返回此对象引用的所有 Models。

remove_on_change(attr: 字符串, *callbacks: Callable[[字符串, Any, Any], None]) → None

从此对象中移除一个回调

select(selector: SelectorType) → Iterable[模型]

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型所附加到的 Document（可以为 None）

class Spinner(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: NumericInput

数值微调器输入部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "format": null, 
  "height": null, 
  "height_policy": "auto", 
  "high": null, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67335", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "low": null, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "mode": "float", 
  "name": null, 
  "page_step_multiplier": 10, 
  "placeholder": "", 
  "resizable": false, 
  "sizing_mode": null, 
  "step": 1, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": null, 
  "visible": true, 
  "wheel_wait": 100, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或工具提示，其中包含此控件功能的富 HTML 描述。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

format = None

类型:

Either(Null, String, Instance(TickFormatter))

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

high = None

类型:

Either(Null, Float, Int)

可选的最高允许值。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

low = None

类型:

Either(Null, Float, Int)

可选的最低允许值。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

mode = 'float'

类型:

Enum(Enumeration(int, float))

定义可以在输入框中输入的数字类型

示例模式 int: 1, -1, 156 模式 float: 1, -1.2, 1.1e-25

name = None

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

page_step_multiplier = 10

类型:

间隔

定义按下 Page Up 和 Page Down 键时应用于步长的乘法因子。

placeholder = ''

类型:

String

空输入字段的占位符。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

step = 1

类型:

间隔

添加到或从当前值中减去的步长。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

Widget 的标签。

value = None

类型:

Either(Null, Float, Int)

初始值或已输入的值。

每当按下 <enter> 键时，都会触发更改事件。

value_throttled = Undefined

类型:

只读

交互结束时报告的值。

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

wheel_wait = 100

类型:

Either(Int, Float)

定义使用鼠标滚轮更改输入值时，更新 value_throttled 前的防抖时间（毫秒）。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型所附加到的 Document（可以为 None）

class Switch(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: ToggleInput

类似复选框的小部件。

JSON 原型

{
  "active": false, 
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67375", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "label": "", 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "off_icon": null, 
  "on_icon": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

active = False

类型:

布尔型

小部件的状态。

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

label = ''

类型:

String

输入框旁边的标签。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

name = None

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

off_icon = None

类型:

Nullable(Either(Image, Enum(ToolIcon), Regex, Regex, Regex))

on_icon = None

类型:

Nullable(Either(Image, Enum(ToolIcon), Regex, Regex, Regex))

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型所附加到的 Document（可以为 None）

class TextAreaInput(*args: Any, id: ID | None = None, **kwargs: Any)

基类： TextLikeInput

多行输入部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "cols": 20, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67407", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_length": 500, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "placeholder": "", 
  "resizable": false, 
  "rows": 2, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": "", 
  "value_input": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

cols = 20

类型:

整数

指定文本区域的宽度（以平均字符宽度为单位）。默认值：20

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或工具提示，其中包含此控件功能的富 HTML 描述。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_length = 500

类型:

Nullable(Int)

字段中字符的最大计数

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

name = None

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

placeholder = ''

类型:

String

空输入字段的占位符。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

rows = 2

类型:

整数

指定文本区域的高度（以行为单位）。默认值：2

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

Widget 的标签。

value = ''

类型:

String

初始或输入的文本值。

每当按下 <enter> 键时，都会触发更改事件。

value_input = ''

类型:

String

初始或当前值。

每当发生任何更新时（即在每次按键时），都会触发更改事件。

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

应用主题(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

类方法 clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

类方法 dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

类方法 descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

类方法 lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

类方法 parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

类方法 properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

类方法 properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型所附加到的 Document（可以为 None）

class TextInput(*args: Any, id: ID | None = None, **kwargs: Any)

基类： TextLikeInput

单行输入部件。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "description": null, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p67443", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_length": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "placeholder": "", 
  "prefix": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "suffix": null, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "value": "", 
  "value_input": "", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留纵横比）。

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

当用户右键单击组件时显示的菜单。

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

右键单击时使用 Shift 键以显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Either(String, Instance(Node)))

允许定义动态计算的 CSS 变量。

例如，这可以用于协调画布渲染器和/或视觉元素与基于 HTML 的 UI 元素之间的定位和样式。

此处定义的变量等效于在 CSS 样式表的 :host { ... } 下设置相同的变量。

注意

此属性是实验性的，随时可能更改。

description = None

类型:

Nullable(Either(String, Instance(Tooltip)))

纯文本或工具提示，其中包含此控件功能的富 HTML 描述。

disabled = False

类型:

布尔型

小部件在渲染时是否将被禁用。

如果为 True，则小部件将灰显，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法在可用垂直空间内适应，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度边界（如果已设置）内适应可用垂直空间。组件的高度既不会被激进地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，但不小于最小高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，但不超过最大高度（如果已设置）。起始点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按照以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。可以使用负边距值来缩小任何方向的空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_length = None

类型:

Nullable(Int)

字段中字符的最大计数

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

name

类型:

Nullable(String)

此模型的任意、用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

placeholder = ''

类型:

String

空输入字段的占位符。

prefix = None

类型:

Nullable(String)

要在输入之前显示的可选字符串前缀。这对于指示例如输入值将分配给的变量很有用。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上可调整。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于维护组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的场景

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。无论后续浏览器窗口大小调整事件如何，它都将保留其原始宽度和高度。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上独立，并将占用所有可用的水平和垂直空间，即使这会改变组件的纵横比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的纵横比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的纵横比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用的宽度和高度，同时保持原始或提供的纵横比。

styles = {}

类型:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []

类型:

列表

用于底层 DOM 元素的其他样式表。

请注意，所有 bokeh 组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

suffix = None

类型:

Nullable(String)

要在输入之后显示的可选字符串后缀。这对于指示例如输入值的计量单位很有用。

syncable = True

类型:

布尔型

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。当处理频繁更新的对象（我们不需要这些对象的更新值）时，设置为 False 可能有助于减少网络流量。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调被触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

附加到此模型的可选的、用户提供的值列表。

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

>>> r = plot.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者仅仅是一种将任何必要的元数据附加到模型上的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

对于提供的任何标签，不强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用这些标签。

title = ''

类型:

Either(String, Instance(HTML))

Widget 的标签。

value = ''

类型:

String

初始或输入的文本值。

每当按下 <enter> 键时，都会触发更改事件。

value_input = ''

类型:

String

初始或当前值。

每当发生任何更新时（即在每次按键时），都会触发更改事件。

visible = True

类型:

布尔型

组件是否应显示在屏幕上。

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界内（如果已设置）适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将代替默认值使用，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享，以节省内存（因此调用者和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用了它们。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这将创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

DataSpec 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序列出的属性描述符列表。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要与之比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个便捷方法，可简化添加 CustomJS 回调，以便在一个 Bokeh 模型属性的值更改时更新另一个属性。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 用于链接可下标的 attr 中的项目的索引

在版本 1.1 中添加

Raises:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个 CustomJS 回调函数附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件格式为 "change:property_name"。 为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能需要响应。 例如，要在数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

根据属性名称，查找类上 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果找不到是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定的事件时，运行回调函数

并非所有模型都支持所有事件。 有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上的属性名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。 为了使当前此方法的使用方式在未来仍然适用，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个字典，该字典将属性名称映射到其值。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

非序列化属性将被跳过，并且属性值采用“序列化”格式，这可能与您通常从属性中读取的值略有不同； 此方法的目的是返回无损地重建对象实例所需的信息。

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。 （默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (*callable*) – 一个可调用对象，它接受属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用中与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用中与给定选择器匹配的对象。如果找到多个对象则引发错误。返回单个匹配对象，如果未找到任何对象则返回 None :param selector: :type selector: JSON-like

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从此对象的 JSON 中设置属性值。

参数:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, optional) –

  这用于防止对 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 setter 与自身进行比较，并阻止任何源自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以从属性名称到值的字典形式返回，或者如果没有主题覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型所附加到的 Document（可以为 None）

ColorMap(*args: Any, **kwargs: Any) → PaletteSelect

颜色调色板选择部件。

Deprecated since version 3.4.0: 请使用 PaletteSelect 小部件代替。