map_plots#

用于在 Bokeh 绘图中显示地图的模型。

class GMapOptions(*args: Any, id: ID | None = None, **kwargs: Any)[源代码]#

基类： MapOptions

GMapPlot 对象的选项。

lat = Undefined#

类型:: Required(Float)

地图应居中显示的纬度。

lng = Undefined#

类型:: Required(Float)

地图应居中显示的经度。

map_type = 'roadmap'#

类型:: Enum(MapType)

用于 GMapPlot 的地图类型。

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

scale_control = False#

类型:: 布尔型

Google 地图是否应显示其距离比例控件。

styles = None#

类型:: Nullable(JSON)

用于 GMapPlot 的地图样式的 JSON 数组。许多示例样式可以在此处找到。

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

tilt = 45#

类型:: 整数

倾斜地图的角度。唯一允许的值为 0 和 45。仅对“卫星”和“混合”地图类型有效。值为 0 会导致地图始终使用 0 度俯视视角。值为 45 会导致倾斜角切换为 45 度图像（如果可用）。

zoom = 12#

类型:: 整数

显示地图时要使用的初始缩放级别。

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, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）
返回:: 从属性名称到其值的映射
返回类型:: dict

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

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

参数:

query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象
include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回:

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

返回类型:

dict

references() → set[Model]#: 返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None#: 从此对象中移除回调

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

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

参数:: selector (JSON-like)
返回:: seq[Model]

select_one(selector: SelectorType) → Model | None#

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

返回:: Model

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

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

参数:

name (str) – 要设置的属性的名称
value (JSON-value) – 要设置为属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
这用于防止对 Bokeh 应用程序的“回旋镖”更新。

在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值会通过更新触发的任何后续更改通知进行传播。会话可以将事件 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#

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

结果以从属性名称到值的字典形式返回，如果此实例没有任何主题覆盖值，则返回 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 GMapPlot(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

基类： MapPlot

一个 Bokeh 图，底部显示 Google 地图。

放置在此图上的数据应以十进制度/经度坐标指定，例如 (37.123, -122.404)。它将被自动转换为 Web 墨卡托投影，以便在 Google 地图瓦片上正确显示。

必须使用 Google API 密钥配置 api_key 属性，GMapPlot 才能正常工作。密钥将存储在 Bokeh 文档 JSON 中。

请注意，Google 地图始终对纵横比施加显式控制，这对 GMapPlot 施加了一些限制

仅支持 Range1d 范围。尝试使用其他范围类型将导致错误。
BoxZoomTool 的使用与 GMapPlot 不兼容。添加 BoxZoomTool 将无效。

JSON 原型

{
  "above": [], 
  "align": "auto", 
  "api_key": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "api_version": "weekly", 
  "aspect_ratio": null, 
  "aspect_scale": 1, 
  "attribution": [], 
  "background_fill_alpha": 0.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": "p61864", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "left": [], 
  "lod_factor": 10, 
  "lod_interval": 300, 
  "lod_threshold": 2000, 
  "lod_timeout": 500, 
  "map_options": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "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": "p61869", 
    "name": "Title", 
    "type": "object"
  }, 
  "title_location": "above", 
  "toolbar": {
    "id": "p61870", 
    "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": "p61865", 
    "name": "Range1d", 
    "type": "object"
  }, 
  "x_scale": {
    "id": "p61867", 
    "name": "LinearScale", 
    "type": "object"
  }, 
  "y_range": {
    "id": "p61866", 
    "name": "Range1d", 
    "type": "object"
  }, 
  "y_scale": {
    "id": "p61868", 
    "name": "LinearScale", 
    "type": "object"
  }
}

above = []#

类型:: 列表

占用绘图上方区域的渲染器列表。

align = 'auto'#

类型:: Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

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

api_key = Undefined#

类型:: Required(Bytes)

Google Maps API 需要 API 密钥。有关如何获取您自己的密钥的更多信息，请参阅 https://developers.google.com/maps/documentation/javascript/get-api-key。

api_version = 'weekly'#

类型:: 字符串

要使用的 Google Maps API 版本。有关更多信息，请参阅 https://developers.google.com/maps/documentation/javascript/versions。

注意

更改此值可能会导致地图渲染中断。

aspect_ratio = None#

