工具

Bokeh 提供了许多交互式工具。

有五种类型的工具交互：

平移/拖动

点击/轻触

滚动/捏合

Actions

Inspectors

前三种属于手势工具类别，每种手势在任何给定时间只能有一个工具处于活动状态。活动工具在工具栏上通过工具旁边的高亮显示来指示。动作是即时或模态操作，只有在按下工具栏中的按钮时才会激活。检查器是被动工具，仅以某种方式报告信息或注释图表，无论当前其他工具是否处于活动状态，检查器都可以始终处于活动状态。

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

基础类：Tool

工具栏中按钮工具的基类。

注意

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

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p63264", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：EditTool, Drag, Tap

工具栏图标:

允许通过编辑底层的ColumnDataSource数据在一个或多个渲染器上绘制、拖动和删除类似盒子的字形（例如Block、Rect、HStrip）。与其他绘图工具一样，要编辑的渲染器必须明确地作为列表提供。当绘制一个新盒子时，数据将始终添加到第一个提供的渲染器的ColumnDataSource上。

该工具将修改数据源上与字形对应的x、y、width和height值的列。在添加新框时，数据源中的任何额外列都将用empty_value填充。

支持的操作包括：

• 添加框：按住Shift键，然后在图表上任意位置点击并拖动，或者点击一次开始绘制，移动鼠标并再次点击完成绘制。

• 移动框：点击并拖动现有的框，一旦松开鼠标按钮，框将被放置。

• 删除框：点击一个框以选择它，然后在鼠标位于绘图区域内时按下BACKSPACE键。

要移动或删除多个框：

• 移动选择：使用SHIFT+点击（或其他选择工具）选择框，然后在图表上的任何位置拖动。选择并拖动特定框将同时移动两者。

• 删除选择：使用SHIFT+点击（或其他选择工具）选择框，然后在鼠标位于绘图区域内时按BACKSPACE键。

JSON Prototype

