注释#

用于可以添加到图表中的各种注释的渲染器。

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

基础类:CustomDimensional

角度测量单位。

JSON Prototype
{
  "basis": {
    "entries": [
      [
        "\u00b0", 
        [
          1, 
          "^\\circ", 
          "degree"
        ]
      ], 
      [
        "'", 
        [
          0.016666666666666666, 
          "^\\prime", 
          "minute"
        ]
      ], 
      [
        "''", 
        [
          0.0002777777777777778, 
          "^{\\prime\\prime}", 
          "second"
        ]
      ]
    ], 
    "type": "map"
  }, 
  "exclude": [], 
  "id": "p51909", 
  "include": null, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "ticks": [
    1, 
    3, 
    6, 
    12, 
    60, 
    120, 
    240, 
    360
  ]
}
basis = {'°': (1, '^\\circ', 'degree'), "'": (0.016666666666666666, '^\\prime', 'minute'), "''": (0.0002777777777777778, '^{\\prime\\prime}', 'second')}#
Type:

Required(Dict(String, Either(Tuple(Float, String), Tuple(Float, String, String))))

定义测量单位的基础。

这包括短单位名称与其对应的缩放因子、TeX名称和可选的完整名称之间的映射。例如,定义角度测量单位的基础是:

basis = {
    "°":  (1,      "^\circ",           "degree"),
    "'":  (1/60,   "^\prime",          "minute"),
    "''": (1/3600, "^{\prime\prime}", "second"),
}
exclude = []#
Type:

List

从基础中要避免的单位子集。

include = None#
Type:

Nullable(List)

从基础中选择的首选单位的可选子集。

name = None#
Type:

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#
Type:

Bool

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

注意

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

tags = []#
Type:

List

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

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

ticks = [1, 3, 6, 12, 60, 120, 240, 360]#
Type:

Required(List)

在非精确模式下选择的首选值。

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

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

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

Parameters:

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

Returns:

无

classmethod clear_extensions() → None#

清除当前定义的所有自定义扩展。

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

clone(**overrides: Any) → Self#

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]#

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

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

Returns:

DataSpec 属性的名称

Return type:

set[str]

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

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

destroy() → None#

清理对文档和属性的引用

equals(other: HasProps) → bool#

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

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

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

这是一个便捷的方法,简化了添加一个 CustomJS 回调的过程,以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

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

  • 其他 (Model) – 一个要链接到 self.attr 的 Bokeh 模型

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

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

在版本1.1中添加

Raises:

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,给定属性名称。

Parameters:
  • name (str) – 要搜索的属性的名称

  • raises (bool) – 如果缺失,是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

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

在此对象上添加一个回调,当attr发生变化时触发。

Parameters:
  • attr (str) – 此对象上的一个属性名称

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

Returns:

无

示例

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值。

Returns:

列表(参数)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

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

Returns:

具有引用的属性名称

Return type:

set[str]

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

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

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

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

Parameters:

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

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

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

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

Returns:

属性名称和值的映射,用于匹配属性

Return type:

dict

references() → set[Model]#

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]#

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

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None#

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

Returns:

模型

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

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

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

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

  • setter (ClientSession 或 ServerSession 或 None, 可选) –

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

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

Returns:

无

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

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

Parameters:
  • selector (类似JSON的)

  • 更新 (dict)

Returns:

无

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

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

结果以属性名称到值的字典形式返回,如果此实例没有主题覆盖任何值,则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep#

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

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None#
unapply_theme() → None#

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

Returns:

无

update(**kwargs: Any) → None#

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

Returns:

无

示例

以下是等价的:

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

基础类: CompositeRenderer

所有注释模型的基类。

注意

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

