表达式

表示要由 BokehJS 在客户端（浏览器）侧计算的数组表达式。

当希望在浏览器中计算数组值时，表达式模型作为 DataSpec 值很有用

p.circle(x={'expr': some_expression}, ...)

或使用 expr 方便函数

from bokeh.core.properties import expr

p.circle(x=expr(some_expression), ...)

在这种情况下，x 坐标的值将在浏览器中通过 some_expression 的 JavaScript 实现使用 ColumnDataSource 作为输入来计算。

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

基类：Expression

用于通过累积求和 ColumnDataSource 中的单个列来生成数组的表达式。

JSON 原型

{
  "field": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "id": "p57372", 
  "include_zero": false, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

field = Undefined

类型:

Required(String)

要为新值累积求和的 ColumnDataSource 列的名称。

include_zero = False

类型:

布尔值

是否在结果的开头包含零。请注意，结果的长度始终与输入列相同。因此，如果此属性为 True，则列的最后一个值将不包含在总和中。

source = ColumnDataSource(data=dict(foo=[1, 2, 3, 4]))

CumSum(field='foo')
# -> [1, 3, 6, 10]

CumSum(field='foo', include_zero=True)
# -> [0, 1, 3, 6]

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

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

返回值:

无

示例

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

返回值:

从属性名称到它们值的映射

返回类型：:

dict

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

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

参数:

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

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

返回值:

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

返回类型：:

dict

references() → set[Model]

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

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

从该对象中删除回调。

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

使用 JSON 设置该对象上的属性值。

参数:

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

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

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

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

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

返回值:

无

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

基类：Expression

评估 JavaScript 函数/生成器。

警告

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

JSON 原型

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

args = {}

类型:

Dict(String, AnyRef)

名称到 Python 对象的映射。尤其是那些可以是 bokeh 的模型。这些对象可作为回调的命名参数的值提供给回调的代码片段。无需手动包含关联的字形渲染器的数据源，因为它可通过this关键字在代码范围内使用（例如，this.data 将提供对原始数据的访问权限）。

code = ''

类型:

字符串

在浏览器中执行的 JavaScript 代码片段。代码被制成生成器函数的主体，并且args中的所有命名对象都可作为代码可用的参数。可以返回类数组对象（数组、类型化数组、nd 数组）、可迭代对象（将被转换为数组）或标量值（将被转换为适当长度的数组），或者替代地生成将被收集到数组中的值。

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

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

返回值:

无

示例

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

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性名称

返回类型：:

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到它们值的映射

返回类型：:

dict

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

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

参数:

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

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

返回值:

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

返回类型：:

dict

references() → set[Model]

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

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

从该对象中删除回调。

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

使用 JSON 设置该对象上的属性值。

参数:

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

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

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

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

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

返回值:

无

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

Bases: Model

用于表示在客户端执行计算的 Expression 模型的基类。

JavaScript 实现应实现以下方法

注意

如果您希望结果被缓存到每个数据源并且仅在数据源更改时更新，请实现 _v_compute: (source)。

注意

这是一个用于帮助组织 Bokeh 模型类型层次结构的抽象基类。**它本身不适合实例化。**

JSON 原型

{
  "id": "p57384", 
  "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

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:

在类上查找 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, optional) – 是否包含自对象创建以来未显式设置的属性。（默认值：True）

返回值:

从属性名称到它们值的映射

返回类型：:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[HasProps 实例的属性值。

参数:

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

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

返回值:

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

返回类型：:

dict

references() → set[Model]

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

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

从该对象中删除回调。

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

使用 JSON 设置该对象上的属性值。

参数:

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

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

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

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

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

返回值:

无

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

Bases: CoordinateTransform

从极坐标转换为笛卡尔坐标。

JSON 原型

{
  "angle": {
    "field": "angle", 
    "type": "field"
  }, 
  "direction": "anticlock", 
  "id": "p57388", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "radius": {
    "field": "radius", 
    "type": "field"
  }, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

angle = Field(field='angle', transform=Unspecified, units=Unspecified)

类型:

AngleSpec

角度坐标（即从参考轴的角度）。

angle_units = 'rad'

类型:

NotSerialized(Enum(AngleUnits))

与关联属性一起使用的单位：deg、rad、grad 或 turn

direction = 'anticlock'

类型:

Enum(Direction)

是否angle从参考轴顺时针或逆时针测量。

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

radius = Field(field='radius', transform=Unspecified, units=Unspecified)

类型:

NumberSpec

径向坐标（即到原点的距离）。

允许负半径，这等效于使用正半径并将direction更改为相反的值。

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

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

返回值:

无

示例

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

on_event(event: str | type[Event], *callbacks: Callable[[bokeh.events 中的特定事件。

classmethod parameters() → list[Parameter]

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

返回值:

list(Parameter)

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

收集此类上的属性名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性名称

返回类型：:

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到它们值的映射

返回类型：:

dict

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

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

参数:

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

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

返回值:

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

返回类型：:

dict

references() → set[Model]

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

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

从该对象中删除回调。

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(

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

返回值:

Model

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

使用 JSON 设置该对象上的属性值。

参数:

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

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

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

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

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

返回值:

无

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

基类：Expression

用于通过对 ColumnDataSource 中的不同列进行求和来生成数组的表达式。

此表达式对于在底层实现堆叠条形图很有用。

JSON 原型

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

fields = []

类型:

Seq(String)

来自 ColumnDataSource 的要相加（逐元素）的字段序列。例如

Stack(fields=['sales', 'marketing'])

将通过将数据源的 'sales' 和 'marketing' 列的元素相加来计算一组值（在浏览器中）。

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

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

返回值:

无

示例

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

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

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

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

classmethod

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

返回值:

list(Parameter)

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

收集此类上的属性名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性名称

返回类型：:

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到它们值的映射

返回类型：:

dict

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

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

参数:

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

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

返回值:

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

返回类型：:

dict

references() → set[Model]

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

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

从该对象中删除回调。

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

set_from_json(name: str, value:

参数:

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

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

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

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