类型:: Either(Null, Auto, Float)

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

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

aspect_scale = 1#

类型:: 浮点数

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

例如，aspect_scale 值为 2 的绘图将导致屏幕上以数据单位绘制的正方形显示为像素宽度是像素高度两倍的矩形。

注意

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

attribution = []#

类型:: 列表

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

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

注意

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

background_fill_alpha = 0.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#

类型:: 大小

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

background_hatch_weight = 1.0#

类型:: 大小

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

below = []#

类型:: 列表

占用绘图下方区域的渲染器列表。

border_fill_alpha = 1.0#

类型:: Alpha

绘图边框样式的填充 Alpha。

border_fill_color = '#ffffff'#

类型:: Nullable(Color)

plot 边框样式的填充颜色。

border_hatch_alpha = 1.0#

类型:: Alpha

plot 边框样式的阴影 alpha 值。

border_hatch_color = 'black'#

类型:: Nullable(Color)

plot 边框样式的阴影颜色。

border_hatch_extra = {}#

类型:: Dict(String, Instance(Texture))

plot 边框样式的额外阴影属性。

border_hatch_pattern = None#

类型:: Nullable(String)

plot 边框样式的阴影图案。

border_hatch_scale = 12.0#

类型:: 大小

plot 边框样式的阴影缩放比例。

border_hatch_weight = 1.0#

类型:: 大小

plot 边框样式的阴影粗细。

center = []#

类型:: 列表

占据 plot 中心区域（frame）的渲染器列表。

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)

允许指定在多 plot 布局中要对齐的 frame 边缘。

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

frame_height = None#

类型:: Nullable(Int)

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

frame_width = None#

类型:: Nullable(Int)

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

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 时，所有重绘 plot 的请求都将被搁置。

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

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

此代码的问题在于，每个流都会触发 plot 的重新渲染。即使仅在最后一个流上重绘也会产生几乎相同的视觉效果。特别是对于具有许多点的线，这在计算上变得非常昂贵，并且可能会冻结您的浏览器。使用便捷方法 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#

类型:: 只读

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

注意

这是一个实验性功能，API 在不久的将来可能会更改。

inner_width = Undefined#

类型:: 只读

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

注意

这是一个实验性功能，API 在不久的将来可能会更改。

left = []#

类型:: 列表

占据 plot 左侧区域的渲染器列表。

lod_factor = 10#

类型:: 整数

在应用细节级别模式时使用的抽取因子。

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

细节级别模式旨在在大量数据点存在时，保持 HTML 画布 plot 上的交互响应时间。

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

lod_interval = 300#

类型:: 整数

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

如果需要在上次交互事件开始后的 lod_interval 毫秒内重绘 plot，则将激活细节级别模式。值越大，细节级别模式就“越容易”开启。

lod_threshold = 2000#

类型:: Nullable(Int)

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

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

lod_timeout = 500#

类型:: 整数

用于检查交互式工具事件是否仍在发生的超时时间（以毫秒为单位）。启用细节级别模式后，每 lod_timeout 毫秒进行一次检查。如果未发生交互式工具事件，则禁用细节级别模式。值越大，细节级别模式就“越慢”关闭。

map_options = Undefined#

类型:: Instance(GMapOptions)

用于显示 plot 的选项。

margin = None#

类型:: Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - Margin-Top、Margin-Right、Margin-Bottom 和 Margin-Left，类似于 CSS 标准。可以使用负 margin 值从任何方向缩小空间。

match_aspect = False#

类型:: 布尔型

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

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

注意

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

警告

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

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)

中心 plot 区域底部下方填充区域的最小像素大小。

注意

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

min_border_left = None#

类型:: Nullable(Int)

中心 plot 区域左侧填充区域的最小像素大小。

注意

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

min_border_right = None#

类型:: Nullable(Int)

中心 plot 区域右侧填充区域的最小像素大小。

注意

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

min_border_top = None#

类型:: Nullable(Int)

中心 plot 区域顶部上方填充区域的最小像素大小。

注意

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

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#

类型:: 只读

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

注意

这是一个实验性功能，API 在不久的将来可能会更改。

outer_width = Undefined#

类型:: 只读

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

注意

这是一个实验性功能，API 在不久的将来可能会更改。

