bokeh.document.events¶

提供表示Bokeh文档的各种更改的事件。

这些事件在内部用于通知文档的更改。有关面向用户（例如UI或工具）事件的信息，请参阅的参考 bokeh.events .

class ColumnDataChangedEvent(document, column_source, cols=None, setter=None, callback_invoker=None)[源代码]¶

代表有效替换的具体事件 all 的现有数据 ColumnDataSource

__init__(document, column_source, cols=None, setter=None, callback_invoker=None)[源代码]¶

参数

document (Document) -- 要更新的文件。
column_source (ColumnDataSource) --
cols (list[str]) -- 要更新的列名的可选显式列表。如果没有，将更新所有列（默认值：无）
setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。（默认值：无）请参见 DocumentChangedEvent 了解更多详细信息。
callback_invoker (callable, optional) -- 一个可调用的函数，它将调用应执行的任何模型回调，以响应触发此事件的更改。（默认值：无）

dispatch(receiver)[源代码]¶

将此事件的处理分派给接收者。

此方法将调用 receiver._column_data_changed 如果它存在的话。

generate(references, buffers)[源代码]¶

为这个事件创建一个适合发送给客户机的JSON表示。

{
    'kind'          : 'ColumnDataChanged'
    'column_source' : <reference to a CDS>
    'new'           : <new data to steam to column_source>
    'cols'          : <specific columns to update>
}

参数

references (dict[str, Model]) -- 如果事件需要引用某些模型才能正常工作，则可以在此处收集它们。 这是一个“out”参数 . 它包含的值将被就地修改。
buffers (set) -- 如果事件需要提供任何额外的Bokeh协议缓冲区，则可以将它们添加到此集合中。 这是一个“out”参数 . 它包含的值将被就地修改。

class ColumnsPatchedEvent(document, column_source, patches, setter=None, callback_invoker=None)[源代码]¶

表示有效地将数据修补程序应用到 ColumnDataSource

__init__(document, column_source, patches, setter=None, callback_invoker=None)[源代码]¶

参数

document (Document) -- 要更新的文件。
column_source (ColumnDataSource) -- 要应用修补程序的数据源。
patches (list) --
setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。（默认值：无）请参见 DocumentChangedEvent 了解更多详细信息。
callback_invoker (callable, optional) -- 一个可调用的函数，它将调用应执行的任何模型回调，以响应触发此事件的更改。（默认值：无）

dispatch(receiver)[源代码]¶

将此事件的处理分派给接收者。

此方法将调用 receiver._columns_patched 如果它存在的话。

generate(references, buffers)[源代码]¶

为这个事件创建一个适合发送给客户机的JSON表示。

{
    'kind'          : 'ColumnsPatched'
    'column_source' : <reference to a CDS>
    'patches'       : <patches to apply to column_source>
}

参数

references (dict[str, Model]) -- 如果事件需要引用某些模型才能正常工作，则可以在此处收集它们。 这是一个“out”参数 . 它包含的值将被就地修改。
buffers (set) -- 如果事件需要提供任何额外的Bokeh协议缓冲区，则可以将它们添加到此集合中。 这是一个“out”参数 . 它包含的值将被就地修改。

class ColumnsStreamedEvent(document, column_source, data, rollover, setter=None, callback_invoker=None)[源代码]¶

表示有效地将新数据流式传输到 ColumnDataSource

__init__(document, column_source, data, rollover, setter=None, callback_invoker=None)[源代码]¶

参数

document (Document) -- 要更新的文件。
column_source (ColumnDataSource) -- 要流式处理新数据的数据源。
data (dict or DataFrame) -- 新数据流。如果一个数据帧，将存储为 {{c: df[c] for c in df.columns}}
rollover (int) -- 翻车限制。如果数据源列超过此限制，则将放弃先前的值，以保持列长度低于该限制。
setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。（默认值：无）请参见 DocumentChangedEvent 了解更多详细信息。
callback_invoker (callable, optional) -- 一个可调用的函数，它将调用应执行的任何模型回调，以响应触发此事件的更改。（默认值：无）

dispatch(receiver)[源代码]¶

将此事件的处理分派给接收者。

此方法将调用 receiver._columns_streamed 如果它存在的话。

generate(references, buffers)[源代码]¶

为这个事件创建一个适合发送给客户机的JSON表示。

{
    'kind'          : 'ColumnsStreamed'
    'column_source' : <reference to a CDS>
    'data'          : <new data to steam to column_source>
    'rollover'      : <rollover limit>
}

