映射器

用于在客户端中映射从一个范围或空间到另一个范围或空间的值的模型。

映射器（与比例尺相反）不假定是可逆的。

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

基类： CategoricalMapper, ColorMapper

将分类因子映射到颜色。

传递给此映射器且不在因子列表中的值将映射到 nan_color。

JSON 原型

{
  "end": null, 
  "factors": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "id": "p63234", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "nan_color": "gray", 
  "palette": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "start": 0, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

end = None

类型:

Nullable(Int)

在映射之前，用于“切片”数据因子的起始索引。

例如，如果要颜色映射的数据由 2 级因子组成，例如 ["2016", "sales"] 和 ["2017", "marketing"]，则设置 end=1 将仅基于第一个子因子执行颜色映射（即在本例中基于年份 "2016" 或 "2017"）

如果 None，则将使用从 start 到因子末尾的所有子因子进行颜色映射。

factors = Undefined

类型:

FactorSeq

映射到某个目标范围的因子/类别序列。例如，以下颜色映射器

mapper = CategoricalColorMapper(palette=["red", "blue"], factors=["foo", "bar"])

将因子 "foo" 映射到红色，将因子 "bar" 映射到蓝色。

name = None

类型:

Nullable(String)

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

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

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

注意

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

nan_color = 'gray'

类型:

颜色

如果数据为 NaN 或其他不可映射的情况，则使用的颜色。

可接受的值为

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

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

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

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

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

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

palette = Undefined

类型:

Seq(Color)

用作映射目标调色板的颜色序列。

此属性也可以设置为 String，指向 bokeh.palettes 中显示的任何调色板的名称。

start = 0

类型:

Int

在映射之前，用于“切片”数据因子的起始索引。

例如，如果要颜色映射的数据由 2 级因子组成，例如 ["2016", "sales"] 和 ["2016", "marketing"]，则设置 start=1 将仅基于第二个子因子执行颜色映射（即在本例中基于部门 "sales" 或 "marketing"）

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

List

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

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

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

或者只是将任何必要的元数据附加到可由 CustomJS 回调等访问的模型的便捷方式。

注意

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

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, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

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

参数:

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

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

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

  这用于防止对 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 CategoricalMapper(*args: Any, id: ID | None = None, **kwargs: Any)

基类：Mapper

用于将分类因子映射到其他值的映射器的基类。

注意

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

JSON 原型

{
  "end": null, 
  "factors": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "id": "p63243", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "start": 0, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

end = None

类型:

Nullable(Int)

在映射之前，用于“切片”数据因子的起始索引。

例如，如果要颜色映射的数据由 2 级因子组成，例如 ["2016", "sales"] 和 ["2017", "marketing"]，则设置 end=1 将仅基于第一个子因子执行颜色映射（即在本例中基于年份 "2016" 或 "2017"）

如果 None，则将使用从 start 到因子末尾的所有子因子进行颜色映射。

factors = Undefined

类型:

FactorSeq

映射到某个目标范围的因子/类别序列。例如，以下颜色映射器

mapper = CategoricalColorMapper(palette=["red", "blue"], factors=["foo", "bar"])

将因子 "foo" 映射到红色，将因子 "bar" 映射到蓝色。

name = None

类型:

Nullable(String)

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

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

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

注意

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

start = 0

类型:

Int

在映射之前，用于“切片”数据因子的起始索引。

例如，如果要颜色映射的数据由 2 级因子组成，例如 ["2016", "sales"] 和 ["2016", "marketing"]，则设置 start=1 将仅基于第二个子因子执行颜色映射（即在本例中基于部门 "sales" 或 "marketing"）

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

List

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

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

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

或者只是将任何必要的元数据附加到可由 CustomJS 回调等访问的模型的便捷方式。

注意

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

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]

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

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, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

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

参数:

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

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

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

  这用于防止对 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 CategoricalMarkerMapper(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: CategoricalMapper

映射分类因子到标记类型。

传递给此映射器且不在因子列表中的值将被映射到 default_value。

注意

此映射器主要仅对 Scatter 标记字形有用，该字形可以通过标记类型进行参数化。

JSON 原型

{
  "default_value": "circle", 
  "end": null, 
  "factors": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "id": "p63250", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "markers": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "name": null, 
  "start": 0, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

default_value = 'circle'

类型:

MarkerType

在传入要映射的无法识别的因子时，要使用的标记类型。

end = None

类型:

Nullable(Int)

在映射之前，用于“切片”数据因子的起始索引。

例如，如果要颜色映射的数据由 2 级因子组成，例如 ["2016", "sales"] 和 ["2017", "marketing"]，则设置 end=1 将仅基于第一个子因子执行颜色映射（即在本例中基于年份 "2016" 或 "2017"）

如果 None，则将使用从 start 到因子末尾的所有子因子进行颜色映射。

factors = Undefined

类型:

FactorSeq

映射到某个目标范围的因子/类别序列。例如，以下颜色映射器

mapper = CategoricalColorMapper(palette=["red", "blue"], factors=["foo", "bar"])

将因子 "foo" 映射到红色，将因子 "bar" 映射到蓝色。

markers = Undefined

类型:

Seq(MarkerType)

用作映射目标的标记类型序列。

name = None

类型:

Nullable(String)

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

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

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

注意

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

start = 0

类型:

Int

在映射之前，用于“切片”数据因子的起始索引。

例如，如果要颜色映射的数据由 2 级因子组成，例如 ["2016", "sales"] 和 ["2016", "marketing"]，则设置 start=1 将仅基于第二个子因子执行颜色映射（即在本例中基于部门 "sales" 或 "marketing"）

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

List

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

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

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

或者只是将任何必要的元数据附加到可由 CustomJS 回调等访问的模型的便捷方式。

注意

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

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, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

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

参数:

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

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

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

  这用于防止对 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 类 CategoricalPatternMapper(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: CategoricalMapper

将分类因子映射到阴影填充图案。

传递给此映射器且不在因子列表中的值将被映射到 default_value。

在 1.1.1 版本中添加

JSON 原型

{
  "default_value": " ", 
  "end": null, 
  "factors": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "id": "p63259", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "patterns": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "start": 0, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

default_value 默认值 = ' '

类型:

HatchPatternType

当传入无法识别的因子进行映射时，使用的阴影图案。

end 结束 = None

类型:

Nullable(Int)

在映射之前，用于“切片”数据因子的起始索引。

例如，如果要颜色映射的数据由 2 级因子组成，例如 ["2016", "sales"] 和 ["2017", "marketing"]，则设置 end=1 将仅基于第一个子因子执行颜色映射（即在本例中基于年份 "2016" 或 "2017"）

如果 None，则将使用从 start 到因子末尾的所有子因子进行颜色映射。

factors 因子 = Undefined

类型:

FactorSeq

映射到某个目标范围的因子/类别序列。例如，以下颜色映射器

mapper = CategoricalColorMapper(palette=["red", "blue"], factors=["foo", "bar"])

将因子 "foo" 映射到红色，将因子 "bar" 映射到蓝色。

name 名称 = None

类型:

Nullable(String)

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

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

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

注意

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

patterns 图案 = Undefined

类型:

Seq(HatchPatternType)

用作映射目标的标记类型序列。

start 开始 = 0

类型:

Int

在映射之前，用于“切片”数据因子的起始索引。

例如，如果要颜色映射的数据由 2 级因子组成，例如 ["2016", "sales"] 和 ["2016", "marketing"]，则设置 start=1 将仅基于第二个子因子执行颜色映射（即在本例中基于部门 "sales" 或 "marketing"）

syncable 可同步 = True

类型:

Bool

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

注意

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

tags 标签 = []

类型:

List

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

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

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

或者只是将任何必要的元数据附加到可由 CustomJS 回调等访问的模型的便捷方式。

注意

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

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, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

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

参数:

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

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

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

  这用于防止对 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 ColorMapper(*args: Any, id: ID | None = None, **kwargs: Any)

基类：Mapper

颜色映射器类型的基类。

注意

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

JSON 原型

{
  "id": "p63268", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "nan_color": "gray", 
  "palette": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

name = None

类型:

Nullable(String)

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

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

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

注意

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

nan_color = 'gray'

类型:

颜色

如果数据为 NaN 或其他不可映射的情况，则使用的颜色。

可接受的值为

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

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

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

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

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

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

palette = Undefined

类型:

Seq(Color)

用作映射目标调色板的颜色序列。

此属性也可以设置为 String，指向 bokeh.palettes 中显示的任何调色板的名称。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

List

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

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

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

或者只是将任何必要的元数据附加到可由 CustomJS 回调等访问的模型的便捷方式。

注意

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

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, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

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

参数:

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

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

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

  这用于防止对 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 ContinuousColorMapper(*args: Any, id: ID | None = None, **kwargs: Any)

基粺： ColorMapper

连续颜色f映;射器类型的基粺类。

注意

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

JSON 原型

{
  "domain": [], 
  "high": null, 
  "high_color": null, 
  "id": "p63274", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "low": null, 
  "low_color": null, 
  "name": null, 
  "nan_color": "gray", 
  "palette": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

domain = []

类型:

List

一组字形渲染器，用于从中池化数据，以建立数据指标。如果为空，将使用f映;射的数据。

high = None

类型:

Nullable(Float)

f映;射到色板的范围的最大值。高于此值的值被箐位到 high。如果 None，则该值从数据中推断。

high_color = None

类型:

Nullable(Color)

如果数据高于 high 值时使用的颜色。如果为 None，则高于 high 的值f映;射到色板中的最后一种颜色。

low = None

类型:

Nullable(Float)

f映;射到色板的范围的最小值。低于此值的值被箐位到 low。如果 None，则该值从数据中推断。

low_color = None

类型:

Nullable(Color)

如果数据低于 low 值时使用的颜色。如果为 None，则低于 low 的值f映;射到色板中的第一种颜色。

name = None

类型:

Nullable(String)

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

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

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

注意

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

nan_color = 'gray'

类型:

颜色

如果数据为 NaN 或其他不可映射的情况，则使用的颜色。

可接受的值为

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

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

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

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

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

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

palette = Undefined

类型:

Seq(Color)

用作映射目标调色板的颜色序列。

此属性也可以设置为 String，指向 bokeh.palettes 中显示的任何调色板的名称。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

List

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

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

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

或者只是将任何必要的元数据附加到可由 CustomJS 回调等访问的模型的便捷方式。

注意

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

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

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

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

参数:

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

返回:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

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]"
    )
)

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

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

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

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

source.js_on_change('streaming', callback)

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

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

参数:

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

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

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回:

None

示例

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

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

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

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

classmethod parameters() → list[Parameter]

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

返回:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回:

属性名称

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

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

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

返回:

具有引用的属性的名称

返回类型:

set[str]

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

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

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

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

参数:

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

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

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

参数:

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

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

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

  这用于防止对 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 EqHistColorMapper(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: ScanningColorMapper

JSON 原型

{
  "bins": 65536, 
  "domain": [], 
  "high": null, 
  "high_color": null, 
  "id": "p63285", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "low": null, 
  "low_color": null, 
  "name": null, 
  "nan_color": "gray", 
  "palette": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "rescale_discrete_levels": false, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

bins = 65536

类型:

Int

直方图箱的数量

domain = []

类型:

List

一组字形渲染器，用于从中池化数据，以建立数据指标。如果为空，将使用f映;射的数据。

high = None

类型:

Nullable(Float)

f映;射到色板的范围的最大值。高于此值的值被箐位到 high。如果 None，则该值从数据中推断。

high_color = None

类型:

Nullable(Color)

如果数据高于 high 值时使用的颜色。如果为 None，则高于 high 的值f映;射到色板中的最后一种颜色。

low = None

类型:

Nullable(Float)

f映;射到色板的范围的最小值。低于此值的值被箐位到 low。如果 None，则该值从数据中推断。

low_color = None

类型:

Nullable(Color)

如果数据低于 low 值时使用的颜色。如果为 None，则低于 low 的值f映;射到色板中的第一种颜色。

name = None

类型:

Nullable(String)

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

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

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

注意

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

nan_color = 'gray'

类型:

颜色

如果数据为 NaN 或其他不可映射的情况，则使用的颜色。

可接受的值为

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

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

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

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

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

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

palette = Undefined

类型:

Seq(Color)

用作映射目标调色板的颜色序列。

此属性也可以设置为 String，指向 bokeh.palettes 中显示的任何调色板的名称。

rescale_discrete_levels = False

类型:

Bool

如果颜色映射的值中只有少量离散级别，则 rescale_discrete_levels=True 会降低跨度的下限，以便值渲染到调色板的顶端。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

List

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

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

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

或者只是将任何必要的元数据附加到可由 CustomJS 回调等访问的模型的便捷方式。

注意

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

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, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

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

参数:

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

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

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

  这用于防止对 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 LinearColorMapper(*args: Any, id: ID | None = None, **kwargs: Any)

基类: ContinuousColorMapper

将范围 [low, high] 内的数字线性映射到颜色序列（调色板）。

例如，如果范围是 [0, 99]，调色板是 ['red', 'green', 'blue']，则值将按如下方式映射

      x < 0  : 'red'     # values < low are clamped
 0 <= x < 33 : 'red'
33 <= x < 66 : 'green'
66 <= x < 99 : 'blue'
99 <= x      : 'blue'    # values > high are clamped

JSON 原型

{
  "domain": [], 
  "high": null, 
  "high_color": null, 
  "id": "p63298", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "low": null, 
  "low_color": null, 
  "name": null, 
  "nan_color": "gray", 
  "palette": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

domain = []

类型:

List

一组字形渲染器，用于从中池化数据，以建立数据指标。如果为空，将使用f映;射的数据。

high = None

类型:

Nullable(Float)

f映;射到色板的范围的最大值。高于此值的值被箐位到 high。如果 None，则该值从数据中推断。

high_color = None

类型:

Nullable(Color)

如果数据高于 high 值时使用的颜色。如果为 None，则高于 high 的值f映;射到色板中的最后一种颜色。

low = None

类型:

Nullable(Float)

f映;射到色板的范围的最小值。低于此值的值被箐位到 low。如果 None，则该值从数据中推断。

low_color = None

类型:

Nullable(Color)

如果数据低于 low 值时使用的颜色。如果为 None，则低于 low 的值f映;射到色板中的第一种颜色。

name = None

类型:

Nullable(String)

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

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

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

注意

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

nan_color = 'gray'

类型:

颜色

如果数据为 NaN 或其他不可映射的情况，则使用的颜色。

可接受的值为

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

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

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

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

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

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

palette = Undefined

类型:

Seq(Color)

用作映射目标调色板的颜色序列。

此属性也可以设置为 String，指向 bokeh.palettes 中显示的任何调色板的名称。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

List

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

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

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

或者只是将任何必要的元数据附加到可由 CustomJS 回调等访问的模型的便捷方式。

注意

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

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, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

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

参数:

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

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

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

  这用于防止对 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 LogColorMapper(*args: Any, id: ID | None = None, **kwargs: Any)

基类: ContinuousColorMapper

将 [low, high] 范围内的数字以自然对数刻度映射到颜色序列（调色板）。

例如，如果范围是 [0, 25]，调色板是 ['red', 'green', 'blue']，则值将按如下方式映射

         x < 0     : 'red'     # values < low are clamped
0     <= x < 2.72  : 'red'     # math.e ** 1
2.72  <= x < 7.39  : 'green'   # math.e ** 2
7.39  <= x < 20.09 : 'blue'    # math.e ** 3
20.09 <= x         : 'blue'    # values > high are clamped

警告

LogColorMapper 仅适用于具有非负标量值的图像。

JSON 原型

{
  "domain": [], 
  "high": null, 
  "high_color": null, 
  "id": "p63309", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "low": null, 
  "low_color": null, 
  "name": null, 
  "nan_color": "gray", 
  "palette": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

domain = []

类型:

List

一组字形渲染器，用于从中池化数据，以建立数据指标。如果为空，将使用f映;射的数据。

high = None

类型:

Nullable(Float)

f映;射到色板的范围的最大值。高于此值的值被箐位到 high。如果 None，则该值从数据中推断。

high_color = None

类型:

Nullable(Color)

如果数据高于 high 值时使用的颜色。如果为 None，则高于 high 的值f映;射到色板中的最后一种颜色。

low = None

类型:

Nullable(Float)

f映;射到色板的范围的最小值。低于此值的值被箐位到 low。如果 None，则该值从数据中推断。

low_color = None

类型:

Nullable(Color)

如果数据低于 low 值时使用的颜色。如果为 None，则低于 low 的值f映;射到色板中的第一种颜色。

name = None

类型:

Nullable(String)

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

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

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

注意

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

nan_color = 'gray'

类型:

颜色

如果数据为 NaN 或其他不可映射的情况，则使用的颜色。

可接受的值为

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

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

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

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

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

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

palette = Undefined

类型:

Seq(Color)

用作映射目标调色板的颜色序列。

此属性也可以设置为 String，指向 bokeh.palettes 中显示的任何调色板的名称。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

List

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

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

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

或者只是将任何必要的元数据附加到可由 CustomJS 回调等访问的模型的便捷方式。

注意

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

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

清理对文档和属性的引用

等于(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 查找(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 参数() → list[Parameter]

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

返回:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回:

属性名称

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

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

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

返回:

具有引用的属性的名称

返回类型:

set[str]

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

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

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

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

参数:

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

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回:

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

返回类型:

dict

引用() → set[Model]

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

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

从此对象中移除回调

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

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

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

参数:

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

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

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

  这用于防止对 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

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

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

取消主题() → None

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

返回:

None

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

Bases: Transform

映射器的基类。

注意

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

JSON 原型

{
  "id": "p63320", 
  "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.scatter([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.scatter([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者只是将任何必要的元数据附加到可由 CustomJS 回调等访问的模型的便捷方式。

注意

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

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]]

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

销毁() → None

清理对文档和属性的引用

等于(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, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

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

参数:

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

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

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

  这用于防止对 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 StackColorMapper(*args: Any, id: ID | None = None, **kwargs: Any)

基粺： ColorMapper

用于操作 ImageStack 字形的颜色映射器的抽象基类。

这些将形状为 (ny, nx, nstack) 的 3D 数据数组映射到形状为 (ny, nx) 的 2D RGBA 图像。

注意

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

JSON 原型

{
  "id": "p63324", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "nan_color": "gray", 
  "palette": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

name = None

类型:

Nullable(String)

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

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

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

注意

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

nan_color = 'gray'

类型:

颜色

如果数据为 NaN 或其他不可映射的情况，则使用的颜色。

可接受的值为

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

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

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

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

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

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

palette = Undefined

类型:

Seq(Color)

用作映射目标调色板的颜色序列。

此属性也可以设置为 String，指向 bokeh.palettes 中显示的任何调色板的名称。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

List

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

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

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

或者只是将任何必要的元数据附加到可由 CustomJS 回调等访问的模型的便捷方式。

注意

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

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: 模型, 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: JS更改回调) → 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) → 属性描述符[Any] | None

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

参数:

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

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

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: 属性回调) → None

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

参数:

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

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

返回:

None

示例

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

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

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

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

classmethod parameters() → list[参数]

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

返回:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回:

属性名称

classmethod properties_with_refs() → dict[str, 属性[[Any]]

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

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

返回:

具有引用的属性的名称

返回类型:

set[str]

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

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

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

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

参数:

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

返回:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[属性描述符[[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

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

参数:

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

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

返回:

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

返回类型:

dict

references() → set[模型]

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

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

从此对象中移除回调

select(selector: 选择器类型) → Iterable[模型]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: 选择器类型) → 模型 | None

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

返回:

Model

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

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

参数:

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

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

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

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

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

返回:

None

set_select(selector: type[模型] | 选择器类型, updates: dict[str, Any]) → None

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

参数:

• selector (JSON-like)

• updates (dict)

返回:

None

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

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

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

返回:

dict 或 None

to_serializable(serializer: 序列化器) → ObjectRefRep

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

trigger(attr: str, old: Any, new: Any, hint: 文档补丁事件 | 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: 文档 | None

此模型所附加的 Document (可以为 None)

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

基类: StackColorMapper

将形状为 (ny, nx, nstack) 的 3D 数据数组映射到形状为 (ny, nx) 的 2D RGBA 图像，使用长度为 nstack 的调色板。

映射分两个阶段进行。首先，使用调色板颜色在 nstack 方向上的加权和计算 RGB 值。然后，使用应用于 nstack 方向上数组总和的 alpha_mapper 计算 alpha 值。

alpha_mapper 计算的 RGB 值会被颜色映射忽略，但会用于显示的任何 ColorBar 中。

JSON 原型

{
  "alpha_mapper": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "color_baseline": null, 
  "id": "p63330", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "nan_color": "gray", 
  "palette": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "stack_labels": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

alpha_mapper = 未定义

类型:

Instance(ContinuousColorMapper)

用于计算映射数据的 alpha 值的颜色映射器。

color_baseline = None

类型:

Nullable(Float)

用于计算调色板颜色加权和的基线值。如果为 None，则使用提供数据的最小值，这意味着此最小值处的值权重为零，并且不参与加权和。作为一种特殊情况，如果特定输出像素的所有数据都位于颜色基线上，则颜色是与所有此类值对应的颜色的均匀加权平均值，以避免颜色未定义。

name = None

类型:

Nullable(String)

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

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

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

注意

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

nan_color = 'gray'

类型:

颜色

如果数据为 NaN 或其他不可映射的情况，则使用的颜色。

可接受的值为

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

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

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

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

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

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

palette = 未定义

类型:

Seq(Color)

用作映射目标调色板的颜色序列。

此属性也可以设置为 String，指向 bokeh.palettes 中显示的任何调色板的名称。

stack_labels = None

类型:

Nullable(Seq(String))

一个可选的字符串序列，用作 nstack 堆叠的标签。如果设置，标签数量应与堆叠数量一致，因此也应与调色板颜色数量一致。

标签用于使用 WeightedStackColorMapper 作为其颜色映射器的 ImageStack 字形的悬停工具提示中。

syncable = True

类型:

Bool

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

注意

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

tags = []

类型:

List

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

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

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

或者只是将任何必要的元数据附加到可由 CustomJS 回调等访问的模型的便捷方式。

注意

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

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 属性的名称

返回类型:

set[str]

classmethod descriptors() → list[属性描述符[[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, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中移除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

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

参数:

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

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

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

  这用于防止对 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)