JSON Prototype
{
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "elements": [], 
  "group": null, 
  "id": "p51917", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "annotation", 
  "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#
Type:

Nullable(Instance(‘.models.ui.Menu’))

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

注意

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

css_classes = []#
Type:

List

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

css_variables = {}#
Type:

Dict(String, Instance(Node))

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

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

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

注意

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

elements = []#
Type:

List

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

这可以包括像工具提示这样的浮动元素,允许在此渲染器与其UI元素之间建立父子关系。

注意

此属性相当于基于DOM的用户界面中的Pane.elements。

group = None#
Type:

Nullable(Instance(RendererGroup))

注意

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

level = 'annotation'#
Type:

Enum(RenderLevel)

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

name = None#
Type:

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#
Type:

Bool

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

注意

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

renderers = []#
Type:

List

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

注意

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

styles = {}#
Type:

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

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

stylesheets = []#
Type:

List

用于底层DOM元素的附加样式表。

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

syncable = True#
Type:

Bool

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

注意

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

tags = []#
Type:

List

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

在查询文档以检索特定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#
Type:

Bool

渲染器是否可见。

x_range_name = 'default'#
Type:

String

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

y_range_name = 'default'#
Type:

String

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

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

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

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

Parameters:

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

Returns:

无

classmethod clear_extensions() → None#

清除当前定义的所有自定义扩展。

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

clone(**overrides: Any) → Self#

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]#

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

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

Returns:

DataSpec 属性的名称

Return type:

set[str]

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

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

destroy() → None#

清理对文档和属性的引用

equals(other: HasProps) → bool#

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

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

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

这是一个便捷的方法,简化了添加一个 CustomJS 回调的过程,以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

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

  • 其他 (Model) – 一个要链接到 self.attr 的 Bokeh 模型

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

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

在版本1.1中添加

Raises:

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,给定属性名称。

Parameters:
  • name (str) – 要搜索的属性的名称

  • raises (bool) – 如果缺失,是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

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

在此对象上添加一个回调,当attr发生变化时触发。

Parameters:
  • attr (str) – 此对象上的一个属性名称

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

Returns:

无

示例

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值。

Returns:

列表(参数)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

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

Returns:

具有引用的属性名称

Return type:

set[str]

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

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

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

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

Parameters:

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

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

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

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

Returns:

属性名称和值的映射,用于匹配属性

Return type:

dict

references() → set[Model]#

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]#

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

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None#

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

Returns:

模型

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

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

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

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

  • setter (ClientSession 或 ServerSession 或 None, 可选) –

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

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

Returns:

无

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

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

Parameters:
  • selector (类似JSON的)

  • 更新 (dict)

Returns:

无

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

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

结果以属性名称到值的字典形式返回,如果此实例没有主题覆盖任何值,则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep#

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

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None#
unapply_theme() → None#

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

Returns:

无

update(**kwargs: Any) → None#

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

Returns:

无

示例

以下是等价的:

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

基础类:DataAnnotation

将箭头渲染为注释。

请参阅Arrows以获取关于绘制箭头的信息。

JSON Prototype
{
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "elements": [], 
  "end": {
    "id": "p51938", 
    "name": "OpenHead", 
    "type": "object"
  }, 
  "end_units": "data", 
  "group": null, 
  "id": "p51934", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "annotation", 
  "line_alpha": {
    "type": "value", 
    "value": 1.0
  }, 
  "line_cap": {
    "type": "value", 
    "value": "butt"
  }, 
  "line_color": {
    "type": "value", 
    "value": "black"
  }, 
  "line_dash": {
    "type": "value", 
    "value": []
  }, 
  "line_dash_offset": {
    "type": "value", 
    "value": 0
  }, 
  "line_join": {
    "type": "value", 
    "value": "bevel"
  }, 
  "line_width": {
    "type": "value", 
    "value": 1
  }, 
  "name": null, 
  "propagate_hover": false, 
  "renderers": [], 
  "source": {
    "attributes": {
      "data": {
        "type": "map"
      }, 
      "selected": {
        "attributes": {
          "indices": [], 
          "line_indices": []
        }, 
        "id": "p51936", 
        "name": "Selection", 
        "type": "object"
      }, 
      "selection_policy": {
        "id": "p51937", 
        "name": "UnionRenderers", 
        "type": "object"
      }
    }, 
    "id": "p51935", 
    "name": "ColumnDataSource", 
    "type": "object"
  }, 
  "start": null, 
  "start_units": "data", 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "x_end": {
    "field": "x_end", 
    "type": "field"
  }, 
  "x_range_name": "default", 
  "x_start": {
    "field": "x_start", 
    "type": "field"
  }, 
  "y_end": {
    "field": "y_end", 
    "type": "field"
  }, 
  "y_range_name": "default", 
  "y_start": {
    "field": "y_start", 
    "type": "field"
  }
}
context_menu = None#
Type:

Nullable(Instance(‘.models.ui.Menu’))

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

注意

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

css_classes = []#
Type:

List

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

css_variables = {}#
Type:

Dict(String, Instance(Node))

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

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

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

注意

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

elements = []#
Type:

List

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

这可以包括像工具提示这样的浮动元素,允许在此渲染器与其UI元素之间建立父子关系。

注意

此属性相当于基于DOM的用户界面中的Pane.elements。

end = OpenHead(id='p51964', ...)#
Type:

Nullable(Instance(ArrowHead))

ArrowHead 的实例。

end_units = 'data'#
Type:

Enum(CoordinateUnits)

end_x 和 end_y 属性的单位类型。默认情况下解释为“数据空间”单位。

group = None#
Type:

Nullable(Instance(RendererGroup))

注意

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

level = 'annotation'#
Type:

Enum(RenderLevel)

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

line_alpha = 1.0#
Type:

AlphaSpec

箭头主体的线条透明度值。

line_cap = 'butt'#
Type:

LineCapSpec

箭头主体的线帽值。

line_color = 'black'#
Type:

ColorSpec

箭头主体的线条颜色值。

line_dash = []#
Type:

DashPatternSpec

箭头主体的虚线值。

line_dash_offset = 0#
Type:

IntSpec

箭头主体的虚线偏移值。

line_join = 'bevel'#
Type:

LineJoinSpec

箭头主体的线条连接值。

line_width = 1#
Type:

NumberSpec

箭头主体的线宽值。

name = None#
Type:

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#
Type:

Bool

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

注意

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

renderers = []#
Type:

List

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

注意

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

source = ColumnDataSource(id='p52035', ...)#
Type:

Instance(DataSource)

在图表上渲染注释时使用的本地数据源。

start = None#
Type:

Nullable(Instance(ArrowHead))

ArrowHead 的实例。

start_units = 'data'#
Type:

Enum(CoordinateUnits)

start_x 和 start_y 属性的单位类型。默认情况下解释为“数据空间”单位。

styles = {}#
Type:

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

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

stylesheets = []#
Type:

List

用于底层DOM元素的附加样式表。

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

syncable = True#
Type:

Bool

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

注意

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

tags = []#
Type:

List

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

在查询文档以检索特定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#
Type:

Bool

渲染器是否可见。

x_end = Field(field='x_end', transform=Unspecified, units=Unspecified)#
Type:

NumberSpec

用于定位箭头终点的x坐标。

x_range_name = 'default'#
Type:

String

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

x_start = Field(field='x_start', transform=Unspecified, units=Unspecified)#
Type:

NumberSpec

箭头起始位置的x坐标。

y_end = Field(field='y_end', transform=Unspecified, units=Unspecified)#
Type:

NumberSpec

用于定位箭头终点的y坐标。

y_range_name = 'default'#
Type:

String

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

y_start = Field(field='y_start', transform=Unspecified, units=Unspecified)#
Type:

NumberSpec

用于定位箭头起点的y坐标。

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

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

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

Parameters:

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

Returns:

无

classmethod clear_extensions() → None#

清除当前定义的所有自定义扩展。

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

clone(**overrides: Any) → Self#

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]#

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

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

Returns:

DataSpec 属性的名称

Return type:

set[str]

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

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

destroy() → None#

清理对文档和属性的引用

equals(other: HasProps) → bool#

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

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

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

这是一个便捷的方法,简化了添加一个 CustomJS 回调的过程,以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

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

  • 其他 (Model) – 一个要链接到 self.attr 的 Bokeh 模型

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

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

在版本1.1中添加

Raises:

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,给定属性名称。

Parameters:
  • name (str) – 要搜索的属性的名称

  • raises (bool) – 如果缺失,是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

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

在此对象上添加一个回调,当attr发生变化时触发。

Parameters:
  • attr (str) – 此对象上的一个属性名称

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

Returns:

无

示例

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值。

Returns:

列表(参数)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

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

Returns:

具有引用的属性名称

Return type:

set[str]

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

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

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

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

Parameters:

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

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

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

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

Returns:

属性名称和值的映射,用于匹配属性

Return type:

dict

references() → set[Model]#

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]#

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

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None#

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

Returns:

模型

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

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

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

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

  • setter (ClientSession 或 ServerSession 或 None, 可选) –

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

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

Returns:

无

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

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

Parameters:
  • selector (类似JSON的)

  • 更新 (dict)

Returns:

无

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

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

结果以属性名称到值的字典形式返回,如果此实例没有主题覆盖任何值,则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep#

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

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None#
unapply_theme() → None#

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

