绘图

用于表示顶层绘图对象的模型。

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

Bases: LayoutDOM, GridCommon

在矩形网格上排列的绘图和其他可布局对象的集合。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "children": [], 
  "cols": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p63339", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": null, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "resizable": false, 
  "rows": null, 
  "sizing_mode": null, 
  "spacing": 0, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "toolbar": {
    "id": "p63340", 
    "name": "Toolbar", 
    "type": "object"
  }, 
  "toolbar_location": "above", 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件的宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此属性有效。如果设置为数字，则将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不会保留宽高比）。

children = []

类型:

列表

子图列表，包含它们在网格中的关联位置、行和列索引以及可选的行和列跨度（默认跨度为 1）。

cols = None

类型:

Nullable(Either(Either(String, Struct), List, Dict(Int, Either(String, Struct))))

描述网格应如何保持其列的宽度。

这映射到 CSS 网格的轨道尺寸选项。特别是允许以下值

• 长度，例如 100px, 5.5em

• 百分比，例如 33%

• 弹性，例如 1fr

• 枚举，例如 max-content, min-content, auto 等。

如果提供单个值，则它应用于所有列。可以提供值列表来调整所有列的大小，或者提供字典来为各个列提供大小调整。

请参阅 https://mdn.org.cn/en-US/docs/Web/CSS/grid-template-columns 或 https://w3c.github.io/csswg-drafts/css-grid/#track-sizing 了解详细信息。

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

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

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供了一个 ToolMenu 实例，以便轻松访问其工具。

注意

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

css_classes = []

类型:

列表

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

css_variables = {}

类型:

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

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

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

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

注意

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

disabled = False

类型:

布尔值

小部件在渲染时是否将被禁用。

如果为 True，小部件将变为灰色，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此面板的基于 DOM 的 UI 元素集合。

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

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法适应可用垂直空间，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许适应最小和最大高度边界内的可用垂直空间（如果已设置）。组件的高度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，不小于最小高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，不超过最大高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，将来可能会更改。请自行酌情使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

html_attributes = {}

类型:

Dict(String, String)

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

html_id = None

类型:

Nullable(String)

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

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

margin = None

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。负边距值可用于从任何方向缩小空间。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

name = None

类型:

Nullable(String)

此模型的任意用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 出于任何原因也不直接使用该名称。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果可以，则在哪些维度上。

rows = None

类型:

Nullable(Either(Either(String, Struct), List, Dict(Int, Either(String, Struct))))

描述网格应如何保持其行的宽度。

这映射到 CSS 网格的轨道尺寸选项。特别是允许以下值

• 长度，例如 100px, 5.5em

• 百分比，例如 33%

• 弹性，例如 1fr

• 枚举，例如 max-content, min-content, auto 等。

如果提供单个值，则它应用于所有行。可以提供值列表来调整所有行的大小，或者提供字典来为各个行提供大小调整。

请参阅 https://mdn.org.cn/en-US/docs/Web/CSS/grid-template-rows 或 https://w3c.github.io/csswg-drafts/css-grid/#track-sizing 了解详细信息。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于保持组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的情况

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。它将保留其原始宽度和高度，而与任何后续浏览器窗口大小调整事件无关。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何宽高比。组件的高度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何宽高比。组件的宽度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上都是独立的，并将占用所有可用的水平和垂直空间，即使这会更改组件的宽高比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的宽高比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的宽高比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用宽度和高度，同时保持原始或提供的宽高比。

spacing = 0

类型:

Either(NonNegative, Tuple(NonNegative, NonNegative))

子元素之间的间隙（以像素为单位）。

可以是数字（如果间距在两个维度上相同），也可以是一对数字（分别表示垂直和水平维度上的间距）。

styles = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

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

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

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

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

注意

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

toolbar = Toolbar(id='p63399', ...)

类型:

Instance(Toolbar)

与此网格图关联的工具栏，其中包含所有工具。如有必要，它会自动随绘图一起创建。