参数

references (dict[str, Model]) -- 如果事件需要引用某些模型才能正常工作，则可以在此处收集它们。 这是一个“out”参数 . 它包含的值将被就地修改。
buffers (set) -- 如果事件需要提供任何额外的Bokeh协议缓冲区，则可以将它们添加到此集合中。 这是一个“out”参数 . 它包含的值将被就地修改。

class DocumentChangedEvent(document, setter=None, callback_invoker=None)[源代码]¶

表示对Bokeh文档的更改的所有内部事件的基类。

__init__(document, setter=None, callback_invoker=None)[源代码]¶

参数

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

combine(event)[源代码]¶

dispatch(receiver)[源代码]¶

将此事件的处理分派给接收者。

此方法将调用 receiver._document_changed 如果它存在的话。

class DocumentPatchedEvent(document, setter=None, callback_invoker=None)[源代码]¶

更新代表其基本事件和类的bo-keh属性。

dispatch(receiver)[源代码]¶

将此事件的处理分派给接收者。

此方法将调用 receiver._document_patched 如果它存在的话。

generate(references, buffers)[源代码]¶

为这个事件创建一个适合发送给客户机的JSON表示。

Sub-classes must implement this method.

参数

references (dict[str, Model]) -- 如果事件需要引用某些模型才能正常工作，则可以在此处收集它们。 这是一个“out”参数 . 它包含的值将被就地修改。
buffers (set) -- 如果事件需要提供任何额外的Bokeh协议缓冲区，则可以将它们添加到此集合中。 这是一个“out”参数 . 它包含的值将被就地修改。

class MessageSentEvent(document, msg_type: str, msg_data: Union[Any, bytes], setter=None, callback_invoker=None)[源代码]¶

dispatch(receiver)[源代码]¶

将此事件的处理分派给接收者。

此方法将调用 receiver._document_patched 如果它存在的话。

generate(references, buffers)[源代码]¶

为这个事件创建一个适合发送给客户机的JSON表示。

Sub-classes must implement this method.

参数

references (dict[str, Model]) -- 如果事件需要引用某些模型才能正常工作，则可以在此处收集它们。 这是一个“out”参数 . 它包含的值将被就地修改。
buffers (set) -- 如果事件需要提供任何额外的Bokeh协议缓冲区，则可以将它们添加到此集合中。 这是一个“out”参数 . 它包含的值将被就地修改。

class ModelChangedEvent(document, model, attr, old, new, serializable_new, hint=None, setter=None, callback_invoker=None)[源代码]¶

表示更新特定Bokeh模型的属性和值的具体事件。

这是更新大多数Bokeh模型属性的“标准”方法。对于可以优化的特殊套管情况（如流式输送等），a hint 可提供覆盖正常机制的。

__init__(document, model, attr, old, new, serializable_new, hint=None, setter=None, callback_invoker=None)[源代码]¶

参数

document (Document) -- 要更新的文件。
model (Model) -- 要更新的模型
attr (str) -- 要在模型上更新的属性的名称。
old (object) -- 属性的旧值
new (object) -- 属性的新值
serializable_new (object) -- 新值的序列化（JSON）版本。可能是吧 None 如果提供了提示。
hint (DocumentPatchedEvent, optional) -- 在适当的时候，可以提供一个辅助事件来修改正常的更新过程。例如，为了比标准更新机制更有效地传输或修补数据。
setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。（默认值：无）请参见 DocumentChangedEvent 了解更多详细信息。
callback_invoker (callable, optional) -- 一个可调用的函数，它将调用应执行的任何模型回调，以响应触发此事件的更改。（默认值：无）

combine(event)[源代码]¶

dispatch(receiver)[源代码]¶

将此事件的处理分派给接收者。

此方法将调用 receiver._document_model_changed 如果它存在的话。

generate(references, buffers)[源代码]¶

为这个事件创建一个适合发送给客户机的JSON表示。

参数

references (dict[str, Model]) -- 如果事件需要引用某些模型才能正常工作，则可以在此处收集它们。 这是一个“out”参数 . 它包含的值将被就地修改。
buffers (set) -- 如果事件需要提供任何额外的Bokeh协议缓冲区，则可以将它们添加到此集合中。 这是一个“out”参数 . 它包含的值将被就地修改。

class RootAddedEvent(document, model, setter=None, callback_invoker=None)[源代码]¶