Returns:

无

update(**kwargs: Any) → None#

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

Returns:

无

示例

以下是等价的:

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

基础类:Marking

箭头基类。

注意

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

JSON Prototype
{
  "id": "p52103", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "size": {
    "type": "value", 
    "value": 25
  }, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}
name = None#
Type:

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也不会直接使用这些名称。

size = 25#
Type:

NumberSpec

箭头的大小,以像素为单位。

syncable = True#
Type:

Bool

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

注意

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

tags = []#
Type:

List

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

在查询文档以检索特定Bokeh模型时,这些数据可能很有用:

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

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

注意

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

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

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

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

Parameters:

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

Returns:

无

classmethod clear_extensions() → None#

清除当前定义的所有自定义扩展。

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

clone(**overrides: Any) → Self#

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]#

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

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

Returns:

DataSpec 属性的名称

Return type:

set[str]

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

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

destroy() → None#

清理对文档和属性的引用

equals(other: HasProps) → bool#

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

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

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

这是一个便捷的方法,简化了添加一个 CustomJS 回调的过程,以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

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

  • 其他 (Model) – 一个要链接到 self.attr 的 Bokeh 模型

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

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

在版本1.1中添加

Raises:

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,给定属性名称。

Parameters:
  • name (str) – 要搜索的属性的名称

  • raises (bool) – 如果缺失,是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

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

在此对象上添加一个回调,当attr发生变化时触发。

Parameters:
  • attr (str) – 此对象上的一个属性名称

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

Returns:

无

示例

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值。

Returns:

列表(参数)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

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

Returns:

具有引用的属性名称

Return type:

set[str]

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

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

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

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

Parameters:

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

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

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

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

Returns:

属性名称和值的映射,用于匹配属性

Return type:

dict

references() → set[Model]#

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]#

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

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None#

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

Returns:

模型

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

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

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

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

  • setter (ClientSession 或 ServerSession 或 None, 可选) –

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

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

Returns:

无

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

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

Parameters:
  • selector (类似JSON的)

  • 更新 (dict)

Returns:

无

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

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

结果以属性名称到值的字典形式返回,如果此实例没有主题覆盖任何值,则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep#

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

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None#
unapply_theme() → None#

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

Returns:

无

update(**kwargs: Any) → None#

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

Returns:

无

示例

以下是等价的:

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

基础类:DataAnnotation

沿着一个维度渲染一个填充区域带。

请参阅Bands以获取关于绘制波段的信息。

JSON Prototype
{
  "base": {
    "field": "base", 
    "type": "field"
  }, 
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "dimension": "height", 
  "elements": [], 
  "fill_alpha": 0.4, 
  "fill_color": "#fff9ba", 
  "group": null, 
  "id": "p52108", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "level": "annotation", 
  "line_alpha": 0.3, 
  "line_cap": "butt", 
  "line_color": "#cccccc", 
  "line_dash": [], 
  "line_dash_offset": 0, 
  "line_join": "bevel", 
  "line_width": 1, 
  "lower": {
    "field": "lower", 
    "type": "field"
  }, 
  "name": null, 
  "propagate_hover": false, 
  "renderers": [], 
  "source": {
    "attributes": {
      "data": {
        "type": "map"
      }, 
      "selected": {
        "attributes": {
          "indices": [], 
          "line_indices": []
        }, 
        "id": "p52110", 
        "name": "Selection", 
        "type": "object"
      }, 
      "selection_policy": {
        "id": "p52111", 
        "name": "UnionRenderers", 
        "type": "object"
      }
    }, 
    "id": "p52109", 
    "name": "ColumnDataSource", 
    "type": "object"
  }, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "upper": {
    "field": "upper", 
    "type": "field"
  }, 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}
base = Field(field='base', transform=Unspecified, units=Unspecified)#
Type:

UnitsSpec

上下值的正交坐标。

base_units = 'data'#
Type:

NotSerialized(Enum(CoordinateUnits))

用于关联属性的单位:canvas、screen 或 data

context_menu = None#
Type:

Nullable(Instance(‘.models.ui.Menu’))

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

注意

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

css_classes = []#
Type:

List

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

css_variables = {}#
Type:

Dict(String, Instance(Node))

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

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

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

注意

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

dimension = 'height'#
Type:

Enum(Dimension)

