map_plots#
用于在 Bokeh 图表中显示地图的模型。
- class GMapOptions(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
基类：
MapOptions用于
GMapPlot对象的选项。JSON 原型
{ "id": "p60118", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "lat": { "name": "unset", "type": "symbol" }, "lng": { "name": "unset", "type": "symbol" }, "map_type": "roadmap", "name": null, "scale_control": false, "styles": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "tilt": 45, "zoom": 12 }
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定 Bokeh 模型时，此名称可能很有用。
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
不保证任何提供的名称的唯一性或其他条件，Bokeh 也不会出于任何原因直接使用该名称。
- styles = None#
-
用于
GMapPlot的 地图样式 的 JSON 数组。可以在 此处找到许多示例样式。
- syncable = True#
- 类型:
指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为
False可能有助于减少处理频繁更新的对象时的网络流量，这些对象的更新值我们不需要。注意
将此属性设置为
False将阻止此对象上的任何on_change()回调触发。但是，任何 JS 侧回调仍然有效。
- tags = []#
- 类型:
一个可选的任意用户提供的值列表，附加到此模型。
当查询文档以检索特定 Bokeh 模型时，此数据可能很有用。
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者，只需一种将任何必要的元数据附加到模型的便捷方法，这些元数据可以通过
CustomJS回调等访问。注意
不保证任何提供的标记的唯一性或其他条件，Bokeh 也不会出于任何原因直接使用这些标记。
- tilt = 45#
- 类型:
地图的 倾斜 角。唯一允许的值为 0 和 45。仅对“卫星”和“混合”地图类型有效。值为 0 导致地图始终使用 0 度俯视视图。值为 45 导致倾斜角切换到 45 度图像（如果可用）。
- apply_theme(property_values: dict[str, Any]) None#
应用一组主题值，这些值将用于默认值，但不会覆盖应用程序设置的值。
传递的字典可以原样保留，并与其他实例共享以节省内存（因此，调用方和
HasProps实例都不应该修改它）。- 参数:
property_values (dict) – 用于替代默认值的主题值
- 返回值:
None
- classmethod clear_extensions() None#
清除任何当前定义的自定义扩展。
序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。
- classmethod descriptors() list[PropertyDescriptor[Any]]#
按定义顺序排列的属性描述符列表。
- 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 模型属性，只要另一个模型属性的值发生变化。- 参数:
在版本 1.1 中添加
- 引发:
示例
带有
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的属性的描述符- 返回类型:
- on_change(attr: str, *callbacks: PropertyCallback) None#
在该对象上添加回调，以在
attr更改时触发。- 参数:
attr (str) – 该对象上的属性名称
*callbacks (callable) – 要注册的回调函数
- 返回值:
None
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None#
当该 Model 上发生指定事件时运行回调。
并非所有 Model 都支持所有事件。有关哪些 Model 可以触发事件的更多信息，请参阅 bokeh.events 中的特定事件。
- classmethod parameters() list[Parameter]#
生成适合从 glyph 派生的函数的 Python
Parameter值。- 返回值:
list(Parameter)
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#
收集该类上属性的名称。
警告
在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。为了使当前对该方法的使用面向未来，请将返回值包装在
list中。- 返回值:
属性名称
- classmethod properties_with_refs() dict[str, Property[Any]]#
收集该类上所有具有引用属性的名称。
此方法始终遍历类层次结构，并包含在任何父类中定义的属性。
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#
收集一个将属性名称映射到其值的字典。
此方法始终遍历类层次结构，并包含在任何父类中定义的属性。
非可序列化属性将被跳过，属性值将以“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损重建对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#
使用谓词查询
HasProps实例的属性值。
- select(selector: SelectorType) Iterable[Model]#
查询此对象及其所有引用，以查找与给定选择器匹配的对象。
- 参数:
selector (类 JSON 的)
- 返回值:
seq[Model]
- select_one(selector: SelectorType) Model | None#
查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则会引发错误。返回单个匹配对象，或者如果未找到任何对象，则返回 None :param selector: :type selector: 类 JSON 的
- 返回值:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#
从此对象的 JSON 中设置属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON 值) – 要设置为属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
用于防止对 Bokeh 应用程序进行“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在进行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知中。会话可以将事件设置程序与其自身进行比较，并抑制来自其自身的任何更新。
- 返回值:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (类 JSON 的)
updates (dict)
- 返回值:
None
- themed_values() dict[str, Any] | None#
获取任何主题提供的覆盖。
结果以字典形式返回，从属性名称到值，如果主题没有覆盖此实例的任何值，则为
None。- 返回值:
字典或 None
- to_serializable(serializer: Serializer) ObjectRefRep#
将此对象转换为可序列化表示形式。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
- class GMapPlot(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
MapPlot一个在下方显示 Google 地图 的 Bokeh 图表。
放置在此图表上的数据应以十进制纬度/经度坐标指定，例如
(37.123, -122.404)。它将自动转换为网络墨卡托投影，以在谷歌地图瓦片上正确显示。为了使
GMapPlot正常工作，必须使用 Google API 密钥配置api_key属性。该密钥将存储在 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", "below": [], "border_fill_alpha": 1.0, "border_fill_color": "#ffffff", "center": [], "context_menu": null, "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, "id": "p60129", "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": "p60134", "name": "Title", "type": "object" }, "title_location": "above", "toolbar": { "id": "p60135", "name": "Toolbar", "type": "object" }, "toolbar_inner": false, "toolbar_location": "right", "toolbar_sticky": true, "visible": true, "width": 600, "width_policy": "auto", "x_range": { "id": "p60130", "name": "Range1d", "type": "object" }, "x_scale": { "id": "p60132", "name": "LinearScale", "type": "object" }, "y_range": { "id": "p60131", "name": "Range1d", "type": "object" }, "y_scale": { "id": "p60133", "name": "LinearScale", "type": "object" } }
- align = 'auto'#
-
父容器内的对齐点。
此属性仅在该组件是布局的子元素（例如网格）时才有用。自我对齐可以由父容器（例如网格轨道对齐）覆盖。
- api_key = Undefined#
-
Google 地图 API 需要 API 密钥。请参阅 https://developers.google.com/maps/documentation/javascript/get-api-key，以获取有关如何获取自己的密钥的更多信息。
- api_version = 'weekly'#
- 类型:
要使用的 Google 地图 API 版本。请参阅 https://developers.google.com/maps/documentation/javascript/versions，以获取更多信息。
注意
更改此值可能会导致地图渲染出现故障。
- aspect_ratio = None#
-
描述组件宽度和高度之间的比例关系。
如果组件的任何尺寸是灵活的，则此选项有效。如果设置为数字，则将保持
width / height = aspect_ratio关系。否则，如果设置为"auto"，则将使用组件的首选宽度和高度来确定纵横比（如果没有设置，则不会保留任何纵横比）。
- aspect_scale = 1#
- 类型:
用于增加纵横比控制的数值。此值将乘以
match_aspect所需的计算值。aspect_scale定义为图形宽度与高度的比率。例如，一个
aspect_scale值为 2 的绘图将导致以数据单位绘制的正方形在屏幕上显示为长宽比为 2 的矩形。注意
此设置仅在
match_aspect设置为True时生效。
- attribution = []#
- 类型:
允许确认或给予数据、图块等提供者认可。
这可以是 HTML 或纯文本形式。渲染器，例如图块渲染器，可以提供额外的属性，这些属性将添加到此处提供的属性之后。
注意
此功能处于试验阶段，可能在短期内发生变化。
- css_variables = {}#
-
允许定义动态计算的 CSS 变量。
例如，这可以用于在画布的渲染器和/或视觉效果与基于 HTML 的 UI 元素之间协调定位和样式。
在此处定义的变量等效于在 CSS 样式表中设置
:host { ... }下的相同变量。注意
此属性处于试验阶段，可能会在任何时候发生变化。
- extra_x_scales = {}#
-
用于映射 x 坐标的额外命名比例。
这对于添加额外的轴很有用。
注意
此功能处于试验阶段，可能在短期内发生变化。
- extra_y_scales = {}#
-
用于映射 y 坐标的额外命名比例。
这对于添加额外的轴很有用。
注意
此功能处于试验阶段，可能在短期内发生变化。
- frame_align = True#
-
允许指定在多图布局中对齐哪些框架边缘。
默认情况下对齐所有边缘，但用户可以选择不对齐任何单个边缘或所有边缘。请注意，其他属性可能会禁用某些边缘的对齐，尤其是在使用固定框架大小（
frame_width和frame_height属性）时。
- height = 600#
- 类型:
组件的高度（以像素为单位）。
这可以是固定高度或首选高度，具体取决于高度大小策略。
- height_policy = 'auto'#
- 类型:
描述组件如何保持其高度。
"auto"使用组件的首选大小策略。
"fixed"使用正好
height像素。如果组件不能容纳在可用垂直空间中，则组件会溢出。"fit"使用组件的首选高度（如果设置）并允许其适应最小和最大高度边界（如果设置）内的可用垂直空间。组件的高度既不会被积极地最小化也不会被最大化。
"min"尽可能使用最少的垂直空间，不小于最小高度（如果设置）。起点是首选高度（如果设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而收缩或增长。
"max"尽可能使用最多的垂直空间，不超过最大高度（如果设置）。起点是首选高度（如果设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而收缩或增长。
注意
这是一个实验性功能，将来可能会更改。自行决定使用它。如果不需要这种控制级别，请优先使用
sizing_mode。
- hold_render = False#
- 类型:
当设置为 True 时，所有请求重新绘制绘图的请求将被延迟。
当定期更新许多图形时，这很有用。例如，假设我们有一个具有 10 条线的绘图，每条线都有自己的数据源。我们像这样在循环中每秒向它们所有流式传输
for line in lines: line.stream(new_points())
这段代码的问题是，每次流式传输都会触发绘图的重新渲染。即使只在最后一次流式传输时重新绘制，也会产生几乎相同的视觉效果。特别是对于具有许多点的线，这在计算上会很昂贵，并可能冻结您的浏览器。使用便捷方法 hold，我们可以控制何时启动渲染，如下所示
with plot.hold(render=True): for line in lines: line.stream(new_points())
在这种情况下，我们只在最后一次流式传输后渲染新追加的点。
- inner_height = Undefined#
- 类型:
只读
这是绘图画布的精确高度，即实际绘图的高度，不包括工具栏等。请注意，这是在 Web 浏览器中计算的，因此此属性仅在支持双向通信（服务器、笔记本）的后端中有效。
注意
这是一个实验性功能，API 在不久的将来可能会更改。
- inner_width = Undefined#
- 类型:
只读
这是绘图画布的精确宽度，即实际绘图的宽度，不包括工具栏等。请注意，这是在 Web 浏览器中计算的，因此此属性仅在支持双向通信（服务器、笔记本）的后端中有效。
注意
这是一个实验性功能，API 在不久的将来可能会更改。
- lod_timeout = 500#
- 类型:
用于检查交互式工具事件是否仍在发生的超时（以毫秒为单位）。一旦启用细节级别模式，每隔
lod_timeout毫秒就会进行一次检查。如果没有任何交互式工具事件发生，则会禁用细节级别模式。
- map_options = Undefined#
- 类型:
显示绘图的选项。
- margin = None#
-
允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - 顶边距、右边距、底边距和左边距，类似于 CSS 标准。可以使用负边距值从任何方向缩减空间。
- match_aspect = False#
- 类型:
指定绘图的纵横比行为。纵横比定义为宽度与高度的比率。此属性控制 Bokeh 是否尝试将数据空间的（宽度/高度）与屏幕空间的像素（宽度/高度）匹配。
默认值为
False，表示数据纵横比和屏幕纵横比独立变化。True表示轴的绘图纵横比将与轴的像素范围的纵横比匹配。最终结果是数据空间中的 1x1 区域在像素中是正方形，反之，1x1 像素在数据单位中是正方形。注意
此设置仅在有两个数据范围时才有效。此设置仅设置初始绘图绘制和后续重置。工具（单轴缩放、无约束框缩放）可能会更改纵横比。
警告
此设置与在多个绘图之间链接数据范围不兼容。这样做可能会导致未定义的行为。
- max_height = None#
- 类型:
如果高度可调整，则组件的最大高度（以像素为单位）。
- max_width = None#
- 类型:
如果宽度可调整，则组件的最大宽度（以像素为单位）。
- min_border_bottom = None#
-
中心绘图区域下方填充区域的最小大小（以像素为单位）。
注意
这是一个最小值。填充区域可能会根据需要扩展以适应标题或轴等。
- min_border_left = None#
-
中心绘图区域左侧填充区域的最小大小（以像素为单位）。
注意
这是一个最小值。填充区域可能会根据需要扩展以适应标题或轴等。
- min_border_right = None#
-
中心绘图区域右侧填充区域的最小大小（以像素为单位）。
注意
这是一个最小值。填充区域可能会根据需要扩展以适应标题或轴等。
- min_border_top = None#
-
中心绘图区域上方填充区域的最小大小（以像素为单位）。
注意
这是一个最小值。填充区域可能会根据需要扩展以适应标题或轴等。
- min_height = None#
- 类型:
如果高度可调整，则组件的最小高度（以像素为单位）。
- min_width = None#
- 类型:
如果宽度可调整，则组件的最小宽度（以像素为单位）。
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定 Bokeh 模型时，此名称可能很有用。
>>> plot.circle([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_dash = []#
- 类型:
绘图边框轮廓的线虚线。
- output_backend = 'canvas'#
- 类型:
指定绘图区域的输出后端。默认值为 HTML5 Canvas。
注意
当设置为
webgl时，没有 WebGL 渲染实现的图形将回退到渲染到 2D 画布上。
- reset_policy = 'standard'#
- 类型:
绘图应该如何响应重置。默认情况下，标准操作是清除任何工具状态历史记录，将绘图范围恢复为原始值，撤消所有选择，并发出
Reset事件。如果需要自定义，此属性可以设置为"event_only"，这将抑制除重置事件之外的所有操作。
- resizable = False#
- 类型:
Either(Bool,Enum(Dimensions))
布局是否可以交互式调整大小，如果可以，在哪些维度上。
- sizing_mode = None#
- 类型:
组件应如何调整自身大小。
这是一个用于维护组件宽度和高度的高级设置。若要获得更细粒度的尺寸控制，请使用
width_policy、height_policy和aspect_ratio而不是sizing_mode（这些优先于sizing_mode）。可能的场景
"inherit"尺寸模式从父布局继承。如果没有父布局（或父布局不是布局），则此值将被视为没有提供
sizing_mode值。"fixed"组件不响应。它将保留其原始宽度和高度，而不管任何后续浏览器窗口调整大小事件。
"stretch_width"组件将响应式调整大小以拉伸到可用宽度，而不维护任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。
"stretch_height"组件将响应式调整大小以拉伸到可用高度，而不维护任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。
"stretch_both"组件在宽度和高度上完全响应式，将占用所有可用的水平和垂直空间，即使这改变了组件的纵横比。
"scale_width"组件将响应式调整大小以拉伸到可用宽度，同时维护原始或提供的纵横比。
"scale_height"组件将响应式调整大小以拉伸到可用高度，同时维护原始或提供的纵横比。
"scale_both"组件将响应式调整大小以适合可用宽度和高度，同时维护原始或提供的纵横比。
- stylesheets = []#
- 类型:
用于底层 DOM 元素的附加样式表。
请注意，所有 bokeh 的组件都使用影子 DOM，因此任何包含的样式表都必须反映这一点，例如使用
:hostCSS 伪选择器访问根 DOM 元素。
- syncable = True#
- 类型:
指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为
False可能有助于减少处理频繁更新的对象时的网络流量，这些对象的更新值我们不需要。注意
将此属性设置为
False将阻止此对象上的任何on_change()回调触发。但是，任何 JS 侧回调仍然有效。
- tags = []#
- 类型:
一个可选的任意用户提供的值列表，附加到此模型。
当查询文档以检索特定 Bokeh 模型时，此数据可能很有用。
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者，只需一种将任何必要的元数据附加到模型的便捷方法，这些元数据可以通过
CustomJS回调等访问。注意
不保证任何提供的标记的唯一性或其他条件，Bokeh 也不会出于任何原因直接使用这些标记。
- width = 600#
- 类型:
组件的宽度（以像素为单位）。
这可以是固定宽度或首选宽度，具体取决于宽度调整大小策略。
- width_policy = 'auto'#
- 类型:
描述组件应如何维护其宽度。
"auto"使用组件的首选大小策略。
"fixed"使用完全
width像素。如果组件不能容纳在可用的水平空间中，它将溢出。"fit"使用组件的首选宽度（如果设置）并允许它适应可用水平空间，在最小和最大宽度边界内（如果设置）。组件的宽度既不会被强行最小化，也不会被强行最大化。
"min"使用尽可能少的水平空间，不小于最小宽度（如果设置）。起点是首选宽度（如果设置）。组件的宽度可能会缩小或增大，具体取决于父布局、纵横比管理和其他因素。
"max"尽可能使用水平空间，但不超过最大宽度（如果设置）。起点是首选宽度（如果设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或扩大。
注意
这是一个实验性功能，将来可能会更改。自行决定使用它。如果不需要这种控制级别，请优先使用
sizing_mode。
- 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#
在指定的位置将对象添加到图中。
- add_tile(tile_source: TileSource | TileProvider | str, retina: bool = False, **kwargs: Any) TileRenderer#
将新的
TileRenderer添加到Plot.renderers中- 参数:
tile_source (TileSource, xyzservices.TileProvider, str) – 包含瓦片集配置的瓦片源实例
retina (bool) – 是否使用瓦片的视网膜版本（如果可用）
- 关键字参数：
renderer (其他关键字参数将按原样传递给瓦片)
- 返回值:
TileRenderer
- 返回类型:
- apply_theme(property_values: dict[str, Any]) None#
应用一组主题值，这些值将用于默认值，但不会覆盖应用程序设置的值。
传递的字典可以原样保留，并与其他实例共享以节省内存（因此，调用方和
HasProps实例都不应该修改它）。- 参数:
property_values (dict) – 用于替代默认值的主题值
- 返回值:
None
- classmethod clear_extensions() None#
清除任何当前定义的自定义扩展。
序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。
- column(col, gridplot)#
返回此图是否位于 GridPlot 的给定列中。
- classmethod descriptors() list[PropertyDescriptor[Any]]#
按定义顺序排列的属性描述符列表。
- 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 模型属性，只要另一个模型属性的值发生变化。- 参数:
在版本 1.1 中添加
- 引发:
示例
带有
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的属性的描述符- 返回类型:
- on_change(attr: str, *callbacks: PropertyCallback) None#
在该对象上添加回调，以在
attr更改时触发。- 参数:
attr (str) – 该对象上的属性名称
*callbacks (callable) – 要注册的回调函数
- 返回值:
None
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None#
当该 Model 上发生指定事件时运行回调。
并非所有 Model 都支持所有事件。有关哪些 Model 可以触发事件的更多信息，请参阅 bokeh.events 中的特定事件。
- classmethod parameters() list[Parameter]#
生成适合从 glyph 派生的函数的 Python
Parameter值。- 返回值:
list(Parameter)
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#
收集该类上属性的名称。
警告
在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。为了使当前对该方法的使用面向未来，请将返回值包装在
list中。- 返回值:
属性名称
- classmethod properties_with_refs() dict[str, Property[Any]]#
收集该类上所有具有引用属性的名称。
此方法始终遍历类层次结构，并包含在任何父类中定义的属性。
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#
收集一个将属性名称映射到其值的字典。
此方法始终遍历类层次结构，并包含在任何父类中定义的属性。
非可序列化属性将被跳过，属性值将以“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损重建对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#
使用谓词查询
HasProps实例的属性值。
- row(row, gridplot)#
返回此绘图是否在 GridPlot 的给定行中。
- select(*args, **kwargs)#
查询此对象及其所有引用，以查找与给定选择器匹配的对象。
有几种不同的方法可以调用
select方法。最一般的方法是将 JSON 类查询字典作为单个参数或关键字参数提供- 参数:
selector (JSON 类) – 一些示例文本
- 关键字参数：
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 的
- 返回值:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#
从此对象的 JSON 中设置属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON 值) – 要设置为属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
用于防止对 Bokeh 应用程序进行“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在进行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知中。会话可以将事件设置程序与其自身进行比较，并抑制来自其自身的任何更新。
- 返回值:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (类 JSON 的)
updates (dict)
- 返回值:
None
- themed_values() dict[str, Any] | None#
获取任何主题提供的覆盖。
结果以字典形式返回，从属性名称到值，如果主题没有覆盖此实例的任何值，则为
None。- 返回值:
字典或 None
- to_serializable(serializer: Serializer) ObjectRefRep#
将此对象转换为可序列化表示形式。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
- 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 legend#
可扩展的
Legend对象列表。
- class MapOptions(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
基类：
Model地图选项模型的抽象基类。
注意
这是一个用于帮助组织 Bokeh 模型类型层次结构的抽象基类。它本身不适合实例化。
JSON 原型
{ "id": "p60716", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "lat": { "name": "unset", "type": "symbol" }, "lng": { "name": "unset", "type": "symbol" }, "name": null, "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "zoom": 12 }
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定 Bokeh 模型时，此名称可能很有用。
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
不保证任何提供的名称的唯一性或其他条件，Bokeh 也不会出于任何原因直接使用该名称。
- syncable = True#
- 类型:
指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为
False可能有助于减少处理频繁更新的对象时的网络流量，这些对象的更新值我们不需要。注意
将此属性设置为
False将阻止此对象上的任何on_change()回调触发。但是，任何 JS 侧回调仍然有效。
- tags = []#
- 类型:
一个可选的任意用户提供的值列表，附加到此模型。
当查询文档以检索特定 Bokeh 模型时，此数据可能很有用。
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者，只需一种将任何必要的元数据附加到模型的便捷方法，这些元数据可以通过
CustomJS回调等访问。注意
不保证任何提供的标记的唯一性或其他条件，Bokeh 也不会出于任何原因直接使用这些标记。
- apply_theme(property_values: dict[str, Any]) None#
应用一组主题值，这些值将用于默认值，但不会覆盖应用程序设置的值。
传递的字典可以原样保留，并与其他实例共享以节省内存（因此，调用方和
HasProps实例都不应该修改它）。- 参数:
property_values (dict) – 用于替代默认值的主题值
- 返回值:
None
- classmethod clear_extensions() None#
清除任何当前定义的自定义扩展。
序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。
- classmethod descriptors() list[PropertyDescriptor[Any]]#
按定义顺序排列的属性描述符列表。
- 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 模型属性，只要另一个模型属性的值发生变化。- 参数:
在版本 1.1 中添加
- 引发:
示例
带有
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的属性的描述符- 返回类型:
- on_change(attr: str, *callbacks: PropertyCallback) None#
在该对象上添加回调，以在
attr更改时触发。- 参数:
attr (str) – 该对象上的属性名称
*callbacks (callable) – 要注册的回调函数
- 返回值:
None
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None#
当该 Model 上发生指定事件时运行回调。
并非所有 Model 都支持所有事件。有关哪些 Model 可以触发事件的更多信息，请参阅 bokeh.events 中的特定事件。
- classmethod parameters() list[Parameter]#
生成适合从 glyph 派生的函数的 Python
Parameter值。- 返回值:
list(Parameter)
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#
收集该类上属性的名称。
警告
在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。为了使当前对该方法的使用面向未来，请将返回值包装在
list中。- 返回值:
属性名称
- classmethod properties_with_refs() dict[str, Property[Any]]#
收集该类上所有具有引用属性的名称。
此方法始终遍历类层次结构，并包含在任何父类中定义的属性。
-
properties_with_values(*, include_defaults:
- 参数:
include_defaults (bool, optional) – 是否包含自对象创建以来未显式设置的属性。（默认值：True）
- 返回值:
从属性名称到其值的映射
- 返回类型:
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#
使用谓词查询
HasProps实例的属性值。
- select(selector: SelectorType) Iterable[Model]#
查询此对象及其所有引用，以查找与给定选择器匹配的对象。
- 参数:
selector (类 JSON 的)
- 返回值:
seq[Model]
- select_one(selector: SelectorType) Model | None#
查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则会引发错误。返回单个匹配对象，或者如果未找到任何对象，则返回 None :param selector: :type selector: 类 JSON 的
- 返回值:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#
从此对象的 JSON 中设置属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON 值) – 要设置为属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
用于防止对 Bokeh 应用程序进行“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在进行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知中。会话可以将事件设置程序与其自身进行比较，并抑制来自其自身的任何更新。
- 返回值:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (类 JSON 的)
updates (dict)
- 返回值:
None
- themed_values() dict[str, Any] | None#
获取任何主题提供的覆盖。
结果以字典形式返回，从属性名称到值，如果主题没有覆盖此实例的任何值，则为
None。- 返回值:
字典或 None
- to_serializable(serializer: Serializer) ObjectRefRep#
将此对象转换为可序列化表示形式。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
- 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)
- class MapPlot(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
Plot地图绘图模型的抽象基类。
注意
这是一个用于帮助组织 Bokeh 模型类型层次结构的抽象基类。它本身不适合实例化。
JSON 原型
{ "above": [], "align": "auto", "aspect_ratio": null, "aspect_scale": 1, "attribution": [], "background_fill_alpha": 1.0, "background_fill_color": "#ffffff", "below": [], "border_fill_alpha": 1.0, "border_fill_color": "#ffffff", "center": [], "context_menu": null, "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, "id": "p60723", "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": "p60728", "name": "Title", "type": "object" }, "title_location": "above", "toolbar": { "id": "p60729", "name": "Toolbar", "type": "object" }, "toolbar_inner": false, "toolbar_location": "right", "toolbar_sticky": true, "visible": true, "width": 600, "width_policy": "auto", "x_range": { "id": "p60724", "name": "DataRange1d", "type": "object" }, "x_scale": { "id": "p60726", "name": "LinearScale", "type": "object" }, "y_range": { "id": "p60725", "name": "DataRange1d", "type": "object" }, "y_scale": { "id": "p60727", "name": "LinearScale", "type": "object" } }
- align = 'auto'#
-
父容器内的对齐点。
此属性仅在该组件是布局的子元素（例如网格）时才有用。自我对齐可以由父容器（例如网格轨道对齐）覆盖。
- aspect_ratio = None#
-
描述组件宽度和高度之间的比例关系。
如果组件的任何尺寸是灵活的，则此选项有效。如果设置为数字，则将保持
width / height = aspect_ratio关系。否则，如果设置为"auto"，则将使用组件的首选宽度和高度来确定纵横比（如果没有设置，则不会保留任何纵横比）。
- aspect_scale = 1#
- 类型:
用于增加纵横比控制的数值。此值将乘以
match_aspect所需的计算值。aspect_scale定义为图形宽度与高度的比率。例如，一个
aspect_scale值为 2 的绘图将导致以数据单位绘制的正方形在屏幕上显示为长宽比为 2 的矩形。注意
此设置仅在
match_aspect设置为True时生效。
- attribution = []#
- 类型:
允许确认或给予数据、图块等提供者认可。
这可以是 HTML 或纯文本形式。渲染器，例如图块渲染器，可以提供额外的属性，这些属性将添加到此处提供的属性之后。
注意
此功能处于试验阶段，可能在短期内发生变化。
- css_variables = {}#
-
允许定义动态计算的 CSS 变量。
例如，这可以用于在画布的渲染器和/或视觉效果与基于 HTML 的 UI 元素之间协调定位和样式。
在此处定义的变量等效于在 CSS 样式表中设置
:host { ... }下的相同变量。注意
此属性处于试验阶段，可能会在任何时候发生变化。
- extra_x_scales = {}#
-
用于映射 x 坐标的额外命名比例。
这对于添加额外的轴很有用。
注意
此功能处于试验阶段，可能在短期内发生变化。
- extra_y_scales = {}#
-
用于映射 y 坐标的额外命名比例。
这对于添加额外的轴很有用。
注意
此功能处于试验阶段，可能在短期内发生变化。
- frame_align = True#
-
允许指定在多图布局中对齐哪些框架边缘。
默认情况下对齐所有边缘，但用户可以选择不对齐任何单个边缘或所有边缘。请注意，其他属性可能会禁用某些边缘的对齐，尤其是在使用固定框架大小（
frame_width和frame_height属性）时。
- height = 600#
- 类型:
组件的高度（以像素为单位）。
这可以是固定高度或首选高度，具体取决于高度大小策略。
- height_policy = 'auto'#
- 类型:
描述组件如何保持其高度。
"auto"使用组件的首选大小策略。
"fixed"使用正好
height像素。如果组件不能容纳在可用垂直空间中，则组件会溢出。"fit"使用组件的首选高度（如果设置）并允许其适应最小和最大高度边界（如果设置）内的可用垂直空间。组件的高度既不会被积极地最小化也不会被最大化。
"min"尽可能使用最少的垂直空间，不小于最小高度（如果设置）。起点是首选高度（如果设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而收缩或增长。
"max"尽可能使用最多的垂直空间，不超过最大高度（如果设置）。起点是首选高度（如果设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而收缩或增长。
注意
这是一个实验性功能，将来可能会更改。自行决定使用它。如果不需要这种控制级别，请优先使用
sizing_mode。
- hold_render = False#
- 类型:
当设置为 True 时，所有请求重新绘制绘图的请求将被延迟。
当定期更新许多图形时，这很有用。例如，假设我们有一个具有 10 条线的绘图，每条线都有自己的数据源。我们像这样在循环中每秒向它们所有流式传输
for line in lines: line.stream(new_points())
这段代码的问题是，每次流式传输都会触发绘图的重新渲染。即使只在最后一次流式传输时重新绘制，也会产生几乎相同的视觉效果。特别是对于具有许多点的线，这在计算上会很昂贵，并可能冻结您的浏览器。使用便捷方法 hold，我们可以控制何时启动渲染，如下所示
with plot.hold(render=True): for line in lines: line.stream(new_points())
在这种情况下，我们只在最后一次流式传输后渲染新追加的点。
- inner_height = Undefined#
- 类型:
只读
这是绘图画布的精确高度，即实际绘图的高度，不包括工具栏等。请注意，这是在 Web 浏览器中计算的，因此此属性仅在支持双向通信（服务器、笔记本）的后端中有效。
注意
这是一个实验性功能，API 在不久的将来可能会更改。
- inner_width = Undefined#
- 类型:
只读
这是绘图画布的精确宽度，即实际绘图的宽度，不包括工具栏等。请注意，这是在 Web 浏览器中计算的，因此此属性仅在支持双向通信（服务器、笔记本）的后端中有效。
注意
这是一个实验性功能，API 在不久的将来可能会更改。
- lod_timeout = 500#
- 类型:
用于检查交互式工具事件是否仍在发生的超时（以毫秒为单位）。一旦启用细节级别模式，每隔
lod_timeout毫秒就会进行一次检查。如果没有任何交互式工具事件发生，则会禁用细节级别模式。
- margin = None#
-
允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - 顶边距、右边距、底边距和左边距，类似于 CSS 标准。可以使用负边距值从任何方向缩减空间。
- match_aspect = False#
- 类型:
指定绘图的纵横比行为。纵横比定义为宽度与高度的比率。此属性控制 Bokeh 是否尝试将数据空间的（宽度/高度）与屏幕空间的像素（宽度/高度）匹配。
默认值为
False，表示数据纵横比和屏幕纵横比独立变化。True表示轴的绘图纵横比将与轴的像素范围的纵横比匹配。最终结果是数据空间中的 1x1 区域在像素中是正方形，反之，1x1 像素在数据单位中是正方形。注意
此设置仅在有两个数据范围时才有效。此设置仅设置初始绘图绘制和后续重置。工具（单轴缩放、无约束框缩放）可能会更改纵横比。
警告
此设置与在多个绘图之间链接数据范围不兼容。这样做可能会导致未定义的行为。
- max_height = None#
- 类型:
如果高度可调整，则组件的最大高度（以像素为单位）。
- max_width = None#
- 类型:
如果宽度可调整，则组件的最大宽度（以像素为单位）。
- min_border_bottom = None#
-
中心绘图区域下方填充区域的最小大小（以像素为单位）。
注意
这是一个最小值。填充区域可能会根据需要扩展以适应标题或轴等。
- min_border_left = None#
-
中心绘图区域左侧填充区域的最小大小（以像素为单位）。
注意
这是一个最小值。填充区域可能会根据需要扩展以适应标题或轴等。
- min_border_right = None#
-
中心绘图区域右侧填充区域的最小大小（以像素为单位）。
注意
这是一个最小值。填充区域可能会根据需要扩展以适应标题或轴等。
- min_border_top = None#
-
中心绘图区域上方填充区域的最小大小（以像素为单位）。
注意
这是一个最小值。填充区域可能会根据需要扩展以适应标题或轴等。
- min_height = None#
- 类型:
如果高度可调整，则组件的最小高度（以像素为单位）。
- min_width = None#
- 类型:
如果宽度可调整，则组件的最小宽度（以像素为单位）。
- name = None#
-
此模型的任意用户提供的名称。
当查询文档以检索特定 Bokeh 模型时，此名称可能很有用。
>>> plot.circle([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_dash = []#
- 类型:
绘图边框轮廓的线虚线。
- output_backend = 'canvas'#
- 类型:
指定绘图区域的输出后端。默认值为 HTML5 Canvas。
注意
当设置为
webgl时，没有 WebGL 渲染实现的图形将回退到渲染到 2D 画布上。
- reset_policy = 'standard'#
- 类型:
绘图应该如何响应重置。默认情况下，标准操作是清除任何工具状态历史记录，将绘图范围恢复为原始值，撤消所有选择，并发出
Reset事件。如果需要自定义，此属性可以设置为"event_only"，这将抑制除重置事件之外的所有操作。
- resizable = False#
- 类型:
Either(Bool,Enum(Dimensions))
布局是否可以交互式调整大小，如果可以，在哪些维度上。
- sizing_mode = None#
- 类型:
组件应如何调整自身大小。
这是一个用于维护组件宽度和高度的高级设置。若要获得更细粒度的尺寸控制，请使用
width_policy、height_policy和aspect_ratio而不是sizing_mode（这些优先于sizing_mode）。可能的场景
"inherit"尺寸模式从父布局继承。如果没有父布局（或父布局不是布局），则此值将被视为没有提供
sizing_mode值。"fixed"组件不响应。它将保留其原始宽度和高度，而不管任何后续浏览器窗口调整大小事件。
"stretch_width"组件将响应式调整大小以拉伸到可用宽度，而不维护任何纵横比。组件的高度取决于组件的类型，并且可能是固定的或适合组件的内容。
"stretch_height"组件将响应式调整大小以拉伸到可用高度，而不维护任何纵横比。组件的宽度取决于组件的类型，并且可能是固定的或适合组件的内容。
"stretch_both"组件在宽度和高度上完全响应式，将占用所有可用的水平和垂直空间，即使这改变了组件的纵横比。
"scale_width"组件将响应式调整大小以拉伸到可用宽度，同时维护原始或提供的纵横比。
"scale_height"组件将响应式调整大小以拉伸到可用高度，同时维护原始或提供的纵横比。
"scale_both"组件将响应式调整大小以适合可用宽度和高度，同时维护原始或提供的纵横比。
- stylesheets = []#
- 类型:
用于底层 DOM 元素的附加样式表。
请注意，所有 bokeh 的组件都使用影子 DOM，因此任何包含的样式表都必须反映这一点，例如使用
:hostCSS 伪选择器访问根 DOM 元素。
- syncable = True#
- 类型:
指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为
False可能有助于减少处理频繁更新的对象时的网络流量，这些对象的更新值我们不需要。注意
将此属性设置为
False将阻止此对象上的任何on_change()回调触发。但是，任何 JS 侧回调仍然有效。
- tags = []#
- 类型:
一个可选的任意用户提供的值列表，附加到此模型。
当查询文档以检索特定 Bokeh 模型时，此数据可能很有用。
>>> r = plot.circle([1,2,3], [4,5,6]) >>> r.tags = ["foo", 10] >>> plot.select(tags=['foo', 10]) [GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]
或者，只需一种将任何必要的元数据附加到模型的便捷方法，这些元数据可以通过
CustomJS回调等访问。注意
不保证任何提供的标记的唯一性或其他条件，Bokeh 也不会出于任何原因直接使用这些标记。
- width = 600#
- 类型:
组件的宽度（以像素为单位）。
这可以是固定宽度或首选宽度，具体取决于宽度调整大小策略。
- width_policy = 'auto'#
- 类型:
描述组件应如何维护其宽度。
"auto"使用组件的首选大小策略。
"fixed"使用完全
width像素。如果组件不能容纳在可用的水平空间中，它将溢出。"fit"使用组件的首选宽度（如果设置）并允许它适应可用水平空间，在最小和最大宽度边界内（如果设置）。组件的宽度既不会被强行最小化，也不会被强行最大化。
"min"使用尽可能少的水平空间，不小于最小宽度（如果设置）。起点是首选宽度（如果设置）。组件的宽度可能会缩小或增大，具体取决于父布局、纵横比管理和其他因素。
"max"尽可能使用水平空间，但不超过最大宽度（如果设置）。起点是首选宽度（如果设置）。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或扩大。
注意
这是一个实验性功能，将来可能会更改。自行决定使用它。如果不需要这种控制级别，请优先使用
sizing_mode。
- 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#
在指定的位置将对象添加到图中。
- add_tile(tile_source: TileSource | TileProvider | str, retina: bool = False, **kwargs: Any) TileRenderer#
将新的
TileRenderer添加到Plot.renderers中- 参数:
tile_source (TileSource, xyzservices.TileProvider, str) – 包含瓦片集配置的瓦片源实例
retina (bool) – 是否使用瓦片的视网膜版本（如果可用）
- 关键字参数：
renderer (其他关键字参数将按原样传递给瓦片)
- 返回值:
TileRenderer
- 返回类型:
- apply_theme(property_values: dict[str, Any]) None#
应用一组主题值，这些值将用于默认值，但不会覆盖应用程序设置的值。
传递的字典可以原样保留，并与其他实例共享以节省内存（因此，调用方和
HasProps实例都不应该修改它）。- 参数:
property_values (dict) – 用于替代默认值的主题值
- 返回值:
None
- classmethod clear_extensions() None#
清除任何当前定义的自定义扩展。
序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。
- column(col, gridplot)#
返回此图是否位于 GridPlot 的给定列中。
- classmethod descriptors() list[PropertyDescriptor[Any]]#
按定义顺序排列的属性描述符列表。
- 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 模型属性，只要另一个模型属性的值发生变化。- 参数:
在版本 1.1 中添加
- 引发:
示例
带有
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的属性的描述符- 返回类型:
- on_change(attr: str, *callbacks: PropertyCallback) None#
在该对象上添加回调，以在
attr更改时触发。- 参数:
attr (str) – 该对象上的属性名称
*callbacks (callable) – 要注册的回调函数
- 返回值:
None
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None#
当该 Model 上发生指定事件时运行回调。
并非所有 Model 都支持所有事件。有关哪些 Model 可以触发事件的更多信息，请参阅 bokeh.events 中的特定事件。
- classmethod parameters() list[Parameter]#
生成适合从 glyph 派生的函数的 Python
Parameter值。- 返回值:
list(Parameter)
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#
收集该类上属性的名称。
警告
在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。为了使当前对该方法的使用面向未来，请将返回值包装在
list中。- 返回值:
属性名称
- classmethod properties_with_refs() dict[str, Property[Any]]#
收集该类上所有具有引用属性的名称。
此方法始终遍历类层次结构，并包含在任何父类中定义的属性。
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#
收集一个将属性名称映射到其值的字典。
此方法始终遍历类层次结构，并包含在任何父类中定义的属性。
非可序列化属性将被跳过，属性值将以“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损重建对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any]#
使用谓词查询
HasProps实例的属性值。
- row(row, gridplot)#
返回此绘图是否在 GridPlot 的给定行中。
- select(*args, **kwargs)#
查询此对象及其所有引用，以查找与给定选择器匹配的对象。
有几种不同的方法可以调用
select方法。最一般的方法是将 JSON 类查询字典作为单个参数或关键字参数提供- 参数:
selector (JSON 类) – 一些示例文本
- 关键字参数：
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
- 返回值:
Model
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#
从此对象的 JSON 中设置属性值。
- 参数:
name (str) – 要设置的属性的名称
value (JSON 值) – 要设置为属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
用于防止对 Bokeh 应用程序进行“回旋镖”更新。
在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在进行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知中。会话可以将事件设置程序与其自身进行比较，并抑制来自其自身的任何更新。
- 返回值:
None
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (类 JSON 的)
updates (dict)
- 返回值:
None
- themed_values() dict[str, Any] | None#
获取任何主题提供的覆盖。
结果以字典形式返回，从属性名称到值，如果主题没有覆盖此实例的任何值，则为
None。- 返回值:
字典或 None
- to_serializable(serializer: Serializer) ObjectRefRep#
将此对象转换为可序列化表示形式。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
- 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 legend#
可扩展的
Legend对象列表。