比例尺#

class CategoricalScale(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

基类: Scale

表示在分类源范围和连续目标范围之间的比例变换。

JSON 原型
{
  "id": "p62630", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}
name = None#
类型:

Nullable(String)

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

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

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

注意

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

syncable = True#
类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是,任何 JS 端回调仍然可以工作。

tags = []#
类型:

列表

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

查询文档以检索特定 Bokeh 模型时,此数据很有用

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

或者只是将任何必要的元数据附加到模型的一种便捷方式,这些元数据可以通过 CustomJS 回调等进行访问。

注意

不保证任何提供的标签的唯一性或其他条件,Bokeh 也不会出于任何原因直接使用这些标签。

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

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

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

参数:

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

返回值:

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

使用 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) – 要注册的回调函数

返回值:

示例

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

生成适合派生自 Glyph 的函数的 Python Parameter 值。

返回值:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性名称

返回类型:

set[str]

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

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

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

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

参数:

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

返回值:

属性名称到其值的映射

返回类型:

字典

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

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

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

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

返回值:

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

返回类型:

字典

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 (ClientSessionServerSessionNone, 可选) –

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

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

返回值:

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

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

参数:
  • selector (JSON-like)

  • updates (dict)

返回值:

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#

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

返回值:

update(**kwargs: Any) 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 CompositeScale(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

基类: Scale

表示两个比例尺的组合,这对于定义子坐标系很有用。

JSON 原型
{
  "id": "p62634", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "source_scale": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "target_scale": {
    "name": "unset", 
    "type": "symbol"
  }
}
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 也不会出于任何原因直接使用该名称。

source_scale = Undefined#
类型:

Required(Instance(Scale))

源比例尺。

syncable = True#
类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是,任何 JS 端回调仍然可以工作。

tags = []#
类型:

列表

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

查询文档以检索特定 Bokeh 模型时,此数据很有用

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

或者只是将任何必要的元数据附加到模型的一种便捷方式,这些元数据可以通过 CustomJS 回调等进行访问。

注意

不保证任何提供的标签的唯一性或其他条件,Bokeh 也不会出于任何原因直接使用这些标签。

target_scale = Undefined#
类型:

Required(Instance(Scale))

目标比例尺。

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

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

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

参数:

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

返回值:

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

使用 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) – 要注册的回调函数

返回值:

示例

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

生成适合派生自 Glyph 的函数的 Python Parameter 值。

返回值:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性名称

返回类型:

set[str]

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

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

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

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

参数:

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

返回值:

属性名称到其值的映射

返回类型:

字典

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

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

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

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

返回值:

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

返回类型:

字典

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 (ClientSessionServerSessionNone, 可选) –

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

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

返回值:

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

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

参数:
  • selector (JSON-like)

  • updates (dict)

返回值:

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#

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

返回值:

update(**kwargs: Any) 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 LinearScale(*args: Any, id: ID | None = None, **kwargs: Any)[源代码]#

基类: ContinuousScale

表示连续范围之间的线性比例转换。

JSON 原型
{
  "id": "p62640", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}
name = None#
类型:

Nullable(String)

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

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

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

注意

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

syncable = True#
类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是,任何 JS 端回调仍然可以工作。

tags = []#
类型:

列表

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

查询文档以检索特定 Bokeh 模型时,此数据很有用

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

或者只是将任何必要的元数据附加到模型的一种便捷方式,这些元数据可以通过 CustomJS 回调等进行访问。

注意

不保证任何提供的标签的唯一性或其他条件,Bokeh 也不会出于任何原因直接使用这些标签。

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

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

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

参数:

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

返回值:

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

使用 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) – 要注册的回调函数

返回值:

示例

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

生成适合派生自 Glyph 的函数的 Python Parameter 值。

返回值:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性名称

返回类型:

set[str]

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

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

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

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

参数:

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

返回值:

属性名称到其值的映射

返回类型:

字典

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

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

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

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

返回值:

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

返回类型:

字典

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 (ClientSessionServerSessionNone, 可选) –

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

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

返回值:

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

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

参数:
  • selector (JSON-like)

  • updates (dict)

返回值:

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#

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

返回值:

update(**kwargs: Any) 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 LogScale(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

基类: ContinuousScale

表示连续范围之间的对数刻度变换。

JSON 原型
{
  "id": "p62644", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}
name = None#
类型:

Nullable(String)

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

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

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

注意

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

syncable = True#
类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是,任何 JS 端回调仍然可以工作。

tags = []#
类型:

列表

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

查询文档以检索特定 Bokeh 模型时,此数据很有用

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

或者只是将任何必要的元数据附加到模型的一种便捷方式,这些元数据可以通过 CustomJS 回调等进行访问。

注意

不保证任何提供的标签的唯一性或其他条件,Bokeh 也不会出于任何原因直接使用这些标签。

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

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

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

参数:

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

返回值:

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

使用 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)
类方法 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) – 要注册的回调函数

返回值:

示例

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None#

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

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

类方法 parameters() list[Parameter]#

生成适合派生自 Glyph 的函数的 Python Parameter 值。

返回值:

list(Parameter)

类方法 properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#

收集此类上属性的名称。

警告

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

返回值:

属性名称

类方法 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)

返回值:

属性名称到其值的映射

返回类型:

字典

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

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

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

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

返回值:

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

返回类型:

字典

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 (ClientSessionServerSessionNone, 可选) –

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

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

返回值:

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

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

参数:
  • selector (JSON-like)

  • updates (dict)

返回值:

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#

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

返回值:

update(**kwargs: Any) 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 Scale(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

基类:Transform

表示在客户端执行的可逆计算的Scale模型的基类。

JavaScript 实现应实现以下方法

注意

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

JSON 原型
{
  "id": "p62648", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}
name = None#
类型:

Nullable(String)

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

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

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

注意

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

syncable = True#
类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是,任何 JS 端回调仍然可以工作。

tags = []#
类型:

列表

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

查询文档以检索特定 Bokeh 模型时,此数据很有用

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

或者只是将任何必要的元数据附加到模型的一种便捷方式,这些元数据可以通过 CustomJS 回调等进行访问。

注意

不保证任何提供的标签的唯一性或其他条件,Bokeh 也不会出于任何原因直接使用这些标签。

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

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

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

参数:

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

返回值:

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

使用 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) – 要注册的回调函数

返回值:

示例

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

生成适合派生自 Glyph 的函数的 Python Parameter 值。

返回值:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性名称

返回类型:

set[str]

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

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

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

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

参数:

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

返回值:

属性名称到其值的映射

返回类型:

字典

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

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

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

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

返回值:

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

返回类型:

字典

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 (ClientSessionServerSessionNone, 可选) –

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

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

返回值:

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

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

参数:
  • selector (JSON-like)

  • updates (dict)

返回值:

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#

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

返回值:

update(**kwargs: Any) 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