outline_line_alpha = 1.0#

类型:: Alpha

plot 边框轮廓的线条 alpha 值。

outline_line_cap = 'butt'#

类型:: Enum(LineCap)

plot 边框轮廓的线帽样式。

outline_line_color = '#e5e5e5'#

类型:: Nullable(Color)

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

outline_line_dash = []#

类型:: DashPattern

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

outline_line_dash_offset = 0#

类型:: 整数

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

outline_line_join = 'bevel'#

类型:: Enum(LineJoin)

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

outline_line_width = 1#

类型:: 浮点数

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

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='p62459', ...)#

类型:: Either(Null, Instance(Title))

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

title_location = 'above'#

类型:: Nullable(Enum(Location))

标题将位于的位置。左侧或右侧的标题将旋转。

toolbar = Toolbar(id='p62474', ...)#

类型:: 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 = Range1d(id='p62531', ...)#

类型:: Instance(Range)

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

x_scale = LinearScale(id='p62539', ...)#

类型:: Instance(Scale)

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

y_range = Range1d(id='p62547', ...)#

类型:: Instance(Range)

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

y_scale = LinearScale(id='p62555', ...)#

类型:: Instance(Scale)

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

add_glyph(source_or_glyph: Glyph | ColumnarDataSource, glyph: Glyph | None ?= None, **kwargs: Any) → GlyphRenderer#

使用关联的数据源和范围向绘图添加字形。

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

参数:

source (DataSource) – 字形要使用的所有数据源
glyph (Glyph) – 要添加到绘图的字形

关键字参数:

the (任何其他关键字参数都按原样传递给)
initializer. (Glyph)

返回:

GlyphRenderer

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

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

参数:

obj (Renderer) – 要添加到绘图的对象
place (str, optional) – 在哪里添加对象（默认值：‘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, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）
返回:: 从属性名称到其值的映射
返回类型:: dict

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

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

参数:

query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象
include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回:

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

返回类型:

dict

references() → set[Model]#: 返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None#: 从此对象中移除回调

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 或 ServerSession 或 None, 可选) –
这用于防止对 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#

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

结果以从属性名称到值的字典形式返回，如果此实例没有任何主题覆盖值，则返回 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 对象列表。

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

基类： Model

地图选项模型的抽象基类。

注意

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

lat = Undefined#

类型:: Required(Float)

地图应居中显示的纬度。

lng = Undefined#

类型:: Required(Float)

地图应居中显示的经度。

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

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

zoom = 12#

类型:: 整数

显示地图时要使用的初始缩放级别。

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]

: 按定义顺序列出的属性描述符列表。

: 清理对文档和属性的引用

模型的结构相等性。

参数:: other (HasProps) – 要比较的另一个实例
返回:: 如果属性在结构上相等，则为 True，否则为 False

使用 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]"
    )
)

将 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)

根据属性名称，在此类上查找 Bokeh 属性的 PropertyDescriptor。

参数:

name (str) – 要搜索的属性的名称
raises (bool) – 如果找不到是否引发异常或返回 None

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

参数:

attr (str) – 此对象上的属性名称
*callbacks (callable) – 要注册的回调函数

返回:

None

示例

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

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

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

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

返回:: list(Parameter)

收集此类上的属性名称。

警告

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

返回:: 属性名称

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

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

返回:: 具有引用的属性的名称
返回类型:: set[str]

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

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

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

参数:: include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）
返回:: 从属性名称到其值的映射
返回类型:: dict

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

参数:

query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象
include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回:

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

返回类型:

dict

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

: 从此对象中移除回调

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

参数:: selector (JSON-like)
返回:: seq[Model]

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

返回:: Model

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

参数:

name (str) – 要设置的属性的名称
value (JSON-value) – 要设置为属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
这用于防止对 Bokeh 应用程序的“回旋镖”更新。

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

返回:

None

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

参数:

selector (JSON-like)
updates (dict)

返回:

None

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

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

返回:: dict 或 None

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

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

返回:: 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)

: 此模型附加到的 Document（可以为 None）

基类: Plot

地图绘图模型的抽象基类。

