bokeh.document

提供 Document 类，它是一个容器，用于将Bokeh模型反射到客户端BokehJS库。

作为一个具体的例子，考虑一个列布局 Slider 和 Select 小部件，一个带有一些工具的绘图，一个轴和网格，以及一个圆的字形渲染器。此文档的简化表示可能如下图所示：

Bokeh文档是Bokeh模型（例如绘图、工具、glyphs等）的集合，可以序列化为单个集合。

class Document(**kwargs)

Bokeh序列化的基本单位。

文档实例收集Bokeh模型（例如，绘图、布局、小部件等），以便将它们反映到BokehJS客户端运行时中。因为模型可能会引用其他模型（例如，图 has 一个呈现器列表），将单个模型转换为JSON通常没有用处或意义。因此 Document 因此是Bokeh的最小序列化单元。

add_next_tick_callback(callback)

添加在事件循环的下一个滴答声时调用的回调。

参数

callback (callable) -- 一个回调函数，在下一个刻度上执行。

返回

can be used with remove_next_tick_callback

返回类型

NextTickCallback

注解

Next tick回调只在Bokeh服务器会话的上下文中工作。当Bokeh输出到独立的HTML或Jupyter笔记本单元格时，此函数将不起作用。

add_periodic_callback(callback, period_milliseconds)

添加要定期在会话上调用的回调。

参数

• callback (callable) -- 定期执行的回调函数

• period_milliseconds (int) -- 每次回调执行之间的毫秒数。

返回

can be used with remove_periodic_callback

返回类型

PeriodicCallback

注解

定期回调只能在Bokeh服务器会话的上下文中工作。当Bokeh输出到独立的HTML或Jupyter笔记本单元格时，此函数将不起作用。

add_root(model, setter=None)

添加模型作为此文档的根目录。

对此模型（包括它引用的其他模型）的任何更改都将触发 on_change 在此文档上注册的回调。

参数

• model (Model) -- 要作为此文档的根添加的模型。

• setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。（默认值：无）在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较，并禁止任何源自自身的更新。

add_timeout_callback(callback, timeout_milliseconds)

添加要在指定超时后调用一次的回调。

参数

• callback (callable) -- 超时后执行的回调函数

• timeout_milliseconds (int) -- 执行回调之前的毫秒数。

返回

can be used with remove_timeout_callback

返回类型

TimeoutCallback

注解

超时回调只能在Bokeh服务器会话的上下文中工作。当Bokeh输出到独立的HTML或Jupyter笔记本单元格时，此函数将不起作用。

apply_json_patch(patch, setter=None)

应用一个JSON补丁对象并处理所有产生的事件。

参数

• patch (JSON-data) -- 包含要应用的修补程序的JSON对象。

• setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。（默认值：无）在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较，并禁止任何源自自身的更新。

返回

没有

apply_json_patch_string(patch)

应用以字符串形式提供的JSON修补程序。

参数

patch (str) --

返回

没有

clear()

从文档中删除所有内容，但不要重置标题。

返回

没有

delete_modules()

当任何文档在该会话后被销毁时。

classmethod from_json(json)

从JSON加载文档。

json（json数据）：

要从中创建新文档的JSON编码文档。

返回

返回类型

Document

classmethod from_json_string(json)

从JSON加载文档。

json（str）：

一个字符串，其中包含要从中创建新文档的JSON编码文档。

返回

返回类型

Document

get_model_by_id(model_id)

在本文档中查找给定ID的模型，或 None 如果找不到。

参数

model_id (str) -- 要搜索的模型的ID

返回

型号或无

get_model_by_name(name)

在本文档中查找给定名称的模型，或 None 如果找不到。

参数

name (str) -- 要搜索的模型的名称

返回

型号或无

hold(policy='combine')

激活文档保留。

当保持处于活动状态时，不会应用模型更改，也不会触发回调。一次 unhold 调用时，将根据保留策略应用保留期间收集的事件。

参数

