渲染器

各种渲染器。

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

基类: Renderer

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

注意

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

JSON 原型

{
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "elements": [], 
  "group": null, 
  "id": "p61808", 
  "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, Instance(Node))

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

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

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

注意

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

elements = []

类型:

列表

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

这可能包括工具提示等浮动元素，允许在该渲染器及其 UI 元素之间建立父子关系。

注意

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

group = None

类型:

Nullable(Instance(RendererGroup))

注意

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

level = 'image'

类型:

Enum(RenderLevel)

指定绘制该渲染器的级别。

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

propagate_hover = False

类型:

布尔值

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

注意

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

renderers = []

类型:

列表

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

注意

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

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

类型:

布尔值

渲染器是否可见。

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

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 模型属性的值更改时更新一个 Bokeh 模型属性。

参数:

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

• other (模型) – 与 self.attr 链接的 Bokeh 模型

• other_attr (字符串) – 与 other 链接的属性

• attr_selector (整数 | 字符串) – 用于链接可索引 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: 字符串, *callbacks: JSChangeCallback) → 无

将 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: 字符串, *, raises: 布尔值 = True) → PropertyDescriptor[任何] | 无

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

参数:

• name (字符串) – 要查找的属性的名称

• raises (布尔值) – 如果缺少，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: 字符串, *callbacks: PropertyCallback) → 无

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

参数:

• attr (字符串) – 此对象的属性名称

• *callbacks (可调用对象) – 要注册的回调函数

返回值:

None

示例

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

on_event(event: 字符串 | 类型[Event], *callbacks: 可调用对象[[Event], 无] | 可调用对象[[], 无]) → 无

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

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

类方法 parameters() → 列表[Parameter]

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

返回值:

list(Parameter)

类方法 properties(*, _with_props: 布尔值 = False) → 集合[字符串] | 字典[字符串, Property[任何]]

收集此类的属性名称。

警告

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

返回值:

属性名称

类方法 properties_with_refs() → 字典[字符串, Property[任何]]

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

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

返回值:

具有引用的属性的名称

返回类型:

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) : 要设置的属性的名称

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

• models (dict or None, optional) –

  模型 ID 到模型的映射（默认值：None）

  这是在要更新的属性也具有具有引用的值的情况下所需的。

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

Bases: DataRenderer

用于等高线图的渲染器，由填充的多边形和/或线组成。

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

JSON 原型

{
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "fill_renderer": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "group": null, 
  "id": "p61825", 
  "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, Instance(Node))

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

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

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

注意

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

fill_renderer = Undefined

类型:

Instance(GlyphRenderer)

用于填充等高线多边形的 Glyph 渲染器。

group = None

类型:

Nullable(Instance(RendererGroup))

注意

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

level = 'glyph'

类型:

Enum(RenderLevel)

指定绘制该渲染器的级别。

levels = []

类型:

Seq(Float)

计算等高线的级别。

line_renderer = Undefined

类型:

Instance(GlyphRenderer)

用于等高线的 Glyph 渲染器。

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

propagate_hover = False

类型:

布尔值

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

注意

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

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

类型:

布尔值

渲染器是否可见。

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

construct_color_bar(**kwargs) → ContourColorBar

构建并返回一个新的 ContourColorBar 用于此 ContourRenderer.

颜色条将使用与 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 模型属性的值更改时更新一个 Bokeh 模型属性。

参数:

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

• other (模型) – 与 self.attr 链接的 Bokeh 模型

• other_attr (字符串) – 与 other 链接的属性

• attr_selector (整数 | 字符串) – 用于链接可索引 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 (字符串) – 要查找的属性的名称

• raises (布尔值) – 如果缺少，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

• attr (字符串) – 此对象的属性名称

• *callbacks (可调用对象) – 要注册的回调函数

返回值:

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

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

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

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

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

参数:

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

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

• models (dict or None, optional) –

  模型 ID 到模型的映射（默认值：None）

  这是在要更新的属性也具有具有引用的值的情况下所需的。

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

基类: Renderer

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

注意

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

JSON 原型

{
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "group": null, 
  "id": "p61843", 
  "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, Instance(Node))

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

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

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

注意

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

group = None

类型:

Nullable(Instance(RendererGroup))

注意

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

level = 'glyph'

类型:

Enum(RenderLevel)

指定绘制该渲染器的级别。

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

propagate_hover = False

类型:

布尔值

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

注意

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

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

类型:

布尔值

渲染器是否可见。

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

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 模型属性的值更改时更新一个 Bokeh 模型属性。

参数:

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

• other (模型) – 与 self.attr 链接的 Bokeh 模型

• other_attr (字符串) – 与 other 链接的属性

• attr_selector (整数 | 字符串) – 用于链接可索引 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

将 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 (字符串) – 要查找的属性的名称

• raises (布尔值) – 如果缺少，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

• attr (字符串) – 此对象的属性名称

• *callbacks (可调用对象) – 要注册的回调函数

返回值:

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) : 要设置的属性的名称

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

• models (dict or None, optional) –

  模型 ID 到模型的映射（默认值：None）

  这是在要更新的属性也具有具有引用的值的情况下所需的。

• 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

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

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

取消应用主题() → None

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

返回值:

None

更新(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

属性 文档: 文档 | None

此模型所附加的 Document（可以是 None）

类 GlyphRenderer(*args: Any, id: ID | None = None, **kwargs: Any)

Bases: 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, 
  "id": "p61858", 
  "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": "p61860", 
        "name": "AllIndices", 
        "type": "object"
      }
    }, 
    "id": "p61859", 
    "name": "CDSView", 
    "type": "object"
  }, 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}