toolbar_location = 'above'

类型:

Nullable(Enum(Location))

指示工具栏将位于布局中的位置。如果设置为 None，则不会将工具栏附加到网格图。

visible = True

类型:

布尔值

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

width = None

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界（如果已设置）内适应可用的水平空间。组件的宽度既不会被大幅度最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起始点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起始点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，将来可能会更改。请自行酌情使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

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

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

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

参数:

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

返回:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回:

DataSpec 属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

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

返回:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

在 BokehJS 端，模型属性的更改事件具有 "change:property_name" 形式。为方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

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

但是，除了属性更改事件之外，还有其他类型的事件可能需要响应。例如，要每当数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

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

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

参数:

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

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

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回:

None

示例

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

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

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

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

classmethod parameters() → list[Parameter]

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

返回:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回:

属性名称

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

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

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

返回:

具有引用的属性的名称

返回类型:

set[str]

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

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

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

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

参数:

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

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

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

参数:

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

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

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

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

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

返回:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回:

None

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

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

结果以从属性名称到值的 dict 形式返回，或者如果主题未覆盖此实例的任何值，则返回 None。

返回:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回:

None

update(**kwargs: Any) → None

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

返回:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

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

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

property document: Document | None

此模型附加到的 Document (可以为 None)

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

基类： LayoutDOM

表示绘图的模型，包含字形、引导线和注释。

JSON 原型

{
  "above": [], 
  "align": "auto", 
  "aspect_ratio": null, 
  "aspect_scale": 1, 
  "attribution": [], 
  "background_fill_alpha": 1.0, 
  "background_fill_color": "#ffffff", 
  "background_hatch_alpha": 1.0, 
  "background_hatch_color": "black", 
  "background_hatch_extra": {
    "type": "map"
  }, 
  "background_hatch_pattern": null, 
  "background_hatch_scale": 12.0, 
  "background_hatch_weight": 1.0, 
  "below": [], 
  "border_fill_alpha": 1.0, 
  "border_fill_color": "#ffffff", 
  "border_hatch_alpha": 1.0, 
  "border_hatch_color": "black", 
  "border_hatch_extra": {
    "type": "map"
  }, 
  "border_hatch_pattern": null, 
  "border_hatch_scale": 12.0, 
  "border_hatch_weight": 1.0, 
  "center": [], 
  "context_menu": "auto", 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "extra_x_ranges": {
    "type": "map"
  }, 
  "extra_x_scales": {
    "type": "map"
  }, 
  "extra_y_ranges": {
    "type": "map"
  }, 
  "extra_y_scales": {
    "type": "map"
  }, 
  "flow_mode": "block", 
  "frame_align": true, 
  "frame_height": null, 
  "frame_width": null, 
  "height": 600, 
  "height_policy": "auto", 
  "hidpi": true, 
  "hold_render": false, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p63408", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "left": [], 
  "lod_factor": 10, 
  "lod_interval": 300, 
  "lod_threshold": 2000, 
  "lod_timeout": 500, 
  "margin": null, 
  "match_aspect": false, 
  "max_height": null, 
  "max_width": null, 
  "min_border": 5, 
  "min_border_bottom": null, 
  "min_border_left": null, 
  "min_border_right": null, 
  "min_border_top": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "outline_line_alpha": 1.0, 
  "outline_line_cap": "butt", 
  "outline_line_color": "#e5e5e5", 
  "outline_line_dash": [], 
  "outline_line_dash_offset": 0, 
  "outline_line_join": "bevel", 
  "outline_line_width": 1, 
  "output_backend": "canvas", 
  "renderers": [], 
  "reset_policy": "standard", 
  "resizable": false, 
  "right": [], 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": {
    "id": "p63413", 
    "name": "Title", 
    "type": "object"
  }, 
  "title_location": "above", 
  "toolbar": {
    "id": "p63414", 
    "name": "Toolbar", 
    "type": "object"
  }, 
  "toolbar_inner": false, 
  "toolbar_location": "right", 
  "toolbar_sticky": true, 
  "visible": true, 
  "width": 600, 
  "width_policy": "auto", 
  "window_axis": "none", 
  "x_range": {
    "id": "p63409", 
    "name": "DataRange1d", 
    "type": "object"
  }, 
  "x_scale": {
    "id": "p63411", 
    "name": "LinearScale", 
    "type": "object"
  }, 
  "y_range": {
    "id": "p63410", 
    "name": "DataRange1d", 
    "type": "object"
  }, 
  "y_scale": {
    "id": "p63412", 
    "name": "LinearScale", 
    "type": "object"
  }
}

