bokeh.document¶

提供 Document クラスは，クライアントBoehJSライブラリのBokehモデルに反映されるコンテナである.

具体例として、その中に含まれる列レイアウトを考慮してください。 Slider そして Select 小さな部品、いくつかのツールを備えた描画、軸、メッシュ、および円の字形レンダラー。この文書の簡略化表示は、以下の図に示すことができる。

Bokeh文書は，Bokehモデル(たとえば，グラフ，ツール，字形など)の集合である.単一の集合に系列化することができる.¶

class Document(**kwargs)[ソース]¶

Bokeh直列化の基本単位。

文書インスタンス収集Bokehモデル(例えば，描画，レイアウト，小部品など)BokehJSクライアントの実行時に反映させることができるようにする.モデルは他のモデル(例えば、図)を参照することができるからである has レンダラリスト)は、単一のモデルをJSONに変換することは、通常、あまり役に立たないことや意味がない。だから、 Document したがって，Bokehの最小直列化ユニットである.

add_next_tick_callback(callback)[ソース]¶

イベントループの次の滴下で1回呼び出すコールバックを追加する.

パラメータ: callback (callable) -- 次の目盛りで実行されるコールバック関数。
戻り値: 一緒にご利用いただけます remove_next_tick_callback
戻り値の型: NextTickCallback

注釈

次に，TickコールバックはBokehサーバセッションのコンテキストでのみ動作する.Bokehが独立したHTMLやJupyterノートセルに出力された場合，この機能は機能しない.

add_periodic_callback(callback, period_milliseconds)[ソース]¶

セッションで定期的に呼び出すコールバックを追加します。

パラメータ

callback (callable) -- 定期的に実行されるコールバック関数
period_milliseconds (int) -- コールバック実行ごとのミリ秒数.

戻り値

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

add_timeout_callback(callback, timeout_milliseconds)[ソース]¶

指定タイムアウト後に1回コールバックを呼び出す.

パラメータ

callback (callable) -- タイムアウト後に実行されるコールバック関数
timeout_milliseconds (int) -- コールバック実行前のミリ秒数.

戻り値

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

戻り値

なし

apply_json_patch_string(patch)[ソース]¶

文字列形式で提供されるJSONパッチを適用する.

パラメータ: patch (str) --
戻り値: なし

clear()[ソース]¶

文書からすべての内容を削除するが，見出しはリセットしない.

戻り値: なし

delete_modules()[ソース]¶: この文書のセッションが破棄された場合には，その文書が作成したすべてのモジュールの後にクリーニングを行う.

classmethod from_json(json)[ソース]¶

JSONから文書をロードする.

JSON(json-data)：: 新しい文書を作成するための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 doc.hold(‘Combine’)Slider.value=10 Slider.value=11 Slider.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アプリケーションの“ブーメラン”の更新を阻止するためのものです。(デフォルト値：なし)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-data)：: この文書をカバーするJSON符号化文書.

戻り値: なし

select(selector)[ソース]¶

この文書では，所与のセレクタに一致するオブジェクトを問い合わせる.

パラメータ: selector (JSON-like query dictionary) -- you can query by type or by name, e.g. {"type": HoverTool}, {"name": "mycircle"}
戻り値: 配列番号. [模型]

select_one(selector)[ソース]¶

この文書では，所与のセレクタに一致するオブジェクトを問い合わせる.複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、オブジェクトが見つからない場合は、NONEを返します。

パラメータ: selector (JSON-like query dictionary) -- you can query by type or by name, e.g. {"type": HoverTool}, {"name": "mycircle"}
戻り値: モデルまたはなし

set_select(selector, updates)[ソース]¶

指定された属性/値を有する所与のセレクタに一致するオブジェクトが更新される。

パラメータ: selector (JSON-like query dictionary) -- you can query by type or by name,i e.g. {"type": HoverTool}, {"name": "mycircle"} updates (dict) :
戻り値: なし

to_json()[ソース]¶

この文書をJSONオブジェクトに変換する.

戻り値: JSONデータ

to_json_string(indent=None) → str [ソース]¶

文書をJSON文字列に変換する.

パラメータ: indent (int or None, optional) -- インデントするスペースの数は、すべての改行およびインデントをキャンセルするためにはありません(デフォルト値：なし)
戻り値: 応力.応力

unhold()[ソース]¶

収集されたすべてのイベントを保留して適用するすべてのアクティビティ文書を閉じます。

戻り値: なし

validate()[ソース]¶

本稿のプロファイル中のパターンに対して完全性チェックを行う.

戻り値: なし

property roots¶: 本稿では，すべてのルートモデルのリストを作成する.

property session_callbacks¶: この文書のすべてのセッションコールバックのリスト。

property session_context¶: ♪the SessionContext この書類です。

property session_destroyed_callbacks¶: このドキュメントのすべてのON_SESSION_DESTEREDコールバックのリストです。

property template¶: この文書を提示するためのJJIA 2テンプレート。

property template_variables¶: 提示時に渡すテンプレート変数の辞書 self.template それがそうです。

property theme¶

海流. Theme 事例は，本稿のプロファイルにおけるモデルに影響を与える.

これを None デフォルトのテーマを設定します。(すなわち、この属性は決して返さない None ()

トピックが任意のモデル属性を修正した場合、トピック変更は、文書中のモデル上でモデル変更イベントをトリガする可能性がある。

property title¶

この文書のタイトル。

このタイトルは、独立したHTML文書上に設定されるが、例えば、設定されない。 autoload_server 全部使っています。

サブコマンドごとの情報は，左側の木を閲覧してください.