注意

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

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": "p62563", 
  "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": "p62568", 
    "name": "Title", 
    "type": "object"
  }, 
  "title_location": "above", 
  "toolbar": {
    "id": "p62569", 
    "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": "p62564", 
    "name": "DataRange1d", 
    "type": "object"
  }, 
  "x_scale": {
    "id": "p62566", 
    "name": "LinearScale", 
    "type": "object"
  }, 
  "y_range": {
    "id": "p62565", 
    "name": "DataRange1d", 
    "type": "object"
  }, 
  "y_scale": {
    "id": "p62567", 
    "name": "LinearScale", 
    "type": "object"
  }
}

类型:: 列表

占用绘图上方区域的渲染器列表。

类型:: Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

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

类型:: Either(Null, Auto, Float)

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

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

类型:: 浮点数

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

例如，aspect_scale 值为 2 的绘图将导致屏幕上以数据单位绘制的正方形显示为像素宽度是像素高度两倍的矩形。

注意

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

类型:: 列表

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

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

注意

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

类型:: Alpha

绘图背景样式的填充 Alpha。

类型:: Nullable(Color)

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

类型:: Alpha

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

类型:: Nullable(Color)

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

类型:: Dict(String, Instance(Texture))

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

类型:: Nullable(String)

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

背景阴影比例 = 12.0#

类型:: 大小

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

背景阴影粗细 = 1.0#

类型:: 大小

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

下方 = []#

类型:: 列表

占用绘图下方区域的渲染器列表。

边框填充透明度 = 1.0#

类型:: Alpha

绘图边框样式的填充 Alpha。

边框填充颜色 = '#ffffff'#

类型:: Nullable(Color)

plot 边框样式的填充颜色。

边框阴影透明度 = 1.0#

类型:: Alpha

plot 边框样式的阴影 alpha 值。

边框阴影颜色 = 'black'#

类型:: Nullable(Color)

plot 边框样式的阴影颜色。

边框阴影额外参数 = {}#

类型:: Dict(String, Instance(Texture))

plot 边框样式的额外阴影属性。

边框阴影图案 = None#

类型:: Nullable(String)

plot 边框样式的阴影图案。

边框阴影比例 = 12.0#

类型:: 大小

plot 边框样式的阴影缩放比例。

边框阴影粗细 = 1.0#

类型:: 大小

plot 边框样式的阴影粗细。

中心 = []#

类型:: 列表

占据 plot 中心区域（frame）的渲染器列表。

上下文菜单 = '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 { ... } 下设置相同的变量。

注意

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

禁用 = False#

类型:: 布尔型

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

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

元素 = []#

类型:: 列表

附加到此窗格的基于 DOM 的 UI 元素集合。

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

额外的 X 轴范围 = {}#

类型:: Dict(String, Instance(Range))

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

这对于添加其他轴很有用。

额外的 X 轴比例 = {}#

类型:: Dict(String, Instance(Scale))

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

这对于添加其他轴很有用。

注意

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

额外的 Y 轴范围 = {}#

类型:: Dict(String, Instance(Range))

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

这对于添加其他轴很有用。

额外的 Y 轴比例 = {}#

类型:: Dict(String, Instance(Scale))

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

这对于添加其他轴很有用。

注意

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

流动模式 = 'block'#

类型:: Enum(FlowMode)

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

框架对齐 = True#

类型:: Either(Bool, Struct)

允许指定在多 plot 布局中要对齐的 frame 边缘。

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

框架高度 = None#

类型:: Nullable(Int)

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

框架宽度 = None#

类型:: Nullable(Int)

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

高度 = 600#

类型:: Nullable(NonNegative)

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

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

高度策略 = 'auto'#

类型:: Either(Auto, Enum(SizingPolicy))

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

"auto": 使用组件的首选尺寸调整策略。
"fixed": 精确使用 height 像素。如果组件无法适应可用垂直空间，则会溢出。
"fit": 使用组件的首选高度（如果已设置），并允许适应最小和最大高度边界内的可用垂直空间（如果已设置）。组件的高度既不会被大幅缩小也不会被大幅放大。
"min": 尽可能少地使用垂直空间，不小于最小高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。
"max": 尽可能多地使用垂直空间，不超过最大高度（如果已设置）。起点是首选高度（如果已设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，将来可能会更改。请自行决定是否使用。如果不需要这种程度的控制，请首选使用 sizing_mode。

高分辨率 = True#