above = []

类型:

列表

要在绘图上方区域占据的渲染器列表。

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

仅当此组件是布局的子元素（例如网格）时，此属性才有用。自对齐可以被父容器覆盖（例如网格轨道对齐）。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件的宽度和高度之间的比例关系。

如果组件的任何尺寸可以灵活调整大小，则此属性有效。如果设置为数字，则将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，则将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不会保留宽高比）。

aspect_scale = 1

类型:

Float

用于增强纵横比控制的值。此值以乘法方式添加到 match_aspect 所需的计算值中。aspect_scale 定义为图形的宽度与高度之比。

例如，aspect_scale 值为 2 的绘图将导致在屏幕上绘制一个正方形（以数据单位为单位），该正方形的像素宽度是像素高度的两倍。

注意

仅当 match_aspect 设置为 True 时，此设置才生效。

attribution = []

类型:

列表

允许确认或感谢数据、瓦片等提供商。

这可以是 HTML 或纯文本形式。渲染器（如瓦片渲染器）可以提供额外的署名，这些署名将在此处提供的署名之后添加。

注意

此功能是实验性的，短期内可能会发生变化。

background_fill_alpha = 1.0

类型:

Alpha

绘图背景样式的填充 alpha 值。

background_fill_color = '#ffffff'

类型:

Nullable(Color)

绘图背景样式的填充颜色。

background_hatch_alpha = 1.0

类型:

Alpha

绘图背景样式的阴影线 alpha 值。

background_hatch_color = 'black'

类型:

Nullable(Color)

绘图背景样式的阴影线颜色。

background_hatch_extra = {}

类型:

Dict(String, Instance(Texture))

绘图背景样式的额外阴影线。

background_hatch_pattern = None

类型:

Nullable(String)

绘图背景样式的阴影线图案。

background_hatch_scale = 12.0

类型:

Size

绘图背景样式的阴影线比例。

background_hatch_weight = 1.0

类型:

Size

绘图背景样式的阴影线粗细。

below = []

类型:

列表

要在绘图下方区域占据的渲染器列表。

border_fill_alpha = 1.0

类型:

Alpha

绘图边框样式的填充 alpha 值。

border_fill_color = '#ffffff'

类型:

Nullable(Color)

绘图边框样式的填充颜色。

border_hatch_alpha = 1.0

类型:

Alpha

绘图边框样式的阴影线 alpha 值。

border_hatch_color = 'black'

类型:

Nullable(Color)

绘图边框样式的阴影线颜色。

border_hatch_extra = {}

类型:

Dict(String, Instance(Texture))

绘图边框样式的额外阴影线。

border_hatch_pattern = None

类型:

Nullable(String)

绘图边框样式的阴影线图案。

border_hatch_scale = 12.0

类型:

Size

绘图边框样式的阴影线比例。

border_hatch_weight = 1.0

类型:

Size

绘图边框样式的阴影线粗细。

center = []

类型:

列表

要在绘图中心区域（框架）占据的渲染器列表。

context_menu = 'auto'

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

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

如果设置为 "auto"，则组件可能会提供动态生成的菜单。例如，Plot 和相关模型提供了一个 ToolMenu 实例，以便轻松访问其工具。

注意

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

css_classes = []

类型:

列表

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

css_variables = {}