可以通过将此属性设置为“height”(y方向)或“width”(x方向)来指定带的方向。

elements = []#
Type:

List

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

这可以包括像工具提示这样的浮动元素,允许在此渲染器与其UI元素之间建立父子关系。

注意

此属性相当于基于DOM的用户界面中的Pane.elements。

fill_alpha = 0.4#
Type:

Alpha

带的填充透明度值。

fill_color = '#fff9ba'#
Type:

Nullable(Color)

波段的填充颜色值。

group = None#
Type:

Nullable(Instance(RendererGroup))

注意

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

level = 'annotation'#
Type:

Enum(RenderLevel)

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

line_alpha = 0.3#
Type:

Alpha

波段的线条透明度值。

line_cap = 'butt'#
Type:

Enum(LineCap)

线条的端帽值用于带。

line_color = '#cccccc'#
Type:

Nullable(Color)

波段的线条颜色值。

line_dash = []#
Type:

DashPattern

波段的虚线值。

line_dash_offset = 0#
Type:

Int

线条虚线偏移量的值用于波段。

line_join = 'bevel'#
Type:

Enum(LineJoin)

波段的线条连接值。

line_width = 1#
Type:

Float

带的线宽值。

lower = Field(field='lower', transform=Unspecified, units=Unspecified)#
Type:

UnitsSpec

填充区域带的下部坐标。

lower_units = 'data'#
Type:

NotSerialized(Enum(CoordinateUnits))

用于关联属性的单位:canvas、screen 或 data

name = None#
Type:

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#
Type:

Bool

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

注意

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

renderers = []#
Type:

List

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

注意

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

source = ColumnDataSource(id='p52208', ...)#
Type:

Instance(DataSource)

在图表上渲染注释时使用的本地数据源。

styles = {}#
Type:

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

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

stylesheets = []#
Type:

List

用于底层DOM元素的附加样式表。

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

syncable = True#
Type:

Bool

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

注意

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

tags = []#
Type:

List

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

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

upper = Field(field='upper', transform=Unspecified, units=Unspecified)#
Type:

UnitsSpec

填充区域带的上部坐标。

upper_units = 'data'#
Type:

NotSerialized(Enum(CoordinateUnits))

用于关联属性的单位:canvas、screen 或 data

visible = True#
Type:

Bool

渲染器是否可见。

x_range_name = 'default'#
Type:

String

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

y_range_name = 'default'#
Type:

String

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

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

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

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

Parameters:

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

Returns:

无

classmethod clear_extensions() → None#

清除当前定义的所有自定义扩展。

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

clone(**overrides: Any) → Self#

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]#

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

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

Returns:

DataSpec 属性的名称

Return type:

set[str]

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

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

destroy() → None#

清理对文档和属性的引用

equals(other: HasProps) → bool#

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

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

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

这是一个便捷的方法,简化了添加一个 CustomJS 回调的过程,以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

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

  • 其他 (Model) – 一个要链接到 self.attr 的 Bokeh 模型

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

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

在版本1.1中添加

Raises:

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,给定属性名称。

Parameters:
  • name (str) – 要搜索的属性的名称

  • raises (bool) – 如果缺失,是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

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

在此对象上添加一个回调,当attr发生变化时触发。

Parameters:
  • attr (str) – 此对象上的一个属性名称

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

Returns:

无

示例

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值。

Returns:

列表(参数)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

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

Returns:

具有引用的属性名称

Return type:

set[str]

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

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

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

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

Parameters:

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

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

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

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

Returns:

属性名称和值的映射,用于匹配属性

Return type:

dict

references() → set[Model]#

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]#

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

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None#

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

Returns:

模型

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

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

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

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

  • setter (ClientSession 或 ServerSession 或 None, 可选) –

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

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

Returns:

无

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

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

Parameters:
  • selector (类似JSON的)

  • 更新 (dict)

Returns:

无

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

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

结果以属性名称到值的字典形式返回,如果此实例没有主题覆盖任何值,则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep#

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

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None#
unapply_theme() → None#

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

Returns:

无

update(**kwargs: Any) → None#

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

Returns:

无

示例

以下是等价的:

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

基础类:Annotation, AreaVisuals

渲染一个带阴影的矩形区域作为注释。

请参阅Box annotations以获取有关绘制箱形注释的信息。

