图表#
用于表示顶层绘图对象的模型。
- class GridPlot(*args: Any, id: ID | None = None, **kwargs: Any)[源代码]#
基础类：
LayoutDOM,GridCommon在矩形网格上排列的图表和其他可布局元素的集合。
JSON Prototype
{ "align": "auto", "aspect_ratio": null, "children": [], "cols": null, "context_menu": null, "css_classes": [], "css_variables": { "type": "map" }, "disabled": false, "elements": [], "flow_mode": "block", "height": null, "height_policy": "auto", "id": "p61394", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "margin": null, "max_height": null, "max_width": null, "min_height": null, "min_width": null, "name": null, "resizable": false, "rows": null, "sizing_mode": null, "spacing": 0, "styles": { "type": "map" }, "stylesheets": [], "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "toolbar": { "id": "p61395", "name": "Toolbar", "type": "object" }, "toolbar_location": "above", "visible": true, "width": null, "width_policy": "auto" }
- align = 'auto'#
-
父容器内的对齐点。
此属性仅在此组件是布局的子元素（例如网格）时有用。自对齐可以被父容器（例如网格轨道对齐）覆盖。
- aspect_ratio = None#
-
描述组件宽度和高度之间的比例关系。
如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，
width / height = aspect_ratio关系将保持不变。否则，如果设置为"auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。
- cols = None#
-
描述网格应如何维护其列的宽度。
这映射到CSS网格的轨道尺寸选项。特别是允许以下值：
长度，例如
100px,5.5em百分比，例如
33%弹性布局，例如 1fr
枚举，例如
max-content,min-content,auto等。
如果提供了一个单一的值，则它适用于所有列。可以提供一个值列表来调整所有列的大小，或者提供一个字典来调整单个列的大小。
请参阅 https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns 或 https://w3c.github.io/csswg-drafts/css-grid/#track-sizing 以获取详细信息。
- css_variables = {}#
-
允许定义动态计算的CSS变量。
例如，这可以用于协调canvas渲染器和/或视觉效果与基于HTML的UI元素之间的定位和样式。
这里定义的变量等同于在CSS样式表中的
:host { ... }下设置相同的变量。注意
此属性是实验性的，可能会随时更改。
- height = None#
- Type:
组件的高度（以像素为单位）。
这可以是固定高度或首选高度，取决于高度调整策略。
- height_policy = 'auto'#
- Type:
描述组件应如何保持其高度。
"auto"使用组件的首选尺寸策略。
"fixed"使用精确的
height像素。如果组件无法适应可用的垂直空间，将会溢出。"fit"使用组件的首选高度（如果已设置），并允许在最小和最大高度范围内适应可用的垂直空间（如果已设置）。组件的高度既不会被过度最小化，也不会被过度最大化。
"min"尽可能使用最少的垂直空间，但不少于最小高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素缩小或增长。
"max"尽可能使用垂直空间，但不超过最大高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素而缩小或增长。
注意
这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用
sizing_mode。
- margin = None#
-
允许在组件周围创建额外的空间。 元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距， 类似于CSS标准。 可以使用负边距值来缩小任何方向的空间。
- max_height = None#
- Type:
如果高度可调，组件的最大高度（以像素为单位）。
- max_width = None#
- Type:
如果宽度可调，组件的最大宽度（以像素为单位）。
- min_height = None#
- Type:
如果高度可调，组件的最小高度（以像素为单位）。
- min_width = None#
- Type:
如果宽度可调，组件的最小宽度（以像素为单位）。
- 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也不会直接使用这些名称。
- resizable = False#
- Type:
Either(Bool,Enum(Dimensions))
布局是否可交互调整大小，如果是，则在哪些维度上。
- rows = None#
-
描述网格应如何维护其行的高度。
这映射到CSS网格的轨道尺寸选项。特别是允许以下值：
长度，例如
100px,5.5em百分比，例如
33%弹性布局，例如 1fr
枚举，例如
max-content,min-content,auto等。
如果提供了一个单一的值，则它适用于所有行。可以提供一个值列表来调整所有行的大小，或者提供一个字典来为个别行提供大小调整。
详情请参见 https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows 或 https://w3c.github.io/csswg-drafts/css-grid/#track-sizing。
- sizing_mode = None#
- Type:
组件应如何调整自身大小。
这是一个用于维护组件宽度和高度的全局设置。要获得更精细的尺寸控制，请使用
width_policy、height_policy和aspect_ratio（这些设置优先于sizing_mode）。可能的场景：
"inherit"尺寸模式继承自父布局。如果没有父布局（或父布局不是布局），则此值被视为未提供
sizing_mode的值。"fixed"组件不具备响应性。无论浏览器窗口如何调整大小，它都将保持其原始的宽度和高度。
"stretch_width"组件将响应式地调整大小以拉伸到可用宽度，而不保持任何宽高比。组件的高度取决于组件的类型，可能是固定的或适应组件的内容。
"stretch_height"组件将响应式地调整大小以拉伸到可用高度，而不保持任何宽高比。组件的宽度取决于组件的类型，可能是固定的或适应组件的内容。
"stretch_both"组件完全响应，宽度和高度独立，并且将占据所有可用的水平和垂直空间，即使这会改变组件的宽高比。
"scale_width"组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的宽高比。
"scale_height"组件将响应式地调整大小以拉伸到可用高度，同时保持原始或提供的宽高比。
"scale_both"组件将根据可用的宽度和高度进行响应式调整大小，同时保持原始或提供的宽高比。
- spacing = 0#
- Type:
子元素之间的间隙（以像素为单位）。
可以是一个数字，如果两个维度的间距相同，或者是一对数字，分别表示垂直和水平维度的间距。
- stylesheets = []#
- Type:
用于底层DOM元素的附加样式表。
请注意，所有Bokeh的组件都使用影子DOM，因此任何包含的样式表都必须反映这一点，例如使用
:hostCSS伪选择器来访问根DOM元素。
- syncable = True#
- Type:
指示当在网页浏览器中更新时，此模型是否应同步回Bokeh服务器。设置为
False可能有助于在处理频繁更新的对象时减少网络流量，这些对象的更新值我们不需要。注意
将此属性设置为
False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。
- tags = []#
- Type:
一个可选的任意用户提供的值列表，用于附加到此模型。
在查询文档以检索特定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也不会出于任何原因直接使用这些标签。
- toolbar_location = 'above'#
-
指示工具栏将位于布局的哪个位置。如果设置为None，则不会将工具栏附加到网格图中。
- width = None#
- Type:
组件的宽度（以像素为单位）。
这可以是固定宽度或首选宽度，取决于宽度调整策略。
- width_policy = 'auto'#
- Type:
描述组件应如何保持其宽度。
"auto"使用组件的首选尺寸策略。
"fixed"使用精确的
width像素。如果组件无法适应可用的水平空间，将会溢出。"fit"使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度范围内（如果已设置）适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。
"min"尽可能少地使用水平空间，但不少于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。
"max"尽可能使用水平空间，但不超过最大宽度（如果已设置）。 起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。
注意
这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用
sizing_mode。
- apply_theme(property_values: dict[str, Any]) None#
应用一组主题值，这些值将用于替代默认值，但不会覆盖应用程序设置的值。
传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和
HasProps实例都不应修改它）。- Parameters:
property_values (dict) – 用于替换默认值的主题值
- Returns:
无
- classmethod clear_extensions() None#
清除当前定义的所有自定义扩展。
序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论是否被使用。此方法可用于清除所有现有的自定义扩展定义。
- classmethod descriptors() list[PropertyDescriptor[Any]]#
属性描述符的列表，按定义的顺序排列。
- equals(other: HasProps) bool#
模型的结构相等性。
- Parameters:
其他 (HasProps) – 要比较的其他实例
- Returns:
如果属性在结构上相等，则为True，否则为False
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None#
使用JavaScript链接两个Bokeh模型属性。
这是一个便捷的方法，简化了添加一个
CustomJS回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。- Parameters:
在版本1.1中添加
- Raises:
示例
这段代码使用了
js_link:select.js_link('value', plot, 'sizing_mode')
等同于以下内容：
from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) )
此外，使用attr_selector将范围滑块的左侧附加到绘图的x_range：
range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)
这相当于：
from bokeh.models import CustomJS range_slider.js_on_change('value', CustomJS(args=dict(other=plot.x_range), code="other.start = this.value[0]" ) )
- js_on_change(event: str, *callbacks: JSChangeCallback) None#
将一个
CustomJS回调附加到任意的BokehJS模型事件。在BokehJS方面，模型属性的更改事件具有
"change:property_name"的形式。为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，那么它将自动加上"change:"前缀：# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
然而，除了属性更改事件之外，还有其他类型的事件可能对响应有用。例如，每当数据流式传输到
ColumnDataSource时运行回调，可以在源上使用"stream"事件：source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#
在类上找到Bokeh属性的
PropertyDescriptor，给定属性名称。- Parameters:
- Returns:
名为
name的属性的描述符- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None#
在此对象上添加一个回调，当
attr发生变化时触发。- Parameters:
attr (str) – 此对象上的一个属性名称
*callbacks (callable) – 要注册的回调函数
- Returns:
无
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None#
当此模型上发生指定事件时运行回调
并非所有模型都支持所有事件。 有关哪些模型能够触发特定事件的更多信息，请参见bokeh.events中的具体事件。
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#
收集此类的属性名称。
警告
在Bokeh的未来版本中，此方法将返回一个将属性名称映射到属性对象的字典。为了使当前使用此方法的方式具有未来兼容性，请将返回值包装在
list中。- Returns:
属性名称
- 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]#
查询此对象及其所有引用，以查找与给定选择器匹配的对象。
- Parameters:
selector (类似JSON的)
- Returns:
序列[模型]
- select_one(selector: SelectorType) Model | None#
查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何内容，则返回None :param selector: :type selector: JSON-like
- Returns:
模型
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#
从JSON设置此对象的属性值。
- Parameters:
name (str) – 要设置的属性名称
value (JSON-value) – 要设置给属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
这用于防止对Bokeh应用程序的“回旋镖”更新。
在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在执行更新的会话进行注释。该值通过更新触发的任何后续更改通知传播。会话可以将事件设置器与自身进行比较，并抑制源自自身的任何更新。
- Returns:
无
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- Parameters:
selector (类似JSON的)
更新 (dict)
- Returns:
无
- themed_values() dict[str, Any] | None#
获取任何主题提供的覆盖。
结果以属性名称到值的字典形式返回，如果此实例没有主题覆盖任何值，则返回
None。- Returns:
字典或无
- to_serializable(serializer: Serializer) ObjectRefRep#
将此对象转换为可序列化的表示形式。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
- class Plot(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
基础类：
LayoutDOM表示绘图的模型，包含图形、指南、注释。
JSON Prototype
{ "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": "p61459", "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": "p61464", "name": "Title", "type": "object" }, "title_location": "above", "toolbar": { "id": "p61465", "name": "Toolbar", "type": "object" }, "toolbar_inner": false, "toolbar_location": "right", "toolbar_sticky": true, "visible": true, "width": 600, "width_policy": "auto", "x_range": { "id": "p61460", "name": "DataRange1d", "type": "object" }, "x_scale": { "id": "p61462", "name": "LinearScale", "type": "object" }, "y_range": { "id": "p61461", "name": "DataRange1d", "type": "object" }, "y_scale": { "id": "p61463", "name": "LinearScale", "type": "object" } }
- align = 'auto'#
-
父容器内的对齐点。
此属性仅在此组件是布局的子元素（例如网格）时有用。自对齐可以被父容器（例如网格轨道对齐）覆盖。
- aspect_ratio = None#
-
描述组件宽度和高度之间的比例关系。
如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，
width / height = aspect_ratio关系将保持不变。否则，如果设置为"auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。
- aspect_scale = 1#
- Type:
一个用于增强宽高比控制的值。该值以乘法方式添加到
match_aspect所需的计算值中。aspect_scale定义为图形的宽度与高度的比率。例如，一个具有
aspect_scale值为2的图将导致在屏幕上绘制的数据单位中的正方形显示为一个像素宽度是其像素高度两倍的矩形。注意
此设置仅在
match_aspect设置为True时生效。
- attribution = []#
- Type:
允许确认或给予数据、瓦片等提供者信用。
这可以是HTML或纯文本形式。渲染器，如瓦片渲染器，可以提供额外的归属信息，这些信息将添加在此处提供的归属信息之后。
注意
此功能是实验性的，可能在短期内发生变化。
- css_variables = {}#
-
允许定义动态计算的CSS变量。
例如，这可以用于协调canvas渲染器和/或视觉效果与基于HTML的UI元素之间的定位和样式。
这里定义的变量等同于在CSS样式表中的
:host { ... }下设置相同的变量。注意
此属性是实验性的，可能会随时更改。
- extra_x_scales = {}#
-
额外的命名比例尺，可用于映射x坐标。
这对于添加额外的轴非常有用。
注意
此功能是实验性的，可能在短期内发生变化。
- extra_y_scales = {}#
-
额外的命名比例尺，可用于映射y坐标。
这对于添加额外的轴非常有用。
注意
此功能是实验性的，可能在短期内发生变化。
- frame_align = True#
-
允许指定在多图布局中对齐哪些框架边缘。
默认情况下是对齐所有边缘，但用户可以选择不对齐每个单独的边缘或所有边缘。还要注意，其他属性可能会禁用某些边缘的对齐，特别是在使用固定框架大小时（
frame_width和frame_height属性）。
- height = 600#
- Type:
组件的高度（以像素为单位）。
这可以是固定高度或首选高度，取决于高度调整策略。
- height_policy = 'auto'#
- Type:
描述组件应如何保持其高度。
"auto"使用组件的首选尺寸策略。
"fixed"使用精确的
height像素。如果组件无法适应可用的垂直空间，将会溢出。"fit"使用组件的首选高度（如果已设置），并允许在最小和最大高度范围内适应可用的垂直空间（如果已设置）。组件的高度既不会被过度最小化，也不会被过度最大化。
"min"尽可能使用最少的垂直空间，但不少于最小高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素缩小或增长。
"max"尽可能使用垂直空间，但不超过最大高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素而缩小或增长。
注意
这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用
sizing_mode。
- hold_render = False#
- Type:
当设置为True时，所有重新绘制图表的请求将被推迟。
这在定期更新许多字形时非常有用。例如，假设我们在一个图上有10条线，每条线都有自己的数据源。我们每秒在一个for循环中向所有这些线流式传输数据，如下所示：
for line in lines: line.stream(new_points())
这段代码的问题在于每个流都会触发图表的重新渲染。即使只在最后一个流上重新绘制也会产生几乎相同的视觉效果。特别是对于具有许多点的线条，这在计算上变得非常昂贵，并可能导致浏览器冻结。使用便捷方法hold，我们可以控制何时启动渲染，如下所示：
with plot.hold(render=True): for line in lines: line.stream(new_points())
在这种情况下，我们仅在最后一个流之后渲染新附加的点。
- inner_height = Undefined#
- Type:
Readonly
这是绘图画布的确切高度，即实际绘图的高度，不包括工具栏等。请注意，这是在网页浏览器中计算的，因此此属性仅在能够进行双向通信的后端（服务器、笔记本）中有效。
注意
这是一个实验性功能，API可能在不久的将来发生变化。
- inner_width = Undefined#
- Type:
Readonly
这是绘图画布的确切宽度，即实际绘图的宽度，不包括工具栏等。请注意，这是在网络浏览器中计算的，因此此属性仅在能够进行双向通信的后端（服务器、笔记本）中有效。
注意
这是一个实验性功能，API 可能会在不久的将来发生变化。
- lod_timeout = 500#
- Type:
检查交互工具事件是否仍在发生的超时时间（以毫秒为单位）。一旦启用了细节层次模式，每
lod_timeout毫秒进行一次检查。如果没有发生交互工具事件，则禁用细节层次模式。
- margin = None#
-
允许在组件周围创建额外的空间。 元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距， 类似于CSS标准。 可以使用负边距值来缩小任何方向的空间。
- match_aspect = False#
- Type:
指定绘图的长宽比行为。长宽比定义为宽度与高度的比率。此属性控制Bokeh是否应尝试将数据空间的（宽度/高度）与屏幕空间的（宽度/高度）以像素为单位匹配。
默认是
False，表示数据的宽高比和屏幕的宽高比是独立变化的。True表示坐标轴的绘图宽高比将与坐标轴的像素范围的宽高比匹配。最终结果是，数据空间中的1x1区域在像素中是正方形，反之，1x1像素在数据单位中也是正方形。注意
此设置仅在存在两个数据范围时生效。此设置仅设置初始绘图绘制和后续重置。工具（单轴缩放、无约束框缩放）可能会改变宽高比。
警告
此设置与跨多个图表链接数据范围不兼容。这样做可能会导致未定义的行为。
- max_height = None#
- Type:
如果高度可调，组件的最大高度（以像素为单位）。
- max_width = None#
- Type:
如果宽度可调，组件的最大宽度（以像素为单位）。
- min_border_bottom = None#
-
中央绘图区域底部下方填充区域的最小像素大小。
注意
这是一个最小值。填充区域可以根据需要扩展以适应标题或轴等。
- min_border_right = None#
-
中央绘图区域右侧填充区域的最小像素大小。
注意
这是一个最小值。填充区域可能会根据需要扩展，以适应标题或轴等。
- min_height = None#
- Type:
如果高度可调，组件的最小高度（以像素为单位）。
- min_width = None#
- Type:
如果宽度可调，组件的最小宽度（以像素为单位）。
- 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#
- Type:
Readonly
这是布局的精确高度，即实际绘图的高度，包括工具栏等。请注意，这是在网络浏览器中计算的，因此此属性仅在能够进行双向通信的后端（服务器、笔记本）中有效。
注意
这是一个实验性功能，API 可能会在不久的将来发生变化。
- outer_width = Undefined#
- Type:
Readonly
这是布局的确切宽度，即实际绘图的高度，包括工具栏等。请注意，这是在网络浏览器中计算的，因此此属性仅适用于能够进行双向通信的后端（服务器、笔记本）。
注意
这是一个实验性功能，API 可能会在不久的将来发生变化。
- outline_line_dash = []#
- Type:
图表边框轮廓的虚线样式。
- output_backend = 'canvas'#
- Type:
指定绘图区域的输出后端。默认为HTML5 Canvas。
注意
当设置为
webgl时，没有WebGL渲染实现的字形将回退到2D画布上进行渲染。
- reset_policy = 'standard'#
- Type:
绘图在重置时应如何响应。默认情况下，标准操作是清除任何工具状态历史记录，将绘图范围恢复到其原始值，撤销所有选择，并发出一个
Reset事件。如果需要自定义，可以将此属性设置为"event_only"，这将抑制除Reset事件之外的所有操作。
- resizable = False#
- Type:
Either(Bool,Enum(Dimensions))
布局是否可交互调整大小，如果是，则在哪些维度上。
- sizing_mode = None#
- Type:
组件应如何调整自身大小。
这是一个用于维护组件宽度和高度的全局设置。要获得更精细的尺寸控制，请使用
width_policy、height_policy和aspect_ratio（这些设置优先于sizing_mode）。可能的场景：
"inherit"尺寸模式继承自父布局。如果没有父布局（或父布局不是布局），则此值被视为未提供
sizing_mode的值。"fixed"组件不具备响应性。无论浏览器窗口如何调整大小，它都将保持其原始的宽度和高度。
"stretch_width"组件将响应式地调整大小以拉伸到可用宽度，而不保持任何宽高比。组件的高度取决于组件的类型，可能是固定的或适应组件的内容。
"stretch_height"组件将响应式地调整大小以拉伸到可用高度，而不保持任何宽高比。组件的宽度取决于组件的类型，可能是固定的或适应组件的内容。
"stretch_both"组件完全响应，宽度和高度独立，并且将占据所有可用的水平和垂直空间，即使这会改变组件的宽高比。
"scale_width"组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的宽高比。
"scale_height"组件将响应式地调整大小以拉伸到可用高度，同时保持原始或提供的宽高比。
"scale_both"组件将根据可用的宽度和高度进行响应式调整大小，同时保持原始或提供的宽高比。
- stylesheets = []#
- Type:
用于底层DOM元素的附加样式表。
请注意，所有Bokeh的组件都使用影子DOM，因此任何包含的样式表都必须反映这一点，例如使用
:hostCSS伪选择器来访问根DOM元素。
- syncable = True#
- Type:
指示当在网页浏览器中更新时，此模型是否应同步回Bokeh服务器。设置为
False可能有助于在处理频繁更新的对象时减少网络流量，这些对象的更新值我们不需要。注意
将此属性设置为
False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。
- tags = []#
- Type:
一个可选的任意用户提供的值列表，用于附加到此模型。
在查询文档以检索特定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#
- Type:
组件的宽度（以像素为单位）。
这可以是固定宽度或首选宽度，取决于宽度调整策略。
- width_policy = 'auto'#
- Type:
描述组件应如何保持其宽度。
"auto"使用组件的首选尺寸策略。
"fixed"使用精确的
width像素。如果组件无法适应可用的水平空间，将会溢出。"fit"使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度范围内（如果已设置）适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。
"min"尽可能少地使用水平空间，但不少于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。
"max"尽可能使用水平空间，但不超过最大宽度（如果已设置）。 起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。
注意
这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用
sizing_mode。
- add_glyph(glyph: Glyph, **kwargs: Any) GlyphRenderer[source]#
- add_glyph(source: ColumnarDataSource, glyph: Glyph, **kwargs: Any) GlyphRenderer
向图表添加一个字形，并关联数据源和范围。
此函数将负责创建和配置一个Glyph对象，然后将其添加到绘图渲染器列表中。
- Parameters:
source (DataSource) – 所有字形使用的数据源
glyph (Glyph) – 要添加到绘图中的图形符号
- Keyword Arguments:
the (任何额外的关键字参数都会原封不动地传递给)
初始化器。 (Glyph)
- Returns:
字形渲染器
- add_layout(obj: Renderer, place: Literal['above', 'below', 'left', 'right', 'center'] = 'center') None[source]#
在指定位置向图表添加一个对象。
- add_tile(tile_source: TileSource | TileProvider | str, retina: bool = False, **kwargs: Any) TileRenderer[source]#
将新的
TileRenderer添加到Plot.renderers中- Parameters:
tile_source (TileSource, xyzservices.TileProvider, str) – 一个包含瓦片集配置的瓦片源实例
retina (bool) – 是否使用视网膜版本的图块（如果可用）
- Keyword Arguments:
renderer (额外的关键字参数会原样传递给 tile)
- Returns:
TileRenderer
- Return type:
- add_tools(*tools: 工具 | str) None[source]#
向图表添加工具。
- Parameters:
*tools (Tool) – 要添加到绘图中的工具
- Returns:
无
- apply_theme(property_values: dict[str, Any]) None#
应用一组主题值，这些值将用于替代默认值，但不会覆盖应用程序设置的值。
传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和
HasProps实例都不应修改它）。- Parameters:
property_values (dict) – 用于替换默认值的主题值
- Returns:
无
- classmethod clear_extensions() None#
清除当前定义的所有自定义扩展。
序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论是否被使用。此方法可用于清除所有现有的自定义扩展定义。
- classmethod descriptors() list[PropertyDescriptor[Any]]#
属性描述符的列表，按定义的顺序排列。
- equals(other: HasProps) bool#
模型的结构相等性。
- Parameters:
其他 (HasProps) – 要比较的其他实例
- Returns:
如果属性在结构上相等，则为True，否则为False
- hold(*, render: bool) Generator[None, None, None][源代码]#
负责在范围内打开和关闭属性。
- Parameters:
render (bool) – 打开或关闭属性 hold_render。
- js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) None#
使用JavaScript链接两个Bokeh模型属性。
这是一个便捷的方法，简化了添加一个
CustomJS回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。- Parameters:
在版本1.1中添加
- Raises:
示例
这段代码使用了
js_link:select.js_link('value', plot, 'sizing_mode')
等同于以下内容：
from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) )
此外，使用attr_selector将范围滑块的左侧附加到绘图的x_range：
range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)
这相当于：
from bokeh.models import CustomJS range_slider.js_on_change('value', CustomJS(args=dict(other=plot.x_range), code="other.start = this.value[0]" ) )
- js_on_change(event: str, *callbacks: JSChangeCallback) None#
将一个
CustomJS回调附加到任意的BokehJS模型事件。在BokehJS方面，模型属性的更改事件具有
"change:property_name"的形式。为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，那么它将自动加上"change:"前缀：# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
然而，除了属性更改事件之外，还有其他类型的事件可能对响应有用。例如，每当数据流式传输到
ColumnDataSource时运行回调，可以在源上使用"stream"事件：source.js_on_change('streaming', callback)
- classmethod lookup(name: str, *, raises: bool = True) PropertyDescriptor[Any] | None#
在类上找到Bokeh属性的
PropertyDescriptor，给定属性名称。- Parameters:
- Returns:
名为
name的属性的描述符- Return type:
- on_change(attr: str, *callbacks: PropertyCallback) None#
在此对象上添加一个回调，当
attr发生变化时触发。- Parameters:
attr (str) – 此对象上的一个属性名称
*callbacks (callable) – 要注册的回调函数
- Returns:
无
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None#
当此模型上发生指定事件时运行回调
并非所有模型都支持所有事件。 有关哪些模型能够触发特定事件的更多信息，请参见bokeh.events中的具体事件。
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]]#
收集此类的属性名称。
警告
在Bokeh的未来版本中，此方法将返回一个将属性名称映射到属性对象的字典。为了使当前使用此方法的方式具有未来兼容性，请将返回值包装在
list中。- Returns:
属性名称
- 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(*args, **kwargs)[source]#
查询此对象及其所有引用，以查找与给定选择器匹配的对象。
有几种不同的方式可以调用
select方法。 最常见的是提供一个类似JSON的查询字典作为 单个参数或作为关键字参数：- Parameters:
selector (JSON-like) – 一些示例文本
- Keyword Arguments:
kwargs – 查询字典键/值作为关键字参数
此外，为了与
Model.select兼容，可以将选择器字典作为selector关键字参数传递，在这种情况下，kwargs['selector']的值将用于查询。为了方便，可以通过提供
name字符串作为单一参数来进行仅针对名称的查询：- Parameters:
name (str) – 要查询的名称
也可以通过仅提供
Model子类作为单一参数来进行类型查询：- Parameters:
type (Model) – 要查询的类型
- Returns:
序列[模型]
示例
# 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
- Returns:
模型
- set_from_json(name: str, value: Any, *, setter: Setter | None = None) None#
从JSON设置此对象的属性值。
- Parameters:
name (str) – 要设置的属性名称
value (JSON-value) – 要设置给属性的值
setter (ClientSession 或 ServerSession 或 None, 可选) –
这用于防止对Bokeh应用程序的“回旋镖”更新。
在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在执行更新的会话进行注释。该值通过更新触发的任何后续更改通知传播。会话可以将事件设置器与自身进行比较，并抑制源自自身的任何更新。
- Returns:
无
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None#
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- Parameters:
selector (类似JSON的)
更新 (dict)
- Returns:
无
- themed_values() dict[str, Any] | None#
获取任何主题提供的覆盖。
结果以属性名称到值的字典形式返回，如果此实例没有主题覆盖任何值，则返回
None。- Returns:
字典或无
- to_serializable(serializer: Serializer) ObjectRefRep#
将此对象转换为可序列化的表示形式。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None#
- update(**kwargs: Any) None#
从给定的关键字参数更新对象的属性。
- Returns:
无
示例
以下是等价的：
from bokeh.models import Range1d r = Range1d # set properties individually: r.start = 10 r.end = 20 # update properties together: r.update(start=10, end=20)
- property legend#
可拆分的
Legend对象列表。