类型:

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

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

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

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

注意

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

disabled = False

类型:

布尔值

小部件在渲染时是否将被禁用。

如果为 True，小部件将变为灰色，并且不对 UI 事件做出响应。

elements = []

类型:

列表

附加到此面板的基于 DOM 的 UI 元素集合。

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

extra_x_ranges = {}

类型:

Dict(String, Instance(Range))

用于映射 x 坐标的其他命名范围。

这对于添加额外的轴很有用。

extra_x_scales = {}

类型:

Dict(String, Instance(Scale))

用于映射 x 坐标的其他命名比例。

这对于添加额外的轴很有用。

注意

此功能是实验性的，短期内可能会发生变化。

extra_y_ranges = {}

类型:

Dict(String, Instance(Range))

用于映射 y 坐标的其他命名范围。

这对于添加额外的轴很有用。

extra_y_scales = {}

类型:

Dict(String, Instance(Scale))

用于映射 y 坐标的其他命名比例。

这对于添加额外的轴很有用。

注意

此功能是实验性的，短期内可能会发生变化。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是在 block 还是 inline 维度中流动。

frame_align = True

类型:

Either(Bool, Struct)

允许指定在多绘图布局中对齐哪些框架边缘。

默认是对齐所有边缘，但用户可以选择不与每个单独的边缘或所有边缘对齐。另请注意，其他属性可能会禁用某些边缘的对齐，尤其是在使用固定框架尺寸（frame_width 和 frame_height 属性）时。

frame_height = None

类型:

Nullable(Int)

绘图框架的高度或绘图的内部高度，不包括任何轴、标题、边框填充等。

frame_width = None

类型:

Nullable(Int)

绘图框架的宽度或绘图的内部宽度，不包括任何轴、标题、边框填充等。

height = 600

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，具体取决于高度调整策略。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 height 像素。如果组件无法适应可用垂直空间，则会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许适应最小和最大高度边界内的可用垂直空间（如果已设置）。组件的高度既不会被积极地最小化，也不会被最大化。

"min"

尽可能少地使用垂直空间，不小于最小高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素而缩小或增大。

"max"

尽可能多地使用垂直空间，不超过最大高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，将来可能会更改。请自行酌情使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

hidpi = True

类型:

布尔值

是否在可用时使用 HiDPI 模式。

hold_render = False

类型:

布尔值

设置为 True 时，所有重绘绘图的请求都将被延迟。

当定期更新许多字形时，这很有用。例如，假设我们在一个绘图上有 10 条线，每条线都有自己的数据源。我们每秒在一个 for 循环中流式传输到所有这些线，如下所示

for line in lines:
    line.stream(new_points())

此代码的问题在于，每次流式传输都会触发绘图的重新渲染。即使仅在最后一次流式传输时重新绘制也会产生几乎相同的视觉效果。特别是对于有很多点的线条，这在计算上变得昂贵，并且可能会冻结您的浏览器。使用便捷方法 hold，我们可以控制何时启动渲染，如下所示

with plot.hold(render=True):
    for line in lines:
        line.stream(new_points())

在这种情况下，我们仅在最后一次流式传输后渲染新附加的点。

html_attributes = {}

类型:

Dict(String, String)

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

html_id = None

类型:

Nullable(String)

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

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

inner_height = Undefined

类型:

只读

这是绘图画布的精确高度，即实际绘图的高度，不包括工具栏等。请注意，这是在 Web 浏览器中计算的，因此此属性仅在能够进行双向通信的后端（服务器、笔记本）中有效。

注意

这是一个实验性功能，API 在不久的将来可能会发生变化。

inner_width = Undefined

类型:

只读

这是绘图画布的精确宽度，即实际绘图的宽度，不包括工具栏等。请注意，这是在 Web 浏览器中计算的，因此此属性仅在能够进行双向通信的后端（服务器、笔记本）中有效。

注意

这是一个实验性功能，API 在不久的将来可能会发生变化。

left = []

