输入

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

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

基础类：TextInput

带有自动补全功能的单行输入小部件。

JSON Prototype

{
  "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", 
  "id": "p64703", 
  "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'

Type:

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

父容器内的对齐点。

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

aspect_ratio = None

Type:

Either(Null, Auto, Float)

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

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

case_sensitive = True

Type:

Bool

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

completions = []

Type:

List

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

context_menu = None

Type:

Nullable(Instance(Menu))

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

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

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

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

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

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

description = None

Type:

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

可以是纯文本，也可以是带有丰富HTML描述的工具提示，用于说明此小部件的功能。

disabled = False

Type:

Bool

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

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

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

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

Type:

Nullable(NonNegative)

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

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

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

Type:

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

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

max_completions = None

Type:

Nullable(Positive)

可选的最大显示完成数。

max_height = None

Type:

Nullable(NonNegative)

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

max_length = None

Type:

Nullable(Int)

字段中的最大字符数

max_width = None

Type:

Nullable(NonNegative)

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

min_characters = 2

Type:

NonNegative

用户必须输入的字符数，然后才会显示补全建议。

min_height = None

Type:

Nullable(NonNegative)

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

min_width = None

Type:

Nullable(NonNegative)

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

name = None

Type:

Nullable(String)

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

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

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

注意

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

placeholder = ''

Type:

String

空输入字段的占位符。

prefix = None

Type:

Nullable(String)

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

resizable = False

Type:

Either(Bool, Enum(Dimensions))

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

restrict = True

Type:

Bool

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

search_strategy = 'starts_with'

Type:

Enum(枚举(starts_with, includes))

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

sizing_mode = None

Type:

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 = {}

Type:

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

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

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

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

suffix = None

Type:

Nullable(String)

一个可选的字符串后缀，显示在输入之后。这对于指示例如输入值的测量单位非常有用。

syncable = True

Type:

Bool

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

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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 = ''

Type:

Either(String, Instance(HTML))

小部件的标签。

value = ''

Type:

String

初始或输入的文本值。

每当按下时，都会触发更改事件。

value_input = ''

Type:

String

初始值或当前值。

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

visible = True

Type:

Bool

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

width = None

Type:

Nullable(NonNegative)

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

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

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

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

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

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

Parameters:

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

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

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

clone(**overrides: Any) → Self

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

Returns:

DataSpec 属性的名称

Return type:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

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

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

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

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

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

• 其他 (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，给定属性名称。

Parameters:

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

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

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

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

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

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

Returns:

无

示例

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值。

Returns:

列表(参数)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

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

Returns:

具有引用的属性名称

Return type:

set[str]

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

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

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

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

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

Parameters:

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

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

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

Returns:

模型

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

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

Parameters:

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

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

• setter (ClientSession 或 ServerSession 或 None, 可选) –

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

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

Returns:

无

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

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

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

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

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

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

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

Returns:

无

update(**kwargs: Any) → None

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

Returns:

无

示例

以下是等价的：

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)

基础类：ToggleInput

一个复选框小部件。

JSON Prototype

{
  "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", 
  "id": "p64743", 
  "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

Type:

Bool

小部件的状态。

align = 'auto'

Type:

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

父容器内的对齐点。

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

aspect_ratio = None

Type:

Either(Null, Auto, Float)

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

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

context_menu = None

Type:

Nullable(Instance(Menu))

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

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

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

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

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

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

disabled = False

Type:

Bool

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

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

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

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

Type:

Nullable(NonNegative)

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

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

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

label = ''

Type:

String

复选框旁边的标签。

margin = 5

Type:

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

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

max_height = None

Type:

Nullable(NonNegative)

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

max_width = None

Type:

Nullable(NonNegative)

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

min_height = None

Type:

Nullable(NonNegative)

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

min_width = None

Type:

Nullable(NonNegative)

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

name = None

Type:

Nullable(String)

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

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

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

注意

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

resizable = False

Type:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

Type:

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 = {}

Type:

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

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

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

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

syncable = True

Type:

Bool

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

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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

Type:

Bool

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

width = None

Type:

Nullable(NonNegative)

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

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

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

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

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

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

Parameters:

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

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

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

clone(**overrides: Any) → Self

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

Returns:

DataSpec 属性的名称

Return type:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

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

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

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

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

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

• 其他 (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，给定属性名称。

Parameters:

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

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

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

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

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

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

Returns:

无

示例

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值。

Returns:

列表(参数)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

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

Returns:

具有引用的属性名称

Return type:

set[str]

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

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

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

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

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

Parameters:

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

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

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

Returns:

模型

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

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

Parameters:

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

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

• setter (ClientSession 或 ServerSession 或 None, 可选) –

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

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

Returns:

无

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

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

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

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

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

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

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

Returns:

无

update(**kwargs: Any) → None

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

Returns:

无

示例

以下是等价的：

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 ColorPicker(*args: Any, id: ID | None = None, **kwargs: Any)

基础类：InputWidget

颜色选择器小部件。

JSON Prototype

{
  "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", 
  "id": "p64771", 
  "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'

Type:

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

父容器内的对齐点。

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

aspect_ratio = None

Type:

Either(Null, Auto, Float)

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

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

color = '#000000'

Type:

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之间的整数组成的三元组 (r, g, b)

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

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

context_menu = None

Type:

Nullable(Instance(Menu))

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

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

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

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

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

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

description = None

Type:

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

可以是纯文本，也可以是带有丰富HTML描述的工具提示，用于说明此小部件的功能。

disabled = False

Type:

Bool

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

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

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

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

Type:

Nullable(NonNegative)

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

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

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

Type:

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

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

max_height = None

Type:

Nullable(NonNegative)

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

max_width = None

Type:

Nullable(NonNegative)

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

min_height = None

Type:

Nullable(NonNegative)

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

min_width = None

Type:

Nullable(NonNegative)

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

name = None

Type:

Nullable(String)

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

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

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

注意

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

resizable = False

Type:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

Type:

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 = {}

Type:

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

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

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

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

syncable = True

Type:

Bool

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

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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 = ''

Type:

Either(String, Instance(HTML))

小部件的标签。

visible = True

Type:

Bool

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

width = None

Type:

Nullable(NonNegative)

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

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

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

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

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

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

Parameters:

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

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

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

clone(**overrides: Any) → Self

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

Returns:

DataSpec 属性的名称

Return type:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

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

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

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

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

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

• 其他 (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，给定属性名称。

Parameters:

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

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

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

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

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

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

Returns:

无

示例

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值。

Returns:

列表(参数)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

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

Returns:

具有引用的属性名称

Return type:

set[str]

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

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

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

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

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

Parameters:

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

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

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

Returns:

模型

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

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

Parameters:

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

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

• setter (ClientSession 或 ServerSession 或 None, 可选) –

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

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

Returns:

无

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

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

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

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

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

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

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

Returns:

无

update(**kwargs: Any) → None

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

Returns:

无

示例

以下是等价的：

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 Prototype

{
  "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", 
  "id": "p64800", 
  "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 = ''

Type:

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'

Type:

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

父容器内的对齐点。

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

aspect_ratio = None

Type:

Either(Null, Auto, Float)

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

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

context_menu = None

Type:

Nullable(Instance(Menu))

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

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

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

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

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

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

description = None

Type:

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

可以是纯文本，也可以是带有丰富HTML描述的工具提示，用于说明此小部件的功能。

directory = False

Type:

Bool

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

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

注意

当上传一个目录时，将会弹出一个确认提示框。 这个确认提示框无法被禁用，因为这是浏览器的一个安全特性。

注意

accept 参数仅适用于文件扩展名。 当将 accept 与 directory 一起使用时，报告的文件数量将是文件的总数，而不是经过筛选的。

disabled = False

Type:

Bool

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

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

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

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

filename = Undefined

Type:

Readonly

加载的文件或文件的名称。

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

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

此列表提供了值和MIME类型中相应列表的文件顺序

注意

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

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

Type:

Nullable(NonNegative)

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

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

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

Type:

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

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

max_height = None

Type:

Nullable(NonNegative)

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

max_width = None

Type:

Nullable(NonNegative)

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

mime_type = Undefined

Type:

Readonly

加载的文件或文件的MIME类型。

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

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

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

min_height = None

Type:

Nullable(NonNegative)

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

min_width = None

Type:

Nullable(NonNegative)

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

multiple = False

Type:

Bool

设置 multiple=False（默认）用于单个文件选择，如果应该允许一次选择多个文件，则设置 multiple=True。

name = None

Type:

Nullable(String)

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

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

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

注意

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

resizable = False

Type:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

Type:

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 = {}

Type:

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

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

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

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

syncable = True

Type:

Bool

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

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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 = ''

Type:

Either(String, Instance(HTML))

小部件的标签。

value = Undefined

Type:

Readonly

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

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

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

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

visible = True

Type:

Bool

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

width = None

Type:

Nullable(NonNegative)

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

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

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

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

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

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

Parameters:

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

Returns:

无

clear() → None

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

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

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

clone(**overrides: Any) → Self

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

Returns:

DataSpec 属性的名称

Return type:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

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

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

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

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

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

• 其他 (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，给定属性名称。

Parameters:

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

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

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

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

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

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

Returns:

无

示例

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值。

Returns:

列表(参数)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

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

Returns:

具有引用的属性名称

Return type:

set[str]

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

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

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

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

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

Parameters:

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

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

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

Returns:

模型

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

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

Parameters:

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

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

• setter (ClientSession 或 ServerSession 或 None, 可选) –

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

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

Returns:

无

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

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

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

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

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

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

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

Returns:

无

update(**kwargs: Any) → None

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

Returns:

无

示例

以下是等价的：

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 InputWidget(*args: Any, id: ID | None = None, **kwargs: Any)

基础类：Widget

输入小部件的抽象基类。

注意

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

JSON Prototype

{
  "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", 
  "id": "p64834", 
  "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'

Type:

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

父容器内的对齐点。

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

aspect_ratio = None

Type:

Either(Null, Auto, Float)

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

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

context_menu = None

Type:

Nullable(Instance(Menu))

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

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

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

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

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

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

description = None

Type:

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

可以是纯文本，也可以是带有丰富HTML描述的工具提示，用于说明此小部件的功能。

disabled = False

Type:

Bool

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

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

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

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

Type:

Nullable(NonNegative)

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

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

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

Type:

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

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

max_height = None

Type:

Nullable(NonNegative)

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

max_width = None

Type:

Nullable(NonNegative)

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

min_height = None

Type:

Nullable(NonNegative)

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

min_width = None

Type:

Nullable(NonNegative)

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

name = None

Type:

Nullable(String)

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

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

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

注意

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

resizable = False

Type:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

Type:

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 = {}

Type:

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

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

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

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

syncable = True

Type:

Bool

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

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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 = ''

Type:

Either(String, Instance(HTML))

小部件的标签。

visible = True

Type:

Bool

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

width = None

Type:

Nullable(NonNegative)

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

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

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

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

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

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

Parameters:

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

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

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

clone(**overrides: Any) → Self

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

Returns:

DataSpec 属性的名称

Return type:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

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

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

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

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

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

• 其他 (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，给定属性名称。

Parameters:

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

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

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

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

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

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

Returns:

无

示例

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值。

Returns:

列表(参数)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

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

Returns:

具有引用的属性名称

Return type:

set[str]

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

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

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

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

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

Parameters:

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

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

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

Returns:

模型

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

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

Parameters:

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

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

• setter (ClientSession 或 ServerSession 或 None, 可选) –

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

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

Returns:

无

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

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

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

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

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

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

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

Returns:

无

update(**kwargs: Any) → None

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

Returns:

无

示例

以下是等价的：

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

多选小部件。

JSON Prototype

{
  "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", 
  "id": "p64862", 
  "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'

Type:

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

父容器内的对齐点。

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

aspect_ratio = None

Type:

Either(Null, Auto, Float)

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

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

context_menu = None

Type:

Nullable(Instance(Menu))

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

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

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

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

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

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

delete_button = True

Type:

Bool

是否添加一个按钮来移除已选选项。

description = None

Type:

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

可以是纯文本，也可以是带有丰富HTML描述的工具提示，用于说明此小部件的功能。

disabled = False

Type:

Bool

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

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

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

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

Type:

Nullable(NonNegative)

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

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

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

Type:

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

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

max_height = None

Type:

Nullable(NonNegative)

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

max_items = None

Type:

Nullable(Int)

可以选择的最大项目数。

max_width = None

Type:

Nullable(NonNegative)

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

min_height = None

Type:

Nullable(NonNegative)

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

min_width = None

Type:

Nullable(NonNegative)

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

name = None

Type:

Nullable(String)

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

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

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

注意

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

option_limit = None

Type:

Nullable(Int)

下拉菜单中将要呈现的选择数量。

options = []

Type:

List

可用的选择选项。选项可以作为可能的字符串值列表提供，或者作为元组列表提供，每个元组的形式为(value, label)。在后一种情况下，每个值的可见小部件文本将是对应的给定标签。

placeholder = None

Type:

Nullable(String)

如果没有添加项目，则显示的字符串。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

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

search_option_limit = None

Type:

Nullable(Int)

当输入搜索字符串时，下拉菜单中将呈现的选择数量。

sizing_mode = None

Type:

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

Type:

Bool

指定选项是否应被实心填充。

styles = {}

Type:

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

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

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

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

syncable = True

Type:

Bool

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

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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 = ''

Type:

Either(String, Instance(HTML))

小部件的标签。

value = []

Type:

List

初始或选定的值。

visible = True

Type:

Bool

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

width = None

Type:

Nullable(NonNegative)

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

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

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

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

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

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

Parameters:

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

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

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

clone(**overrides: Any) → Self

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

Returns:

DataSpec 属性的名称

Return type:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

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

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

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

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

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

• 其他 (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，给定属性名称。

Parameters:

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

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

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

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

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

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

Returns:

无

示例

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值。

Returns:

列表(参数)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

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

Returns:

具有引用的属性名称

Return type:

set[str]

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

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

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

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

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

Parameters:

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

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

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

Returns:

模型

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

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

Parameters:

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

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

• setter (ClientSession 或 ServerSession 或 None, 可选) –

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

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

Returns:

无

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

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

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

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

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

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

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

Returns:

无

update(**kwargs: Any) → None

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

Returns:

无

示例

以下是等价的：

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 Prototype

{
  "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", 
  "id": "p64898", 
  "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'

Type:

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

父容器内的对齐点。

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

aspect_ratio = None

Type:

Either(Null, Auto, Float)

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

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

context_menu = None

Type:

Nullable(Instance(Menu))

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

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

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

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

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

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

description = None

Type:

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

可以是纯文本，也可以是带有丰富HTML描述的工具提示，用于说明此小部件的功能。

disabled = False

Type:

Bool

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

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

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

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

Type:

Nullable(NonNegative)

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

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

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

margin = 5

Type:

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

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

max_height = None

Type:

Nullable(NonNegative)

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

max_width = None

Type:

Nullable(NonNegative)

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

min_height = None

Type:

Nullable(NonNegative)

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

min_width = None

Type:

Nullable(NonNegative)

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

name = None

Type:

Nullable(String)

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

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

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

注意

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

options = []

Type:

List

可用的选择选项。选项可以作为可能的字符串值列表提供，或者作为元组列表提供，每个元组的形式为(value, label)。在后一种情况下，每个值的可见小部件文本将是对应的给定标签。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

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

size = 4

Type:

Int

下拉列表中可见选项的数量。（这使用了select HTML元素的size属性。某些浏览器可能不会显示少于3个选项。）

sizing_mode = None

Type:

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 = {}

Type:

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

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

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

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

syncable = True

Type:

Bool

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

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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 = ''

Type:

Either(String, Instance(HTML))

小部件的标签。

value = []

Type:

List

初始或选定的值。

visible = True

Type:

Bool

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

width = None

Type:

Nullable(NonNegative)

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

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

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

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

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

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

Parameters:

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

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

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

clone(**overrides: Any) → Self

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

Returns:

DataSpec 属性的名称

Return type:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

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

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

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

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

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

• 其他 (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，给定属性名称。

Parameters:

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

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

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

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

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

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

Returns:

无

示例

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值。

Returns:

列表(参数)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

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

Returns:

具有引用的属性名称

Return type:

set[str]

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

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

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

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

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

Parameters:

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

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

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

Returns:

模型

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

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

Parameters:

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

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

• setter (ClientSession 或 ServerSession 或 None, 可选) –

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

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

Returns:

无

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

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

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

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

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

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

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

Returns:

无

update(**kwargs: Any) → None

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

Returns:

无

示例

以下是等价的：

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 NumericInput(*args: Any, id: ID | None = None, **kwargs: Any)

基础类: InputWidget

数字输入小部件。

JSON Prototype

{
  "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, 
  "id": "p64929", 
  "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'

Type:

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

父容器内的对齐点。

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

aspect_ratio = None

Type:

Either(Null, Auto, Float)

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

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

context_menu = None

Type:

Nullable(Instance(Menu))

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

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

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

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

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

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

description = None

Type:

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

可以是纯文本，也可以是带有丰富HTML描述的工具提示，用于说明此小部件的功能。

disabled = False

Type:

Bool

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

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

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

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

format = None

Type:

Either(Null, String, Instance(TickFormatter))

height = None

Type:

Nullable(NonNegative)

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

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

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

high = None

Type:

Either(Null, Float, Int)

可选的最大允许值。

low = None

Type:

Either(Null, Float, Int)

可选的最低允许值。

margin = 5

Type:

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

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

max_height = None

Type:

Nullable(NonNegative)

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

max_width = None

Type:

Nullable(NonNegative)

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

min_height = None

Type:

Nullable(NonNegative)

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

min_width = None

Type:

Nullable(NonNegative)

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

mode = 'int'

Type:

Enum(枚举(int, float))

定义可以在输入中输入的数值类型

示例 模式 int: 1, -1, 156 模式 float: 1, -1.2, 1.1e-25

name = None

Type:

Nullable(String)

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

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

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

注意

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

placeholder = ''

Type:

String

空输入字段的占位符。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

Type:

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 = {}

Type:

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

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

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

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

syncable = True

Type:

Bool

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

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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 = ''

Type:

Either(String, Instance(HTML))

小部件的标签。

value = None

Type:

Either(Null, Float, Int)

初始或输入的值。

每当按下时，都会触发更改事件。

visible = True

Type:

Bool

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

width = None

Type:

Nullable(NonNegative)

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

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

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

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

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

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

Parameters:

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

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

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

clone(**overrides: Any) → Self

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

Returns:

DataSpec 属性的名称

Return type:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

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

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

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

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

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

• 其他 (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，给定属性名称。

Parameters:

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

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

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

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

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

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

Returns:

无

示例

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值。

Returns:

列表(参数)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

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

Returns:

具有引用的属性名称

Return type:

set[str]

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

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

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

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

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

Parameters:

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

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

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

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

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

Returns:

模型

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

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

Parameters:

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

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

• setter (ClientSession 或 ServerSession 或 None, 可选) –

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

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

Returns:

无

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

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

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

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

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

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

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

Returns:

无

update(**kwargs: Any) → None

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

Returns:

无

示例

以下是等价的：

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 Prototype

{
  "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", 
  "id": "p64963", 
  "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'

Type:

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

父容器内的对齐点。

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

aspect_ratio = None

Type:

Either(Null, Auto, Float)

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

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

context_menu = None

Type:

Nullable(Instance(Menu))

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

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

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

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

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

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

description = None

Type:

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

可以是纯文本，也可以是带有丰富HTML描述的工具提示，用于说明此小部件的功能。

disabled = False

Type:

Bool

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

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

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

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

Type:

Nullable(NonNegative)

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

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

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

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

"fit"

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

"min"

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

"max"

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

注意

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

items = Undefined

Type:

Required(Seq(Tuple(String, Seq(Color))))

可供选择的一系列命名调色板。

margin = 5

Type:

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

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

max_height = None

Type:

Nullable(NonNegative)

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

max_width = None

Type:

Nullable(NonNegative)

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

min_height = None

Type:

Nullable(NonNegative)

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

min_width = None

Type:

Nullable(NonNegative)

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

name = None

Type:

Nullable(String)

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

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

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

注意

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

ncols = 1

Type:

Positive

将调色板显示拆分的列数。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

Type:

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 = {}

Type:

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

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

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

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

swatch_height = 'auto'

Type:

Either(Auto, NonNegative)

显示调色板预览的UI元素的高度，可以是像素值或自动调整。

swatch_width = 100

Type:

NonNegative

显示调色板预览的UI元素的宽度，以像素为单位。

syncable = True

Type:

Bool

指示当在网页浏览器中更新时，此模型是否应同步回Bokeh服务器。设置为False可能有助于在处理频繁更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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 = ''

Type:

Either(String, Instance(HTML))

小部件的标签。

value = Undefined

Type:

Required(String)

初始或选定的调色板名称。

visible = True

Type:

Bool

组件是否应该在屏幕上显示。

width = None

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，取决于宽度调整策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的width像素。如果组件无法适应可用的水平空间，将会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度范围内（如果已设置）适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不少于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

"max"

尽可能使用水平空间，但不超过最大宽度（如果已设置）。 起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于替代默认值，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和HasProps实例都不应修改它）。

Parameters:

property_values (dict) – 用于替换默认值的主题值

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制一个HasProps对象。

这将创建原始模型的浅克隆，即任何可变的容器或子模型将不会被复制。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有DataSpec属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

DataSpec 属性的名称

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符的列表，按定义的顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

如果属性在结构上相等，则为True，否则为False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用JavaScript链接两个Bokeh模型属性。

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

• attr (str) – 此模型上的Bokeh属性的名称

• 其他 (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，给定属性名称。

Parameters:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

• attr (str) – 此对象上的一个属性名称

• *callbacks (callable) – 要注册的回调函数

Returns:

无

示例

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值。

Returns:

列表(参数)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类的属性名称。

警告

在Bokeh的未来版本中，此方法将返回一个将属性名称映射到属性对象的字典。为了使当前使用此方法的方式具有未来兼容性，请将返回值包装在list中。

Returns:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

具有引用的属性名称

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

不可序列化的属性将被跳过，属性值以“序列化”格式呈现，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损重构对象实例所需的信息。

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

Parameters:

• query (callable) – 一个可调用对象，接受属性描述符并返回 True 或 False

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何内容，则返回None :param selector: :type selector: JSON-like

Returns:

模型

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从JSON设置此对象的属性值。

Parameters:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止对Bokeh应用程序的“回旋镖”更新。

  在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在执行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置器与自身进行比较，并抑制源自自身的任何更新。

Returns:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以属性名称到值的字典形式返回，如果此实例没有主题覆盖任何值，则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认设置。

Returns:

无

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

Returns:

无

示例

以下是等价的：

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 Prototype

{
  "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", 
  "id": "p64996", 
  "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'

Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

此属性仅在此组件是布局的子元素（例如网格）时有用。自对齐可以被父容器（例如网格轨道对齐）覆盖。

aspect_ratio = None

Type:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

context_menu = None

Type:

Nullable(Instance(Menu))

当用户右键点击组件时显示的菜单。

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

允许定义动态计算的CSS变量。

例如，这可以用于协调canvas渲染器和/或视觉效果与基于HTML的UI元素之间的定位和样式。

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

此属性是实验性的，可能会随时更改。

description = None

Type:

Nullable(Either(String, Instance(Tooltip)))

可以是纯文本，也可以是带有丰富HTML描述的工具提示，用于说明此小部件的功能。

disabled = False

Type:

Bool

小部件在渲染时是否会被禁用。

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

附加到此窗格的基于DOM的UI元素集合。

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

Type:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，取决于高度调整策略。

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的height像素。如果组件无法适应可用的垂直空间，将会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度范围内适应可用的垂直空间（如果已设置）。组件的高度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能使用最少的垂直空间，但不少于最小高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素缩小或增长。

"max"

尽可能使用垂直空间，但不超过最大高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

margin = 5

Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。 元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距， 类似于CSS标准。 可以使用负边距值来缩小任何方向的空间。

max_height = None

Type:

Nullable(NonNegative)

如果高度可调，组件的最大高度（以像素为单位）。

max_length = None

Type:

Nullable(Int)

字段中的最大字符数

max_width = None

Type:

Nullable(NonNegative)

如果宽度可调，组件的最大宽度（以像素为单位）。

min_height = None

Type:

Nullable(NonNegative)

如果高度可调，组件的最小高度（以像素为单位）。

min_width = None

Type:

Nullable(NonNegative)

如果宽度可调，组件的最小宽度（以像素为单位）。

name = None

Type:

Nullable(String)

此模型的任意用户提供的名称。

在查询文档以检索特定Bokeh模型时，此名称可能很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，没有强制执行唯一性保证或其他条件，Bokeh也不会直接使用这些名称。

placeholder = ''

Type:

String

空输入字段的占位符。

prefix = None

Type:

Nullable(String)

一个可选的字符串前缀，显示在输入之前。这对于指示例如将分配给输入值的变量很有用。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上。

sizing_mode = None

Type:

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 = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层DOM元素的内联CSS样式。

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

请注意，所有Bokeh的组件都使用影子DOM，因此任何包含的样式表都必须反映这一点，例如使用:host CSS伪选择器来访问根DOM元素。

suffix = None

Type:

Nullable(String)

一个可选的字符串后缀，显示在输入之后。这对于指示例如输入值的测量单位非常有用。

syncable = True

Type:

Bool

指示当在网页浏览器中更新时，此模型是否应同步回Bokeh服务器。设置为False可能有助于在处理频繁更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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 = ''

Type:

Either(String, Instance(HTML))

小部件的标签。

value = ''

Type:

String

初始或输入的文本值。

每当按下时，都会触发更改事件。

value_input = ''

Type:

String

初始值或当前值。

每当发生任何更新时，即每次按键时，都会触发更改事件。

visible = True

Type:

Bool

组件是否应该在屏幕上显示。

width = None

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，取决于宽度调整策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的width像素。如果组件无法适应可用的水平空间，将会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度范围内（如果已设置）适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不少于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

"max"

尽可能使用水平空间，但不超过最大宽度（如果已设置）。 起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于替代默认值，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和HasProps实例都不应修改它）。

Parameters:

property_values (dict) – 用于替换默认值的主题值

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制一个HasProps对象。

这将创建原始模型的浅克隆，即任何可变的容器或子模型将不会被复制。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有DataSpec属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

DataSpec 属性的名称

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符的列表，按定义的顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

如果属性在结构上相等，则为True，否则为False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用JavaScript链接两个Bokeh模型属性。

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

• attr (str) – 此模型上的Bokeh属性的名称

• 其他 (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，给定属性名称。

Parameters:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

• attr (str) – 此对象上的一个属性名称

• *callbacks (callable) – 要注册的回调函数

Returns:

无

示例

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值。

Returns:

列表(参数)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类的属性名称。

警告

在Bokeh的未来版本中，此方法将返回一个将属性名称映射到属性对象的字典。为了使当前使用此方法的方式具有未来兼容性，请将返回值包装在list中。

Returns:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

具有引用的属性名称

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

不可序列化的属性将被跳过，属性值以“序列化”格式呈现，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损重构对象实例所需的信息。

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

Parameters:

• query (callable) – 一个可调用对象，接受属性描述符并返回 True 或 False

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何内容，则返回None :param selector: :type selector: JSON-like

Returns:

模型

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从JSON设置此对象的属性值。

Parameters:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止对Bokeh应用程序的“回旋镖”更新。

  在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在执行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置器与自身进行比较，并抑制源自自身的任何更新。

Returns:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以属性名称到值的字典形式返回，如果此实例没有主题覆盖任何值，则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认设置。

Returns:

无

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

Returns:

无

示例

以下是等价的：

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 Prototype

{
  "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", 
  "id": "p65030", 
  "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'

Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

此属性仅在此组件是布局的子元素（例如网格）时有用。自对齐可以被父容器（例如网格轨道对齐）覆盖。

aspect_ratio = None

Type:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

context_menu = None

Type:

Nullable(Instance(Menu))

当用户右键点击组件时显示的菜单。

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

允许定义动态计算的CSS变量。

例如，这可以用于协调canvas渲染器和/或视觉效果与基于HTML的UI元素之间的定位和样式。

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

此属性是实验性的，可能会随时更改。

description = None

Type:

Nullable(Either(String, Instance(Tooltip)))

可以是纯文本，也可以是带有丰富HTML描述的工具提示，用于说明此小部件的功能。

disabled = False

Type:

Bool

小部件在渲染时是否会被禁用。

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

附加到此窗格的基于DOM的UI元素集合。

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

Type:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，取决于高度调整策略。

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的height像素。如果组件无法适应可用的垂直空间，将会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度范围内适应可用的垂直空间（如果已设置）。组件的高度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能使用最少的垂直空间，但不少于最小高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素缩小或增长。

"max"

尽可能使用垂直空间，但不超过最大高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

margin = 5

Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。 元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距， 类似于CSS标准。 可以使用负边距值来缩小任何方向的空间。

max_height = None

Type:

Nullable(NonNegative)

如果高度可调，组件的最大高度（以像素为单位）。

max_width = None

Type:

Nullable(NonNegative)

如果宽度可调，组件的最大宽度（以像素为单位）。

min_height = None

Type:

Nullable(NonNegative)

如果高度可调，组件的最小高度（以像素为单位）。

min_width = None

Type:

Nullable(NonNegative)

如果宽度可调，组件的最小宽度（以像素为单位）。

name = None

Type:

Nullable(String)

此模型的任意用户提供的名称。

在查询文档以检索特定Bokeh模型时，此名称可能很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，没有强制执行唯一性保证或其他条件，Bokeh也不会直接使用这些名称。

options = []

Type:

Either(List, Dict(String, List))

可用的选择选项。

选项可以作为可能的字符串值列表提供，这些字符串值也作为选项的标签，或者作为元组列表提供，每个元组的格式为(value, label)，其中value可以是任何类型，不一定是字符串。在后一种情况下，每个值的可见小部件文本将是对应的给定标签。

可以通过提供一个字典对象来提供选项分组，该字典对象的值采用上述列表格式。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上。

sizing_mode = None

Type:

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 = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层DOM元素的内联CSS样式。

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

请注意，所有Bokeh的组件都使用影子DOM，因此任何包含的样式表都必须反映这一点，例如使用:host CSS伪选择器来访问根DOM元素。

syncable = True

Type:

Bool

指示当在网页浏览器中更新时，此模型是否应同步回Bokeh服务器。设置为False可能有助于在处理频繁更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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 = ''

Type:

Either(String, Instance(HTML))

小部件的标签。

value = ''

Type:

Any

初始值或选定的值。

visible = True

Type:

Bool

组件是否应该在屏幕上显示。

width = None

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，取决于宽度调整策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的width像素。如果组件无法适应可用的水平空间，将会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度范围内（如果已设置）适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不少于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

"max"

尽可能使用水平空间，但不超过最大宽度（如果已设置）。 起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于替代默认值，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和HasProps实例都不应修改它）。

Parameters:

property_values (dict) – 用于替换默认值的主题值

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制一个HasProps对象。

这将创建原始模型的浅克隆，即任何可变的容器或子模型将不会被复制。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有DataSpec属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

DataSpec 属性的名称

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符的列表，按定义的顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

如果属性在结构上相等，则为True，否则为False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用JavaScript链接两个Bokeh模型属性。

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

• attr (str) – 此模型上的Bokeh属性的名称

• 其他 (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，给定属性名称。

Parameters:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

• attr (str) – 此对象上的一个属性名称

• *callbacks (callable) – 要注册的回调函数

Returns:

无

示例

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值。

Returns:

列表(参数)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类的属性名称。

警告

在Bokeh的未来版本中，此方法将返回一个将属性名称映射到属性对象的字典。为了使当前使用此方法的方式具有未来兼容性，请将返回值包装在list中。

Returns:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

具有引用的属性名称

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

不可序列化的属性将被跳过，属性值以“序列化”格式呈现，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损重构对象实例所需的信息。

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

Parameters:

• query (callable) – 一个可调用对象，接受属性描述符并返回 True 或 False

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何内容，则返回None :param selector: :type selector: JSON-like

Returns:

模型

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从JSON设置此对象的属性值。

Parameters:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止对Bokeh应用程序的“回旋镖”更新。

  在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在执行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置器与自身进行比较，并抑制源自自身的任何更新。

Returns:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以属性名称到值的字典形式返回，如果此实例没有主题覆盖任何值，则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认设置。

Returns:

无

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

Returns:

无

示例

以下是等价的：

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)

基础类：NumericInput

数字微调器输入小部件。

JSON Prototype

{
  "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, 
  "id": "p65060", 
  "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'

Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

此属性仅在此组件是布局的子元素（例如网格）时有用。自对齐可以被父容器（例如网格轨道对齐）覆盖。

aspect_ratio = None

Type:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

context_menu = None

Type:

Nullable(Instance(Menu))

当用户右键点击组件时显示的菜单。

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

允许定义动态计算的CSS变量。

例如，这可以用于协调canvas渲染器和/或视觉效果与基于HTML的UI元素之间的定位和样式。

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

此属性是实验性的，可能会随时更改。

description = None

Type:

Nullable(Either(String, Instance(Tooltip)))

可以是纯文本，也可以是带有丰富HTML描述的工具提示，用于说明此小部件的功能。

disabled = False

Type:

Bool

小部件在渲染时是否会被禁用。

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

附加到此窗格的基于DOM的UI元素集合。

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

format = None

Type:

Either(Null, String, Instance(TickFormatter))

height = None

Type:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，取决于高度调整策略。

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的height像素。如果组件无法适应可用的垂直空间，将会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度范围内适应可用的垂直空间（如果已设置）。组件的高度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能使用最少的垂直空间，但不少于最小高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素缩小或增长。

"max"

尽可能使用垂直空间，但不超过最大高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

high = None

Type:

Either(Null, Float, Int)

可选的最大允许值。

low = None

Type:

Either(Null, Float, Int)

可选的最低允许值。

margin = 5

Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。 元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距， 类似于CSS标准。 可以使用负边距值来缩小任何方向的空间。

max_height = None

Type:

Nullable(NonNegative)

如果高度可调，组件的最大高度（以像素为单位）。

max_width = None

Type:

Nullable(NonNegative)

如果宽度可调，组件的最大宽度（以像素为单位）。

min_height = None

Type:

Nullable(NonNegative)

如果高度可调，组件的最小高度（以像素为单位）。

min_width = None

Type:

Nullable(NonNegative)

如果宽度可调，组件的最小宽度（以像素为单位）。

mode = 'float'

Type:

Enum(枚举(int, float))

定义可以在输入中输入的数值类型

示例 模式 int: 1, -1, 156 模式 float: 1, -1.2, 1.1e-25

name = None

Type:

Nullable(String)

此模型的任意用户提供的名称。

在查询文档以检索特定Bokeh模型时，此名称可能很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，没有强制执行唯一性保证或其他条件，Bokeh也不会直接使用这些名称。

page_step_multiplier = 10

Type:

Interval

定义当按下向上翻页和向下翻页键时应用于步长的乘法因子。

placeholder = ''

Type:

String

空输入字段的占位符。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上。

sizing_mode = None

Type:

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

Type:

Interval

当前值增加或减少的步长。

styles = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层DOM元素的内联CSS样式。

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

请注意，所有Bokeh的组件都使用影子DOM，因此任何包含的样式表都必须反映这一点，例如使用:host CSS伪选择器来访问根DOM元素。

syncable = True

Type:

Bool

指示当在网页浏览器中更新时，此模型是否应同步回Bokeh服务器。设置为False可能有助于在处理频繁更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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 = ''

Type:

Either(String, Instance(HTML))

小部件的标签。

value = None

Type:

Either(Null, Float, Int)

初始或输入的值。

每当按下时，都会触发更改事件。

value_throttled = Undefined

Type:

Readonly

在交互结束时报告的值。

visible = True

Type:

Bool

组件是否应该在屏幕上显示。

wheel_wait = 100

Type:

Either(Int, Float)

定义在使用鼠标滚轮更改输入时更新value_throttled之前的去抖动时间（以毫秒为单位）。

width = None

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，取决于宽度调整策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的width像素。如果组件无法适应可用的水平空间，将会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度范围内（如果已设置）适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不少于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

"max"

尽可能使用水平空间，但不超过最大宽度（如果已设置）。 起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于替代默认值，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和HasProps实例都不应修改它）。

Parameters:

property_values (dict) – 用于替换默认值的主题值

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制一个HasProps对象。

这将创建原始模型的浅克隆，即任何可变的容器或子模型将不会被复制。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有DataSpec属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

DataSpec 属性的名称

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符的列表，按定义的顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

如果属性在结构上相等，则为True，否则为False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用JavaScript链接两个Bokeh模型属性。

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

• attr (str) – 此模型上的Bokeh属性的名称

• 其他 (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，给定属性名称。

Parameters:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

• attr (str) – 此对象上的一个属性名称

• *callbacks (callable) – 要注册的回调函数

Returns:

无

示例

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值。

Returns:

列表(参数)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类的属性名称。

警告

在Bokeh的未来版本中，此方法将返回一个将属性名称映射到属性对象的字典。为了使当前使用此方法的方式具有未来兼容性，请将返回值包装在list中。

Returns:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

具有引用的属性名称

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

不可序列化的属性将被跳过，属性值以“序列化”格式呈现，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损重构对象实例所需的信息。

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

Parameters:

• query (callable) – 一个可调用对象，接受属性描述符并返回 True 或 False

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何内容，则返回None :param selector: :type selector: JSON-like

Returns:

模型

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从JSON设置此对象的属性值。

Parameters:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止对Bokeh应用程序的“回旋镖”更新。

  在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在执行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置器与自身进行比较，并抑制源自自身的任何更新。

Returns:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以属性名称到值的字典形式返回，如果此实例没有主题覆盖任何值，则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认设置。

Returns:

无

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

Returns:

无

示例

以下是等价的：

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)

基础类：ToggleInput

一个类似复选框的小部件。

JSON Prototype

{
  "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", 
  "id": "p65098", 
  "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": [], 
  "visible": true, 
  "width": 32, 
  "width_policy": "auto"
}

active = False

Type:

Bool

小部件的状态。

align = 'auto'

Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

此属性仅在此组件是布局的子元素（例如网格）时有用。自对齐可以被父容器（例如网格轨道对齐）覆盖。

aspect_ratio = None

Type:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

context_menu = None

Type:

Nullable(Instance(Menu))

当用户右键点击组件时显示的菜单。

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

允许定义动态计算的CSS变量。

例如，这可以用于协调canvas渲染器和/或视觉效果与基于HTML的UI元素之间的定位和样式。

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

此属性是实验性的，可能会随时更改。

disabled = False

Type:

Bool

小部件在渲染时是否会被禁用。

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

附加到此窗格的基于DOM的UI元素集合。

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

Type:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，取决于高度调整策略。

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的height像素。如果组件无法适应可用的垂直空间，将会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度范围内适应可用的垂直空间（如果已设置）。组件的高度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能使用最少的垂直空间，但不少于最小高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素缩小或增长。

"max"

尽可能使用垂直空间，但不超过最大高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

margin = 5

Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。 元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距， 类似于CSS标准。 可以使用负边距值来缩小任何方向的空间。

max_height = None

Type:

Nullable(NonNegative)

如果高度可调，组件的最大高度（以像素为单位）。

max_width = None

Type:

Nullable(NonNegative)

如果宽度可调，组件的最大宽度（以像素为单位）。

min_height = None

Type:

Nullable(NonNegative)

如果高度可调，组件的最小高度（以像素为单位）。

min_width = None

Type:

Nullable(NonNegative)

如果宽度可调，组件的最小宽度（以像素为单位）。

name = None

Type:

Nullable(String)

此模型的任意用户提供的名称。

在查询文档以检索特定Bokeh模型时，此名称可能很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，没有强制执行唯一性保证或其他条件，Bokeh也不会直接使用这些名称。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上。

sizing_mode = None

Type:

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 = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层DOM元素的内联CSS样式。

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

请注意，所有Bokeh的组件都使用影子DOM，因此任何包含的样式表都必须反映这一点，例如使用:host CSS伪选择器来访问根DOM元素。

syncable = True

Type:

Bool

指示当在网页浏览器中更新时，此模型是否应同步回Bokeh服务器。设置为False可能有助于在处理频繁更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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

Type:

Bool

组件是否应该在屏幕上显示。

width = 32

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，取决于宽度调整策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的width像素。如果组件无法适应可用的水平空间，将会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度范围内（如果已设置）适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不少于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

"max"

尽可能使用水平空间，但不超过最大宽度（如果已设置）。 起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于替代默认值，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和HasProps实例都不应修改它）。

Parameters:

property_values (dict) – 用于替换默认值的主题值

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制一个HasProps对象。

这将创建原始模型的浅克隆，即任何可变的容器或子模型将不会被复制。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有DataSpec属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

DataSpec 属性的名称

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符的列表，按定义的顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

如果属性在结构上相等，则为True，否则为False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用JavaScript链接两个Bokeh模型属性。

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

• attr (str) – 此模型上的Bokeh属性的名称

• 其他 (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，给定属性名称。

Parameters:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

• attr (str) – 此对象上的一个属性名称

• *callbacks (callable) – 要注册的回调函数

Returns:

无

示例

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值。

Returns:

列表(参数)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类的属性名称。

警告

在Bokeh的未来版本中，此方法将返回一个将属性名称映射到属性对象的字典。为了使当前使用此方法的方式具有未来兼容性，请将返回值包装在list中。

Returns:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

具有引用的属性名称

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

不可序列化的属性将被跳过，属性值以“序列化”格式呈现，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损重构对象实例所需的信息。

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

Parameters:

• query (callable) – 一个可调用对象，接受属性描述符并返回 True 或 False

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何内容，则返回None :param selector: :type selector: JSON-like

Returns:

模型

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从JSON设置此对象的属性值。

Parameters:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止对Bokeh应用程序的“回旋镖”更新。

  在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在执行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置器与自身进行比较，并抑制源自自身的任何更新。

Returns:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以属性名称到值的字典形式返回，如果此实例没有主题覆盖任何值，则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认设置。

Returns:

无

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

Returns:

无

示例

以下是等价的：

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 Prototype

{
  "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", 
  "id": "p65125", 
  "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'

Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

此属性仅在此组件是布局的子元素（例如网格）时有用。自对齐可以被父容器（例如网格轨道对齐）覆盖。

aspect_ratio = None

Type:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

cols = 20

Type:

Int

指定文本区域的宽度（以平均字符宽度为单位）。默认值：20

context_menu = None

Type:

Nullable(Instance(Menu))

当用户右键点击组件时显示的菜单。

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

允许定义动态计算的CSS变量。

例如，这可以用于协调canvas渲染器和/或视觉效果与基于HTML的UI元素之间的定位和样式。

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

此属性是实验性的，可能会随时更改。

description = None

Type:

Nullable(Either(String, Instance(Tooltip)))

可以是纯文本，也可以是带有丰富HTML描述的工具提示，用于说明此小部件的功能。

disabled = False

Type:

Bool

小部件在渲染时是否会被禁用。

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

附加到此窗格的基于DOM的UI元素集合。

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

Type:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，取决于高度调整策略。

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的height像素。如果组件无法适应可用的垂直空间，将会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度范围内适应可用的垂直空间（如果已设置）。组件的高度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能使用最少的垂直空间，但不少于最小高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素缩小或增长。

"max"

尽可能使用垂直空间，但不超过最大高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

margin = 5

Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。 元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距， 类似于CSS标准。 可以使用负边距值来缩小任何方向的空间。

max_height = None

Type:

Nullable(NonNegative)

如果高度可调，组件的最大高度（以像素为单位）。

max_length = 500

Type:

Nullable(Int)

字段中的最大字符数

max_width = None

Type:

Nullable(NonNegative)

如果宽度可调，组件的最大宽度（以像素为单位）。

min_height = None

Type:

Nullable(NonNegative)

如果高度可调，组件的最小高度（以像素为单位）。

min_width = None

Type:

Nullable(NonNegative)

如果宽度可调，组件的最小宽度（以像素为单位）。

name = None

Type:

Nullable(String)

此模型的任意用户提供的名称。

在查询文档以检索特定Bokeh模型时，此名称可能很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，没有强制执行唯一性保证或其他条件，Bokeh也不会直接使用这些名称。

placeholder = ''

Type:

String

空输入字段的占位符。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上。

rows = 2

Type:

Int

指定文本区域的高度（以行数为单位）。默认值：2

sizing_mode = None

Type:

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 = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层DOM元素的内联CSS样式。

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

请注意，所有Bokeh的组件都使用影子DOM，因此任何包含的样式表都必须反映这一点，例如使用:host CSS伪选择器来访问根DOM元素。

syncable = True

Type:

Bool

指示当在网页浏览器中更新时，此模型是否应同步回Bokeh服务器。设置为False可能有助于在处理频繁更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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 = ''

Type:

Either(String, Instance(HTML))

小部件的标签。

value = ''

Type:

String

初始或输入的文本值。

每当按下时，都会触发更改事件。

value_input = ''

Type:

String

初始值或当前值。

每当发生任何更新时，即每次按键时，都会触发更改事件。

visible = True

Type:

Bool

组件是否应该在屏幕上显示。

width = None

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，取决于宽度调整策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的width像素。如果组件无法适应可用的水平空间，将会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度范围内（如果已设置）适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不少于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

"max"

尽可能使用水平空间，但不超过最大宽度（如果已设置）。 起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于替代默认值，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和HasProps实例都不应修改它）。

Parameters:

property_values (dict) – 用于替换默认值的主题值

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制一个HasProps对象。

这将创建原始模型的浅克隆，即任何可变的容器或子模型将不会被复制。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有DataSpec属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

DataSpec 属性的名称

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符的列表，按定义的顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

如果属性在结构上相等，则为True，否则为False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用JavaScript链接两个Bokeh模型属性。

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

• attr (str) – 此模型上的Bokeh属性的名称

• 其他 (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，给定属性名称。

Parameters:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

• attr (str) – 此对象上的一个属性名称

• *callbacks (callable) – 要注册的回调函数

Returns:

无

示例

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值。

Returns:

列表(参数)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类的属性名称。

警告

在Bokeh的未来版本中，此方法将返回一个将属性名称映射到属性对象的字典。为了使当前使用此方法的方式具有未来兼容性，请将返回值包装在list中。

Returns:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

具有引用的属性名称

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

不可序列化的属性将被跳过，属性值以“序列化”格式呈现，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损重构对象实例所需的信息。

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

Parameters:

• query (callable) – 一个可调用对象，接受属性描述符并返回 True 或 False

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何内容，则返回None :param selector: :type selector: JSON-like

Returns:

模型

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从JSON设置此对象的属性值。

Parameters:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止对Bokeh应用程序的“回旋镖”更新。

  在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在执行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置器与自身进行比较，并抑制源自自身的任何更新。

Returns:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以属性名称到值的字典形式返回，如果此实例没有主题覆盖任何值，则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认设置。

Returns:

无

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

Returns:

无

示例

以下是等价的：

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 Prototype

{
  "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", 
  "id": "p65159", 
  "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'

Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

此属性仅在此组件是布局的子元素（例如网格）时有用。自对齐可以被父容器（例如网格轨道对齐）覆盖。

aspect_ratio = None

Type:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

context_menu = None

Type:

Nullable(Instance(Menu))

当用户右键点击组件时显示的菜单。

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

允许定义动态计算的CSS变量。

例如，这可以用于协调canvas渲染器和/或视觉效果与基于HTML的UI元素之间的定位和样式。

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

此属性是实验性的，可能会随时更改。

description = None

Type:

Nullable(Either(String, Instance(Tooltip)))

可以是纯文本，也可以是带有丰富HTML描述的工具提示，用于说明此小部件的功能。

disabled = False

Type:

Bool

小部件在渲染时是否会被禁用。

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

附加到此窗格的基于DOM的UI元素集合。

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

Type:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，取决于高度调整策略。

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的height像素。如果组件无法适应可用的垂直空间，将会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度范围内适应可用的垂直空间（如果已设置）。组件的高度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能使用最少的垂直空间，但不少于最小高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素缩小或增长。

"max"

尽可能使用垂直空间，但不超过最大高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

margin = 5

Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。 元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距， 类似于CSS标准。 可以使用负边距值来缩小任何方向的空间。

max_height = None

Type:

Nullable(NonNegative)

如果高度可调，组件的最大高度（以像素为单位）。

max_length = None

Type:

Nullable(Int)

字段中的最大字符数

max_width = None

Type:

Nullable(NonNegative)

如果宽度可调，组件的最大宽度（以像素为单位）。

min_height = None

Type:

Nullable(NonNegative)

如果高度可调，组件的最小高度（以像素为单位）。

min_width = None

Type:

Nullable(NonNegative)

如果宽度可调，组件的最小宽度（以像素为单位）。

name = None

Type:

Nullable(String)

此模型的任意用户提供的名称。

在查询文档以检索特定Bokeh模型时，此名称可能很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，没有强制执行唯一性保证或其他条件，Bokeh也不会直接使用这些名称。

placeholder = ''

Type:

String

空输入字段的占位符。

prefix = None

Type:

Nullable(String)

一个可选的字符串前缀，显示在输入之前。这对于指示例如将分配给输入值的变量很有用。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上。

sizing_mode = None

Type:

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 = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层DOM元素的内联CSS样式。

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

请注意，所有Bokeh的组件都使用影子DOM，因此任何包含的样式表都必须反映这一点，例如使用:host CSS伪选择器来访问根DOM元素。

suffix = None

Type:

Nullable(String)

一个可选的字符串后缀，显示在输入之后。这对于指示例如输入值的测量单位非常有用。

syncable = True

Type:

Bool

指示当在网页浏览器中更新时，此模型是否应同步回Bokeh服务器。设置为False可能有助于在处理频繁更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([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 = ''

Type:

Either(String, Instance(HTML))

小部件的标签。

value = ''

Type:

String

初始或输入的文本值。

每当按下时，都会触发更改事件。

value_input = ''

Type:

String

初始值或当前值。

每当发生任何更新时，即每次按键时，都会触发更改事件。

visible = True

Type:

Bool

组件是否应该在屏幕上显示。

width = None

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，取决于宽度调整策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的width像素。如果组件无法适应可用的水平空间，将会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度范围内（如果已设置）适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不少于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

"max"

尽可能使用水平空间，但不超过最大宽度（如果已设置）。 起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于替代默认值，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和HasProps实例都不应修改它）。

Parameters:

property_values (dict) – 用于替换默认值的主题值

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制一个HasProps对象。

这将创建原始模型的浅克隆，即任何可变的容器或子模型将不会被复制。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有DataSpec属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

DataSpec 属性的名称

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符的列表，按定义的顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

如果属性在结构上相等，则为True，否则为False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用JavaScript链接两个Bokeh模型属性。

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

• attr (str) – 此模型上的Bokeh属性的名称

• 其他 (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，给定属性名称。

Parameters:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

• attr (str) – 此对象上的一个属性名称

• *callbacks (callable) – 要注册的回调函数

Returns:

无

示例

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值。

Returns:

列表(参数)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类的属性名称。

警告

在Bokeh的未来版本中，此方法将返回一个将属性名称映射到属性对象的字典。为了使当前使用此方法的方式具有未来兼容性，请将返回值包装在list中。

Returns:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

具有引用的属性名称

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

不可序列化的属性将被跳过，属性值以“序列化”格式呈现，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损重构对象实例所需的信息。

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

Parameters:

• query (callable) – 一个可调用对象，接受属性描述符并返回 True 或 False

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何内容，则返回None :param selector: :type selector: JSON-like

Returns:

模型

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从JSON设置此对象的属性值。

Parameters:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止对Bokeh应用程序的“回旋镖”更新。

  在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在执行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置器与自身进行比较，并抑制源自自身的任何更新。

Returns:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以属性名称到值的字典形式返回，如果此实例没有主题覆盖任何值，则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认设置。

Returns:

无

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

Returns:

无

示例

以下是等价的：

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

调色板选择小部件。

自版本 3.4.0 起已弃用：请改用 PaletteSelect 小部件。