hold ('combine' or 'collect', optional) -- 当设置为时，是否应尝试合并在保留期间收集的事件（默认为：“combine”） 'collect' 当所有事件按顺序重新播放时 unhold 被称为。设置为时 'combine' Bokeh将尝试将兼容的事件组合在一起。通常，可以合并在同一模式下更改相同属性的不同事件。例如，如果发生以下顺序：。。代码块：：python文件保留（“合并”）滑块.value=10滑块.value=11滑块.value=12则仅此 one 回拨，最后一次 slider.value = 12 将被触发。

返回

没有

注解

hold 仅适用于文档更改事件，即在模型上设置属性。它不适用于诸如 ButtonClick 等。

on_change(*callbacks)

提供在文档或可从其根访问的任何模型发生更改时调用的回调。

on_event(event, *callbacks)

提供在接收到bokeh事件时调用的回调。

on_session_destroyed(*callbacks)

提供在服务于文档的会话被破坏时调用的回调

remove_next_tick_callback(callback_obj)

删除先前添加的回调 add_next_tick_callback .

参数

callback_obj -- 从返回的值 add_next_tick_callback

返回

没有

引发

ValueError, if the callback was never added or has already been run or removed --

remove_on_change(*callbacks)

删除先前添加的回调 on_change .

引发

KeyError, if the callback was never added --

remove_periodic_callback(callback_obj)

删除先前添加的回调 add_periodic_callback

参数

callback_obj -- 从返回的值 add_periodic_callback

返回

没有

引发

ValueError, if the callback was never added or has already been removed --

remove_root(model, setter=None)

从此文档中删除作为根模型的模型。

对此模型的更改可能仍会触发 on_change 如果模型仍被其他根模型引用，则对此文档的回调。

参数

• model (Model) -- 要作为此文档的根添加的模型。

• setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。（默认值：无）在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在进行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置程序与其自身进行比较，并禁止任何源自自身的更新。

remove_timeout_callback(callback_obj)

删除先前添加的回调 add_timeout_callback .

参数

callback_obj -- 从返回的值 add_timeout_callback

返回

没有

引发

ValueError, if the callback was never added or has already been run or removed --

replace_with_json(json)

用JSON编码的文档覆盖此文档中的所有内容。

json（json数据）：

一个JSON编码的文档来覆盖这个文档。

返回

没有

select(selector)

在此文档中查询与给定选择器匹配的对象。

参数

selector (JSON-like query dictionary) -- 您可以按类型或名称进行查询，例如。 {{"type": HoverTool}} ， {{"name": "mycircle"}}

返回

SEQ [模型]

select_one(selector)

在此文档中查询与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果找不到任何对象，则返回无

参数

selector (JSON-like query dictionary) -- 您可以按类型或名称进行查询，例如。 {{"type": HoverTool}} ， {{"name": "mycircle"}}

返回

型号或无

set_select(selector, updates)

更新与具有指定属性/值的给定选择器匹配的对象将更新。

参数

selector (JSON-like query dictionary) -- 您可以按类型或名称进行查询，例如。 {{"type": HoverTool}} ， {{"name": "mycircle"}} 更新（dict）：

返回

没有

to_json()

将此文档转换为JSON对象。

返回

JSON数据

to_json_string(indent=None) → str

将文档转换为JSON字符串。

参数

indent (int or None, optional) -- 要缩进的空格数，或不显示所有换行符和缩进（默认值：无）

返回

STR

unhold()

关闭任何活动文档保留并应用所有收集的事件。

返回

没有

validate()

对本文档中的模式执行完整性检查。

返回

没有

property roots

此文档中所有根模型的列表。

property session_callbacks

此文档上所有会话回调的列表。

property session_context

这个 SessionContext 对于本文件。

property session_destroyed_callbacks

此文档上所有已销毁的on-unu session回调的列表。

property template

用于呈现此文档的Jinja2模板。

property template_variables

在呈现变量时传递模板字典 self.template .

property theme

The current Theme instance affecting models in this Document.

设置为 None 设置默认主题。（即该财产永远不会归还 None ）

如果主题修改了任何模型属性，更改主题可能会触发文档中模型上的模型更改事件。

property title

此文档的标题。

此标题将在独立的HTML文档上设置，但不包括 autoload_server 使用。

导航左侧的树以获取有关每个子命令的信息。

• bokeh.document.document
• bokeh.document.events
• bokeh.document.locking
• bokeh.document.util