菜单

各种类型的菜单。

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

基类：MenuItem

一个带有图标、标签、快捷键、子菜单和关联操作的基本菜单项。

仅标签是必需的。所有其他属性都是可选的。

JSON 原型

{
  "action": null, 
  "disabled": false, 
  "icon": null, 
  "id": "p64184", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "label": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "menu": null, 
  "name": null, 
  "shortcut": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tooltip": null
}

action = None

类型：:

Nullable(Instance(Callback))

与该项关联的可选操作（回调）。

disabled = False

类型：:

布尔值

指示单击该项是否会激活关联的操作。

icon = None

类型：:

Nullable(Either(Image, Enum(ToolIcon), Regex, Regex))

在标签左侧显示的可选图标。

label = Undefined

类型：:

Required(String)

纯文本字符串标签。

menu = None

类型：:

Nullable(Instance(Menu))

将鼠标悬停在该项上时显示的可选子菜单。

name = None

类型：:

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 也不会出于任何原因直接使用该名称。

shortcut = None

类型：:

Nullable(String)

一个可选的字符串，表示触发操作的键盘序列。

注意

这只是对用户的 UI 提示。菜单本身不实现任何基于键盘输入触发操作的支持。

syncable = True

类型：:

布尔值

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

注意

将此属性设置为 False 将阻止该对象上的任何 on_change() 回调触发。但是，任何 JS 侧回调仍将起作用。

tags = []

类型：:

列表

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

当查询文档以检索特定 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 也不会出于任何原因直接使用这些标签。

tooltip = None

类型：:

Nullable(String)

悬停在该项目上时显示的可选纯文本描述。

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

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

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

参数：:

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

返回：:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回：:

DataSpec 属性的名称

返回类型：:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数：:

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

返回：:

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

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

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

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

参数：:

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

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

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

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

在版本 1.1 中添加

引发：:

ValueError –

例子

此代码使用 js_link

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

等效于以下内容

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

此外，要使用 attr_selector 将范围滑块的左侧附加到图表的 x_range

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

等效于

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

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

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则会自动在前面加上 "change:"

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

但是，除了属性更改事件之外，还有其他类型的事件可能有助于响应。例如，要运行一个回调，每当将数据流式传输到 ColumnDataSource 时运行，请在源上使用 "stream" 事件

source.js_on_change('streaming', callback)

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

在类中查找 Bokeh 属性的 PropertyDescriptor，给出属性名称。

参数：:

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

• raises (bool) – 如果丢失，是否引发异常或返回 None

返回：:

名为 name 的属性的描述符

返回类型：:

PropertyDescriptor

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

在该对象上添加一个回调，当 attr 发生更改时触发。

参数：:

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

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

返回：:

None

例子

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

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

当该 Model 上发生指定的事件时运行回调

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

classmethod parameters() → list[Parameter]

生成适合从 glyph 派生的函数的 Python Parameter 值。

返回：:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回：:

属性名称

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

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

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

返回：:

具有引用的属性的名称

返回类型：:

set[str]

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

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

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

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

参数：:

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

返回：:

属性名称与其值的映射

返回类型：:

dict

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

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

参数：:

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

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

返回：:

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

返回类型：:

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：:

selector (JSON-like)

返回：:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回：:

Model

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

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

参数：:

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

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

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

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

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

返回：:

None

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

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

参数：:

• selector (JSON-like)

• updates (dict)

返回：:

None

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

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

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

返回：:

dict 或者 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回：:

None

update(**kwargs: Any) → None

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

返回：:

None

例子

以下是等效的

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

Bases: ActionItem

一个两态可选中菜单项。

JSON 原型

{
  "action": null, 
  "checked": false, 
  "disabled": false, 
  "icon": null, 
  "id": "p64195", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "label": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "menu": null, 
  "name": null, 
  "shortcut": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tooltip": null
}

action = None

类型：:

Nullable(Instance(Callback))

与该项关联的可选操作（回调）。

checked = False

类型：:

布尔值

可选中项的状态。

选中的项目在项目左侧用一个勾号表示。未选中的项目用一个空白表示。

disabled = False

类型：:

布尔值

指示单击该项是否会激活关联的操作。

icon = None

类型：:

