renderers#

各种渲染器。

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

基类： Renderer

一种渲染器，允许附加其他渲染器和基于 DOM 的 UI。

注意

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

JSON 原型

{
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "elements": [], 
  "group": null, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p64133", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "image", 
  "name": null, 
  "propagate_hover": false, 
  "renderers": [], 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}

context_menu = None#

类型:

Nullable(Instance(Menu))

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

注意

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []#

类型:

列表

要添加到底层 DOM 元素的其他 CSS 类的列表。

css_variables = {}#

类型:

Dict(String, Either(String, Instance(Node)))

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

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

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

注意

此属性是实验性的，可能会在任何时候更改。

elements = []#

类型:

列表

附加到此渲染器的基于 DOM 的 UI 元素集合。

这可以包括浮动元素（如工具提示），从而在此渲染器及其 UI 元素之间建立父子关系。

注意

此属性等效于基于 DOM 的 UI 中的 Pane.elements。

group = None#

类型:

Nullable(Instance(RendererGroup))

注意

此属性是实验性的，可能会在任何时候更改。

html_attributes = {}#

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None#

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

level = 'image'#

类型:

Enum(RenderLevel)

指定绘制此渲染器的层级。

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

propagate_hover = False#

类型:

布尔值

允许将悬停事件传播到父渲染器、框架或画布。

注意

此属性是实验性的，可能会在任何时候更改。

renderers = []#

类型:

列表

附加到此渲染器的渲染器集合。

注意

此属性是实验性的，可能会在任何时候更改。

styles = {}#

类型:

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

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []#

类型:

列表

用于底层 DOM 元素的其他样式表。

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

syncable = True#

类型:

布尔值

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

注意

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

tags = []#

类型:

列表

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

当查询文档以检索特定的 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 也不会出于任何原因直接使用这些标签。

visible = True#

类型:

布尔值

渲染器是否可见。

x_range_name = 'default'#

类型:

字符串

用于在绘图上渲染字形时计算屏幕位置的特定（命名）x 轴范围。如果未设置，则使用默认 x 轴范围。

y_range_name = 'default'#

类型:

字符串

用于在绘图上渲染字形时计算屏幕位置的特定（命名）y 轴范围。如果未设置，则使用默认 y 轴范围。

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

当此 Model 上发生指定的事件时，运行回调函数。

并非所有 Model 都支持所有 Event。有关哪些 Model 能够触发哪些 Event 的更多信息，请参阅 bokeh.events 中的特定 Event。

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）

返回:

从属性名称到其值的映射

返回类型:

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

基类： DataRenderer

由填充多边形和/或线条组成的轮廓图的渲染器。

与其手动创建这些，通常最好使用 contour() 代替。

JSON 原型

{
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "fill_renderer": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "group": null, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p64152", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "glyph", 
  "levels": [], 
  "line_renderer": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "name": null, 
  "propagate_hover": false, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}

context_menu = None#

类型:

Nullable(Instance(Menu))

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

注意

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []#

类型:

列表

要添加到底层 DOM 元素的其他 CSS 类的列表。

css_variables = {}#

类型:

Dict(String, Either(String, Instance(Node)))

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

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

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

注意

此属性是实验性的，可能会在任何时候更改。

fill_renderer = Undefined#

类型:

Instance(GlyphRenderer)

用于填充轮廓多边形的 Glyph 渲染器。

group = None#

类型:

Nullable(Instance(RendererGroup))

注意

此属性是实验性的，可能会在任何时候更改。

html_attributes = {}#

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None#

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

level = 'glyph'#

类型:

Enum(RenderLevel)

指定绘制此渲染器的层级。

levels = []#

类型:

Seq(Float)

计算轮廓线的水平。

line_renderer = Undefined#

类型:

Instance(GlyphRenderer)

用于轮廓线的字形渲染器。

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

propagate_hover = False#

类型:

布尔值

允许将悬停事件传播到父渲染器、框架或画布。

注意

此属性是实验性的，可能会在任何时候更改。

styles = {}#

类型:

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

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []#

类型:

列表

用于底层 DOM 元素的其他样式表。

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

syncable = True#

类型:

布尔值

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

注意

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

tags = []#

类型:

列表

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

