对话框

各种类型的对话框。

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

基类: 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"
  }, 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "id": "p66285", 
  "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(枚举(hide, destroy))

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

选项包括

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

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

• "destroy" - 销毁关联的视图及其状态

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

collapsible = True

类型:

布尔值

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

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

注意

可以通过在其标题上滚动来折叠对话框。

content = Undefined

类型:

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

此对话框的内容。

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

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(枚举(auto))))

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

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

注意

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

css_classes = []

类型:

列表

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

css_variables = {}

类型:

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

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

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

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

注意

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

html_attributes = {}

类型:

Dict(String, String)

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

html_id = None

类型:

Nullable(String)

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

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

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.scatter([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

类型:

布尔值

指示此模型在 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 = 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

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回:

`DataSpec` 属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型结构相等性。

参数:

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

返回:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

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

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

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

source.js_on_change('streaming', callback)

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

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

参数:

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

• raises (bool) – 如果缺失，是引发异常还是返回 None

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回:

None

示例

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

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

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

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

classmethod parameters() → list[Parameter]

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

返回:

list(Parameter)

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

收集此类上的属性名称。

警告

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

返回:

属性名称

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

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

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

返回:

具有引用的属性的名称

返回类型:

set[str]

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

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

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

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

参数:

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

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

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

返回:

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

返回类型:

dict

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类 JSON)

返回:

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

返回:

None

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

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

参数:

• selector (类 JSON)

• updates (dict)

返回:

None

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

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

结果作为从属性名称到值的字典返回，如果主题未覆盖此实例的任何值，则返回 None。

返回:

dict or 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）