类型:

列表

要在绘图左侧区域占据的渲染器列表。

lod_factor = 10

类型:

Int

在应用细节层次模式时要使用的抽取因子。

lod_factor 为 N 表示在交互事件处于活动状态时，仅绘制数据源中每第 N 个点。例如，如果 lod_factor=200，则仅绘制每第 200 个点。

细节层次模式旨在在大量数据点存在时，保持 HTML 画布绘图上的交互响应时间。

请注意，细节层次模式的可能替代方案是使用 WebGL output_backend。WebGL 渲染可能允许非常大的数据集保持交互性，而无需任何细节层次降采样。启用 WebGL 输出后，不使用细节层次模式。

lod_interval = 300

类型:

Int

交互式工具事件将启用细节层次降采样的时间间隔（以毫秒为单位）。

如果在上次交互事件开始后的 lod_interval 毫秒内需要重新绘制绘图，则将激活细节层次模式。值越大意味着细节层次模式将“更容易”开启。

lod_threshold = 2000

类型:

Nullable(Int)

数据点的数量，超过此数量时，字形渲染器可能会执行细节层次降采样。例如，如果 lod_threshold=10000，则如果数据源中的点少于 10000 个，则不会激活细节层次模式。

设置为 None 以完全禁用任何细节层次降采样。

lod_timeout = 500

类型:

Int

用于检查交互式工具事件是否仍在发生的超时时间（以毫秒为单位）。一旦启用细节层次模式，则每 lod_timeout 毫秒进行一次检查。如果没有发生交互式工具事件，则禁用细节层次模式。值越大意味着细节层次模式将“更慢”地关闭。

margin = None

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 CSS 标准。负边距值可用于从任何方向缩小空间。

match_aspect = False

类型:

布尔值

指定绘图的纵横比行为。纵横比定义为宽度与高度之比。此属性控制 Bokeh 是否应尝试将数据空间的（宽度/高度）与屏幕空间的像素（宽度/高度）相匹配。

默认值为 False，表示数据纵横比和屏幕纵横比独立变化。True 表示轴的绘图纵横比将与轴的像素范围的纵横比匹配。最终结果是数据空间中 1x1 的区域在像素中是一个正方形，反之亦然，1x1 像素在数据单位中是一个正方形。

注意

仅当有两个数据范围时，此设置才生效。此设置仅设置初始绘图绘制和后续重置。工具（单轴缩放、无约束框缩放）可能会更改纵横比。

警告

此设置与跨多个绘图链接数据范围不兼容。这样做可能会导致未定义的行为。

max_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最大高度（以像素为单位）。

max_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最大宽度（以像素为单位）。

min_border = 5

类型:

Nullable(Int)

用于将所有 min_border_X 属性设置为相同值的便捷属性。如果显式设置了单个边框属性，它将覆盖 min_border。

min_border_bottom = None

类型:

Nullable(Int)

中央绘图区域底部下方填充区域的最小像素尺寸。

注意

这是一个最小值。填充区域可能会根据需要扩展，以容纳标题或坐标轴等。

min_border_left = None

类型:

Nullable(Int)

中央绘图区域左侧填充区域的最小像素尺寸。

注意

这是一个最小值。填充区域可能会根据需要扩展，以容纳标题或坐标轴等。

min_border_right = None

类型:

Nullable(Int)

中央绘图区域右侧填充区域的最小像素尺寸。

注意

这是一个最小值。填充区域可能会根据需要扩展，以容纳标题或坐标轴等。

min_border_top = None

类型:

Nullable(Int)

中央绘图区域顶部上方填充区域的最小像素尺寸。

注意

这是一个最小值。填充区域可能会根据需要扩展，以容纳标题或坐标轴等。

min_height = None

类型:

Nullable(NonNegative)

如果高度可调整，则为组件的最小高度（以像素为单位）。

min_width = None

类型:

Nullable(NonNegative)

如果宽度可调整，则为组件的最小宽度（以像素为单位）。