JSON Prototype
{
  "border_radius": 0, 
  "bottom": {
    "attributes": {
      "symbol": "bottom", 
      "target": "frame"
    }, 
    "id": "p52251", 
    "name": "Node", 
    "type": "object"
  }, 
  "bottom_limit": null, 
  "bottom_units": "data", 
  "context_menu": null, 
  "coordinates": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "editable": false, 
  "elements": [], 
  "fill_alpha": 0.4, 
  "fill_color": "#fff9ba", 
  "group": null, 
  "handles": {
    "attributes": {
      "all": {
        "attributes": {
          "fill_color": "white", 
          "hover_fill_color": "lightgray"
        }, 
        "id": "p52252", 
        "name": "AreaVisuals", 
        "type": "object"
      }
    }, 
    "id": "p52253", 
    "name": "BoxInteractionHandles", 
    "type": "object"
  }, 
  "hatch_alpha": 1.0, 
  "hatch_color": "black", 
  "hatch_extra": {
    "type": "map"
  }, 
  "hatch_pattern": null, 
  "hatch_scale": 12.0, 
  "hatch_weight": 1.0, 
  "hover_fill_alpha": 0.4, 
  "hover_fill_color": null, 
  "hover_hatch_alpha": 1.0, 
  "hover_hatch_color": "black", 
  "hover_hatch_extra": {
    "type": "map"
  }, 
  "hover_hatch_pattern": null, 
  "hover_hatch_scale": 12.0, 
  "hover_hatch_weight": 1.0, 
  "hover_line_alpha": 0.3, 
  "hover_line_cap": "butt", 
  "hover_line_color": null, 
  "hover_line_dash": [], 
  "hover_line_dash_offset": 0, 
  "hover_line_join": "bevel", 
  "hover_line_width": 1, 
  "id": "p52247", 
  "inverted": false, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "left": {
    "attributes": {
      "symbol": "left", 
      "target": "frame"
    }, 
    "id": "p52248", 
    "name": "Node", 
    "type": "object"
  }, 
  "left_limit": null, 
  "left_units": "data", 
  "level": "annotation", 
  "line_alpha": 0.3, 
  "line_cap": "butt", 
  "line_color": "#cccccc", 
  "line_dash": [], 
  "line_dash_offset": 0, 
  "line_join": "bevel", 
  "line_width": 1, 
  "max_height": {
    "type": "number", 
    "value": "+inf"
  }, 
  "max_width": {
    "type": "number", 
    "value": "+inf"
  }, 
  "min_height": 0, 
  "min_width": 0, 
  "movable": "both", 
  "name": null, 
  "propagate_hover": false, 
  "renderers": [], 
  "resizable": "all", 
  "right": {
    "attributes": {
      "symbol": "right", 
      "target": "frame"
    }, 
    "id": "p52249", 
    "name": "Node", 
    "type": "object"
  }, 
  "right_limit": null, 
  "right_units": "data", 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "symmetric": false, 
  "syncable": true, 
  "tags": [], 
  "top": {
    "attributes": {
      "symbol": "top", 
      "target": "frame"
    }, 
    "id": "p52250", 
    "name": "Node", 
    "type": "object"
  }, 
  "top_limit": null, 
  "top_units": "data", 
  "use_handles": false, 
  "visible": true, 
  "x_range_name": "default", 
  "y_range_name": "default"
}
border_radius = 0#
Type:

Either(NonNegative, Tuple(NonNegative, NonNegative, NonNegative, NonNegative), Struct)

允许盒子具有圆角。

注意

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

bottom = Node(id='p52268', ...)#
Type:

Either(Either(Float, Datetime, Factor), Instance(Node))

框注释底边的y坐标。

bottom_limit = None#
Type:

Nullable(Either(Either(Float, Datetime, Factor), Instance(Node)))

盒子移动的可选底部限制。

注意

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

bottom_units = 'data'#
Type:

Enum(CoordinateUnits)

底部属性的单位类型。默认情况下解释为数据单位。如果bottom是一个节点,则此属性没有任何效果。

context_menu = None#
Type:

Nullable(Instance(‘.models.ui.Menu’))

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

注意

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

css_classes = []#
Type:

List

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

css_variables = {}#
Type:

Dict(String, Instance(Node))

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

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

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

注意

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

editable = False#
Type:

Bool

允许交互式修改此盒子的几何形状。

注意

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

elements = []#
Type:

List

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