Nullable(Either(Image, Enum(ToolIcon), Regex, Regex))

在标签左侧显示的可选图标。

label = Undefined

类型：:

Required(String)

纯文本字符串标签。

menu = None

类型：:

Nullable(Instance(Menu))

将鼠标悬停在该项上时显示的可选子菜单。

name = None

类型：:

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 也不会出于任何原因直接使用该名称。

shortcut = None

类型：:

Nullable(String)

一个可选的字符串，表示触发操作的键盘序列。

注意

这只是对用户的 UI 提示。菜单本身不实现任何基于键盘输入触发操作的支持。

syncable = True

类型：:

布尔值

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

注意

将此属性设置为 False 将阻止该对象上的任何 on_change() 回调触发。但是，任何 JS 侧回调仍将起作用。

tags = []

类型：:

列表

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

当查询文档以检索特定 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 也不会出于任何原因直接使用这些标签。

tooltip = None

类型：:

Nullable(String)

悬停在该项目上时显示的可选纯文本描述。

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

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

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

参数：:

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

返回：:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回：:

DataSpec 属性的名称

返回类型：:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数：:

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

返回：:

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

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

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

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

参数：:

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

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

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

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

在版本 1.1 中添加

引发：:

ValueError –

例子

此代码使用 js_link

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

等效于以下内容

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

此外，要使用 attr_selector 将范围滑块的左侧附加到图表的 x_range

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

等效于

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

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

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则会自动在前面加上 "change:"

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

但是，除了属性更改事件之外，还有其他类型的事件可能有助于响应。例如，要运行一个回调，每当将数据流式传输到 ColumnDataSource 时运行，请在源上使用 "stream" 事件

source.js_on_change('streaming', callback)

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

在类中查找 Bokeh 属性的 PropertyDescriptor，给出属性名称。

参数：:

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

• raises (bool) – 如果丢失，是否引发异常或返回 None

返回：:

名为 name 的属性的描述符

返回类型：:

PropertyDescriptor

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

在该对象上添加一个回调，当 attr 发生更改时触发。

参数：:

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

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

返回：:

None

例子

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

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

当该 Model 上发生指定的事件时运行回调

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

classmethod parameters() → list[Parameter]

生成适合从 glyph 派生的函数的 Python Parameter 值。

返回：:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回：:

属性名称

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

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

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

返回：:

具有引用的属性的名称

返回类型：:

set[str]

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

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

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

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

参数：:

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

返回：:

属性名称与其值的映射

返回类型：:

dict

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

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

参数：:

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

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

返回：:

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

返回类型：:

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：:

selector (JSON-like)

返回：:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回：:

Model

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

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

参数：:

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

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

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

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

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

返回：:

None

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

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

参数：:

• selector (JSON-like)

• updates (dict)

返回：:

None

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

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

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

返回：:

dict 或者 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回：:

None

update(**kwargs: Any) → None

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

返回：:

None

例子

以下是等效的

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

基类：MenuItem

菜单项之间的一条分割线。

JSON 原型