类型:: 布尔型

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

暂停渲染 = False#

类型:: 布尔型

当设置为 True 时，所有重绘 plot 的请求都将被搁置。

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

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

此代码的问题在于，每个流都会触发 plot 的重新渲染。即使仅在最后一个流上重绘也会产生几乎相同的视觉效果。特别是对于具有许多点的线，这在计算上变得非常昂贵，并且可能会冻结您的浏览器。使用便捷方法 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 优先。

内部高度 = Undefined#

类型:: 只读

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

注意

这是一个实验性功能，API 在不久的将来可能会更改。

内部宽度 = Undefined#

类型:: 只读

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

注意

这是一个实验性功能，API 在不久的将来可能会更改。

左侧 = []#

类型:: 列表

占据 plot 左侧区域的渲染器列表。

细节层次因子 = 10#

类型:: 整数

在应用细节级别模式时使用的抽取因子。

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

细节级别模式旨在在大量数据点存在时，保持 HTML 画布 plot 上的交互响应时间。

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

细节层次间隔 = 300#

类型:: 整数

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

如果需要在上次交互事件开始后的 lod_interval 毫秒内重绘 plot，则将激活细节级别模式。值越大，细节级别模式就“越容易”开启。

细节层次阈值 = 2000#

类型:: Nullable(Int)

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

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

细节层次超时 = 500#

类型:: 整数

用于检查交互式工具事件是否仍在发生的超时时间（以毫秒为单位）。启用细节级别模式后，每 lod_timeout 毫秒进行一次检查。如果未发生交互式工具事件，则禁用细节级别模式。值越大，细节级别模式就“越慢”关闭。

边距 = None#

类型:: Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - Margin-Top、Margin-Right、Margin-Bottom 和 Margin-Left，类似于 CSS 标准。可以使用负 margin 值从任何方向缩小空间。

匹配宽高比 = False#

类型:: 布尔型

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

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

注意

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

警告

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

最大高度 = None#

类型:: Nullable(NonNegative)

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

最大宽度 = None#

类型:: Nullable(NonNegative)

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

最小边框 = 5#

类型:: Nullable(Int)

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

最小底部边框 = None#

类型:: Nullable(Int)

中心 plot 区域底部下方填充区域的最小像素大小。

注意

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

最小左侧边框 = None#

类型:: Nullable(Int)

中心 plot 区域左侧填充区域的最小像素大小。

注意

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

最小右侧边框 = None#

类型:: Nullable(Int)

中心 plot 区域右侧填充区域的最小像素大小。

注意

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

最小顶部边框 = None#

类型:: Nullable(Int)

中心 plot 区域顶部上方填充区域的最小像素大小。

注意

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

最小高度 = None#

类型:: Nullable(NonNegative)

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

最小宽度 = None#

类型:: Nullable(NonNegative)

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

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

外部高度 = Undefined#

类型:: 只读

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

注意

这是一个实验性功能，API 在不久的将来可能会更改。

外部宽度 = Undefined#

类型:: 只读

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

注意

这是一个实验性功能，API 在不久的将来可能会更改。

轮廓线透明度 = 1.0#

类型:: Alpha

plot 边框轮廓的线条 alpha 值。

轮廓线端点样式 = 'butt'#

类型:: Enum(LineCap)

plot 边框轮廓的线帽样式。

轮廓线颜色 = '#e5e5e5'#

类型:: Nullable(Color)

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

轮廓线虚线 = []#

类型:: DashPattern

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

轮廓线虚线偏移 = 0#

类型:: 整数

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

轮廓线连接样式 = 'bevel'#

类型:: Enum(LineJoin)

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

轮廓线宽度 = 1#

类型:: 浮点数

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

输出后端 = 'canvas'#

类型:: Enum(OutputBackend)

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

注意

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

渲染器 = []#

类型:: 列表

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

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

重置策略 = 'standard'#

类型:: Enum(ResetPolicy)

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

可调整大小 = False#

类型:: Either(Bool, Enum(Dimensions))

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

右侧 = []#

类型:: 列表

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

尺寸模式 = 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": 组件将响应式调整大小以同时拉伸到可用宽度和高度，同时保持原始或提供的纵横比。

样式 = {}#

类型:: Either(Dict(String, Nullable(String)), Instance(Styles))

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