name = None

类型:

Nullable(String)

此模型的任意用户提供的名称。

在查询文档以检索特定的 Bokeh 模型时，此名称可能很有用。

>>> plot.scatter([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，不强制执行唯一性保证或其他条件，Bokeh 出于任何原因也不直接使用该名称。

outer_height = Undefined

类型:

只读

这是布局的精确高度，即包含工具栏等的实际绘图的高度。请注意，这是在 Web 浏览器中计算的，因此此属性仅在能够进行双向通信的后端（服务器、笔记本）中有效。

注意

这是一个实验性功能，API 在不久的将来可能会发生变化。

outer_width = Undefined

类型:

只读

这是布局的精确宽度，即包含工具栏等的实际绘图的宽度。请注意，这是在 Web 浏览器中计算的，因此此属性仅在能够进行双向通信的后端（服务器、笔记本）中有效。

注意

这是一个实验性功能，API 在不久的将来可能会发生变化。

outline_line_alpha = 1.0

类型:

Alpha

绘图边框轮廓的线条 alpha 值。

outline_line_cap = 'butt'

类型:

Enum(LineCap)

绘图边框轮廓的线条端帽样式。

outline_line_color = '#e5e5e5'

类型:

Nullable(Color)

绘图边框轮廓的线条颜色。

outline_line_dash = []

类型:

DashPattern

绘图边框轮廓的线条虚线模式。

outline_line_dash_offset = 0

类型:

Int

绘图边框轮廓的线条虚线偏移。

outline_line_join = 'bevel'

类型:

Enum(LineJoin)

绘图边框轮廓的线条连接样式。

outline_line_width = 1

类型:

Float

绘图边框轮廓的线条宽度。

output_backend = 'canvas'

类型:

Enum(OutputBackend)

指定绘图区域的输出后端。默认为 HTML5 Canvas。

注意

当设置为 webgl 时，没有 WebGL 渲染实现的字形将回退到渲染到 2D 画布上。

renderers = []

类型:

列表

此绘图的所有字形渲染器的列表。

此属性可以手动操作，但建议使用 add_glyph 以帮助确保执行所有必要的设置。

reset_policy = 'standard'

类型:

Enum(ResetPolicy)

绘图应如何响应重置。默认情况下，标准操作是清除任何工具状态历史记录，将绘图范围恢复为其原始值，撤消所有选择，并发出 Reset 事件。如果需要自定义，可以将此属性设置为 "event_only"，这将抑制除 Reset 事件之外的所有操作。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果可以，则在哪些维度上。

right = []

类型:

列表

占据绘图右侧区域的渲染器列表。

sizing_mode = None

类型:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是用于保持组件宽度和高度的高级设置。要更精细地控制尺寸调整，请改用 width_policy、height_policy 和 aspect_ratio（这些优先于 sizing_mode）。

可能的情况

"inherit"

尺寸调整模式从父布局继承。如果没有父布局（或父布局不是布局），则此值被视为未提供 sizing_mode 的值。

"fixed"

组件不响应。它将保留其原始宽度和高度，而与任何后续浏览器窗口大小调整事件无关。

"stretch_width"

组件将响应式调整大小以拉伸到可用宽度，而不保持任何宽高比。组件的高度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_height"

组件将响应式调整大小以拉伸到可用高度，而不保持任何宽高比。组件的宽度取决于组件的类型，并且可以是固定的或适合组件的内容。

"stretch_both"

组件是完全响应式的，在宽度和高度上都是独立的，并将占用所有可用的水平和垂直空间，即使这会更改组件的宽高比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的宽高比。

"scale_height"

组件将响应式调整大小以拉伸到可用高度，同时保持原始或提供的宽高比。

"scale_both"

组件将响应式调整大小以同时拉伸到可用宽度和高度，同时保持原始或提供的宽高比。

styles = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

syncable = True

类型:

布尔值

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

注意

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

tags = []

类型:

列表

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

当查询文档以检索特定的 Bokeh 模型时，此数据可能很有用

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

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

注意

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

title = Title(id='p63982', ...)

类型:

Either(Null, Instance(Title))

绘图的标题。可以是文本字符串或 Title 注释。

title_location = 'above'

类型:

Nullable(Enum(Location))

标题将位于何处。左侧或右侧的标题将被旋转。

toolbar = Toolbar(id='p63997', ...)

类型:

Instance(Toolbar)

与此绘图关联的工具栏，其中包含所有工具。如有必要，它会自动随绘图一起创建。

toolbar_inner = False

类型:

布尔值

将工具栏放置在框架内部。将此属性设置为 True 在自动隐藏工具栏的情况下最有意义。

toolbar_location = 'right'

类型:

Nullable(Enum(Location))

工具栏将位于何处。如果设置为 None，则不会将工具栏附加到绘图。

toolbar_sticky = True

类型:

布尔值

将工具栏固定到绘图的边缘。默认值：True。如果为 False，则工具栏将位于坐标轴、标题等之外。

visible = True

类型:

布尔值

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

width = 600

类型:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，具体取决于宽度尺寸调整策略。

width_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸调整策略。

"fixed"

精确使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界（如果已设置）内适应可用的水平空间。组件的宽度既不会被大幅度最小化，也不会被最大化。

"min"

尽可能少地使用水平空间，不小于最小宽度（如果已设置）。起始点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

尽可能多地使用水平空间，不超过最大宽度（如果已设置）。起始点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，将来可能会更改。请自行酌情使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

window_axis = 'none'

类型:

Enum(WindowAxis)

当绘图上存在数据范围时，用于窗口自动调整范围的轴。例如，如果 window_axis 设置为值 "x"，则 y 维度中的任何数据范围都将仅使用当前视口中配置的 x 轴范围边界内的数据来计算其自动调整范围的范围。

如果设置为“none”（默认值），则自动调整范围将使用所有可用数据，而与视口无关。

x_range = DataRange1d(id='p64054', ...)

类型:

Instance(Range)

绘图水平维度的（默认）数据范围。

x_scale = LinearScale(id='p64062', ...)

类型:

Instance(Scale)

使用哪种类型的比例来将数据空间中的 x 坐标转换为屏幕空间中的 x 坐标。

y_range = DataRange1d(id='p64070', ...)

类型:

Instance(Range)

绘图垂直维度的（默认）数据范围。

y_scale = LinearScale(id='p64078', ...)

类型:

Instance(Scale)

使用哪种类型的比例来将数据空间中的 y 坐标转换为屏幕空间中的 y 坐标。

add_glyph(glyph: Glyph, **kwargs: Any) → GlyphRenderer

add_glyph(source: ColumnarDataSource, glyph: Glyph, **kwargs: Any) → GlyphRenderer

向绘图添加字形，并关联数据源和范围。

此函数将负责创建和配置 Glyph 对象，然后将其添加到绘图的渲染器列表中。

参数:

• source (DataSource) – 供所有字形使用的数据源

• glyph (Glyph) – 要添加到绘图的字形

关键字参数:

• the (*任何其他关键字参数都按原样传递给*)

• 初始化器。 (Glyph)

返回:

GlyphRenderer

add_layout(obj: Renderer, place: Literal['above', 'below', 'left', 'right', 'center'] = 'center') → None

在绘图的指定位置添加对象。

参数:

• obj (Renderer) – 要添加到绘图的对象

• place (str, 可选) – 添加对象的位置（默认值：‘center’）。有效位置为：‘left’、‘right’、‘above’、‘below’、‘center’。

返回:

None

add_tile(tile_source: TileSource | TileProvider | str, retina: bool = False, **kwargs: Any) → TileRenderer

将新的 TileRenderer 添加到 Plot.renderers 中

参数:

• tile_source (TileSource, xyzservices.TileProvider, str) – 包含瓦片集配置的瓦片源实例

• retina (bool) – 是否使用瓦片的 retina 版本（如果可用）

关键字参数:

renderer (*附加关键字参数按原样传递给瓦片*)

返回:

TileRenderer

返回类型:

TileRenderer

add_tools(*tools: Tool | str) → None

向绘图添加工具。

参数:

*tools (Tool) – 要添加到绘图的工具

返回:

None

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

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

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

参数:

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

返回:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

column(col, gridplot)

返回此绘图是否在 GridPlot 的给定列中。

参数:

• col (int) – 要测试的列的索引

• gridplot (GridPlot) – 要检查的 GridPlot

返回:

bool

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回:

DataSpec 属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

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

返回:

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

hold(*, render: bool) → Generator[None, None, None]

负责在一个作用域内开启和关闭属性。

参数:

render (bool) – 开启和关闭属性 hold_render。

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

在 BokehJS 端，模型属性的更改事件具有 "change:property_name" 形式。为方便起见，如果传递给此方法的事件名称也是模型上属性的名称，则它将自动以 "change:" 为前缀

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

但是，除了属性更改事件之外，还有其他类型的事件可能需要响应。例如，要每当数据流式传输到 ColumnDataSource 时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

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

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

参数:

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

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

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回:

None

示例

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

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

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

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

classmethod parameters() → list[Parameter]

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

返回:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回:

属性名称

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

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

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

返回:

具有引用的属性的名称

返回类型:

set[str]

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

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

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

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

参数:

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

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中删除回调

remove_tools(*tools: Tool) → None

从绘图中移除工具。

参数:

*tools (Tool) – 要从绘图中移除的工具

返回:

None

row(row, gridplot)

返回此绘图是否在 GridPlot 的给定行中。

参数:

• row (int) – 要测试的行的索引

• gridplot (GridPlot) – 要检查的 GridPlot

返回:

bool

select(*args, **kwargs)

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

调用 select 方法有几种不同的方式。最常见的方式是提供一个 JSON 样式的查询字典作为单个参数或作为关键字参数

参数:

selector (JSON-like) – 一些示例文本

关键字参数:

kwargs – 作为关键字参数的查询字典键/值

此外，为了与 Model.select 兼容，可以选择将选择器字典作为 selector 关键字参数传递，在这种情况下，kwargs['selector'] 的值将用于查询。

为了方便起见，仅对名称的查询可以通过提供 name 字符串作为单个参数来完成

参数:

name (str) – 要查询的名称

同样，仅对类型的查询也可以通过简单地提供 Model 子类作为单个参数来完成

参数:

type (Model) – 要查询的类型

返回:

seq[Model]

示例

# These three are equivalent
p.select(selector={"type": HoverTool})
p.select({"type": HoverTool})
p.select(HoverTool)

# These two are also equivalent
p.select({"name": "mycircle"})
p.select("mycircle")

# Keyword arguments can be supplied in place of selector dict
p.select({"name": "foo", "type": HoverTool})
p.select(name="foo", type=HoverTool)

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

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

参数:

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

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

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

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

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

返回:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回:

None

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

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

结果以从属性名称到值的 dict 形式返回，或者如果主题未覆盖此实例的任何值，则返回 None。

返回:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

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

返回:

None

update(**kwargs: Any) → None

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

返回:

None

示例

以下是等效的

from bokeh.models import Range1d

r = Range1d

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

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

property axis

可展开的 Axis 对象列表。

property document: Document | None

此模型附加到的 Document (可以为 None)

property grid

可展开列表，包含 Grid 对象。

property hover

可展开列表，包含 HoverTool 对象。

property legend

可展开列表，包含 Legend 对象。

property xaxis

可展开列表，包含用于 x 维度的 Axis 对象。

property xgrid

可展开列表，包含用于 x 维度的 Grid 对象。

property yaxis

可展开列表，包含用于 y 维度的 Axis 对象。

property ygrid

可展开列表，包含用于 y 维度的 Grid 对象。