刻度器

用于在不同类型的绘图上计算良好刻度位置的模型。

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

基类：ContinuousTicker

在任何数量级上生成“漂亮”的圆形刻度。

创建刻度，这些刻度是给定一组给定尾数的“基数”倍数。例如，使用 base=10 和 mantissas=[1, 2, 5]，刻度器将生成序列

..., 0.1, 0.2, 0.5, 1, 2, 5, 10, 20, 50, 100, ...

JSON 原型

{
  "base": 10.0, 
  "desired_num_ticks": 6, 
  "id": "p62962", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "mantissas": [
    1, 
    2, 
    5
  ], 
  "max_interval": null, 
  "min_interval": 0.0, 
  "name": null, 
  "num_minor_ticks": 5, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

base = 10.0

类型:

Float

用于缩放尾数的乘数。

desired_num_ticks = 6

类型:

Int

在绘图范围内生成的主刻度位置的所需目标数量。

mantissas = [1, 2, 5]

类型:

Seq(Float)

生成倍数的允许数字列表。

max_interval = None

类型:

Nullable(Float)

两个相邻刻度之间允许的最大间隔。

注意

要指定无界间隔，请设置为 None。

min_interval = 0.0

类型:

Float

两个相邻刻度之间允许的最小间隔。

name = None

类型:

Nullable(String)

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

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

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

注意

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

num_minor_ticks = 5

类型:

Int

在相邻主刻度值之间生成的次刻度位置的数量。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

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 实例都不应修改它）。

参数:

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec 属性的名称

返回类型：

set[str]

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

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

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

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

返回值:

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

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

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

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

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

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

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

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

在版本 1.1 中添加

引发：

ValueError –

示例

这段带有 js_link 的代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

示例

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

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

当指定事件在此模型上发生时运行回调

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

classmethod parameters() → list[Parameter]

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

返回值:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型：

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

使用 JSON 在此对象上设置属性值。

参数:

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

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

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

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

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

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

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

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

Bases: AdaptiveTicker

在线性刻度上生成刻度。

注意

此类将来可能会重命名为 LinearTicker。

JSON 原型

{
  "base": 10.0, 
  "desired_num_ticks": 6, 
  "id": "p62972", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "mantissas": [
    1, 
    2, 
    5
  ], 
  "max_interval": null, 
  "min_interval": 0.0, 
  "name": null, 
  "num_minor_ticks": 5, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

base = 10.0

类型:

Float

用于缩放尾数的乘数。

desired_num_ticks = 6

类型:

Int

在绘图范围内生成的主刻度位置的所需目标数量。

mantissas = [1, 2, 5]

类型:

Seq(Float)

生成倍数的允许数字列表。

max_interval = None

类型:

Nullable(Float)

两个相邻刻度之间允许的最大间隔。

注意

要指定无界间隔，请设置为 None。

min_interval = 0.0

类型:

Float

两个相邻刻度之间允许的最小间隔。

name = None

类型:

Nullable(String)

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

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

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

注意

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

num_minor_ticks = 5

类型:

Int

在相邻主刻度值之间生成的次刻度位置的数量。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

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 实例都不应修改它）。

参数:

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec 属性的名称

返回类型：

set[str]

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

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

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

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

返回值:

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

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

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

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

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

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

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

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

在版本 1.1 中添加

引发：

ValueError –

示例

这段带有 js_link 的代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

示例

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

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

当指定事件在此模型上发生时运行回调

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

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

返回值:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型：

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

使用 JSON 在此对象上设置属性值。

参数:

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

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

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

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

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

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

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

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

Bases: Ticker

用于对齐扫描色映射器的分箱边界的刻度标签的刻度器。

JSON 原型

{
  "id": "p62982", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "mapper": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "name": null, 
  "num_major_ticks": 8, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

mapper = Undefined

类型:

Instance(ScanningColorMapper)

要使用的扫描色映射器（例如 EqHistColorMapper）。

name = None

类型:

Nullable(String)

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

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

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

注意

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

num_major_ticks = 8

类型:

Either(Int, Auto)

要显示的主要刻度标签数量，或使用“auto”来自动使用映射器提供的分箱数量。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

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 实例都不应修改它）。

参数:

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec 属性的名称

返回类型：

set[str]

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

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

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

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

返回值:

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

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

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

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

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

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

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

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

在版本 1.1 中添加

引发：

ValueError –

示例

这段带有 js_link 的代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

示例

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

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

当指定事件在此模型上发生时运行回调

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

classmethod parameters() → list[Parameter]

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

返回值:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型：

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

使用 JSON 在此对象上设置属性值。

参数:

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

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

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

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

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

返回值:

None

set_select(selector: type[Model] | SelectorType, updates:

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

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

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

Bases: Ticker

为分类范围生成刻度。

JSON 原型

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

name = None

类型:

Nullable(String)

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

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

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

注意

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

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

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 实例都不应修改它）。

参数:

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

返回值:

None

classmethod clear_extensions() →

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec 属性的名称

返回类型：

set[str]

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

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

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

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

返回值:

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

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

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

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

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

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

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

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

在版本 1.1 中添加

引发：

ValueError –

示例

这段带有 js_link 的代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

示例

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

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

当指定事件在此模型上发生时运行回调

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

classmethod parameters() → list[Parameter]

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

返回值:

list(Parameter)

classmethod properties

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型：

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

使用 JSON 在此对象上设置属性值。

参数:

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

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

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

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

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

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

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

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

基类：ContinuousTicker

组合不同比例的刻度器。

使用刻度器的min_interval 和 max_interval 间隔属性来选择不同比例的刻度器。

JSON 原型

{
  "desired_num_ticks": 6, 
  "id": "p62992", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "num_minor_ticks": 5, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tickers": {
    "name": "unset", 
    "type": "symbol"
  }
}

desired_num_ticks = 6

类型:

Int

在绘图范围内生成的主刻度位置的所需目标数量。

name = None

类型:

Nullable(String)

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

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

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

注意

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

num_minor_ticks = 5

类型:

Int

在相邻主刻度值之间生成的次刻度位置的数量。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

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

tickers = Undefined

类型:

非空

一个 Ticker 对象列表，用于在不同尺度上组合以生成刻度值。提供的刻度器应按顺序排列。具体来说，如果 S 在 T 之前，则应该有以下情况：

S.get_max_interval() < T.get_min_interval()

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

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

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

参数:

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec 属性的名称

返回类型：

set[str]

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

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

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

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

返回值:

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

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

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

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

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

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

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

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

在版本 1.1 中添加

引发：

ValueError –

示例

这段带有 js_link 的代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

示例

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

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

当指定事件在此模型上发生时运行回调

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

classmethod parameters() → list[Parameter]

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

返回值:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型：

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

使用 JSON 在此对象上设置属性值。

参数:

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

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

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

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

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

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

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

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

Bases: Ticker

用于非分类刻度类型基类。

注意

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

JSON 原型

{
  "desired_num_ticks": 6, 
  "id": "p62999", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "num_minor_ticks": 5, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

desired_num_ticks = 6

类型:

Int

在绘图范围内生成的主刻度位置的所需目标数量。

name = None

类型:

Nullable(String)

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

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

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

注意

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

num_minor_ticks = 5

类型:

Int

在相邻主刻度值之间生成的次刻度位置的数量。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

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 实例都不应修改它）。

参数:

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec 属性的名称

返回类型：

set[str]

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

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

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

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

返回值:

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

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

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

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

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

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

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

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

在版本 1.1 中添加

引发：

ValueError –

示例

这段带有 js_link 的代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

示例

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

on_event(event:

当指定事件在此模型上发生时运行回调

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

classmethod parameters() → list[Parameter]

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

返回值:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型：

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model |

返回值:

Model

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

使用 JSON 在此对象上设置属性值。

参数:

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

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

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

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

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

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

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

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

Bases: Ticker

通过用户定义的函数生成刻度位置。

CustomJSTicker 可用于连续（数字）轴或分类轴。但是，仅支持基本的非分层分类轴（即只有一级因素）。

警告

此 Bokeh 模型的明确目的是嵌入供浏览器执行的原始 JavaScript 代码。如果代码的任何部分源自不可信的用户输入，则您必须采取适当的措施在将用户输入传递给 Bokeh 之前对其进行清理。

JSON 原型

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

args = {}

类型:

Dict(String, AnyRef)

名称到 Python 对象的映射。特别是，这些可以是 bokeh 的模型。这些对象在回调中作为命名参数的值提供给刻度器的代码片段。

major_code = ''

类型:

字符串

要在浏览器中运行的回调代码，用于计算当前视窗的主刻度位置。

回调代码可用的 cb_data 参数将包含四个特定字段

start

计算出的轴起始坐标

end

计算出的轴结束位置

range

此轴的 Range 模型

cross_loc

此轴与正交轴相交的坐标

minor_code = ''

类型:

字符串

要在浏览器中运行的回调代码，用于计算当前视窗的主刻度位置。

注意

分类轴不使用次刻度。当范围为 FactorRange 时，此属性将被忽略。

回调代码可用的 cb_data 参数将包含五个特定字段

major_ticks

当前计算出的主刻度位置列表

start

计算出的轴起始坐标

end

计算出的轴结束位置

range

此轴的 Range 模型

cross_loc

此轴与正交轴相交的坐标

name = None

类型:

Nullable(String)

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

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

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

注意

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

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

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 实例都不应修改它）。

参数:

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec 属性的名称

返回类型：

set[str]

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

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

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

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

返回值:

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

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

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

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

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

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

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

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

在版本 1.1 中添加

引发：

ValueError –

示例

这段带有 js_link 的代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

示例

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

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

当指定事件在此模型上发生时运行回调

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

classmethod parameters() → list[Parameter]

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

返回值:

list(Parameter)

classmethod properties

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型：

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

使用 JSON 在此对象上设置属性值。

参数:

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

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

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

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

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

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

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

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

Bases: CompositeTicker

生成跨不同日期和时间尺度的良好刻度。

JSON 原型

{
  "desired_num_ticks": 6, 
  "id": "p63012", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "num_minor_ticks": 0, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tickers": [
    {
      "attributes": {
        "mantissas": [
          1, 
          2, 
          5
        ], 
        "max_interval": 500.0, 
        "num_minor_ticks": 0
      }, 
      "id": "p63013", 
      "name": "AdaptiveTicker", 
      "type": "object"
    }, 
    {
      "attributes": {
        "base": 60, 
        "mantissas": [
          1, 
          2, 
          5, 
          10, 
          15, 
          20, 
          30
        ], 
        "max_interval": 1800000.0, 
        "min_interval": 1000.0, 
        "num_minor_ticks": 0
      }, 
      "id": "p63014", 
      "name": "AdaptiveTicker", 
      "type": "object"
    }, 
    {
      "attributes": {
        "base": 24, 
        "mantissas": [
          1, 
          2, 
          4, 
          6, 
          8, 
          12
        ], 
        "max_interval": 43200000.0, 
        "min_interval": 3600000.0, 
        "num_minor_ticks": 0
      }, 
      "id": "p63015", 
      "name": "AdaptiveTicker", 
      "type": "object"
    }, 
    {
      "attributes": {
        "days": [
          1, 
          2, 
          3, 
          4, 
          5, 
          6, 
          7, 
          8, 
          9, 
          10, 
          11, 
          12, 
          13, 
          14, 
          15, 
          16, 
          17, 
          18, 
          19, 
          20, 
          21, 
          22, 
          23, 
          24, 
          25, 
          26, 
          27, 
          28, 
          29, 
          30, 
          31
        ]
      }, 
      "id": "p63016", 
      "name": "DaysTicker", 
      "type": "object"
    }, 
    {
      "attributes": {
        "days": [
          1, 
          4, 
          7, 
          10, 
          13, 
          16, 
          19, 
          22, 
          25, 
          28
        ]
      }, 
      "id": "p63017", 
      "name": "DaysTicker", 
      "type": "object"
    }, 
    {
      "attributes": {
        "days": [
          1, 
          8, 
          15, 
          22
        ]
      }, 
      "id": "p63018", 
      "name": "DaysTicker", 
      "type": "object"
    }, 
    {
      "attributes": {
        "days": [
          1, 
          15
        ]
      }, 
      "id": "p63019", 
      "name": "DaysTicker", 
      "type": "object"
    }, 
    {
      "attributes": {
        "months": [
          0, 
          1, 
          2, 
          3, 
          4, 
          5, 
          6, 
          7, 
          8, 
          9, 
          10, 
          11
        ]
      }, 
      "id": "p63020", 
      "name": "MonthsTicker", 
      "type": "object"
    }, 
    {
      "attributes": {
        "months": [
          0, 
          2, 
          4, 
          6, 
          8, 
          10
        ]
      }, 
      "id": "p63021", 
      "name": "MonthsTicker", 
      "type": "object"
    }, 
    {
      "attributes": {
        "months": [
          0, 
          4, 
          8
        ]
      }, 
      "id": "p63022", 
      "name": "MonthsTicker", 
      "type": "object"
    }, 
    {
      "attributes": {
        "months": [
          0, 
          6
        ]
      }, 
      "id": "p63023", 
      "name": "MonthsTicker", 
      "type": "object"
    }, 
    {
      "id": "p63024", 
      "name": "YearsTicker", 
      "type": "object"
    }
  ]
}

desired_num_ticks = 6

类型:

Int

在绘图范围内生成的主刻度位置的所需目标数量。

name = None

类型:

Nullable(String)

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

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

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

注意

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

num_minor_ticks = 0

类型:

Int

在相邻主刻度值之间生成的次刻度位置的数量。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

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

tickers = [AdaptiveTicker(id='p63103', ...), AdaptiveTicker(id='p63104', ...), AdaptiveTicker(id='p63105', ...), DaysTicker(id='p63106', ...), DaysTicker(id='p63107', ...), DaysTicker(id='p63108', ...), DaysTicker(id='p63109', ...), MonthsTicker(id='p63110', ...), MonthsTicker(id='p63111', ...), MonthsTicker(id='p63112', ...), MonthsTicker(id='p63113', ...), YearsTicker(id='p63114', ...)]

类型:

非空

一个 Ticker 对象列表，用于在不同尺度上组合以生成刻度值。提供的刻度器应按顺序排列。具体来说，如果 S 在 T 之前，则应该有以下情况：

S.get_max_interval() < T.get_min_interval()

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

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

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

参数:

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec 属性的名称

返回类型：

set[str]

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

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

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

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

返回值:

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

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

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

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

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

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

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

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

在版本 1.1 中添加

引发：

ValueError –

示例

这段带有 js_link 的代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

示例

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

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

当指定事件在此模型上发生时运行回调

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

classmethod parameters() → list[Parameter]

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

返回值:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型：

set[str]

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

使用 JSON 在此对象上设置属性值。

参数:

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

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

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

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

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

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

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

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

Bases: BaseSingleIntervalTicker

按特定、均匀的天数倍数生成间隔的刻度。

JSON 原型

{
  "days": [], 
  "desired_num_ticks": 6, 
  "id": "p63115", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "num_minor_ticks": 0, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

days = []

类型:

Seq(Int)

要使用的天数间隔。

desired_num_ticks = 6

类型:

Int

在绘图范围内生成的主刻度位置的所需目标数量。

name = None

类型:

Nullable(String)

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

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

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

注意

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

num_minor_ticks = 0

类型:

Int

在相邻主刻度值之间生成的次刻度位置的数量。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

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 实例都不应修改它）。

参数:

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec 属性的名称

返回类型：

set[str]

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

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

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

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

返回值:

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

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

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

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

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

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

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

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

在版本 1.1 中添加

引发：

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) → CustomJS 回调附加到任意 BokehJS 模型事件。

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

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

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

source.js_on_change('streaming', callback)

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

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

示例

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

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

当指定事件在此模型上发生时运行回调

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

classmethod parameters() → list[Parameter]

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

返回值:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型：

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

remove_on_change(attr: str, *callbacks: Callable[[str,

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

使用 JSON 在此对象上设置属性值。

参数:

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

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

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

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

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

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

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

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

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

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

基类：ContinuousTicker

在固定的、显式提供的点生成刻度。

注意

该 Ticker 会忽略 desired_num_ticks 属性。

JSON 原型

{
  "desired_num_ticks": 6, 
  "id": "p63122", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "minor_ticks": [], 
  "name": null, 
  "num_minor_ticks": 5, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "ticks": []
}

desired_num_ticks = 6

类型:

Int

在绘图范围内生成的主刻度位置的所需目标数量。

minor_ticks = []

类型:

Seq(Float)

次刻度位置列表。

name = None

类型:

Nullable(String)

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

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

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

注意

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

num_minor_ticks = 5

类型:

Int

在相邻主刻度值之间生成的次刻度位置的数量。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

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

ticks = []

类型:

Seq(Float)

主刻度位置列表。

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

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

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

参数:

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec 属性的名称

返回类型：

set[str]

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

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

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

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

返回值:

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

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

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

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

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

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

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

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

在版本 1.1 中添加

引发：

ValueError –

示例

这段带有 js_link 的代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

示例

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

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

当指定事件在此模型上发生时运行回调

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

classmethod parameters() → list[Parameter]

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

返回值:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型：

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

使用 JSON 在此对象上设置属性值。

参数:

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

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

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

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

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

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型附加到的 Document（可以是 None）

class LogTicker(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: AdaptiveTicker

在对数刻度上生成刻度。

JSON 原型

{
  "base": 10.0, 
  "desired_num_ticks": 6, 
  "id": "p63130", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "mantissas": [
    1, 
    5
  ], 
  "max_interval": null, 
  "min_interval": 0.0, 
  "name": null, 
  "num_minor_ticks": 5, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

base = 10.0

类型:

Float

用于缩放尾数的乘数。

desired_num_ticks = 6

类型:

Int

在绘图范围内生成的主刻度位置的所需目标数量。

mantissas = [1, 5]

类型:

Seq(Float)

生成倍数的允许数字列表。

max_interval = None

类型:

Nullable(Float)

两个相邻刻度之间允许的最大间隔。

注意

要指定无界间隔，请设置为 None。

min_interval = 0.0

类型:

Float

两个相邻刻度之间允许的最小间隔。

name = None

类型:

Nullable(String)

此模型的任意用户提供的名称。

当查询文档以检索特定 Bokeh 模型时，此名称很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

不会对提供的任何名称强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用名称。

num_minor_ticks = 5

类型:

Int

在相邻主刻度值之间生成的次刻度位置的数量。

syncable = True

类型:

Bool

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。设置为 False 可能有助于在处理经常更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 端回调仍然有效。

tags = []

类型:

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 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值。

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这会创建一个原始模型的浅层克隆，即不会复制任何可变容器或子模型。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类中所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

DataSpec 属性的名称

返回类型：

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序排列的属性描述符列表。

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

True，如果属性在结构上相等，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 要链接到可订阅 attr 中的项目的索引

在版本 1.1 中添加

引发：

ValueError –

示例

这段带有 js_link 的代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀。

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他类型的事件对响应可能有用。例如，要在数据流式传输到 ColumnDataSource 时运行回调，请在源上使用 "stream" 事件。

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果丢失，是否引发或返回 None

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

当attr更改时，在此对象上添加一个回调以触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当指定事件在此模型上发生时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适合从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，将属性名称映射到属性对象。为了使此方法的当前用法面向未来，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

具有引用的属性的名称

返回类型：

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

不可序列化属性将被跳过，属性值将采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回重建对象实例所需的信息。

参数:

include_defaults (bool, optional) – 是否包含自对象创建以来未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型：

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

参数:

• query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

• include_defaults (bool, optional) – 是否包含用户未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型：

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则会引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector:

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

使用 JSON 在此对象上设置属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON-value) – 要设置为属性的值

• setter (ClientSession or ServerSession or None, optional) –

  用于防止对 Bokeh 应用程序的“回弹”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。该会话可以将事件设置程序与自身进行比较，并抑制任何来自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新，更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果将以字典形式返回，从属性名称到值，如果主题未覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化表示。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型附加到的 Document（可以是 None）

class MercatorTicker(*args: Any, id: ID | None = None, **kwargs: Any)

基类：BasicTicker

从底层 WebMercator 坐标生成良好的经纬度刻度。

JSON 原型

{
  "base": 10.0, 
  "desired_num_ticks": 6, 
  "dimension": null, 
  "id": "p63140", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "mantissas": [
    1, 
    2, 
    5
  ], 
  "max_interval": null, 
  "min_interval": 0.0, 
  "name": null, 
  "num_minor_ticks": 5, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

base = 10.0

类型:

Float

用于缩放尾数的乘数。

desired_num_ticks = 6

类型:

Int

在绘图范围内生成的主刻度位置的所需目标数量。

dimension = None

类型:

Nullable(Enum(LatLon))

指定是否为纬度或经度生成刻度。

投影坐标不可分离，从 WebMercator 计算纬度和经度刻度位置需要同时考虑两个维度上的坐标。使用此属性指定要返回的结果。

通常，如果刻度用于 x 轴，则维度应为 "lon"，如果刻度用于 y 轴，则维度应为 “lat”`。

为了防止难以调试的错误，维度没有默认值。使用未配置的 MercatorTicker 将导致验证错误和 JavaScript 控制台错误。

mantissas = [1, 2, 5]

类型:

Seq(Float)

生成倍数的允许数字列表。

max_interval = None

类型:

Nullable(Float)

两个相邻刻度之间允许的最大间隔。

注意

要指定无界间隔，请设置为 None。

min_interval = 0.0

类型:

Float

两个相邻刻度之间允许的最小间隔。

name = None

类型:

Nullable(String)

此模型的任意用户提供的名称。

当查询文档以检索特定 Bokeh 模型时，此名称很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

不会对提供的任何名称强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用名称。

num_minor_ticks = 5

类型:

Int

在相邻主刻度值之间生成的次刻度位置的数量。

syncable = True

类型:

Bool

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。设置为 False 可能有助于在处理经常更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 端回调仍然有效。

tags = []

类型:

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 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值。

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这会创建一个原始模型的浅层克隆，即不会复制任何可变容器或子模型。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类中所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

DataSpec 属性的名称

返回类型：

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序排列的属性描述符列表。

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

True，如果属性在结构上相等，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 要链接到可订阅 attr 中的项目的索引

在版本 1.1 中添加

引发：

ValueError –

示例

这段带有 js_link 的代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀。

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他类型的事件对响应可能有用。例如，要在数据流式传输到 ColumnDataSource 时运行回调，请在源上使用 "stream" 事件。

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果丢失，是否引发或返回 None

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

当attr更改时，在此对象上添加一个回调以触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当指定事件在此模型上发生时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适合从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

具有引用的属性的名称

返回类型：

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

不可序列化属性将被跳过，属性值将采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回重建对象实例所需的信息。

参数:

include_defaults (bool, optional) – 是否包含自对象创建以来未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型：

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

参数:

• query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

• include_defaults (bool, optional) – 是否包含用户未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型：

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则会引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector:

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

使用 JSON 在此对象上设置属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON-value) – 要设置为属性的值

• setter (ClientSession or ServerSession or None, optional) –

  用于防止对 Bokeh 应用程序的“回弹”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。该会话可以将事件设置程序与自身进行比较，并抑制任何来自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新，更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果将以字典形式返回，从属性名称到值，如果主题未覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化表示。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型附加到的 Document（可以是 None）

class MonthsTicker(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: BaseSingleIntervalTicker

生成以特定月份的偶数倍数间隔的刻度。

JSON 原型

{
  "desired_num_ticks": 6, 
  "id": "p63151", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "months": [], 
  "name": null, 
  "num_minor_ticks": 5, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

desired_num_ticks = 6

类型:

Int

在绘图范围内生成的主刻度位置的所需目标数量。

months = []

类型:

Seq(Int)

要使用的月份间隔。

name = None

类型:

Nullable(String)

此模型的任意用户提供的名称。

当查询文档以检索特定 Bokeh 模型时，此名称很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

不会对提供的任何名称强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用名称。

num_minor_ticks = 5

类型:

Int

在相邻主刻度值之间生成的次刻度位置的数量。

syncable = True

类型:

Bool

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。设置为 False 可能有助于在处理经常更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 端回调仍然有效。

tags = []

类型:

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 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值。

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这会创建一个原始模型的浅层克隆，即不会复制任何可变容器或子模型。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类中所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

DataSpec 属性的名称

返回类型：

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序排列的属性描述符列表。

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

True，如果属性在结构上相等，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 要链接到可订阅 attr 中的项目的索引

在版本 1.1 中添加

引发：

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

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果丢失，是否引发或返回 None

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

当attr更改时，在此对象上添加一个回调以触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当指定事件在此模型上发生时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适合从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，将属性名称映射到属性对象。为了使此方法的当前用法面向未来，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

具有引用的属性的名称

返回类型：

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

不可序列化属性将被跳过，属性值将采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回重建对象实例所需的信息。

参数:

include_defaults (bool, optional) – 是否包含自对象创建以来未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型：

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

参数:

• query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

• include_defaults (bool, optional) – 是否包含用户未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型：

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str,

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则会引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector:

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

使用 JSON 在此对象上设置属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON-value) – 要设置为属性的值

• setter (ClientSession or ServerSession or None, optional) –

  用于防止对 Bokeh 应用程序的“回弹”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。该会话可以将事件设置程序与自身进行比较，并抑制任何来自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新，更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果将以字典形式返回，从属性名称到值，如果主题未覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化表示。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型附加到的 Document（可以是 None）

class SingleIntervalTicker(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: BaseSingleIntervalTicker

在固定间隔内生成均匀间隔的刻度线，而无论比例如何。

JSON 原型

{
  "desired_num_ticks": 6, 
  "id": "p63158", 
  "interval": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "num_minor_ticks": 5, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

desired_num_ticks = 6

类型:

Int

在绘图范围内生成的主刻度位置的所需目标数量。

interval = Undefined

类型:

Required(Float)

相邻刻度线之间的间隔。

name = None

类型:

Nullable(String)

此模型的任意用户提供的名称。

当查询文档以检索特定 Bokeh 模型时，此名称很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

不会对提供的任何名称强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用名称。

num_minor_ticks = 5

类型:

Int

在相邻主刻度值之间生成的次刻度位置的数量。

syncable = True

类型:

Bool

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。设置为 False 可能有助于在处理经常更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 端回调仍然有效。

tags = []

类型:

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 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值。

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这会创建一个原始模型的浅层克隆，即不会复制任何可变容器或子模型。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类中所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

DataSpec 属性的名称

返回类型：

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序排列的属性描述符列表。

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

True，如果属性在结构上相等，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 要链接到可订阅 attr 中的项目的索引

在版本 1.1 中添加

引发：

ValueError –

示例

这段带有 js_link 的代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀。

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他类型的事件对响应可能有用。例如，要在数据流式传输到 ColumnDataSource 时运行回调，请在源上使用 "stream" 事件。

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果丢失，是否引发或返回 None

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

当attr更改时，在此对象上添加一个回调以触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当指定事件在此模型上发生时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适合从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，将属性名称映射到属性对象。为了使此方法的当前用法面向未来，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

具有引用的属性的名称

返回类型：

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

不可序列化属性将被跳过，属性值将采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回重建对象实例所需的信息。

参数:

include_defaults (bool, optional) – 是否包含自对象创建以来未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型：

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

参数:

• query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

• include_defaults (bool, optional) – 是否包含用户未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型：

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则会引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector:

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

使用 JSON 在此对象上设置属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON-value) – 要设置为属性的值

• setter (ClientSession or ServerSession or None, optional) –

  用于防止对 Bokeh 应用程序的“回弹”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。该会话可以将事件设置程序与自身进行比较，并抑制任何来自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新，更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values(

获取任何主题提供的覆盖。

结果将以字典形式返回，从属性名称到值，如果主题未覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化表示。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型附加到的 Document（可以是 None）

class Ticker(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: Model

所有刻度类型基类。

注意

这是一个抽象基类，用于帮助组织 Bokeh 模型类型的层次结构。**它本身没有用处。**

JSON 原型

{
  "id": "p63165", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

name = None

类型:

Nullable(String)

此模型的任意用户提供的名称。

当查询文档以检索特定 Bokeh 模型时，此名称很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

不会对提供的任何名称强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用名称。

syncable = True

类型:

Bool

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。设置为 False 可能有助于在处理经常更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 端回调仍然有效。

tags = []

类型:

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 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值。

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这会创建一个原始模型的浅层克隆，即不会复制任何可变容器或子模型。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类中所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

DataSpec 属性的名称

返回类型：

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序排列的属性描述符列表。

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

True，如果属性在结构上相等，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 要链接到可订阅 attr 中的项目的索引

在版本 1.1 中添加

引发：

ValueError –

示例

这段带有 js_link 的代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀。

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他类型的事件对响应可能有用。例如，要在数据流式传输到 ColumnDataSource 时运行回调，请在源上使用 "stream" 事件。

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果丢失，是否引发或返回 None

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

当attr更改时，在此对象上添加一个回调以触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当指定事件在此模型上发生时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适合从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，将属性名称映射到属性对象。为了使此方法的当前用法面向未来，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

具有引用的属性的名称

返回类型：

set[str]

properties_with_values(*, include_defaults: bool

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

不可序列化属性将被跳过，属性值将采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回重建对象实例所需的信息。

参数:

include_defaults (bool, optional) – 是否包含自对象创建以来未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型：

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

参数:

• query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

• include_defaults (bool, optional) – 是否包含用户未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型：

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则会引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector:

返回值:

Model

set_from_json(name: str, value:

参数:

• name (str) – 要设置的属性的名称

• value (JSON-value) – 要设置为属性的值

• setter (ClientSession or ServerSession or None, optional) –

  用于防止对 Bokeh 应用程序的“回弹”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。该会话可以将事件设置程序与自身进行比较，并抑制任何来自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新，更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果将以字典形式返回，从属性名称到值，如果主题未覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化表示。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型附加到的 Document（可以是 None）

class YearsTicker(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: BaseSingleIntervalTicker

生成间隔为偶数年的刻度。

JSON 原型

{
  "desired_num_ticks": 6, 
  "id": "p63169", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "num_minor_ticks": 5, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

desired_num_ticks = 6

类型:

Int

在绘图范围内生成的主刻度位置的所需目标数量。

name = None

类型:

Nullable(String)

此模型的任意用户提供的名称。

当查询文档以检索特定 Bokeh 模型时，此名称很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

不会对提供的任何名称强制执行唯一性保证或其他条件，Bokeh 也不会出于任何原因直接使用名称。

num_minor_ticks = 5

类型:

Int

在相邻主刻度值之间生成的次刻度位置的数量。

syncable = True

类型:

Bool

指示此模型在 Web 浏览器中更新时是否应同步回 Bokeh 服务器。设置为 False 可能有助于在处理经常更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 端回调仍然有效。

tags = []

类型:

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 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值。

返回值:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论是否使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这会创建一个原始模型的浅层克隆，即不会复制任何可变容器或子模型。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类中所有 DataSpec 属性的名称。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

DataSpec 属性的名称

返回类型：

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

按定义顺序排列的属性描述符列表。

destroy() → None

清理对文档和属性的引用。

equals(other: HasProps) → bool

模型的结构等价性。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

True，如果属性在结构上相等，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一个简便方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性更改值。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的 other 上的属性

• attr_selector (int | str) – 要链接到可订阅 attr 中的项目的索引

在版本 1.1 中添加

引发：

ValueError –

示例

这段带有 js_link 的代码

select.js_link('value', plot, 'sizing_mode')

等效于以下代码

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧连接到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀。

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他类型的事件对响应可能有用。例如，要在数据流式传输到 ColumnDataSource 时运行回调，请在源上使用 "stream" 事件。

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

在类上查找 Bokeh 属性的 PropertyDescriptor，给定属性名称。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果丢失，是否引发或返回 None

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

当attr更改时，在此对象上添加一个回调以触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当指定事件在此模型上发生时运行回调

并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息，请参阅 bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

生成适合从字形派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，将属性名称映射到属性对象。为了使此方法的当前用法面向未来，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[

收集此类上所有也具有引用的属性的名称。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

返回值:

具有引用的属性的名称

返回类型：

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包含在任何父类中定义的属性。

不可序列化属性将被跳过，属性值将采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回重建对象实例所需的信息。

参数:

include_defaults (bool, optional) – 是否包含自对象创建以来未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型：

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

参数:

• query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

• include_defaults (bool, optional) – 是否包含用户未显式设置的属性（默认值：True）

返回值:

匹配属性的属性名称和值的映射

返回类型：

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则会引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector:

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

使用 JSON 在此对象上设置属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON-value) – 要设置为属性的值

• setter (ClientSession or ServerSession or None, optional) –

  用于防止对 Bokeh 应用程序的“回弹”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。该会话可以将事件设置程序与自身进行比较，并抑制任何来自自身的更新。

返回值:

None

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新，更新与给定选择器匹配的对象。

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果将以字典形式返回，从属性名称到值，如果主题未覆盖此实例的任何值，则返回 None。

返回值:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化表示。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认值。

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型附加到的 Document（可以是 None）