这可以包括像工具提示这样的浮动元素,允许在此渲染器与其UI元素之间建立父子关系。

注意

此属性相当于基于DOM的用户界面中的Pane.elements。

fill_alpha = 0.4#
Type:

Alpha

盒子的填充透明度值。

fill_color = '#fff9ba'#
Type:

Nullable(Color)

盒子的填充颜色值。

group = None#
Type:

Nullable(Instance(RendererGroup))

注意

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

handles = BoxInteractionHandles(id='p52347', ...)#
Type:

Instance(BoxInteractionHandles)

配置交互手柄的外观。

可以按递增的特定级别批量配置句柄,每个级别如果定义了,将覆盖更通用的设置:

  • all -> move, resize

  • resize -> sides, corners

  • sides -> left, right, top, bottom

  • corners -> top_left, top_right, bottom_left, bottom_right

注意

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

hatch_alpha = 1.0#
Type:

Alpha

箱子的阴影透明度值。

hatch_color = 'black'#
Type:

Nullable(Color)

盒子的填充颜色值。

hatch_extra = {}#
Type:

Dict(String, Instance(Texture))

盒子的额外填充值。

hatch_pattern = None#
Type:

Nullable(String)

盒子的填充图案值。

hatch_scale = 12.0#
Type:

Size

盒子的阴影比例值。

hatch_weight = 1.0#
Type:

Size

箱子的阴影权重值。

hover_fill_alpha = 0.4#
Type:

Alpha

当悬停在盒子上时的填充透明度值。

hover_fill_color = None#
Type:

Nullable(Color)

当悬停时框的填充颜色值。

hover_hatch_alpha = 1.0#
Type:

Alpha

当悬停在盒子上时的填充透明度值。

hover_hatch_color = 'black'#
Type:

Nullable(Color)

悬停时框的填充颜色值。

hover_hatch_extra = {}#
Type:

Dict(String, Instance(Texture))

悬停时盒子的额外填充值。

hover_hatch_pattern = None#
Type:

Nullable(String)

悬停时框的填充图案值。

hover_hatch_scale = 12.0#
Type:

Size

当悬停在盒子上时的阴影比例值。

hover_hatch_weight = 1.0#
Type:

Size

悬停时框的阴影权重值。

hover_line_alpha = 0.3#
Type:

Alpha

当悬停在盒子上时的线条透明度值。

hover_line_cap = 'butt'#
Type:

Enum(LineCap)

悬停时框的线帽值。

hover_line_color = None#
Type:

Nullable(Color)

悬停时框的线条颜色值。

hover_line_dash = []#
Type:

DashPattern

悬停时框的虚线值。

hover_line_dash_offset = 0#
Type:

Int

悬停时框的虚线偏移值。

hover_line_join = 'bevel'#
Type:

Enum(LineJoin)

当悬停在盒子上时的线条连接值。

hover_line_width = 1#
Type:

Float

悬停时框的线宽值。

inverted = False#
Type:

Bool

反转盒子的几何形状,即应用填充和阴影视觉效果到盒子的外部而不是内部。视觉效果应用于盒子与其父元素之间,例如框架。

left = Node(id='p52509', ...)#
Type:

Either(Either(Float, Datetime, Factor), Instance(Node))

框注释左侧边缘的x坐标。

left_limit = None#
Type:

Nullable(Either(Either(Float, Datetime, Factor), Instance(Node)))

盒子移动的可选左限。

注意

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

left_units = 'data'#
Type:

Enum(CoordinateUnits)

left属性的单位类型。默认情况下解释为数据单位。如果left是一个节点,则此属性没有任何效果。

level = 'annotation'#
Type:

Enum(RenderLevel)

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

line_alpha = 0.3#
Type:

Alpha

盒子的线条透明度值。

line_cap = 'butt'#
Type:

Enum(LineCap)

盒子的线帽值。

line_color = '#cccccc'#
Type:

Nullable(Color)

盒子的线条颜色值。

line_dash = []#
Type:

DashPattern

盒子的虚线值。

line_dash_offset = 0#
Type:

Int

盒子的虚线偏移值。

line_join = 'bevel'#
Type:

Enum(LineJoin)

盒子的线条连接值。

line_width = 1#
Type:

Float

盒子的线条宽度值。

max_height = inf#
Type:

Positive

允许设置盒子的最大高度。

注意

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

max_width = inf#
Type:

Positive