当查询文档以检索特定的 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 也不会出于任何原因直接使用这些标签。

visible = True#

类型:

布尔值

渲染器是否可见。

x_range_name = 'default'#

类型:

字符串

用于在绘图上渲染字形时计算屏幕位置的特定（命名）x 轴范围。如果未设置，则使用默认 x 轴范围。

y_range_name = 'default'#

类型:

字符串

用于在绘图上渲染字形时计算屏幕位置的特定（命名）y 轴范围。如果未设置，则使用默认 y 轴范围。

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

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

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

参数:

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

返回:

None

classmethod clear_extensions() → None#

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

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

clone(**overrides: Any) → Self#

复制 HasProps 对象。

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

construct_color_bar(**kwargs) → ContourColorBar[source]#

构造并返回此 ContourRenderer 的新 ContourColorBar。

颜色栏将使用与 ContourRenderer 相同的填充、阴影线和线条视觉属性。可以传入额外的关键字参数来控制 BaseColorBar 属性，例如 title。

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

当此 Model 上发生指定的事件时，运行回调函数。

并非所有 Model 都支持所有 Event。有关哪些 Model 能够触发哪些 Event 的更多信息，请参阅 bokeh.events 中的特定 Event。

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）

返回:

从属性名称到其值的映射

返回类型:

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_data(data: ContourData) → None[source]#

设置要渲染的轮廓线和填充多边形数据。

接受 ContourData 对象，例如从 contour_data() 返回的对象。

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

基类： Renderer

数据渲染器类型的抽象基类（例如 GlyphRenderer、GraphRenderer）。

注意

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

JSON 原型

{
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "group": null, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p64172", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "glyph", 
  "name": null, 
  "propagate_hover": false, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}

context_menu = None#

类型:

Nullable(Instance(Menu))

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

注意

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []#

类型:

列表

要添加到底层 DOM 元素的其他 CSS 类的列表。

css_variables = {}#

类型:

Dict(String, Either(String, Instance(Node)))

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

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

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

注意

此属性是实验性的，可能会在任何时候更改。

group = None#

类型:

Nullable(Instance(RendererGroup))

注意

此属性是实验性的，可能会在任何时候更改。

html_attributes = {}#

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None#

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

level = 'glyph'#

类型:

Enum(RenderLevel)

指定绘制此渲染器的层级。

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

propagate_hover = False#

类型:

布尔值

允许将悬停事件传播到父渲染器、框架或画布。

注意

此属性是实验性的，可能会在任何时候更改。

styles = {}#

类型:

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

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []#

类型:

列表

用于底层 DOM 元素的其他样式表。

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

syncable = True#

类型:

布尔值

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

注意

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

tags = []#

类型:

列表

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

当查询文档以检索特定的 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 也不会出于任何原因直接使用这些标签。

visible = True#

类型:

布尔值

渲染器是否可见。

x_range_name = 'default'#

类型:

字符串

用于在绘图上渲染字形时计算屏幕位置的特定（命名）x 轴范围。如果未设置，则使用默认 x 轴范围。

y_range_name = 'default'#

类型:

字符串

用于在绘图上渲染字形时计算屏幕位置的特定（命名）y 轴范围。如果未设置，则使用默认 y 轴范围。

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

当此 Model 上发生指定的事件时，运行回调函数。

并非所有 Model 都支持所有 Event。有关哪些 Model 能够触发哪些 Event 的更多信息，请参阅 bokeh.events 中的特定 Event。

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）

返回:

从属性名称到其值的映射

返回类型:

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

基类： DataRenderer

JSON 原型

{
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "data_source": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "glyph": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "group": null, 
  "hover_glyph": null, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p64189", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "glyph", 
  "muted": false, 
  "muted_glyph": "auto", 
  "name": null, 
  "nonselection_glyph": "auto", 
  "propagate_hover": false, 
  "selection_glyph": "auto", 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "view": {
    "attributes": {
      "filter": {
        "id": "p64191", 
        "name": "AllIndices", 
        "type": "object"
      }
    }, 
    "id": "p64190", 
    "name": "CDSView", 
    "type": "object"
  }, 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}

context_menu = None#

类型:

Nullable(Instance(Menu))

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

注意

右键单击时使用 Shift 键显示原生上下文菜单。

css_classes = []#