样式表 = []#

类型:: 列表

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

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

可同步 = True#

类型:: 布尔型

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

注意

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

标签 = []#

类型:: 列表

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

当查询文档以检索特定的 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(id='p63137', ...)#

类型:: Either(Null, Instance(Title))

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

标题位置 = 'above'#

类型:: Nullable(Enum(Location))

标题将位于的位置。左侧或右侧的标题将旋转。

工具栏 = Toolbar(id='p63152', ...)#

类型:: Instance(Toolbar)

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

工具栏内部显示 = False#

类型:: 布尔型

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

工具栏位置 = 'right'#

类型:: Nullable(Enum(Location))

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

工具栏吸附 = True#

类型:: 布尔型

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

可见 = True#

类型:: 布尔型

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

宽度 = 600#

类型:: Nullable(NonNegative)

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

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

宽度策略 = 'auto'#

类型:: Either(Auto, Enum(SizingPolicy))

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

"auto": 使用组件的首选尺寸调整策略。
"fixed": 完全使用 width 像素。如果组件无法适应可用的水平空间，则会溢出。
"fit": 使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度边界（如果已设置）内适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。
"min": 尽可能少地使用水平空间，但不小于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。
"max": 尽可能多地使用水平空间，但不超过最大宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，将来可能会更改。请自行决定是否使用。如果不需要这种程度的控制，请首选使用 sizing_mode。

窗口轴 = 'none'#

类型:: Enum(WindowAxis)

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

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

X 轴范围 = DataRange1d(id='p63209', ...)#

类型:: Instance(Range)

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

X 轴比例 = LinearScale(id='p63217', ...)#

类型:: Instance(Scale)

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

Y 轴范围 = DataRange1d(id='p63225', ...)#

类型:: Instance(Range)

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

Y 轴比例 = LinearScale(id='p63233', ...)#

类型:: Instance(Scale)

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

add_glyph(source_or_glyph: Glyph | ColumnarDataSource, glyph: Glyph | None = None, **kwargs: Any) → GlyphRenderer#

使用关联的数据源和范围向绘图添加字形。

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

参数:

source (DataSource) – 字形要使用的所有数据源
glyph (Glyph) – 要添加到绘图的字形

关键字参数:

the (任何其他关键字参数都按原样传递给)
initializer. (Glyph)

返回:

GlyphRenderer

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

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

参数:

obj (Renderer) – 要添加到绘图的对象
place (str, optional) – 在哪里添加对象（默认值：‘center’）。有效位置为：‘left’、‘right’、‘above’、‘below’、‘center’。

返回:

None

add_tile(tile_source: TileSource | TileProvider | str, retina: bool = False, **kwargs: Any) → TileRendererTileRenderer 添加到 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)

类方法 查找(名称: 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 中的特定事件。

类方法 parameters() → list[Parameter]#

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

返回:: list(Parameter)

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

收集此类上的属性名称。

警告

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

返回:: 属性名称

类方法 properties_with_refs() → dict[str, Property[Any]]#

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

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

返回:: 具有引用的属性的名称
返回类型:: set[str]

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

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

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

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

参数:: include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。（默认值：True）
返回:: 从属性名称到其值的映射
返回类型:: dict

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

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

参数:

query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象
include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性（默认值：True）

返回:

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

返回类型:

dict

references() → set[Model]#: 返回此对象引用的所有 Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None#: 从此对象中移除回调

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 或 ServerSession 或 None, 可选) –
这用于防止对 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#

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

结果以从属性名称到值的字典形式返回，如果此实例没有任何主题覆盖值，则返回 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)

属性 axis#: 可展开的 Axis 对象列表。

属性 document: Document | None#: 此模型附加到的 Document（可以为 None）

属性 grid#: 可展开的 Grid 对象列表。

属性 hover#: 可展开的 HoverTool 对象列表。

属性 legend#: 可展开的 Legend 对象列表。

属性 xaxis#: 用于 x 维度的可展开的 Axis 对象列表。

属性 xgrid#: 用于 x 维度的可展开的 Grid 对象列表。

属性 yaxis#: 用于 y 维度的可展开的 Axis 对象列表。

属性 ygrid#: 用于 y 维度的可展开的 Grid 对象列表。