允许设置盒子的最小高度。

注意

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

min_height = 0#
Type:

NonNegative

允许设置盒子的最大宽度。

注意

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

min_width = 0#
Type:

NonNegative

允许设置盒子的最小宽度。

注意

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

movable = 'both'#
Type:

Enum(Movable)

如果设置了editable,此属性允许配置盒子可以在哪些方向上移动。

注意

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

name = None#
Type:

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#
Type:

Bool

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

注意

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

renderers = []#
Type:

List

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

注意

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

resizable = 'all'#
Type:

Enum(Resizable)

如果设置了editable,此属性允许配置哪些边的组合可以被移动,从而允许对框的大小调整进行限制。

注意

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

right = Node(id='p52650', ...)#
Type:

Either(Either(Float, Datetime, Factor), Instance(Node))

框注释右侧边缘的x坐标。

right_limit = None#
Type:

Nullable(Either(Either(Float, Datetime, Factor), Instance(Node)))

盒子移动的可选右限。

注意

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

right_units = 'data'#
Type:

Enum(CoordinateUnits)

right属性的单位类型。默认情况下解释为数据单位。如果right是一个节点,则此属性没有任何效果。

styles = {}#
Type:

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

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

stylesheets = []#
Type:

List

用于底层DOM元素的附加样式表。

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

symmetric = False#
Type:

Bool

指示框是否围绕其中心或角落可调整大小。

注意

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

syncable = True#
Type:

Bool

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

注意

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

tags = []#
Type:

List

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

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

top = Node(id='p52707', ...)#
Type:

Either(Either(Float, Datetime, Factor), Instance(Node))

框注释顶部边缘的y坐标。

top_limit = None#
Type:

Nullable(Either(Either(Float, Datetime, Factor), Instance(Node)))

盒子移动的可选上限。

注意

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

top_units = 'data'#
Type:

Enum(CoordinateUnits)

顶部属性的单位类型。默认情况下解释为数据单位。如果top是一个节点,则没有任何效果。

use_handles = False#
Type:

Bool

是否显示交互(移动、调整大小等)手柄。

如果不使用手柄,那么整个注释、其边框和角落的行为就像它们是交互手柄一样。

注意

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

visible = True#
Type:

Bool

渲染器是否可见。

x_range_name = 'default'#
Type:

String

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

y_range_name = 'default'#
Type:

String

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

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

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

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

Parameters:

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

Returns:

无

classmethod clear_extensions() → None#

清除当前定义的所有自定义扩展。

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

clone(**overrides: Any) → Self#

复制一个HasProps对象。

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

classmethod dataspecs() → dict[str, DataSpec]#

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

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

Returns:

DataSpec 属性的名称

Return type:

set[str]

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

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

destroy() → None#

清理对文档和属性的引用

equals(other: HasProps) → bool#

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

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

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

这是一个便捷的方法,简化了添加一个 CustomJS 回调的过程,以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

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

  • 其他 (Model) – 一个要链接到 self.attr 的 Bokeh 模型

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

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

在版本1.1中添加

Raises:

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,给定属性名称。

Parameters:
  • name (str) – 要搜索的属性的名称

  • raises (bool) – 如果缺失,是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

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

在此对象上添加一个回调,当attr发生变化时触发。

Parameters:
  • attr (str) – 此对象上的一个属性名称

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

Returns:

无

示例

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值。

Returns:

列表(参数)

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

收集此类的属性名称。

警告

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

Returns:

属性名称

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

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

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

Returns:

具有引用的属性名称

Return type:

set[str]

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

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

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

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

Parameters:

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

Returns:

从属性名称到其值的映射

Return type:

dict

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

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

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

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

Returns:

属性名称和值的映射,用于匹配属性

Return type:

dict

references() → set[Model]#

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

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

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]#

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

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None#

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

Returns:

模型

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

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

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

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

  • setter (ClientSession 或 ServerSession 或 None, 可选) –

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

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

Returns:

无

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

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

Parameters:
  • selector (类似JSON的)

  • 更新 (dict)

Returns:

无

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

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

结果以属性名称到值的字典形式返回,如果此实例没有主题覆盖任何值,则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep#

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

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None#
unapply_theme() → None#

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

Returns:

无

update(**kwargs: Any) → None#

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

Returns:

无

示例

以下是等价的:

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

基础类:Model

定义用于类似框的注释的交互句柄。