类型:

列表

要添加到底层 DOM 元素的其他 CSS 类的列表。

css_variables = {}#

类型:

Dict(String, Either(String, Instance(Node)))

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

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

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

注意

此属性是实验性的，可能会在任何时候更改。

data_source = Undefined#

类型:

Required(Instance(DataSource))

用于在绘图上渲染字形的本地数据源。

glyph = Undefined#

类型:

Required(Instance(Glyph))

要渲染的字形，与提供的数据源和范围结合使用。

group = None#

类型:

Nullable(Instance(RendererGroup))

注意

此属性是实验性的，可能会在任何时候更改。

hover_glyph = None#

类型:

Nullable(Instance(Glyph))

用于检查点的可选字形，例如，那些被 HoverTool 悬停在其上的点。

html_attributes = {}#

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None#

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写形式。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

level = 'glyph'#

类型:

Enum(RenderLevel)

指定绘制此渲染器的层级。

muted = False#

类型:

布尔值

定义此字形渲染器是否静音。静音渲染器将使用静音字形而不是主字形进行渲染。通常，渲染器由用户通过 UI 操作静音，例如，如果图例配置了 click_policy = "mute"，则通过单击图例项。

muted_glyph = 'auto'#

类型:

Nullable(Either(Auto, Instance(Glyph)))

当 muted 设置时，替换主字形的可选字形。如果设置为 "auto"，它将基于具有预定义视觉属性的主字形创建一个新字形。

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

nonselection_glyph = 'auto'#

类型:

Nullable(Either(Auto, Instance(Glyph)))

用于显式未选定点的可选字形（即，当存在其他已选定点时未选定，但当根本没有选择任何点时则不未选定。）

如果设置为“auto”，则将使用具有低 alpha 值 (0.1) 的字形用于未选定点。

propagate_hover = False#

类型:

布尔值

允许将悬停事件传播到父渲染器、框架或画布。

注意

此属性是实验性的，可能会在任何时候更改。

selection_glyph = 'auto'#

类型:

Nullable(Either(Auto, Instance(Glyph)))

用于选定点的可选字形。

如果设置为“auto”，则标准字形将用于选定点。

styles = {}#

类型:

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

应用于底层 DOM 元素的内联 CSS 样式。

stylesheets = []#

类型:

列表

用于底层 DOM 元素的其他样式表。

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

syncable = True#

类型:

布尔值

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

注意

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

tags = []#

类型:

列表

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

当查询文档以检索特定的 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 也不会出于任何原因直接使用这些标签。

view = CDSView(id='p64255', ...)#

类型:

Instance(CDSView)

数据源的视图，用于在渲染字形时使用。当初始化期间未传入视图时，将创建整个数据源的默认视图。

visible = True#

类型:

布尔值

渲染器是否可见。

x_range_name = 'default'#

类型:

字符串

用于在绘图上渲染字形时计算屏幕位置的特定（命名）x 轴范围。如果未设置，则使用默认 x 轴范围。

y_range_name = 'default'#

类型:

字符串

用于在绘图上渲染字形时计算屏幕位置的特定（命名）y 轴范围。如果未设置，则使用默认 y 轴范围。

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

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

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

参数:

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

返回:

None

classmethod clear_extensions() → None#

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

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

clone(**overrides: Any) → Self#

复制 HasProps 对象。

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

construct_color_bar(**kwargs: Any) → ColorBar[source]#

为此 GlyphRenderer 构建并返回新的 ColorBar。

该函数将按以下顺序检查 GlyphRenderer 的主字形适当属性上的颜色映射器

• fill_color.transform 用于 FillGlyph

• line_color.transform 用于 LineGlyph

• text_color.transform 用于 TextGlyph

• color_mapper 用于 Image

通常，该函数将根据字形类型“做正确的事情”。如果需要不同的行为，可以手动构建 ColorBar。

可以传入额外的关键字参数来控制 ColorBar 属性，例如 title。

返回:

ColorBar

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

当此 Model 上发生指定的事件时，运行回调函数。

并非所有 Model 都支持所有 Event。有关哪些 Model 能够触发哪些 Event 的更多信息，请参阅 bokeh.events 中的特定 Event。

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）

返回:

从属性名称到其值的映射

返回类型:

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)