{
  "id": "p64207", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

name = None

类型：:

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 也不会出于任何原因直接使用该名称。

syncable = True

类型：:

布尔值

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

注意

将此属性设置为 False 将阻止该对象上的任何 on_change() 回调触发。但是，任何 JS 侧回调仍将起作用。

tags = []

类型：:

列表

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

当查询文档以检索特定 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 也不会出于任何原因直接使用这些标签。

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

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

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

参数：:

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

返回：:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回：:

DataSpec 属性的名称

返回类型：:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数：:

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

返回：:

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

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

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

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

参数：:

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

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

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

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

在版本 1.1 中添加

引发：:

ValueError –

例子

此代码使用 js_link

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

等效于以下内容

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

此外，要使用 attr_selector 将范围滑块的左侧附加到图表的 x_range

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

等效于

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

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

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则会自动在前面加上 "change:"

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

但是，除了属性更改事件之外，还有其他类型的事件可能有助于响应。例如，要运行一个回调，每当将数据流式传输到 ColumnDataSource 时运行，请在源上使用 "stream" 事件

source.js_on_change('streaming', callback)

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

在类中查找 Bokeh 属性的 PropertyDescriptor，给出属性名称。

参数：:

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

• raises (bool) – 如果丢失，是否引发异常或返回 None

返回：:

名为 name 的属性的描述符

返回类型：:

PropertyDescriptor

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

在该对象上添加一个回调，当 attr 发生更改时触发。

参数：:

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

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

返回：:

None

例子

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

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

当该 Model 上发生指定的事件时运行回调

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

classmethod parameters() → list[Parameter]

生成适合从 glyph 派生的函数的 Python Parameter 值。

返回：:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回：:

属性名称

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

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

返回：:

具有引用的属性的名称

返回类型：:

set[str]

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

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

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

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

参数：:

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

返回：:

属性名称与其值的映射

返回类型：:

dict

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

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

参数：:

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

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

返回：:

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

返回类型：:

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：:

selector (JSON-like)

返回：:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回：:

Model

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

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

参数：:

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

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

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

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

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

返回：:

None

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

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

参数：:

• selector (JSON-like)

• updates (dict)

返回：:

None

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

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

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

返回：:

dict 或者 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回：:

None

update(**kwargs: Any) → None

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

返回：:

None

例子

以下是等效的

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

Bases: UIElement

一个隐式定位的面板，包含一个项目集合。

这些项目可以包括命令、选中项目、分隔符等。

JSON 原型

{
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "id": "p64211", 
  "items": [], 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "reversed": false, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

context_menu = None

类型：:

Nullable(Instance(‘.models.ui.Menu’))

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

注意

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

css_classes = []

类型：:

列表

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

css_variables = {}

类型：:

Dict(String, Instance(Node))

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

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

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

注意

此属性为实验性质，可能随时更改。

items = []

类型：:

列表

代表菜单项的集合。

name = None

类型：:

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 也不会出于任何原因直接使用该名称。

reversed = False

类型：:

布尔值

是否保持菜单项的顺序或反转。

styles = {}

类型：:

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

应用于基础 DOM 元素的内联 CSS 样式。

stylesheets = []

类型：:

列表

要用于基础 DOM 元素的附加样式表。

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

syncable = True

类型：:

布尔值

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

注意

将此属性设置为 False 将阻止该对象上的任何 on_change() 回调触发。但是，任何 JS 侧回调仍将起作用。

tags = []

类型：:

列表

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

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

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

类型：:

布尔值

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

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

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

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

参数：:

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

返回：:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回：:

DataSpec 属性的名称

返回类型：:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数：:

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

返回：:

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

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

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

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

参数：:

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

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

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

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

在版本 1.1 中添加

引发：:

ValueError –

例子

此代码使用 js_link

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

等效于以下内容

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

此外，要使用 attr_selector 将范围滑块的左侧附加到图表的 x_range

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

等效于

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

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

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则会自动在前面加上 "change:"

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

但是，除了属性更改事件之外，还有其他类型的事件可能有助于响应。例如，要运行一个回调，每当将数据流式传输到 ColumnDataSource 时运行，请在源上使用 "stream" 事件

source.js_on_change('streaming', callback)

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

在类中查找 Bokeh 属性的 PropertyDescriptor，给出属性名称。

参数：:

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

• raises (bool) – 如果丢失，是否引发异常或返回 None

返回：:

名为 name 的属性的描述符

返回类型：:

PropertyDescriptor

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

在该对象上添加一个回调，当 attr 发生更改时触发。

参数：:

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

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

返回：:

None

例子

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

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

当该 Model 上发生指定的事件时运行回调

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

classmethod parameters() → list[Parameter]

生成适合从 glyph 派生的函数的 Python Parameter 值。

返回：:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回：:

属性名称

classmethod properties_with_refs() → dict[str,

返回：:

具有引用的属性的名称

返回类型：:

set[str]

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

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

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

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

参数：:

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

返回：:

属性名称与其值的映射

返回类型：:

dict

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

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

参数：:

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

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

返回：:

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

返回类型：:

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：:

selector (JSON-like)

返回：:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回：:

Model

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

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

参数：:

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

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

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

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

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

返回：:

None

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

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

参数：:

• selector (JSON-like)

• updates (dict)

返回：:

None

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

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

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

返回：:

dict 或者 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回：:

None

update(**kwargs: Any) → None

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

返回：:

None

例子

以下是等效的

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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