dialogs#

各种类型的对话框。

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

基类：UIElement

用于 UI 元素的浮动、可移动和可调整大小的容器。

注意

此模型及其所有属性均处于实验阶段，可能会随时更改。

JSON 原型
{
  "bottom_limit": null, 
  "closable": true, 
  "close_action": "destroy", 
  "collapsible": true, 
  "content": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "id": "p63804", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "left_limit": null, 
  "maximizable": true, 
  "minimizable": true, 
  "movable": "both", 
  "name": null, 
  "pinnable": true, 
  "resizable": "all", 
  "right_limit": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "symmetric": false, 
  "syncable": true, 
  "tags": [], 
  "title": null, 
  "top_limit": null, 
  "visible": true
}
bottom_limit = None#
类型:

Nullable(Instance(Node))

可选的底部移动或调整大小限制。

与 top_limit、left_limit 和 right_limit 共同形成此对话框移动和调整大小的边界框。

closable = True#
类型:

布尔值

确定是否允许关闭对话框。

属性 close_action 确定关闭对话框时会发生什么。请注意，即使对话框无法通过 UI 关闭，它也可以通过编程方式关闭。

close_action = 'destroy'#
类型:

Enum(Enumeration(hide, destroy))

确定关闭对话框时的操作。

选项是

  • "hide" - 从 DOM 中移除对话框，但保持其

    视图“存活”，以便它可以再次打开。

  • "destroy" - 销毁相关的视图和它存储的

    状态。需要使用新的状态重新构建对话框才能再次打开。

collapsible = True#
类型:

布尔值

确定是否允许折叠对话框。

折叠的对话框只显示其标题，而其内容隐藏在视图之外。这允许在保持对话框打开的同时更好地访问其下面的 UI。

注意

可以通过滚动对话框标题将其折叠。

content = Undefined#
类型:

Required(Either(String, Instance(DOMNode), Instance(UIElement)))

此对话框的内容。

这可以是纯文本字符串、DOM 节点、UI 元素或布局。

context_menu = None#
类型:

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

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

注意

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

css_classes = []#
类型:

列表

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

css_variables = {}#
类型:

Dict(String, Instance(Node))

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

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

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

注意

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

left_limit = None#
类型:

Nullable(Instance(Node))

可选的左侧移动或调整大小限制。

与 top_limit、bottom_limit 和 right_limit 一起，它形成了该对话框移动和调整大小的边界框。

maximizable = True#
类型:

布尔值

确定是否允许最大化对话框。

最大化的对话框会覆盖整个视窗区域。多个对话框可以同时最大化，但一次只有一个对话框会在视窗顶部。

minimizable = True#
类型:

布尔值

确定是否允许最小化对话框。

最小化对话框意味着折叠它并将其移动到视窗左下角的指定“最小化”区域。

movable = 'both'#
类型:

Enum(Movable)

确定对话框是否可以移动，以及可以移动到哪些方向。

name = None#
类型:

Nullable(String)

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

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

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

注意

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

pinnable = True#
类型:

布尔值

确定是否允许固定对话框。

固定的对话框始终保持在其他对话框的顶部。固定一个对话框会取消固定任何其他对话框。

resizable = 'all'#
类型:

Enum(Resizable)

确定对话框是否可以调整大小，以及可以调整到哪些方向。

right_limit = None#
类型:

Nullable(Instance(Node))

可选的右侧移动或调整大小限制。

与 top_limit、bottom_limit 和 left_limit 一起，它形成了该对话框移动和调整大小的边界框。

styles = {}#
类型:

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

应用于基础 DOM 元素的内联 CSS 样式。

stylesheets = []#
类型:

列表

要用于基础 DOM 元素的其他样式表。

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

symmetric = False#
类型:

布尔值

确定调整一个边缘或角点是否会影响相对的边缘或角点。

syncable = True#
类型:

布尔值

指示此模型是否应在网页浏览器中更新时同步回 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 也不会出于任何原因直接使用这些标签。

title = None#
类型:

Nullable(Either(String, Instance(DOMNode), Instance(UIElement)))

对话框的标题。

这可以是纯文本字符串、DOM 节点、UI 元素或布局。

top_limit = None#
类型:

Nullable(Instance(Node))

可选的顶部移动或调整大小限制。

与 bottom_limit、left_limit 和 right_limit 一起，它形成了该对话框移动和调整大小的边界框。

visible = True#
类型:

布尔值

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

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

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

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

参数:

property_values (dict) – 用作默认值的主题值

返回值:

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发：

ValueError –

示例

这段代码使用 js_link

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

等效于以下代码

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

此外，要使用 attr_selector 将范围滑块的左侧连接到图表的 x_range

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

等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)
js_on_change(event: str, *callbacks: JSChangeCallback) → None#

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

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

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

但是，除了属性更改事件之外，还有其他一些事件可以用来响应。例如，要运行一个回调，以在数据流式传输到 ColumnDataSource 时运行，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)
classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None#

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

参数:

  • name (str) – 要查找的属性的名称

  • raises (bool) – 如果丢失，是否引发或返回 None

返回值:

名为 name 的属性的描述符

返回类型：

PropertyDescriptor

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

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

参数:

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

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

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None#

在该模型上发生指定事件时运行回调

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

classmethod parameters() → list[Parameter]#

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

返回值:

list(Parameter)

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

收集此类上的属性名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型：

set[str]

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

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

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

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

参数:

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

返回值:

属性名称到其值的映射

返回类型：

dict

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

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

参数:

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

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

返回值:

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

返回类型：

dict

references() → set[Model]#

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

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

从此对象中移除回调。

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

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None#

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

返回值:

Model

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

使用 JSON 设置此对象的属性值。

参数:

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

  • json – (JSON-value) : 要设置为属性的值

  • models (dict or None, optional) –

    模型 ID 到模型的映射 (默认: None)

    这在需要更新的属性也具有包含引用的值的场景中是必需的。

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

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

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

返回值:

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）

在此页面上