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) -- 更新するBokeh文書。

  • column_source (ColumnDataSource) --

  • cols (list[str]) -- 更新されるオプションの明示的な名前リスト。Noneであれば、すべての列(デフォルト値：None)が更新されます。

  • setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。(デフォルト値：なし)参照 DocumentChangedEvent もっと細かいことを知っています。

  • callback_invoker (callable, optional) -- 1つのCallableは、このイベントの変更をトリガするために実行すべきModelコールバックを呼び出す。(デフォルト値：なし)

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) -- 更新するBokeh文書。

  • column_source (ColumnDataSource) -- パッチのデータソースを適用しなければならない.

  • patches (list) --

  • setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。(デフォルト値：なし)参照 DocumentChangedEvent もっと細かいことを知っています。

  • callback_invoker (callable, optional) -- 1つのCallableは、このイベントの変更をトリガするために実行すべきModelコールバックを呼び出す。(デフォルト値：なし)

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) -- 更新するBokeh文書。

  • column_source (ColumnDataSource) -- 新しいデータをストリーミングするデータソース。

  • data (dict or DataFrame) -- ストリーミングの新しいデータが必要です。DataFrameであれば，これを格納する. {{c: df[c] for c in df.columns}}

  • rollover (int) -- スクロール制限。データソース列がこの制限を超える場合、列長をこの制限以下に維持するために、より早い値が破棄される。

  • setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。(デフォルト値：なし)参照 DocumentChangedEvent もっと細かいことを知っています。

  • callback_invoker (callable, optional) -- 1つのCallableは、このイベントの変更をトリガするために実行すべきModelコールバックを呼び出す。(デフォルト値：なし)

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) -- 更新するBokeh文書。

  • setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。(デフォルト値：なし)Bokehサーバアプリケーションのコンテキストでは、入力された属性更新は、更新を実行するセッションを使用して注釈される。この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

  • callback_invoker (callable, optional) -- 1つのCallableは、このイベントの変更をトリガするために実行すべきModelコールバックを呼び出す。(デフォルト値：なし)

combine(event)[ソース]
dispatch(receiver)[ソース]

このイベントの処理を受信側にスケジューリングする.

この方法は呼び出されます receiver._document_changed もしそれが存在すれば。

class DocumentPatchedEvent(document, setter=None, callback_invoker=None)[ソース]

Bokehモデルとその属性を更新するイベントの基底クラスを表す.

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モデル属性を更新する“標準”方式である.最適化可能な特別な場合(例えば、ストリームなど)については、 hint 通常のメカニズムをカバーすることができます

__init__(document, model, attr, old, new, serializable_new, hint=None, setter=None, callback_invoker=None)[ソース]
パラメータ

  • document (Document) -- 更新するBokeh文書。

  • model (Model) -- 更新するモデル

  • attr (str) -- モデル上で新しい属性の名前を更新しなければならない.

  • old (object) -- 属性の旧値

  • new (object) -- 属性の新しい値

  • serializable_new (object) -- 新しい値の直列化(JSON)バージョン。そのせいかもしれない None もしヒントが提供されたら。

  • hint (DocumentPatchedEvent, optional) -- 適切な場合には、通常の更新プロセスを修正する二次イベントを提供することができる。例えば、標準更新機構よりも効率的にデータをストリーミングまたは修復するために使用される。

  • setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。(デフォルト値：なし)参照 DocumentChangedEvent もっと細かいことを知っています。

  • callback_invoker (callable, optional) -- 1つのCallableは、このイベントの変更をトリガするために実行すべきModelコールバックを呼び出す。(デフォルト値：なし)

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) -- 更新するBokeh文書。

  • model (Model) -- 文書根のBokehモデルに追加する.

  • setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。(デフォルト値：なし)参照 DocumentChangedEvent もっと細かいことを知っています。

  • callback_invoker (callable, optional) -- 1つのCallableは、このイベントの変更をトリガするために実行すべきModelコールバックを呼び出す。(デフォルト値：なし)

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) -- 更新するBokeh文書。

  • model (Model) -- 文書根削除のBokehモデルとする.

  • setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。(デフォルト値：なし)参照 DocumentChangedEvent もっと細かいことを知っています。

  • callback_invoker (callable, optional) -- 1つのCallableは、このイベントの変更をトリガするために実行すべきModelコールバックを呼び出す。(デフォルト値：なし)

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)[ソース]
パラメータ
dispatch(receiver)[ソース]

このイベントの処理を受信側にスケジューリングする.

この方法は呼び出されます receiver._session_callback_added もしそれが存在すれば。

class SessionCallbackRemoved(document, callback)[ソース]

既存のコールバック(例えば、周期性、タイムアウト、または“次の滴下”)を文書から削除する変更を表す特定のイベント。

__init__(document, callback)[ソース]
パラメータ
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) -- 更新するBokeh文書。

  • title (str) -- 文書に設定する新しい見出し

  • setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。(デフォルト値：なし)参照 DocumentChangedEvent もっと細かいことを知っています。

  • callback_invoker (callable, optional) -- 1つのCallableは、このイベントの変更をトリガするために実行すべきModelコールバックを呼び出す。(デフォルト値：なし)

combine(event)[ソース]
generate(references, buffers)[ソース]

クライアントに送信するのに適したこのイベントのJSON表現を作成する.

{
    'kind'  : 'TitleChanged'
    'title' : <new title to set>
}
パラメータ

  • references (dict[str, Model]) -- イベントが実行するためにはいくつかのモデルを参照する必要があれば，ここでそれらを収集することができる. これは“out”パラメータです それがそうです。それに含まれる値はその場で修正されるだろう。

  • buffers (set) -- イベントが任意の追加のBokehプロトコルバッファを提供する必要がある場合、それらをこのセットに追加することができる。 これは“out”パラメータです それがそうです。それに含まれる値はその場で修正されるだろう。