上下文菜单 = None

类型:

Nullable(Instance(Menu))

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

注意

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

css_classes = []

类型:

列表

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

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

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

数据源 = Undefined

类型:

Required(Instance(DataSource))

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

字形 = Undefined

类型:

Required(Instance(Glyph))

与提供的數據源和範圍一起渲染的字形。

组 = None

类型:

Nullable(Instance(RendererGroup))

注意

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

悬停字形 = None

类型:

Nullable(Instance(Glyph))

用于检查点的可选字形，例如，由 HoverTool 悬停的点。

级别 = '字形'

类型:

Enum(RenderLevel)

指定绘制该渲染器的级别。

静音 = False

类型:

布尔值

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

静音字形 = 'auto'

类型:

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

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

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

非选中字形 = 'auto'

类型:

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

用于显式非选中点的可选字形（即，当存在其他选中的点时未选中，但在没有点被选中时未选中。）

如果设置为“auto”，则将使用具有低 alpha 值（0.1）的字形来表示非选中点。

传播悬停 = False

类型:

布尔值

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

注意

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

选中字形 = 'auto'

类型:

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

用于选中点的可选字形。

如果设置为“auto”，则将使用标准字形来表示选中点。

样式 = {}

类型:

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

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

样式表 = []

类型:

列表

用于基础 DOM 元素的额外样式表。

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

可同步 = True

类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 侧回调仍然会起作用。

标签 = []

类型:

列表

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

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

视图 = CDSView(id='p61918', ...)

类型:

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

construct_color_bar(**kwargs: Any) → ColorBar

为该 GlyphRenderer 构建并返回一个新的 ColorBar。

该函数将按照以下顺序检查 GlyphRenderer 主图形相应属性上的颜色映射器

• fill_color.transform 对于 FillGlyph

• line_color.transform 对于 LineGlyph

• text_color.transform 对于 TextGlyph

• color_mapper 对于 Image

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

可以传入额外的关键字参数来控制 ColorBar 属性，例如 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 模型属性的值更改时更新一个 Bokeh 模型属性。

参数:

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

• other (模型) – 与 self.attr 链接的 Bokeh 模型

• other_attr (字符串) – 与 other 链接的属性

• attr_selector (整数 | 字符串) – 用于链接可索引 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 (字符串) – 要查找的属性的名称

• raises (布尔值) – 如果缺少，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

• attr (字符串) – 此对象的属性名称

• *callbacks (可调用对象) – 要注册的回调函数

返回值:

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:

参数:

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) : 要设置的属性的名称

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

• models (dict or None, optional) –

  模型 ID 到模型的映射（默认值：None）

  这是在要更新的属性也具有具有引用的值的情况下所需的。

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

Bases: DataRenderer

JSON 原型