表示将新模型添加到文档“根”模型集合的更改的具体事件。

__init__(document, model, setter=None, callback_invoker=None)[源代码]¶

参数

document (Document) -- 要更新的文件。
model (Model) -- 作为文档根添加的Bokeh模型。
setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。（默认值：无）请参见 DocumentChangedEvent 了解更多详细信息。
callback_invoker (callable, optional) -- 一个可调用的函数，它将调用应执行的任何模型回调，以响应触发此事件的更改。（默认值：无）

generate(references, buffers)[源代码]¶

为这个事件创建一个适合发送给客户机的JSON表示。

{
    'kind'  : 'RootAdded'
    'title' : <reference to a Model>
}

参数

references (dict[str, Model]) -- 如果事件需要引用某些模型才能正常工作，则可以在此处收集它们。 这是一个“out”参数 . 它包含的值将被就地修改。
buffers (set) -- 如果事件需要提供任何额外的Bokeh协议缓冲区，则可以将它们添加到此集合中。 这是一个“out”参数 . 它包含的值将被就地修改。

class RootRemovedEvent(document, model, setter=None, callback_invoker=None)[源代码]¶

表示从文档的“根”模型集合中移除现有模型的更改的具体事件。

__init__(document, model, setter=None, callback_invoker=None)[源代码]¶

参数

document (Document) -- 要更新的文件。
model (Model) -- 作为文档根移除的Bokeh模型。
setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。（默认值：无）请参见 DocumentChangedEvent 了解更多详细信息。
callback_invoker (callable, optional) -- 一个可调用的函数，它将调用应执行的任何模型回调，以响应触发此事件的更改。（默认值：无）

generate(references, buffers)[源代码]¶

为这个事件创建一个适合发送给客户机的JSON表示。

{
    'kind'  : 'RootRemoved'
    'title' : <reference to a Model>
}

参数

references (dict[str, Model]) -- 如果事件需要引用某些模型才能正常工作，则可以在此处收集它们。 这是一个“out”参数 . 它包含的值将被就地修改。
buffers (set) -- 如果事件需要提供任何额外的Bokeh协议缓冲区，则可以将它们添加到此集合中。 这是一个“out”参数 . 它包含的值将被就地修改。

class SessionCallbackAdded(document, callback)[源代码]¶

一个具体的事件，表示向文档中添加新回调的更改（例如周期性、超时或“下一个滴答声”）。

__init__(document, callback)[源代码]¶

参数

document (Document) -- 要更新的文件。
callback (SessionCallback) -- 要添加的回调

dispatch(receiver)[源代码]¶

将此事件的处理分派给接收者。

此方法将调用 receiver._session_callback_added 如果它存在的话。

class SessionCallbackRemoved(document, callback)[源代码]¶

一个具体的事件，表示从文档中删除现有回调（例如周期性、超时或“下一个滴答声”）的更改。

__init__(document, callback)[源代码]¶

参数

document (Document) -- 要更新的文件。
callback (SessionCallback) -- 要删除的回调

dispatch(receiver)[源代码]¶

将此事件的处理分派给接收者。

此方法将调用 receiver._session_callback_removed 如果它存在的话。

class TitleChangedEvent(document, title, setter=None, callback_invoker=None)[源代码]¶

一个具体的事件，代表对一个Bokeh文档标题的更改。

__init__(document, title, setter=None, callback_invoker=None)[源代码]¶

参数

document (Document) -- 要更新的文件。
title (str) -- 要在文档上设置的新标题
setter (ClientSession or ServerSession or None, optional) -- 这是用来防止“飞镖”更新到博克应用程序。（默认值：无）请参见 DocumentChangedEvent 了解更多详细信息。
callback_invoker (callable, optional) -- 一个可调用的函数，它将调用应执行的任何模型回调，以响应触发此事件的更改。（默认值：无）

combine(event)[源代码]¶

generate(references, buffers)[源代码]¶

为这个事件创建一个适合发送给客户机的JSON表示。

{
    'kind'  : 'TitleChanged'
    'title' : <new title to set>
}

参数

references (dict[str, Model]) -- 如果事件需要引用某些模型才能正常工作，则可以在此处收集它们。 这是一个“out”参数 . 它包含的值将被就地修改。
buffers (set) -- 如果事件需要提供任何额外的Bokeh协议缓冲区，则可以将它们添加到此集合中。 这是一个“out”参数 . 它包含的值将被就地修改。