ui_element

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

基类： Model

基于 DOM 的 UI 元素的基类，具有可配置的样式。

注意

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

JSON 原型

{
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "id": "p64240", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

css_classes = []

类型：

列表

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

css_variables = {}

类型：

Dict(String, Instance(Node))

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

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

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

注意

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

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

styles = {}

类型：

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于基础 DOM 元素的内联 CSS 样式。

stylesheets = []

类型：

列表

用于基础 DOM 元素的其他样式表。

请注意，所有 Bokeh 组件都使用影子 DOM，因此任何包含的样式表都必须反映这一点，例如使用 :host CSS 伪选择器访问根 DOM 元素。

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) – 用于代替默认值的主题值

返回:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回:

DataSpec 属性的名称

返回类型:

set[str]

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

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

destroy() → None

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

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回:

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

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

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

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

参数:

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

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

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

• attr_selector (int | str) – 要链接可下标 attr 中项目的索引

添加在 1.1 版中

引发:

ValueError –

示例

这段使用 js_link 的代码

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

等效于以下代码

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

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

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

等效于

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

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

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

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

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

但是，除了属性变更事件之外，还有其他类型的事件可以用于响应。例如，要在一个 ColumnDataSource 数据流到数据源时运行一个回调函数，可以使用数据源上的 "stream" 事件。

source.js_on_change('streaming', callback)

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

在类中找到给定属性名称的 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要查找的属性的名称

• raises (bool) – 如果缺少属性，则决定是引发异常还是返回 None

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

在这个对象上添加一个回调函数，当 attr 发生改变时触发。

参数:

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

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

返回:

None

示例

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

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

当这个模型上发生指定事件时，运行回调函数。

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

classmethod parameters() → list[Parameter]

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

返回:

list(Parameter)

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

收集此类上的属性名称。

警告

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

返回:

属性名称

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

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

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

返回:

具有引用的属性的名称

返回类型:

set[str]

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

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

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

不可序列化的属性会被跳过，属性值以“序列化”格式存储，可能略微不同于你通常从属性中读取的值；这个方法的目的是返回重建对象实例所需的信息，以确保无损。

参数:

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

返回:

属性名到值的映射

返回类型:

dict

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

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

参数:

• query (callable) – 可调用函数，接受属性描述符，并返回 True 或 False

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则会引发错误。返回单个匹配对象，或如果未找到任何对象，则返回 None :param selector: :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 服务器应用程序的上下文中，传入的属性更新将用进行更新的会话进行注释。此值将传播到更新触发的任何后续更改通知。会话可以将事件设置程序与自身进行比较，并抑制任何来自自身的更新。

返回:

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。

返回:

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

Bases: StyledElement

用户界面元素的基类。

注意

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

JSON 原型

{
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "id": "p64248", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true
}

context_menu = None

类型：

Nullable(Instance(Menu))

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

注意

右键单击时使用 shift 键显示本机上下文菜单。

css_classes = []

类型：

列表

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

css_variables = {}

类型：

Dict(String, Instance(Node))

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

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

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

注意

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

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

styles = {}

类型：

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于基础 DOM 元素的内联 CSS 样式。

stylesheets = []

类型：

列表

用于基础 DOM 元素的其他样式表。

请注意，所有 Bokeh 组件都使用影子 DOM，因此任何包含的样式表都必须反映这一点，例如使用 :host CSS 伪选择器访问根 DOM 元素。

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

visible = True

类型：

布尔值

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

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: attr 发生改变时触发。

参数:

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

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

返回:

None

示例

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

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

当这个模型上发生指定事件时，运行回调函数。

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

classmethod parameters() → list[Parameter]

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

返回:

list(Parameter)

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

收集此类上的属性名称。

警告

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

返回:

属性名称

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

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

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

返回:

具有引用的属性的名称

返回类型:

set[str]

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

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

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

不可序列化的属性会被跳过，属性值以“序列化”格式存储，可能略微不同于你通常从属性中读取的值；这个方法的目的是返回重建对象实例所需的信息，以确保无损。

参数:

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

返回:

属性名到值的映射

返回类型:

dict

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

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

参数:

• query (callable) – 可调用函数，接受属性描述符，并返回 True 或 False

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(

返回:

Model

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

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

参数:

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

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

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

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

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

返回:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回:

None

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

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

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

返回:

字典或 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）