{
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "edge_renderer": {
    "attributes": {
      "data_source": {
        "attributes": {
          "data": {
            "entries": [
              [
                "start", 
                []
              ], 
              [
                "end", 
                []
              ]
            ], 
            "type": "map"
          }, 
          "selected": {
            "attributes": {
              "indices": [], 
              "line_indices": []
            }, 
            "id": "p61939", 
            "name": "Selection", 
            "type": "object"
          }, 
          "selection_policy": {
            "id": "p61940", 
            "name": "UnionRenderers", 
            "type": "object"
          }
        }, 
        "id": "p61938", 
        "name": "ColumnDataSource", 
        "type": "object"
      }, 
      "glyph": {
        "id": "p61937", 
        "name": "MultiLine", 
        "type": "object"
      }, 
      "view": {
        "attributes": {
          "filter": {
            "id": "p61943", 
            "name": "AllIndices", 
            "type": "object"
          }
        }, 
        "id": "p61942", 
        "name": "CDSView", 
        "type": "object"
      }
    }, 
    "id": "p61941", 
    "name": "GlyphRenderer", 
    "type": "object"
  }, 
  "group": null, 
  "id": "p61929", 
  "inspection_policy": {
    "id": "p61945", 
    "name": "NodesOnly", 
    "type": "object"
  }, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "layout_provider": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "level": "glyph", 
  "name": null, 
  "node_renderer": {
    "attributes": {
      "data_source": {
        "attributes": {
          "data": {
            "entries": [
              [
                "index", 
                []
              ]
            ], 
            "type": "map"
          }, 
          "selected": {
            "attributes": {
              "indices": [], 
              "line_indices": []
            }, 
            "id": "p61932", 
            "name": "Selection", 
            "type": "object"
          }, 
          "selection_policy": {
            "id": "p61933", 
            "name": "UnionRenderers", 
            "type": "object"
          }
        }, 
        "id": "p61931", 
        "name": "ColumnDataSource", 
        "type": "object"
      }, 
      "glyph": {
        "id": "p61930", 
        "name": "Scatter", 
        "type": "object"
      }, 
      "view": {
        "attributes": {
          "filter": {
            "id": "p61936", 
            "name": "AllIndices", 
            "type": "object"
          }
        }, 
        "id": "p61935", 
        "name": "CDSView", 
        "type": "object"
      }
    }, 
    "id": "p61934", 
    "name": "GlyphRenderer", 
    "type": "object"
  }, 
  "propagate_hover": false, 
  "selection_policy": {
    "id": "p61944", 
    "name": "NodesOnly", 
    "type": "object"
  }, 
  "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, Instance(Node))

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

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

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

注意

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

edge_renderer = GlyphRenderer(id='p62018', ...)

类型:

Instance(GlyphRenderer)

图的边将被渲染为 MultiLine Glyph 的 GlyphRenderer 实例。

group = None

类型:

Nullable(Instance(RendererGroup))

注意

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

inspection_policy = NodesOnly(id='p62055', ...)

类型:

Instance(GraphHitTestPolicy)

一个 GraphHitTestPolicy 实例，它为检查图组件提供逻辑。

layout_provider = Undefined

类型:

Instance(LayoutProvider)

一个 LayoutProvider 实例，它提供网络图在笛卡尔空间中的布局。

level = 'glyph'

类型:

Enum(RenderLevel)

指定绘制该渲染器的级别。

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

node_renderer = GlyphRenderer(id='p62128', ...)

类型:

Instance(GlyphRenderer)

图的节点将被渲染为 XYGlyph Glyph 的 GlyphRenderer 实例。

propagate_hover = False

类型:

布尔值

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

注意

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

selection_policy = NodesOnly(id='p62165', ...)

类型:

Instance(GraphHitTestPolicy)

一个 GraphHitTestPolicy 实例，它提供用于选择图形组件的逻辑。

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

类型:

布尔值

渲染器是否可见。

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

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 模型属性的值更改时更新一个 Bokeh 模型属性。

参数:

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

• other (模型) – 与 self.attr 链接的 Bokeh 模型

• other_attr (字符串) – 与 other 链接的属性

• attr_selector (整数 | 字符串) – 用于链接可索引 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 (字符串) – 要查找的属性的名称

• raises (布尔值) – 如果缺少，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

• attr (字符串) – 此对象的属性名称

• *callbacks (可调用对象) – 要注册的回调函数

返回值:

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[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) : 要设置的属性的名称

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

• models (dict or None, optional) –

  模型 ID 到模型的映射（默认值：None）

  这是在要更新的属性也具有具有引用的值的情况下所需的。

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

基类: Renderer

所有向导渲染器类型的基类。 GuideRenderer 通常不建议单独实例化。

注意

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

JSON 原型

{
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "group": null, 
  "id": "p62285", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "guide", 
  "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, Instance(Node))

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

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

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

注意

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

group = None

类型:

Nullable(Instance(RendererGroup))

注意

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

level = 'guide'

类型:

Enum(RenderLevel)

指定绘制该渲染器的级别。

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

propagate_hover = False

类型:

布尔值

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

注意

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

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

类型:

布尔值

渲染器是否可见。

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

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 模型属性的值更改时更新一个 Bokeh 模型属性。

参数:

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

• other (模型) – 与 self.attr 链接的 Bokeh 模型

• other_attr (字符串) – 与 other 链接的属性

• attr_selector (整数 | 字符串) – 用于链接可索引 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，给出属性名称。

参数:

• name (字符串) – 要查找的属性的名称

• raises (布尔值) – 如果缺少，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

• attr (字符串) – 此对象的属性名称

• *callbacks (可调用对象) – 要注册的回调函数

返回值:

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) : 要设置的属性的名称

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

• models (dict or None, optional) –

  模型 ID 到模型的映射（默认值：None）

  这是在要更新的属性也具有具有引用的值的情况下所需的。

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

Bases: StyledElement

渲染器类型的抽象基类。

注意

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

JSON 原型

{
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "group": null, 
  "id": "p62300", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "image", 
  "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, Instance(Node))

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

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

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

注意

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

group = None

类型:

Nullable(Instance(RendererGroup))

注意

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

level = 'image'

类型:

Enum(RenderLevel)

指定绘制该渲染器的级别。

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

propagate_hover = False

类型:

布尔值

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

注意

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

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

类型:

布尔值

渲染器是否可见。

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

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 模型属性的值更改时更新一个 Bokeh 模型属性。

参数:

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

• other (模型) – 与 self.attr 链接的 Bokeh 模型

• other_attr (字符串) – 与 other 链接的属性

• attr_selector (整数 | 字符串) – 用于链接可索引 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 (字符串) – 要查找的属性的名称

• raises (布尔值) – 如果缺少，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

• attr (字符串) – 此对象的属性名称

• *callbacks (可调用对象) – 要注册的回调函数

返回值:

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(

警告

在 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) : 要设置的属性的名称

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

• models (dict or None, optional) –

  模型 ID 到模型的映射（默认值：None）

  这是在要更新的属性也具有具有引用的值的情况下所需的。

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

Bases: Model

渲染器集合。

JSON 原型

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

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

visible = True

类型:

布尔值

使所有分组的渲染器可见或不可见。

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

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

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

参数:

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

返回值:

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 模型属性的值更改时更新一个 Bokeh 模型属性。

参数:

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

• other (模型) – 与 self.attr 链接的 Bokeh 模型

• other_attr (字符串) – 与 other 链接的属性

• attr_selector (整数 | 字符串) – 用于链接可索引 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) <

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

参数:

• name (字符串) – 要查找的属性的名称

• raises (布尔值) – 如果缺少，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

• attr (字符串) – 此对象的属性名称

• *callbacks (可调用对象) – 要注册的回调函数

返回值:

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 |

返回值:

Model

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

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

参数:

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

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

• models (dict or None, optional) –

  模型 ID 到模型的映射（默认值：None）

  这是在要更新的属性也具有具有引用的值的情况下所需的。

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

基类: Renderer

JSON 原型

{
  "alpha": 1.0, 
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "group": null, 
  "id": "p62320", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "image", 
  "name": null, 
  "propagate_hover": false, 
  "render_parents": true, 
  "smoothing": true, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "tile_source": {
    "id": "p62321", 
    "name": "WMTSTileSource", 
    "type": "object"
  }, 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}

alpha = 1.0

类型:

浮点数

瓦片不透明度 0.0 - 1.0

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

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

css_classes = []

类型:

列表

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

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

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

group = None

类型:

Nullable(Instance(RendererGroup))

注意

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

level = 'image'

类型:

Enum(RenderLevel)

指定绘制该渲染器的级别。

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

propagate_hover = False

类型:

布尔值

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

注意

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

render_parents = True

类型:

布尔值

标志启用/禁用在等待新瓦片到达时绘制父瓦片。默认值为 True。

smoothing = True

类型:

布尔值

为渲染的瓦片启用图像平滑。

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

tile_source = WMTSTileSource(id='p62352', ...)

类型:

Instance(TileSource)

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

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

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 模型属性的值更改时更新一个 Bokeh 模型属性。

参数:

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

• other (模型) – 与 self.attr 链接的 Bokeh 模型

• other_attr (字符串) – 与 other 链接的属性

• attr_selector (整数 | 字符串) – 用于链接可索引 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 (字符串) – 要查找的属性的名称

• raises (布尔值) – 如果缺少，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

• attr (字符串) – 此对象的属性名称

• *callbacks (可调用对象) – 要注册的回调函数

返回值:

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

收集此类的属性名称。

警告

在 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) : 要设置的属性的名称

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

• models (dict or None, optional) –

  模型 ID 到模型的映射（默认值：None）

  这是在要更新的属性也具有具有引用的值的情况下所需的。

• 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）