{
  "default_overrides": {
    "type": "map"
  }, 
  "description": null, 
  "dimensions": "both", 
  "empty_value": 0, 
  "icon": null, 
  "id": "p63271", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "num_objects": 0, 
  "renderers": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

default_overrides = {}

Type:

Dict(String, Any)

填充值覆盖 ColumnarDataSource.default_values。

定义在将新字形插入ColumnDataSource列时要插入非坐标列的值，例如当一个圆形字形定义了"x"、"y"和"color"列时，添加一个新点将会将x和y坐标添加到"x"和"y"列，而颜色列将填充定义的默认值。

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

dimensions = 'both'

Type:

Enum(Dimensions)

盒子绘图在哪些维度上是自由的。默认情况下，用户可以自由绘制任何尺寸的盒子。如果仅设置了“宽度”，盒子将被限制为跨越图表的整个垂直空间，只有水平尺寸可以控制。如果仅设置了“高度”，盒子将被限制为跨越图表的整个水平空间，垂直尺寸可以控制。

empty_value = 0

Type:

Either(Bool, Int, Float, Date, Datetime, Color, String)

“最后手段”的填充值。

这与default_values的使用方式相同，当工具无法确定默认值时使用。工具将按顺序尝试以下替代方案：

1. EditTool.default_overrides

2. ColumnarDataSource.default_values

3. ColumnarDataSource 的推断默认值

4. EditTool.empty_value

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

num_objects = 0

Type:

Int

定义可以绘制的框的数量限制。默认情况下，对对象的数量没有限制，但如果启用此限制，最旧的绘制框将被删除，以便为新添加的框腾出空间。

renderers = []

Type:

List

对应于可以编辑的字形的渲染器列表。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：Drag, RegionSelectTool

工具栏图标:

框选工具允许用户通过在绘图区域上拖动鼠标或手指来显示一个矩形区域，从而在图表上进行选择。拖动事件的结束表示选择区域已准备就绪。

请参阅Selected and unselected glyphs以获取有关样式化选中和未选中字形信息。

JSON Prototype

{
  "continuous": false, 
  "description": null, 
  "dimensions": "both", 
  "greedy": false, 
  "icon": null, 
  "id": "p63283", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "mode": "replace", 
  "name": null, 
  "origin": "corner", 
  "overlay": {
    "attributes": {
      "bottom": {
        "type": "number", 
        "value": "nan"
      }, 
      "editable": true, 
      "fill_alpha": 0.5, 
      "fill_color": "lightgrey", 
      "handles": {
        "attributes": {
          "all": {
            "attributes": {
              "fill_color": "white", 
              "hover_fill_color": "lightgray"
            }, 
            "id": "p63289", 
            "name": "AreaVisuals", 
            "type": "object"
          }
        }, 
        "id": "p63290", 
        "name": "BoxInteractionHandles", 
        "type": "object"
      }, 
      "left": {
        "type": "number", 
        "value": "nan"
      }, 
      "level": "overlay", 
      "line_alpha": 1.0, 
      "line_color": "black", 
      "line_dash": [
        4, 
        4
      ], 
      "line_width": 2, 
      "right": {
        "type": "number", 
        "value": "nan"
      }, 
      "syncable": false, 
      "top": {
        "type": "number", 
        "value": "nan"
      }, 
      "visible": false
    }, 
    "id": "p63284", 
    "name": "BoxAnnotation", 
    "type": "object"
  }, 
  "persistent": false, 
  "renderers": "auto", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

continuous = False

Type:

Bool

选择计算是否应在选择手势期间连续进行，或仅在选择区域完成时进行一次。

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

dimensions = 'both'

Type:

Enum(Dimensions)

框选在哪些维度上是自由的。默认情况下，用户可以自由绘制任何尺寸的选择框。如果只设置了“宽度”，框将被限制为跨越图表的整个垂直空间，只能控制水平维度。如果只设置了“高度”，框将被限制为跨越图表的整个水平空间，可以控制垂直维度。

greedy = False

Type:

Bool

定义是否需要对字形进行完全包围（非贪婪）或仅需交集（贪婪）的点击（即区域内至少有一个点）。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

mode = 'replace'

Type:

Enum(RegionSelectionMode)

定义当进行新选择时应发生的情况。默认是替换现有选择。其他选项包括附加到选择、与选择相交或从选择中减去。

定义在选择新选项时应发生的情况。

默认是替换现有的选择。其他选项包括追加到选择、与选择相交、从选择中减去或计算与选择的对称差。

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也不会直接使用这些名称。

origin = 'corner'

Type:

Enum(枚举(corner, center))

指示矩形选择区域是否应从角落（根据方向为左上角或右下角）或框的中心开始。

overlay = BoxAnnotation(id='p63363', ...)

Type:

Instance(BoxAnnotation)

一个阴影注释，用于指示选择区域。

persistent = False

Type:

Bool

选择手势完成后，选择覆盖是否应持续存在。这可以与在注释上设置editable = True配对，以允许修改选择。

renderers = 'auto'

Type:

Either(Auto, List)

用于点击测试的渲染器列表。如果未设置，则默认为绘图上的所有渲染器。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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）

select_every_mousemove

这是 'continuous' 属性的向后兼容别名。

注意

属性 'select_every_mousemove' 在 Bokeh 3.1.0 中已被弃用，并将在未来版本中移除。请更新您的代码，改用 'continuous'。

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

基础类: Drag

工具栏图标:

框选缩放工具允许用户通过在绘图区域上拖动鼠标或手指来定义要缩放的绘图矩形区域。拖动事件的结束表示选择区域已准备好。

注意

BoxZoomTool 与 GMapPlot 不兼容，原因是 Google Maps 对宽高比施加了明确控制。将此工具添加到 GMapPlot 将不会产生任何效果。

JSON Prototype

{
  "description": null, 
  "dimensions": "both", 
  "icon": null, 
  "id": "p63410", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "match_aspect": false, 
  "name": null, 
  "origin": "corner", 
  "overlay": {
    "attributes": {
      "bottom": {
        "type": "number", 
        "value": "nan"
      }, 
      "bottom_units": "canvas", 
      "fill_alpha": 0.5, 
      "fill_color": "lightgrey", 
      "handles": {
        "attributes": {
          "all": {
            "attributes": {
              "fill_color": "white", 
              "hover_fill_color": "lightgray"
            }, 
            "id": "p63416", 
            "name": "AreaVisuals", 
            "type": "object"
          }
        }, 
        "id": "p63417", 
        "name": "BoxInteractionHandles", 
        "type": "object"
      }, 
      "left": {
        "type": "number", 
        "value": "nan"
      }, 
      "left_units": "canvas", 
      "level": "overlay", 
      "line_alpha": 1.0, 
      "line_color": "black", 
      "line_dash": [
        4, 
        4
      ], 
      "line_width": 2, 
      "right": {
        "type": "number", 
        "value": "nan"
      }, 
      "right_units": "canvas", 
      "syncable": false, 
      "top": {
        "type": "number", 
        "value": "nan"
      }, 
      "top_units": "canvas", 
      "visible": false
    }, 
    "id": "p63411", 
    "name": "BoxAnnotation", 
    "type": "object"
  }, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

dimensions = 'both'

Type:

Either(Enum(Dimensions), Auto)

缩放框在哪些维度上是自由的。默认情况下，用户可以自由绘制具有任何尺寸的缩放框。如果只提供“宽度”，则框将被限制为跨越图表的整个垂直空间，只有水平尺寸可以控制。如果只提供“高度”，则框将被限制为跨越图表的整个水平空间，垂直尺寸可以控制。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

match_aspect = False

Type:

Bool

是否应将框缩放区域限制为与绘图区域具有相同的宽高比。

注意

如果工具被限制在一维，这个值没有影响。

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也不会直接使用这些名称。

origin = 'corner'

Type:

Enum(枚举(corner, center))

指示矩形缩放区域是否应从角落（根据方向为左上角或右下角）或框的中心开始。

overlay = BoxAnnotation(id='p63474', ...)

Type:

Instance(BoxAnnotation)

一个阴影注释，用于指示选择区域。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：PlotActionTool

一个工具，允许通过点击按钮以固定量平移图表。

JSON Prototype

{
  "description": null, 
  "direction": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "factor": 0.1, 
  "icon": null, 
  "id": "p63505", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

direction = Undefined

Type:

Required(Enum(PanDirection))

平移绘图的方向。

接受的值为 "left", "right", "up" 或 "down"，或者它们各自的别名 "west", "east", "north", "south"。

factor = 0.1

Type:

Percent

每次使用工具时平移范围的百分比。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：ActionTool

工具栏图标:

复制工具是一个操作工具，它允许将绘图或一组绘图的渲染内容复制到系统的剪贴板。此工具依赖于浏览器，可能在某些浏览器中无法使用，或者需要授予网页额外的权限。

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p63514", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：InspectTool

工具栏图标:

十字准线工具是一个被动的检查工具。它通常一直处于开启状态，但可以在与上面显示的工具栏图标相关的检查器菜单中进行配置。

十字准线工具在图表上绘制一个十字准线注释，以当前鼠标位置为中心。可以通过将dimension属性设置为仅width或height来配置十字准线工具仅在一个维度上绘制。

JSON Prototype

{
  "description": null, 
  "dimensions": "both", 
  "icon": null, 
  "id": "p63521", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "line_alpha": 1.0, 
  "line_color": "black", 
  "line_width": 1, 
  "name": null, 
  "overlay": "auto", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

dimensions = 'both'

Type:

Enum(Dimensions)

十字准线工具要跟踪的维度。默认情况下，将绘制垂直和水平线。如果仅提供“width”，则仅绘制水平线。如果仅提供“height”，则仅绘制垂直线。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

line_alpha = 1.0

Type:

Alpha

用于描边路径的alpha值。

可接受的值为0到1之间的浮点数（0表示透明，1表示不透明）。

line_color = 'black'

Type:

Color

用于描边路径的颜色。

可接受的值有：

• 任何命名的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位无符号整数

line_width = 1

Type:

Float

笔画宽度以像素为单位。

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也不会直接使用这些名称。

overlay = 'auto'

Type:

Either(Auto, Instance(Span), Tuple(Instance(Span), Instance(Span)))

绘制注释以指示十字线。

如果 "auto"，这将根据 dimensions 属性创建跨度，根据其值，将导致一个跨度（水平或垂直）或两个跨度（水平和垂直）。

或者，用户可以提供一个Span实例，其中维度由Span的dimension属性指示。也可以提供两个Span实例。提供显式的Span实例允许构建链接的十字线，当这些实例在不同图表的十字线工具之间共享时。

注意

此属性是实验性的，可能会随时更改。特别是将来这将允许使用除Span之外的注释和注释组。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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）

toggleable

这是‘visible’属性的向后兼容别名。

注意

属性‘toggleable’在Bokeh 3.4.0中已被弃用，并将在未来版本中移除。请更新您的代码，改用‘visible’。

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

基础类：ActionTool

执行自定义操作，例如当工具栏图标被激活时，CustomJS 回调。

Example

tool = CustomAction(icon="icon.png",
                    callback=CustomJS(code='alert("foo")'))

plot.add_tools(tool)

JSON Prototype

{
  "callback": null, 
  "description": "Perform a Custom Action", 
  "icon": null, 
  "id": "p63533", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

callback = None

Type:

Nullable(Instance(Callback))

当自定义操作图标被激活时执行的Bokeh回调。

description = 'Perform a Custom Action'

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：Model

定义一个自定义格式化程序以应用于悬停工具字段。

此模型可以通过JavaScript代码配置以格式化悬停工具提示。 JavaScript代码可以访问当前要格式化的值、一些特殊变量以及工具提示上配置的任何格式。变量value将包含未转换的值。变量special_vars将提供一个包含以下内容的字典：

• x 数据空间中鼠标的x坐标

• y 数据空间中鼠标的y坐标

• sx 鼠标的屏幕空间x坐标

• sy 鼠标的屏幕空间 y 坐标

• data_x 悬停符号的数据空间x坐标

• data_y 悬停符号的数据空间 y 坐标

• indices 所有当前悬停的图标的列索引

• name 悬停的 glyph 渲染器的 name 属性值

如果悬停在一个“多”字形上，例如 Patches 或 MultiLine，那么还会出现一个 segment_index 键。

最后，在工具提示规范中传递的格式值可作为 format 变量使用。

Example

例如，以下代码添加了一个自定义格式化程序，用于将WebMercator北向坐标（以米为单位）格式化为纬度：

lat_custom = CustomJSHover(code="""
    const projections = Bokeh.require("core/util/projections");
    const x = special_vars.x
    const y = special_vars.y
    const coords = projections.wgs84_mercator.invert(x, y)
    return "" + coords[1]
""")

p.add_tools(HoverTool(
    tooltips=[( 'lat','@y{custom}' )],
    formatters={'@y':lat_custom}
))

警告

这个Bokeh模型的明确目的是嵌入原始JavaScript代码供浏览器执行。如果代码的任何部分来自不受信任的用户输入，则必须在传递给Bokeh之前对用户输入进行适当的清理。

JSON Prototype

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

args = {}

Type:

Dict(String, AnyRef)

名称到Bokeh绘图对象的映射。这些对象作为回调函数的命名参数值，可供回调代码片段使用。

code = ''

Type:

String

一段用于转换单个值的JavaScript代码片段。变量 value 将包含未转换的值，并且可以预期在渲染时存在于函数命名空间中。此外，变量 special_vars 也将可用，并将提供一个包含以下内容的字典：

• x 数据空间中鼠标的x坐标

• y 数据空间中鼠标的y坐标

• sx 鼠标的屏幕空间x坐标

• sy 鼠标的屏幕空间 y 坐标

• data_x 悬停符号的数据空间x坐标

• data_y 悬停符号的数据空间 y 坐标

• indices 列索引，表示当前所有悬停的图标的索引

如果悬停在一个“多”字形上，例如 Patches 或 MultiLine，那么还会出现一个 segment_index 键。

最后，在工具提示规范中传递的格式值可作为 format 变量使用。

该代码片段将被转换为函数体，因此需要一个返回语句。

示例

code = '''
return value + " total"
'''

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也不会直接使用这些名称。

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也不会出于任何原因直接使用这些标签。

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

基础类: GestureTool

用于响应拖动事件的工具的基类。

注意

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

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p63547", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：GestureTool

所有交互式绘图工具类型的基类。

注意

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

JSON Prototype

{
  "default_overrides": {
    "type": "map"
  }, 
  "description": null, 
  "empty_value": 0, 
  "icon": null, 
  "id": "p63554", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

default_overrides = {}

Type:

Dict(String, Any)

填充值覆盖 ColumnarDataSource.default_values。

定义在将新字形插入ColumnDataSource列时要插入非坐标列的值，例如当一个圆形字形定义了"x"、"y"和"color"列时，添加一个新点将会将x和y坐标添加到"x"和"y"列，而颜色列将填充定义的默认值。

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

empty_value = 0

Type:

Either(Bool, Int, Float, Date, Datetime, Color, String)

“最后手段”的填充值。

这与default_values的使用方式相同，当工具无法确定默认值时使用。工具将按顺序尝试以下替代方案：

1. EditTool.default_overrides

2. ColumnarDataSource.default_values

3. ColumnarDataSource 的推断默认值

4. EditTool.empty_value

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：ActionTool

一个允许检查和配置模型的工具。

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p63563", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：EditTool, Drag, Tap

工具栏图标:

允许自由绘制Patches和MultiLine图形。绘制的图形可以通过renderers属性定义。

该工具将修改数据源中与图标的xs和ys值对应的列。在添加新点时，数据源中的任何额外列将用声明的empty_value填充。

支持的操作包括：

• 绘制顶点：点击并拖动以绘制一条线

• 删除补丁/多行：点击补丁/多行以选择它，然后在鼠标位于绘图区域内时按下BACKSPACE键。

JSON Prototype

{
  "default_overrides": {
    "type": "map"
  }, 
  "description": null, 
  "empty_value": 0, 
  "icon": null, 
  "id": "p63570", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "num_objects": 0, 
  "renderers": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

default_overrides = {}

Type:

Dict(String, Any)

填充值覆盖 ColumnarDataSource.default_values。

定义在将新字形插入ColumnDataSource列时要插入非坐标列的值，例如当一个圆形字形定义了"x"、"y"和"color"列时，添加一个新点将会将x和y坐标添加到"x"和"y"列，而颜色列将填充定义的默认值。

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

empty_value = 0

Type:

Either(Bool, Int, Float, Date, Datetime, Color, String)

“最后手段”的填充值。

这与default_values的使用方式相同，当工具无法确定默认值时使用。工具将按顺序尝试以下替代方案：

1. EditTool.default_overrides

2. ColumnarDataSource.default_values

3. ColumnarDataSource 的推断默认值

4. EditTool.empty_value

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

num_objects = 0

Type:

Int

定义可以绘制的补丁或多线的数量限制。 默认情况下，对对象的数量没有限制，但如果启用此限制，当达到限制时，最早绘制的补丁或多线将被覆盖。

renderers = []

Type:

List

对应于可以编辑的字形的渲染器列表。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：ActionTool

一个允许将UI元素放大到全屏的工具。

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p63581", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：Tool

用于响应拖动事件的工具的基类。

注意

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

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p63588", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：ActionTool

一个按钮工具，为用户提供“帮助”链接。

悬停文本可以通过help_tooltip属性进行自定义，并且重定向站点也可以被覆盖。

JSON Prototype

{
  "description": "Click the question mark to learn more about Bokeh plot tools.", 
  "icon": null, 
  "id": "p63595", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "redirect": "https://docs.bokeh.org/en/latest/docs/user_guide/interaction/tools.html", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = 'Click the question mark to learn more about Bokeh plot tools.'

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

redirect = 'https://docs.bokeh.org/en/latest/docs/user_guide/interaction/tools.html'

Type:

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也不会出于任何原因直接使用这些标签。

visible = True

Type:

Bool

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：InspectTool

工具栏图标:

悬停工具是一个被动的检查工具。它通常一直处于开启状态，但可以在与上方显示的工具栏图标相关的检查器菜单中进行配置。

默认情况下，当光标直接悬停在图形上时，悬停工具会显示信息提示。显示的数据来自图形的数据源，并且可以通过tooltips属性配置要显示的内容，该属性将显示名称映射到数据源中的列，或映射到特殊的已知变量。

以下是如何配置和使用悬停工具的示例：

# Add tooltip (name, field) pairs to the tool. See below for a
# description of possible field values.
hover.tooltips = [
    ("index", "$index"),
    ("(x,y)", "($x, $y)"),
    ("radius", "@radius"),
    ("fill color", "$color[hex, swatch]:fill_color"),
    ("fill color", "$color[hex]:fill_color"),
    ("fill color", "$color:fill_color"),
    ("fill color", "$swatch:fill_color"),
    ("foo", "@foo"),
    ("bar", "@bar"),
    ("baz", "@baz{safe}"),
    ("total", "@total{$0,0.00}"),
]

你也可以向HoverTool提供一个Callback，以构建自定义的悬停交互。在这种情况下，你可能希望通过设置tooltips=None来关闭工具提示。

警告

当提供回调或自定义模板时，此Bokeh模型的明确意图是嵌入原始HTML和JavaScript代码供浏览器执行。如果代码的任何部分来自不受信任的用户输入，则必须在传递给Bokeh之前对用户输入进行适当的清理。

悬停工具目前不适用于以下字形：

环形 弧 贝塞尔 image_url

椭圆形 补丁 二次的

ray 步骤 text

JSON Prototype

{
  "anchor": "center", 
  "attachment": "horizontal", 
  "callback": null, 
  "description": null, 
  "formatters": {
    "type": "map"
  }, 
  "icon": null, 
  "id": "p63603", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "line_policy": "nearest", 
  "mode": "mouse", 
  "muted_policy": "show", 
  "name": null, 
  "point_policy": "snap_to_data", 
  "renderers": "auto", 
  "show_arrow": true, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tooltips": [
    [
      "index", 
      "$index"
    ], 
    [
      "data (x, y)", 
      "($x, $y)"
    ], 
    [
      "screen (x, y)", 
      "($sx, $sy)"
    ]
  ], 
  "visible": true
}

anchor = 'center'

Type:

Enum(Anchor)

如果点策略设置为“snap_to_data”，anchor定义了工具提示的附着点。默认是附着在图形的中心。

attachment = 'horizontal'

Type:

Enum(TooltipAttachment)

工具提示是否应显示在光标位置的左侧或右侧，或上方或下方，或者是否应自动放置在水平或垂直方向上。

callback = None

Type:

Nullable(Instance(Callback))

每当输入值发生变化时，在浏览器中运行的回调函数。回调代码可用的cb_data参数将包含两个HoverTool特定字段：

Index:

包含数据源中悬停点索引的对象

Geometry:

包含悬停光标坐标的对象

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

formatters = {}

Type:

Dict(String, Either(Enum(TooltipFieldFormatter), Instance(CustomJSHover)))

指定数据源列的格式化方案，例如

tool.formatters = {"@date": "datetime"}

将导致“date”列的格式规范根据“datetime”格式方案进行解释。以下是可用的方案：

“numeral”:

提供了多种格式用于数字、货币、字节、时间和百分比的显示。完整的格式集可以在NumeralTickFormatter参考文档中找到。

“datetime”:

提供日期和时间值的格式。完整的格式集列在DatetimeTickFormatter参考文档中。

“printf”:

提供类似于C风格的“printf”类型说明符的格式。有关完整详细信息，请参阅 PrintfTickFormatter 参考文档。

如果没有为列名指定格式化程序，则假定使用默认的"numeral"格式化程序。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

line_policy = 'nearest'

Type:

Enum(枚举(prev, next, nearest, interp, none))

指定当悬停在线条符号上时，工具提示将定位的位置：

“prev”:

在最近的两个相邻线点之间，将工具提示定位在具有较低（“前一个”）索引的点上

“next”:

在最近的两个相邻线点之间，将工具提示定位在具有较高（“下一个”）索引的点上

“nearest”:

在最近的两个相邻线点之间，将工具提示定位在离鼠标光标位置最近的点上

“interp”:

将工具提示定位在连接两个最近相邻线点的线段上的插值点。

“none”:

将工具提示直接定位在鼠标光标位置下方

mode = 'mouse'

Type:

Enum(枚举(mouse, hline, vline))

是否将悬停指针视为一个点（x/y值），或者在h或v方向上的一个跨度。

muted_policy = 'show'

Type:

Enum(枚举(显示, 忽略))

是否避免在静音的图形上显示工具提示。

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也不会直接使用这些名称。

point_policy = 'snap_to_data'

Type:

Enum(枚举(snap_to_data, follow_mouse, none))

工具提示位置是否应捕捉到相关图标的“中心”（或其他锚点）位置，或始终跟随当前鼠标光标位置。

renderers = 'auto'

Type:

Either(Auto, List)

用于点击测试的渲染器列表。如果未设置，则默认为绘图上的所有渲染器。

show_arrow = True

Type:

Bool

是否应显示工具提示的箭头。

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也不会出于任何原因直接使用这些标签。

tooltips = [('index', '$index'), ('data (x, y)', '($x, $y)'), ('screen (x, y)', '($sx, $sy)')]

Type:

Either(Null, Instance(DOMElement), String, List)

描述当有命中时悬停工具应显示的（名称，字段）对。

以“@”开头的字段名称被解释为数据源上的列。例如，“@temp”将从数据源的“temp”列中查找要显示的值。

以“$”开头的字段名称是特殊的已知字段：

$index:

数据源中悬停点的索引

$name:

悬停的 glyph 渲染器的 name 属性的值

$x:

数据空间中光标下的x坐标

$y:

光标下的数据空间中的y坐标

$sx:

光标在屏幕（画布）空间中的x坐标

$sy:

光标在屏幕（画布）空间中的y坐标

$color:

来自数据源的颜色数据，语法为： $color[options]:field_name。可用的选项 有：hex（将颜色显示为十六进制值），swatch （将来自数据源的颜色数据显示为一个小颜色框）

$swatch:

数据源中的颜色数据显示为一个小颜色框

以@开头的字段名称与ColumnDataSource中的列相关联。例如，字段名称"@price"将在触发悬停时显示"price"列中的值。如果悬停是针对第17个字形，则悬停工具提示将相应地显示第17个价格值。

请注意，如果列名包含空格，则必须用大括号括起来提供，例如 @{adjusted close} 将显示名为 "adjusted close" 的列中的值。

有时（特别是对于堆叠图表），希望允许间接指定列名。字段名 @$name 的特殊之处在于，它会在悬停的 glyph 渲染器上查找 name 字段，并将该值用作列名。例如，如果用户悬停时名称为 "US East"，那么 @$name 等同于 @{US East}。

默认情况下，字段的值（例如 @foo）以基本的数字格式显示。然而，可以更精确地控制值的格式。可以通过在字段末尾附加一个格式说明符来修改字段，格式说明符用大括号括起来。以下是一些示例。

"@foo{0,0.000}"    # formats 10000.1234 as: 10,000.123

"@foo{(.00)}"      # formats -10000.1234 as: (10000.123)

"@foo{($ 0.00 a)}" # formats 1230974 as: $ 1.23 m

在字段名称后指定格式 {safe} 将覆盖工具提示数据源的自动转义。数据标签中的任何HTML标签将在生成的HoverTool输出中呈现为HTML。有关更详细的示例，请参见 自定义工具提示。

None 也是工具提示的有效值。这将关闭工具提示的渲染。这在通过回调属性提供其他悬停操作时非常有用。

注意

工具提示属性也可以配置为映射类型， 例如 dict 或 OrderedDict。

visible = True

Type:

Bool

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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）

toggleable

这是‘visible’属性的向后兼容别名。

注意

属性‘toggleable’在Bokeh 3.4.0中已被弃用，并将在未来版本中移除。请更新您的代码，改用‘visible’。

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

基础类：GestureTool

用于执行“检查”的工具的基类，例如 HoverTool。

注意

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

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p63621", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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）

toggleable

这是‘visible’属性的向后兼容别名。

注意

属性‘toggleable’在Bokeh 3.4.0中已被弃用，并将在未来版本中移除。请更新您的代码，改用‘visible’。

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

基础类：Drag, RegionSelectTool

工具栏图标:

套索选择工具允许用户通过在绘图区域上拖动鼠标或手指来指示自由绘制的“套索”区域，从而在绘图上进行选择。拖动事件的结束表示选择区域已准备就绪。

请参阅Selected and unselected glyphs以获取有关样式化选中和未选中字形信息。

注意

选择可以包含多个区域，甚至是由不同的选择工具创建的区域。在创建选择时按住SHIFT键，可以将新选择附加到任何可能存在的先前选择上。

JSON Prototype

{
  "continuous": true, 
  "description": null, 
  "greedy": false, 
  "icon": null, 
  "id": "p63628", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "mode": "replace", 
  "name": null, 
  "overlay": {
    "attributes": {
      "editable": true, 
      "fill_alpha": 0.5, 
      "fill_color": "lightgrey", 
      "level": "overlay", 
      "line_alpha": 1.0, 
      "line_color": "black", 
      "line_dash": [
        4, 
        4
      ], 
      "line_width": 2, 
      "syncable": false, 
      "visible": false, 
      "xs": [], 
      "ys": []
    }, 
    "id": "p63629", 
    "name": "PolyAnnotation", 
    "type": "object"
  }, 
  "persistent": false, 
  "renderers": "auto", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

continuous = True

Type:

Bool

选择计算是否应在选择手势期间连续进行，或仅在选择区域完成时进行一次。

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

greedy = False

Type:

Bool

定义是否需要对字形进行完全包围（非贪婪）或仅需交集（贪婪）的点击（即区域内至少有一个点）。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

mode = 'replace'

Type:

Enum(RegionSelectionMode)

定义当进行新选择时应发生的情况。默认是替换现有选择。其他选项包括附加到选择、与选择相交或从选择中减去。

定义在选择新选项时应发生的情况。

默认是替换现有的选择。其他选项包括追加到选择、与选择相交、从选择中减去或计算与选择的对称差。

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也不会直接使用这些名称。

overlay = PolyAnnotation(id='p63644', ...)

Type:

Instance(PolyAnnotation)

一个阴影注释，用于指示选择区域。

persistent = False

Type:

Bool

选择手势完成后，选择覆盖是否应持续存在。这可以与在注释上设置editable = True配对，以允许修改选择。

renderers = 'auto'

Type:

Either(Auto, List)

用于点击测试的渲染器列表。如果未设置，则默认为绘图上的所有渲染器。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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）

select_every_mousemove

这是 'continuous' 属性的向后兼容别名。

注意

属性 'select_every_mousemove' 在 Bokeh 3.1.0 中已被弃用，并将在未来版本中移除。请更新您的代码，改用 'continuous'。

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

基础类：EditTool, Drag, Tap

工具栏图标:

LineEditTool 允许编辑一个或多个 Line 图标的交点。 要编辑的图标通过 renderers 属性定义， 交点的渲染器通过 intersection_renderer 属性设置（必须渲染一个点状图标（XYGlyph 的子类））。

该工具将修改数据源中与图标的x和y值对应的列。在添加新点时，数据源中的任何额外列将用声明的empty_value填充。

支持的操作包括：

• 显示交叉点：按下现有线条

• 移动点：拖动现有点并松开鼠标按钮以释放它。

JSON Prototype

{
  "default_overrides": {
    "type": "map"
  }, 
  "description": null, 
  "dimensions": "both", 
  "empty_value": 0, 
  "icon": null, 
  "id": "p63655", 
  "intersection_renderer": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "renderers": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

default_overrides = {}

Type:

Dict(String, Any)

填充值覆盖 ColumnarDataSource.default_values。

定义在将新字形插入ColumnDataSource列时要插入非坐标列的值，例如当一个圆形字形定义了"x"、"y"和"color"列时，添加一个新点将会将x和y坐标添加到"x"和"y"列，而颜色列将填充定义的默认值。

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

dimensions = 'both'

Type:

Enum(Dimensions)

此编辑工具被限制在哪些维度上操作。默认情况下，线条编辑工具允许在任何维度上移动点，但可以配置为仅允许在绘图宽度上进行水平移动，或在绘图高度上进行垂直移动。

empty_value = 0

Type:

Either(Bool, Int, Float, Date, Datetime, Color, String)

“最后手段”的填充值。

这与default_values的使用方式相同，当工具无法确定默认值时使用。工具将按顺序尝试以下替代方案：

1. EditTool.default_overrides

2. ColumnarDataSource.default_values

3. ColumnarDataSource 的推断默认值

4. EditTool.empty_value

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

intersection_renderer = Undefined

Type:

TypeOfAttr(Instance(GlyphRenderer))

用于渲染选定线交点的渲染器

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也不会直接使用这些名称。

renderers = []

Type:

List

对应于可以编辑的字形的渲染器列表。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类: Drag

工具栏图标:

平移工具允许用户通过在绘图区域左键拖动鼠标，或在触摸设备上拖动手指或触控笔来平移绘图。

平移工具还会激活绘图的边框区域以进行“单轴”平移。例如，在垂直边框或轴上拖动将仅在垂直方向上进行平移，而水平维度保持固定。

JSON Prototype

{
  "description": null, 
  "dimensions": "both", 
  "icon": null, 
  "id": "p63667", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

dimensions = 'both'

Type:

Enum(Dimensions)

平移工具被限制在哪些维度上操作。默认情况下，平移工具可以在任何维度上平移，但可以配置为仅在绘图宽度上水平平移，或在绘图高度上垂直平移。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：EditTool, Drag, Tap

工具栏图标:

PointDrawTool 允许通过编辑底层的 ColumnDataSource 数据，在一个或多个渲染器上添加、拖动和删除点状图形（即 XYGlyph 的子类）。与其他绘图工具一样，要编辑的渲染器必须明确地作为列表提供。任何新添加的点都将插入到第一个提供的渲染器的 ColumnDataSource 中。

该工具将修改数据源上与图标的x和y值对应的列。在添加新点时，数据源中的任何额外列将用给定的empty_value填充。

注意

数据源的更新将在BokehJS端的编辑操作过程中持续触发数据变更事件。在Bokeh服务器应用中，数据源只会在编辑操作完成时同步一次。

支持的操作包括：

• 添加点：点击图上的任意位置

• 移动点：点击并拖动一个现有的点，一旦松开鼠标按钮，点将被放置。

• 删除点：点击一个点以选择它，然后在鼠标位于绘图区域内时按下BACKSPACE键。

JSON Prototype

{
  "add": true, 
  "default_overrides": {
    "type": "map"
  }, 
  "description": null, 
  "drag": true, 
  "empty_value": 0, 
  "icon": null, 
  "id": "p63675", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "num_objects": 0, 
  "renderers": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

add = True

Type:

Bool

允许在点击事件上添加新点。

default_overrides = {}

Type:

Dict(String, Any)

填充值覆盖 ColumnarDataSource.default_values。

定义在将新字形插入ColumnDataSource列时要插入非坐标列的值，例如当一个圆形字形定义了"x"、"y"和"color"列时，添加一个新点将会将x和y坐标添加到"x"和"y"列，而颜色列将填充定义的默认值。

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

drag = True

Type:

Bool

启用拖动现有点在平移事件上。

empty_value = 0

Type:

Either(Bool, Int, Float, Date, Datetime, Color, String)

“最后手段”的填充值。

这与default_values的使用方式相同，当工具无法确定默认值时使用。工具将按顺序尝试以下替代方案：

1. EditTool.default_overrides

2. ColumnarDataSource.default_values

3. ColumnarDataSource 的推断默认值

4. EditTool.empty_value

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

num_objects = 0

Type:

Int

定义可以绘制的点的数量的限制。默认情况下，对对象的数量没有限制，但如果启用此限制，最旧的绘制点将被删除，以便为新点腾出空间。

renderers = []

Type:

List

对应于可以编辑的字形的渲染器列表。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：PolyTool, Drag, Tap

工具栏图标:

PolyDrawTool 允许通过编辑底层的 ColumnDataSource 数据，在一个或多个渲染器上绘制、选择和删除 Patches 和 MultiLine 图形。与其他绘图工具一样，要编辑的渲染器必须明确提供。

该工具将修改数据源中与图标的xs和ys值对应的列。在添加新点时，数据源中的任何额外列将用声明的empty_value填充。

如果提供了一个带有点状符号的vertex_renderer，那么PolyDrawTool将使用它来显示所有提供的渲染器上的多线或补丁的顶点。这也启用了在绘制时捕捉到现有顶点的能力。

支持的操作包括：

• 添加补丁或多行：按下以添加第一个顶点，然后使用点击添加每个后续顶点，完成绘制操作按下以插入最后一个顶点或按下ESC键。

• 移动补丁或多行：点击并拖动现有的补丁/多行，一旦松开鼠标按钮，点将被放置。

• 删除补丁或多行：点击补丁/多行以选择它，然后在鼠标位于绘图区域内时按下退格键。

JSON Prototype

{
  "default_overrides": {
    "type": "map"
  }, 
  "description": null, 
  "drag": true, 
  "empty_value": 0, 
  "icon": null, 
  "id": "p63688", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "num_objects": 0, 
  "renderers": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "vertex_renderer": null, 
  "visible": true
}

default_overrides = {}

Type:

Dict(String, Any)

填充值覆盖 ColumnarDataSource.default_values。

定义在将新字形插入ColumnDataSource列时要插入非坐标列的值，例如当一个圆形字形定义了"x"、"y"和"color"列时，添加一个新点将会将x和y坐标添加到"x"和"y"列，而颜色列将填充定义的默认值。

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

drag = True

Type:

Bool

允许在平移事件中拖动现有的补丁和多行。

empty_value = 0

Type:

Either(Bool, Int, Float, Date, Datetime, Color, String)

“最后手段”的填充值。

这与default_values的使用方式相同，当工具无法确定默认值时使用。工具将按顺序尝试以下替代方案：

1. EditTool.default_overrides

2. ColumnarDataSource.default_values

3. ColumnarDataSource 的推断默认值

4. EditTool.empty_value

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

num_objects = 0

Type:

Int

定义可以绘制的补丁或多线的数量限制。 默认情况下，对对象的数量没有限制，但如果启用此限制，则最旧的绘制的补丁或多线将被删除，以便为新补丁或多线腾出空间。

renderers = []

Type:

List

对应于可以编辑的字形的渲染器列表。

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也不会出于任何原因直接使用这些标签。

vertex_renderer = None

Type:

Nullable(TypeOfAttr(Instance(GlyphRenderer)))

用于渲染选定线条或多边形顶点的渲染器。

visible = True

Type:

Bool

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：PolyTool, Drag, Tap

工具栏图标:

PolyEditTool 允许编辑一个或多个 Patches 或 MultiLine 图标的顶点。要编辑的图标通过 renderers 属性定义，顶点的渲染器通过 vertex_renderer 属性设置（必须渲染一个点状图标（XYGlyph 的子类））。

该工具将修改数据源中与图标的xs和ys值对应的列。在添加新点时，数据源中的任何额外列将用声明的empty_value填充。

支持的操作包括：

• 显示顶点：按下一个现有的补丁或多行

• 添加顶点：按下一个现有的顶点以选择它，工具将绘制下一个点，要添加它请在新位置点击。要完成编辑并添加一个点，请按下，否则按ESC键取消。

• 移动顶点：拖动现有顶点并松开鼠标按钮以释放它。

• 删除顶点：选择一个或多个顶点后，当鼠标光标位于绘图区域内时按退格键。

JSON Prototype

{
  "default_overrides": {
    "type": "map"
  }, 
  "description": null, 
  "empty_value": 0, 
  "icon": null, 
  "id": "p63701", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "renderers": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "vertex_renderer": null, 
  "visible": true
}

default_overrides = {}

Type:

Dict(String, Any)

填充值覆盖 ColumnarDataSource.default_values。

定义在将新字形插入ColumnDataSource列时要插入非坐标列的值，例如当一个圆形字形定义了"x"、"y"和"color"列时，添加一个新点将会将x和y坐标添加到"x"和"y"列，而颜色列将填充定义的默认值。

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

empty_value = 0

Type:

Either(Bool, Int, Float, Date, Datetime, Color, String)

“最后手段”的填充值。

这与default_values的使用方式相同，当工具无法确定默认值时使用。工具将按顺序尝试以下替代方案：

1. EditTool.default_overrides

2. ColumnarDataSource.default_values

3. ColumnarDataSource 的推断默认值

4. EditTool.empty_value

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

renderers = []

Type:

List

对应于可以编辑的字形的渲染器列表。

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也不会出于任何原因直接使用这些标签。

vertex_renderer = None

Type:

Nullable(TypeOfAttr(Instance(GlyphRenderer)))

用于渲染选定线条或多边形顶点的渲染器。

visible = True

Type:

Bool

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：Tap, RegionSelectTool

工具栏图标:

多边形选择工具允许用户通过鼠标点击指示多边形区域在图表上进行选择。单次点击（或轻触）会为多边形的定义添加连续的点，而按下点击（或轻触）则表示选择区域已准备就绪。

请参阅Selected and unselected glyphs以获取有关样式化选中和未选中字形信息。

注意

选择可以包含多个区域，甚至是由不同选择工具创建的区域。在按住SHIFT键的同时进行选择，可以将新选择附加到任何可能存在的先前选择上。

JSON Prototype

{
  "continuous": false, 
  "description": null, 
  "greedy": false, 
  "icon": null, 
  "id": "p63712", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "mode": "replace", 
  "name": null, 
  "overlay": {
    "attributes": {
      "editable": true, 
      "fill_alpha": 0.5, 
      "fill_color": "lightgrey", 
      "level": "overlay", 
      "line_alpha": 1.0, 
      "line_color": "black", 
      "line_dash": [
        4, 
        4
      ], 
      "line_width": 2, 
      "syncable": false, 
      "visible": false, 
      "xs": [], 
      "ys": []
    }, 
    "id": "p63713", 
    "name": "PolyAnnotation", 
    "type": "object"
  }, 
  "persistent": false, 
  "renderers": "auto", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

continuous = False

Type:

Bool

选择计算是否应在选择手势期间连续进行，或仅在选择区域完成时进行一次。

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

greedy = False

Type:

Bool

定义是否需要对字形进行完全包围（非贪婪）或仅需交集（贪婪）的点击（即区域内至少有一个点）。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

mode = 'replace'

Type:

Enum(RegionSelectionMode)

定义当进行新选择时应发生的情况。默认是替换现有选择。其他选项包括附加到选择、与选择相交或从选择中减去。

定义在选择新选项时应发生的情况。

默认是替换现有的选择。其他选项包括追加到选择、与选择相交、从选择中减去或计算与选择的对称差。

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也不会直接使用这些名称。

overlay = PolyAnnotation(id='p63728', ...)

Type:

Instance(PolyAnnotation)

一个阴影注释，用于指示选择区域。

persistent = False

Type:

Bool

选择手势完成后，选择覆盖是否应持续存在。这可以与在注释上设置editable = True配对，以允许修改选择。

renderers = 'auto'

Type:

Either(Auto, List)

用于点击测试的渲染器列表。如果未设置，则默认为绘图上的所有渲染器。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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）

select_every_mousemove

这是 'continuous' 属性的向后兼容别名。

注意

属性 'select_every_mousemove' 在 Bokeh 3.1.0 中已被弃用，并将在未来版本中移除。请更新您的代码，改用 'continuous'。

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

基础类：Tool

工具栏图标:

范围工具允许用户通过拖动相应的阴影注释来更新x或y维度的范围对象，以移动它或更改其边界。

一个常见的用例是将此工具添加到具有大固定范围的图中，但从不同的图配置工具范围。当用户操作覆盖层时，第二个图的范围将自动更新。

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p63739", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "overlay": {
    "attributes": {
      "bottom": {
        "type": "number", 
        "value": "nan"
      }, 
      "bottom_limit": {
        "attributes": {
          "symbol": "bottom", 
          "target": "frame"
        }, 
        "id": "p63743", 
        "name": "Node", 
        "type": "object"
      }, 
      "editable": true, 
      "fill_alpha": 0.5, 
      "fill_color": "lightgrey", 
      "handles": {
        "attributes": {
          "all": {
            "attributes": {
              "fill_color": "white", 
              "hover_fill_color": "lightgray"
            }, 
            "id": "p63749", 
            "name": "AreaVisuals", 
            "type": "object"
          }
        }, 
        "id": "p63750", 
        "name": "BoxInteractionHandles", 
        "type": "object"
      }, 
      "left": {
        "type": "number", 
        "value": "nan"
      }, 
      "left_limit": {
        "attributes": {
          "symbol": "left", 
          "target": "frame"
        }, 
        "id": "p63740", 
        "name": "Node", 
        "type": "object"
      }, 
      "level": "overlay", 
      "line_alpha": 1.0, 
      "line_color": "black", 
      "line_dash": [
        2, 
        2
      ], 
      "line_width": 0.5, 
      "propagate_hover": true, 
      "right": {
        "type": "number", 
        "value": "nan"
      }, 
      "right_limit": {
        "attributes": {
          "symbol": "right", 
          "target": "frame"
        }, 
        "id": "p63741", 
        "name": "Node", 
        "type": "object"
      }, 
      "syncable": false, 
      "top": {
        "type": "number", 
        "value": "nan"
      }, 
      "top_limit": {
        "attributes": {
          "symbol": "top", 
          "target": "frame"
        }, 
        "id": "p63742", 
        "name": "Node", 
        "type": "object"
      }
    }, 
    "id": "p63744", 
    "name": "BoxAnnotation", 
    "type": "object"
  }, 
  "start_gesture": "none", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "x_interaction": true, 
  "x_range": null, 
  "y_interaction": true, 
  "y_range": null
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

overlay = BoxAnnotation(id='p63803', ...)

Type:

Instance(BoxAnnotation)

绘制的阴影注释以指示配置的范围。

start_gesture = 'none'

Type:

Enum(枚举(pan, tap, none))

哪种手势将在新位置启动范围更新交互。

当值为 "pan" 时，新的范围从指针拖动操作开始的位置开始。在拖动操作持续期间，范围会不断更新。结束拖动操作将设置范围的最终值。

当值为"tap"时，新的范围从单次点击的位置开始。当指针移动时，范围会持续更新。在另一个位置点击将设置范围的最终值。

当值为"none"时，只能通过拖动其边缘或内部来更新现有的范围定义。

配置此属性可以使此工具与另一个可能共享手势的工具同时共存。

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

与此工具关联的工具按钮是否应出现在工具栏中。

x_interaction = True

Type:

Bool

当存在x_range时，是否响应水平平移动作。

默认情况下，当指定了x_range时，可以通过在框内水平平移或沿着框的顶部或底部边缘来调整范围框的水平位置。要禁用此功能并固定范围框的水平位置，请设置为False。（如果x_range以编程方式更新，框仍将更新。）

x_range = None

Type:

Nullable(Instance(Range))

一个与覆盖层的x维度同步的范围。如果为None，覆盖层将跨越整个x维度。

y_interaction = True

Type:

Bool

当存在y_range时，是否响应垂直平移动作。

默认情况下，当指定了y_range时，可以通过在框内垂直平移或沿着框的顶部或底部边缘来调整范围框的垂直位置。要禁用此功能并固定范围框的垂直位置，请设置为False。（如果y_range以编程方式更新，框仍将更新。）

y_range = None

Type:

Nullable(Instance(Range))

一个与覆盖层的y维度同步的范围。如果为None，覆盖层将跨越整个y维度。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：PlotActionTool

工具栏图标:

重做工具撤销了由撤销工具执行的最后一个操作。

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p63906", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：PlotActionTool

工具栏图标:

重置工具是一个操作。当在工具栏中激活时，该工具将绘图的数据边界重置为绘图最初创建时的值。

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p63913", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：ActionTool

工具栏图标:

保存工具是一个操作。当激活时，该工具会打开一个下载对话框，允许以PNG格式保存图表的图像副本。如果网页浏览器不支持自动下载，该工具会转而在新标签页或窗口中打开生成的图像。用户随后可以通过右键点击图像并选择“另存为”（或类似）菜单项来手动保存它。

JSON Prototype

{
  "description": null, 
  "filename": null, 
  "icon": null, 
  "id": "p63920", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

filename = None

Type:

Nullable(String)

可选的字符串，指定保存图像的文件名（不需要扩展名）。如果未提供文件名或设置为None，则在保存时会提示用户输入文件名。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：GestureTool

用于响应滚动事件的工具的基类。

注意

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

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p63928", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：GestureTool

用于响应点击/点击事件的工具的基类。

注意

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

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p63935", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：Tap, SelectTool

工具栏图标:

点击选择工具允许用户通过鼠标左键点击或手指点击来选择单个点。

请参阅Selected and unselected glyphs以获取有关样式化选中和未选中字形信息。

注意

选择可以包含多个区域，甚至是由不同选择工具创建的区域。在按住SHIFT键的同时进行选择，可以将新选择附加到任何可能存在的先前选择上。

JSON Prototype

{
  "behavior": "select", 
  "callback": null, 
  "description": null, 
  "gesture": "tap", 
  "icon": null, 
  "id": "p63942", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "mode": "toggle", 
  "modifiers": {
    "type": "map"
  }, 
  "name": null, 
  "renderers": "auto", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

behavior = 'select'

Type:

Enum(枚举(选择, 检查))

此工具可以配置为对关联的数据源进行选择或检查。区别在于，选择更改会在bokeh和其他组件（例如选择字形）之间传播并通知。检查不会这样操作，因此在设置behavior=’inspect’时配置callback是有用的。

callback = None

Type:

Nullable(Instance(Callback))

当鼠标点击或轻触“击中”一个字形时执行的回调。

这在与OpenURL模型一起使用时通常很有用，用于在用户点击或轻触特定字形时打开URL。

然而，它也可能是CustomJS，它可以执行任意的JavaScript代码以响应点击或轻触图形。回调将在每次点击或轻触到图形时执行，并将接收TapTool模型作为cb_obj。可选的cb_data将具有数据源作为其.source属性，并将选择几何作为其.geometries属性。

.geometries 属性有5个成员。 .type 是几何类型，对于点击事件来说，它始终是 .point。 .sx 和 .sy 是点击发生的屏幕X和Y坐标。 .x 和 .y 是被选中项目的转换后的数据坐标。.x 和 .y 值基于分配给该字形（glyph）的轴。

注意

此回调不会在每次点击时执行，仅在字形被“击中”时执行。如果您希望在每次鼠标点击时执行回调，请参阅js_on_event回调触发器。

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

gesture = 'tap'

Type:

Enum(枚举(tap, doubletap))

指定将使用哪种手势来触发工具，无论是单击还是双击。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

mode = 'toggle'

Type:

Enum(SelectionMode)

定义在选择新选项时应发生的情况。

默认是切换现有选择。其他选项包括替换选择、附加到选择、与选择相交、从选择中减去或计算与选择的对称差异。

modifiers = {}

Type:

Struct

允许配置一组修饰键的组合，这些键需要在选定的手势期间按下才能触发此工具。

例如，仅在按下Ctrl和Shift键时接受点击事件，使用：

tool = TapTool(modifiers=dict(ctrl=True, shift=True))
plot.add_tools(tool)

或者使用简洁的语法：

tool = TapTool(modifiers="ctrl+shift")
plot.add_tools(tool)

警告

配置修饰符是一个依赖于平台的功能，并且可能使此工具在例如移动设备上无法使用。

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也不会直接使用这些名称。

renderers = 'auto'

Type:

Either(Auto, List)

用于点击测试的渲染器列表。如果未设置，则默认为绘图上的所有渲染器。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：Model

所有交互式工具类型的基类。

注意

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

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p63955", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：Model

JSON Prototype

{
  "active": false, 
  "disabled": false, 
  "id": "p63962", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tools": []
}

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也不会直接使用这些名称。

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也不会出于任何原因直接使用这些标签。

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

基础类: UIElement

收集工具以显示单个图表。

JSON Prototype

{
  "active_drag": "auto", 
  "active_inspect": "auto", 
  "active_multi": "auto", 
  "active_scroll": "auto", 
  "active_tap": "auto", 
  "autohide": false, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "id": "p63966", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "logo": "normal", 
  "name": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tools": [], 
  "visible": true
}

active_drag = 'auto'

Type:

Either(Null, Auto, Instance(Drag), Instance(ToolProxy))

指定在显示图表时激活的拖动工具。

active_inspect = 'auto'

Type:

Either(Null, Auto, Instance(InspectTool), Instance(ToolProxy), Seq(Instance(InspectTool)))

指定在显示绘图时激活的检查工具或检查工具序列。

active_multi = 'auto'

Type:

Either(Null, Auto, Instance(GestureTool), Instance(ToolProxy))

指定一个活动的多手势工具，例如编辑工具或范围工具。

请注意，激活多手势工具将适当地停用任何其他手势工具。例如，如果平移工具被设置为活动拖动工具，并且此属性设置为BoxEditTool实例，则平移工具将被停用（即多手势工具将优先）。

active_scroll = 'auto'

Type:

Either(Null, Auto, Instance(Scroll), Instance(ToolProxy))

指定在显示图表时激活滚动/缩放工具。

active_tap = 'auto'

Type:

Either(Null, Auto, Instance(Tap), Instance(ToolProxy))

指定在显示图表时激活的点击/单击工具。

autohide = False

Type:

Bool

工具栏是否默认隐藏。默认值：False。 如果为True，当光标不在画布中时隐藏工具栏。

context_menu = None

Type:

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

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

注意

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

css_classes = []

Type:

List

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

css_variables = {}

Type:

Dict(String, Instance(Node))

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

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

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

注意

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

logo = 'normal'

Type:

Nullable(Enum(Enumeration(normal, grey)))

在工具栏上显示哪个版本的Bokeh徽标。如果设置为None，则不会显示徽标。

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也不会直接使用这些名称。

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也不会出于任何原因直接使用这些标签。

tools = []

Type:

List

要添加到图表中的工具列表。

visible = True

Type:

Bool

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

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

基础类：PlotActionTool

工具栏图标:

撤销工具允许恢复绘图的上一个状态。

JSON Prototype

{
  "description": null, 
  "icon": null, 
  "id": "p63984", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：Scroll

工具栏图标:

滚轮平移工具允许用户使用滚轮沿配置的维度平移图表。

JSON Prototype

{
  "description": null, 
  "dimension": "width", 
  "icon": null, 
  "id": "p63991", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "modifiers": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

dimension = 'width'

Type:

Enum(Dimension)

滚轮平移工具被限制在哪个维度上操作。默认情况下，滚轮平移工具将沿x轴平移图表。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

modifiers = {}

Type:

Struct

允许配置一组修饰键的组合，这些键需要在选定的手势期间按下才能触发此工具。

例如，仅在按下Ctrl和Shift键时进行平移，请使用：

tool = WheelPanTool(modifiers=dict(ctrl=True, shift=True))
plot.add_tools(tool)

或者使用简洁的语法：

tool = WheelPanTool(modifiers="ctrl+shift")
plot.add_tools(tool)

注意

设置修饰符允许此工具自动激活，如果Toolbar.active_scroll设置为"auto"。

警告

配置修饰符是一个依赖于平台的功能，并且可能使此工具在例如移动设备上无法使用。

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也不会直接使用这些名称。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类: Scroll

工具栏图标:

滚轮缩放工具将以当前鼠标位置为中心，放大和缩小绘图。

滚轮缩放工具还会激活图表的边框区域，用于“单轴”缩放。例如，在垂直边框或轴上缩放将仅影响垂直方向的缩放，而水平维度保持不变。

JSON Prototype

{
  "description": null, 
  "dimensions": "both", 
  "hit_test": false, 
  "hit_test_behavior": "only_hit", 
  "hit_test_mode": "point", 
  "icon": null, 
  "id": "p64000", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": 0, 
  "maintain_focus": true, 
  "modifiers": {
    "type": "map"
  }, 
  "name": null, 
  "renderers": "auto", 
  "speed": 0.0016666666666666668, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "zoom_on_axis": true, 
  "zoom_together": "all"
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

dimensions = 'both'

Type:

Enum(Dimensions)

滚轮缩放工具被限制在哪些维度上操作。默认情况下，滚轮缩放工具可以在任何维度上缩放，但可以配置为仅在绘图宽度上水平缩放，或在绘图高度上垂直缩放。

hit_test = False

Type:

Bool

是否仅放大那些被指向的渲染器。

此设置仅适用于配置了子坐标的渲染器进行缩放时，否则无效。

如果 True，则 hit_test_mode 属性定义了如何进行命中测试，而 hit_test_behavior 允许配置此设置的其他方面。详情请参见各自的属性。

注意

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

hit_test_behavior = 'only_hit'

Type:

Either(Instance(GroupBy), Enum(Enumeration(only_hit)))

允许配置在启用hit_test时哪些渲染器将被缩放。

默认情况下（hit_only）只有实际命中的渲染器会被缩放。可以使用GroupBy模型的实例来指定当某个渲染器被命中时，其他哪些渲染器也应该被缩放。

注意

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

hit_test_mode = 'point'

Type:

Enum(枚举(point, hline, vline))

允许配置在启用hit_test时使用哪种几何形状。

支持的模式有 "point" 用于单点命中测试，以及 hline 和 vline 用于水平或垂直跨度命中测试。

注意

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

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

level = 0

Type:

NonNegative

在使用复合比例尺（子坐标）时，此属性允许配置要缩放的范围集。默认情况下是缩放顶级（框架）范围。

maintain_focus = True

Type:

Bool

如果为True，则在任何一维达到范围限制时，将阻止所有维度的进一步缩放。如果为False，则可以在尚未达到其限制的任何维度中继续独立缩放，即使这会导致整体焦点或宽高比发生变化。

modifiers = {}

Type:

Struct

允许配置一组修饰键的组合，这些键需要在选定的手势期间按下才能触发此工具。

例如，仅在按下Ctrl和Shift键时进行缩放，请使用：

tool = WheelZoomTool(modifiers=dict(ctrl=True, shift=True))
plot.add_tools(tool)

或者使用简洁的语法：

tool = WheelZoomTool(modifiers="ctrl+shift")
plot.add_tools(tool)

注意

设置修饰符允许此工具自动激活，如果Toolbar.active_scroll设置为"auto"。

警告

配置修饰符是一个依赖于平台的功能，并且可能使此工具在例如移动设备上无法使用。

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也不会直接使用这些名称。

renderers = 'auto'

Type:

Either(Auto, List)

将缩放限制为提供的数据渲染器使用的范围。如果"auto"，则将使用笛卡尔框架提供的所有范围。

speed = 0.0016666666666666668

Type:

Float

滚轮缩放的速度。默认值为1/600。最佳范围在0.001到0.09之间。高值将被裁剪。速度可能因浏览器而异。

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

与此工具关联的工具按钮是否应出现在工具栏中。

zoom_on_axis = True

Type:

Bool

是否在某个轴（中央绘图区域之外）上滚动时应该缩放该维度。如果启用，可以通过zoom_together属性配置此功能的行为。

zoom_together = 'all'

Type:

Enum(枚举(none, cross, all))

定义工具在轴上缩放时的行为：

• "none"

  仅缩放正在交互的轴。任何交叉轴或此轴维度中的任何其他轴都不会受到影响。

• "cross"

  放大正在交互的轴及其交叉轴（如果已配置）。此维度或交叉维度中的其他轴将不受影响。

• "all"

  在与正在交互的轴维度上缩放所有轴。所有交叉轴将不受影响。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：ZoomBaseTool

工具栏图标:

放大工具允许用户点击按钮以固定量放大。

JSON Prototype

{
  "description": null, 
  "dimensions": "both", 
  "factor": 0.1, 
  "icon": null, 
  "id": "p64018", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": 0, 
  "name": null, 
  "renderers": "auto", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

dimensions = 'both'

Type:

Enum(Dimensions)

缩放工具被限制在哪些维度上操作。默认情况下，工具可以在任何维度上缩放，但可以配置为仅在绘图宽度上水平缩放，或在绘图高度上垂直缩放。

factor = 0.1

Type:

Percent

每次使用工具时缩放的百分比范围。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

level = 0

Type:

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也不会直接使用这些名称。

renderers = 'auto'

Type:

Either(Auto, List)

将缩放限制为提供的数据渲染器使用的范围。如果"auto"，则将使用笛卡尔框架提供的所有范围。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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

基础类：ZoomBaseTool

工具栏图标:

缩小工具允许用户点击按钮以固定量缩小。

JSON Prototype

{
  "description": null, 
  "dimensions": "both", 
  "factor": 0.1, 
  "icon": null, 
  "id": "p64029", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": 0, 
  "maintain_focus": true, 
  "name": null, 
  "renderers": "auto", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

description = None

Type:

Nullable(String)

描述此工具用途的字符串。如果未定义，将使用自动生成的描述。此描述通常会在用户界面中作为工具提示显示。

dimensions = 'both'

Type:

Enum(Dimensions)

缩放工具被限制在哪些维度上操作。默认情况下，工具可以在任何维度上缩放，但可以配置为仅在绘图宽度上水平缩放，或在绘图高度上垂直缩放。

factor = 0.1

Type:

Percent

每次使用工具时缩放的百分比范围。

icon = None

Type:

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

工具栏中显示的图标。

图标可以作为众所周知的工具图标名称、CSS类选择器、带有image/* MIME的数据URI、图像路径、PIL Image对象或RGB(A) NumPy数组提供。如果为None，则将使用固有图标（可能取决于工具的配置）。

level = 0

Type:

NonNegative

在使用复合比例尺（子坐标）时，此属性允许配置要缩放的范围集。默认情况下是缩放顶级（框架）范围。

maintain_focus = True

Type:

Bool

如果 True，则在任何一维中达到范围限制将阻止所有维度的进一步缩放。如果 False，则可以在任何尚未达到其限制的维度中独立继续缩放，即使这会导致整体焦点或宽高比发生变化。

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也不会直接使用这些名称。

renderers = 'auto'

Type:

Either(Auto, List)

将缩放限制为提供的数据渲染器使用的范围。如果"auto"，则将使用笛卡尔框架提供的所有范围。

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

与此工具关联的工具按钮是否应出现在工具栏中。

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

classmethod from_string(name: str) → Tool

接受一个字符串并返回相应的Tool实例。

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）