bokeh.models.tools¶

Bokehには多くのインタラクティブなツールが付属している。

5種類のツール相互作用があります

平行移動/ドラッグ

クリック/クリック

スクロール/収縮

行くぞ！

検査員.

最初の3つはジェスチャーツールのカテゴリを含み、各ジェスチャは任意の所与の時間に1つのツールのみがアクティブ状態にある。ツールバー上のアクティブツールは，そのツールの横のハイライト表示によって指示される.操作は、ツールバーのボタンが押下されたときにのみ起動される即時またはモード操作である。チェッカは、何らかの方法で情報を報告したり、描画を注釈したりするだけであり、現在どの他のツールがアクティブ状態にあるかにかかわらず、チェッカは常にアクティブ状態にある可能性がある受動的なツールである。

class Action(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Tool

ツールの基本クラス，これらのツールはツールバーのボタンである.

注釈

これは，Bokehモデルタイプの階層構造の組織を支援するための抽象基底クラスである. 単独インスタンス化は無駄である.

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "id": "16198",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class BoxEditTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.EditTool, bokeh.models.tools.Drag, bokeh.models.tools.Tap

ツールバーアイコン ：

描画、ドラッグ、削除を可能にする Rect 1つ以上のレンダラー上のフォント、方法が編集ベース ColumnDataSource データです。他の描画ツールと同様に、編集するレンダラは、リスト形式で明示的に提供されなければならない。新しいボックスを描画する場合、データは常に追加されます ColumnDataSource 最初に提供されたレンダラーで。

The tool will modify the columns on the data source corresponding to the x, y, width and height values of the glyph. Any additional columns in the data source will be padded with empty_value, when adding a new box.

サポートする操作には，

追加枠：Shiftキーを押し、描画上の任意の位置でクリックしてドラッグしたり、一度クリックして描画を開始したり、マウスを移動させて再びダブルクリックして描画を完了します。
移動ブロック：既存のブロックをクリックしてドラッグし、マウスボタンを離すと、ブロックは破棄されます。
削除ボックス：1つのボックスをクリックして選択し、マウスが描画領域にあるときに<<backspace>>ボタンを押します。

至る Move あるいは…。削除一度に複数の箱：

選択内容の移動：<<Shift>>を押しながらクリック(または他の選択ツール)選択ボックスをクリックし，描画上の任意の位置にドラッグする.特定のボックスを選択してドラッグすると、2つのボックスが同時に移動します。
選択内容の削除：<<Shift>>+Tap(または他の選択ツール)を用いてボックスを選択し，マウスが描画領域内にあるときに<<Backspace>>を押す.

custom_icon¶

属性タイプ： Image

ツールバーに表示されるアイコン。

このアイコンは、画像の文字列ファイル名、PILとして提供することができます Image オブジェクトまたはRGB(A)NumPy配列.

custom_tooltip¶

属性タイプ： String

デフォルト名を代替するためのカスタムツールは、タグを提示します。

dimensions¶

属性タイプ： Enum () Dimensions ）

ブロック図は、どのサイズに自由に配置されるであろうか。デフォルトの場合、ユーザは任意のサイズのブロックを自由に描画することができる。幅のみが設定されている場合、枠は、描画された垂直空間全体にわたって制限され、水平サイズしか制御できない。高さのみが設定されている場合、枠は、描画全体にわたる水平空間に制限され、垂直サイズは制御されてもよい。

empty_value¶

property type: Either ( Bool , Int , Float , Date , Datetime , Color , String )

属性に新しい字形を挿入する際には，非座標列に挿入する値を定義する. ColumnDataSource 列は、例えば、円形字形が“x”、“y”、“color”列を定義する場合、新たな点を追加すると“x”および“y”の列にxおよびy座標が追加され、色列は定義されたヌル値で満たされる。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

num_objects¶

属性タイプ： Int

描画可能な枠数制約を定義する.デフォルトでは、オブジェクトの数に制限はありませんが、有効になった場合、追加する新しいボックスのための空間を作るために、最も古い描画ボックスが削除されます。

renderers¶

属性タイプ： List () Instance () Renderer ））

編集可能な分散フォントに対応する明示的レンダラリスト。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "custom_icon": null,
  "custom_tooltip": null,
  "dimensions": "both",
  "empty_value": null,
  "id": "16204",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_objects": 0,
  "renderers": [],
  "subscribed_events": [],
  "tags": []
}

class BoxSelectTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Drag, bokeh.models.tools.SelectTool

ツールバーアイコン ：

ボックス選択ツールは、ユーザが描画領域上でマウスや指をドラッグして矩形領域を表示することにより、描画上で選択することができる。ドラッグイベントが終了すると、選択領域が完了したことを示します。

見選定された字形の選定と取り消し設定選定と未選定字形パターンに関する情報。

dimensions¶

属性タイプ： Enum () Dimensions ）

ボックス選択はどの次元で自由に選択するか.デフォルトの場合、ユーザは任意のサイズの選択ボックスを自由に描画することができます。幅のみが設定されている場合、枠は、描画された垂直空間全体にわたって制限され、水平サイズしか制御できない。高さのみが設定されている場合、枠は、描画全体にわたる水平空間に制限され、垂直サイズは制御されてもよい。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

mode¶

属性タイプ： Enum () SelectionMode ）

新たな選択を行う際に実行すべき操作を定義する.デフォルトの場合、既存の選択を置き換える。他のオプションは、選挙区に追加されるか、選挙区と交差するか、またはそこから減算されること

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

names¶

属性タイプ： List () String ）

検索したい名前リストです。設定されている場合、それに一致する値のみを有するレンダラー name 属性が使用される。

origin¶

属性タイプ： Enum (角·中心)

矩形選択領域がブロックの角(左上または右下、方向に依存)から開始されるべきか、中心から開始されるべきかを示す。

overlay¶

属性タイプ： Instance () BoxAnnotation ）

選択領域を指示するために描画されたシャドウアノテーション。

renderers¶

property type: Either ( Auto , List ( Instance ( Renderer ) ) )

これをテストする明示的レンダラーリスト。設定されていない場合は、デフォルトで描画上のすべてのレンダラーとする。

select_every_mousemove¶

属性タイプ： Bool

選択計算はマウスイベントごとに行うべきか，選択領域が完了したときに1回のみ行うべきか.デフォルト値：False

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "dimensions": "both",
  "id": "16216",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "mode": "replace",
  "name": null,
  "names": [],
  "origin": "corner",
  "overlay": {
    "id": "16217"
  },
  "renderers": "auto",
  "select_every_mousemove": false,
  "subscribed_events": [],
  "tags": []
}

class BoxZoomTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Drag

ツールバーアイコン ：

枠縮小ツールは、ユーザが描画領域上でマウスや指をドラッグすることにより、格納する描画の矩形領域を定義することができる。ドラッグイベントが終了すると、選択領域が完了したことを示します。

注釈

BoxZoomTool 互換性がない GMapPlot Googleマップはアスペクト比を明示的に制御しているためですこのツールを追加して GMapPlot 何の効果もありません。

dimensions¶

属性タイプ： Enum () Dimensions ）

スケーリング枠はどの次元で自由に使用されるか.デフォルトの場合、ユーザは任意のサイズの縮小枠を自由に描画することができる。“Width”のみが提供される場合、枠は、描画された垂直空間全体にわたって制限され、水平サイズしか制御できない。高さのみが提供される場合、枠は、描画された水平空間全体にわたって制限され、垂直サイズは制御されてもよい。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

match_aspect¶

属性タイプ： Bool

枠縮小領域は、描画領域と同じアスペクト比に制限すべきか否か。

注釈

ツールが1つの次元に限定されている場合、その値は機能しない。

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

origin¶

属性タイプ： Enum (角·中心)

矩形スケーリング領域がブロックの角(左上または右下、方向に依存)から開始すべきか、中心から開始されるべきかを示す。

overlay¶

属性タイプ： Instance () BoxAnnotation ）

選択領域を指示するために描画されたシャドウアノテーション。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "dimensions": "both",
  "id": "16230",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "match_aspect": false,
  "name": null,
  "origin": "corner",
  "overlay": {
    "id": "16231"
  },
  "subscribed_events": [],
  "tags": []
}

class CrosshairTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Inspection

ツールバーアイコン ：

十字準線ツールは受動的な検査ツールである。通常は開いている状態ですが、関連する検査員メニューで構成することができます ツールバーアイコン 上の図に示すように。

照準線ツールは，描画上方に現在のマウス位置を中心に照準線アノテーションを描画する.十字準線ツールを1次元でのみ描画するように構成することができ、方法は設定である dimension プロパティはOnlyに設定します width あるいは…。 height それがそうです。

dimensions¶

属性タイプ： Enum () Dimensions ）

十字準線ツールは追跡するサイズです。デフォルトの場合、垂直線と水平線が同時に描画されます。“Width”のみが設けられている場合には、水平ラインのみが描画される。“高さ”のみを提供する場合は、垂直線のみが描かれる。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

line_alpha¶

属性タイプ： Float

エッジ経路を描画するためのAlpha値.

許容可能な値は、0(透明)と1(不透明)との間の浮動小数点数である。

line_color¶

属性タイプ： Color

エッジパスの色を描くために用いられる.

許容可能な値は、以下のことを含む。

any of the 147 named CSS colors, e.g 'green', 'indigo'
an RGB(A) hex value, e.g., '#FF0000', '#44444444'
0と255の間の3元整数(r，g，b)
(r，g，b，a)の4タプル(式中、r，g，bは0..255間の整数であり、aは0..1間の整数である。

line_width¶

属性タイプ： Float

ストローク幅(画素単位).

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

toggleable¶

属性タイプ： Bool

この検査ツールのツールバーにはスイッチ/懸念スイッチが表示されるべきかどうかをチェックする.もし False この場合，描画ビューアはツールバーを用いてチェッカを開閉することができなくなる.

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "dimensions": "both",
  "id": "16241",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "line_alpha": 1.0,
  "line_color": "black",
  "line_width": 1,
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "toggleable": true
}

class CustomAction(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Action

カスタマイズ操作を実行し、例えば CustomJS ツールバーアイコンがアクティブになったときのコールバック.

例を引く

tool = CustomAction(icon="icon.png",
                    callback=CustomJS(code='alert("foo")'))

plot.add_tools(tool)

action_tooltip¶

属性タイプ： String

カスタマイズ操作アイコン上にマウスをホバリングしたときに表示されるツール提示.

callback¶

属性タイプ： Instance () Callback ）

カスタム操作アイコンを起動する際に実行するBokehコール.

icon¶

属性タイプ： Image

ツールバーに表示されるアイコン。

このアイコンは、画像の文字列ファイル名、PILとして提供することができます Image オブジェクトまたはRGB(A)NumPy配列.

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "action_tooltip": "Perform a Custom Action",
  "callback": null,
  "icon": null,
  "id": "16252",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class CustomJSHover(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.model.Model

ホバリングツールフィールドに適用されるカスタムフォーマットプログラムを定義する。

このモデルはJavaScriptコードを用いて構成され，ホバリングツールによって提示されるフォーマットを設定することができる.JavaScriptコードは、フォーマットされる現在の値、いくつかの特殊な変数、およびツールプロンプト上に構成された任意のフォーマットにアクセスすることができます。変数 value 未変換の値を含む.変数 special_vars 以下を含む辞書を提供する：

x マウスのデータ空間x座標
y マウスのデータ空間y座標
sx マウスのスクリーン空間x座標
sy マウスのスクリーン空間y座標
data_x ホバリング字形のデータ空間x座標
data_y ホバリング字形のデータ空間y座標
indices 現在停止しているすべての字形の列インデックス
name の値 name ホバリングした字形レンダラーの属性

マウスが“マルチ”の字に止まっていれば Patches あるいは…。 MultiLine そして1つは segment_index 鍵も出てきます。

最後に，ツール提示仕様で渡されるフォーマットの値とすることができる. format 変数です。

例を引く

例えば、次のコードには、WebMercator北距離座標(メートル単位)フォーマットを緯度に設定するカスタムフォーマットプログラムが追加される。

lat_custom = CustomJSHover(code="""
    var projections = Bokeh.require("core/util/projections");
    var x = special_vars.x
    var y = special_vars.y
    var coords = projections.wgs84_mercator.invert(x, y)
    return "" + coords[1]
""")

p.add_tools(HoverTool(
    tooltips=[( 'lat','@y{custom}' )],
    formatters=dict(y=lat_custom)
))

警告

このBokehモデルは埋め込みを明確に目的としている. 原始JavaScriptコード ブラウザが実行するためのものですコードの任意の部分が信頼されていないユーザ入力から派生する場合、Bokehに渡す前に、ユーザ入力を適切に掃除することに注意しなければならない。

args¶

property type: Dict ( String , Instance ( Model ) )

Bokeh印刷オブジェクトへの名前のマッピング。コールバックコード片は，これらのオブジェクトをコールバックの名前パラメータ値として用いることができる.

code¶

属性タイプ： String

個々の値のJavaScriptコード片を変換する.変数 value 変換されていない値が含まれ、提示時に関数命名空間に現れることが予想される。また，変数 special_vars 利用可能であり、以下を含む辞書が提供される。

x マウスのデータ空間x座標
y マウスのデータ空間y座標
sx マウスのスクリーン空間x座標
sy マウスのスクリーン空間y座標
data_x ホバリング字形のデータ空間x座標
data_y ホバリング字形のデータ空間y座標
indices 現在停止しているすべての字形の列インデックス

マウスが“マルチ”の字に止まっていれば Patches あるいは…。 MultiLine そして1つは segment_index 鍵も出てきます。

最後に，ツール提示仕様で渡されるフォーマットの値とすることができる. format 変数です。

このコードセグメントは関数体が作成されるため，戻り文が必要となる.

例：

code = '''
return value + " total"
'''

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "args": {},
  "code": "",
  "id": "16261",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class Drag(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Gesture

イベントをドラッグするツールの基本クラスに応答します。

注釈

これは，Bokehモデルタイプの階層構造の組織を支援するための抽象基底クラスである. 単独インスタンス化は無駄である.

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "id": "16269",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class EditTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Gesture

すべてのインタラクティブな描画ツールタイプの基本クラス。

注釈

これは，Bokehモデルタイプの階層構造の組織を支援するための抽象基底クラスである. 単独インスタンス化は無駄である.

custom_icon¶

属性タイプ： Image

ツールバーに表示されるアイコン。

このアイコンは、画像の文字列ファイル名、PILとして提供することができます Image オブジェクトまたはRGB(A)NumPy配列.

custom_tooltip¶

属性タイプ： String

デフォルト名を代替するためのカスタムツールは、タグを提示します。

empty_value¶

property type: Either ( Bool , Int , Float , Date , Datetime , Color , String )

属性に新しい字形を挿入する際には，非座標列に挿入する値を定義する. ColumnDataSource 列は、例えば、円形字形が“x”、“y”、“color”列を定義する場合、新たな点を追加すると“x”および“y”の列にxおよびy座標が追加され、色列は定義されたヌル値で満たされる。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

renderers¶

属性タイプ： List () Instance () Renderer ））

編集可能な分散フォントに対応する明示的レンダラリスト。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "custom_icon": null,
  "custom_tooltip": null,
  "empty_value": null,
  "id": "16275",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "renderers": [],
  "subscribed_events": [],
  "tags": []
}

class FreehandDrawTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.EditTool, bokeh.models.tools.Drag, bokeh.models.tools.Tap

ツールバーアイコン ：

手描きを許す Patches そして MultiLine 字形です。描きたい字は通過することができます renderers 財産です。

このツールはデータソースを修正し xs そして ys 字形の値。データソースの他の列は宣言されます empty_value 新しい点を追加した場合。

サポートする操作には，

折れ線を引く：クリックしてドラッグして線を描く
タイルを削除/複数行：タイル/複数行をクリックして選択し，マウスが描画領域にあるときに<<Backspace>>ボタンを押す.

custom_icon¶

属性タイプ： Image

ツールバーに表示されるアイコン。

このアイコンは、画像の文字列ファイル名、PILとして提供することができます Image オブジェクトまたはRGB(A)NumPy配列.

custom_tooltip¶

属性タイプ： String

デフォルト名を代替するためのカスタムツールは、タグを提示します。

empty_value¶

property type: Either ( Bool , Int , Float , Date , Datetime , Color , String )

属性に新しい字形を挿入する際には，非座標列に挿入する値を定義する. ColumnDataSource 列は、例えば、円形字形が“x”、“y”、“color”列を定義する場合、新たな点を追加すると“x”および“y”の列にxおよびy座標が追加され、色列は定義されたヌル値で満たされる。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

num_objects¶

属性タイプ： Int

描画可能なパッチまたは複数のセグメント数の制限を定義する.デフォルトの場合、オブジェクトの数に制限はありませんが、有効にすると、制限に達したときに最初に描画されたタイルまたは複数の行が上書きされます。

renderers¶

属性タイプ： List () Instance () Renderer ））

編集可能な分散フォントに対応する明示的レンダラリスト。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "custom_icon": null,
  "custom_tooltip": null,
  "empty_value": null,
  "id": "16285",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_objects": 0,
  "renderers": [],
  "subscribed_events": [],
  "tags": []
}

class Gesture(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Tool

イベントをドラッグするツールの基本クラスに応答します。

注釈

これは，Bokehモデルタイプの階層構造の組織を支援するための抽象基底クラスである. 単独インスタンス化は無駄である.

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "id": "16296",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class HelpTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Action

ユーザに“ヘルプ”リンクのボタンツールを提供する.

ホバリングテキストは help_tooltip 属性やリダイレクトサイトも書き換えられる.

help_tooltip¶

属性タイプ： String

ヘルプアイコン上にマウスをホバリングしたときに表示されるツール提示.

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

redirect¶

属性タイプ： String

クリックすると通過するサイトをリダイレクトします。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "help_tooltip": "Click the question mark to learn more about Bokeh plot tools.",
  "id": "16302",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "redirect": "https://docs.bokeh.org/en/latest/docs/user_guide/tools.html",
  "subscribed_events": [],
  "tags": []
}

class HoverTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Inspection

ツールバーアイコン ：

ホバリングツールは受動検査器ツールである。通常は開いている状態ですが、関連する検査員メニューで構成することができます ツールバーアイコン 上の図に示すように。

デフォルトの場合，カーソルが字形の真上にある限り，ホバリングツールは情報ツール提示を表示する.表示するデータはフォントのデータソースから，表示する内容は使用可能である. tooltips 表示名をデータソース内の列または特別な既知変数の属性にマッピングします。

以下は、ホバリングツールをどのように構成して使用するかの例である。

# Add tooltip (name, field) pairs to the tool. See below for a
# description of possible field values.
hover.tooltips = [
    ("index", "$index"),
    ("(x,y)", "($x, $y)"),
    ("radius", "@radius"),
    ("fill color", "$color[hex, swatch]:fill_color"),
    ("foo", "@foo"),
    ("bar", "@bar"),
    ("baz", "@baz{safe}"),
    ("total", "@total{$0,0.00}"
]

あなたはまた一つを提供することができます Callback 致す HoverTool ，ホバリング時にカスタムインタラクションを構築する.この場合、設定する必要があるかもしれません tooltips=None それがそうです。

警告

コールバックやカスタマイズテンプレートを提供する場合，このBokehモデルの明示的な意図は埋め込みである. オリジナルHTMLとJavaScriptコード ブラウザが実行するためのものですコードの任意の部分が信頼されていないユーザ入力から派生する場合、Bokehに渡す前に、ユーザ入力を適切に掃除することに注意しなければならない。

ホバリングツールは、現在、以下の字形を使用することができません。

環空.

弧を描く

ベゼル

image_url

楕円形.

継ぎ

二次型

雷

段取り

テキスト

anchor¶

属性タイプ： Enum () LegendLocation ）

If point policy is set to "snap_to_data", anchor defines the attachment point of a tooltip. The default is to attach to the center of a glyph.

attachment¶

属性タイプ： Enum () TooltipAttachment ）

ツール提示は，カーソル位置の左側または右側に表示すべきか，カーソル位置の上方または下方に表示すべきか，あるいは自動的に水平または垂直次元に置くべきかどうかである.

callback¶

属性タイプ： Instance () Callback ）

入力値が変更されるたびにブラウザで動作するコールバック.♪the cb_data コールバックコードで利用可能なパラメータは2つ含まれる HoverTool 特定フィールド：

指標.: オブジェクトは，データソース中の懸垂点のインデックスを含む.
幾何学: オブジェクトは，このオブジェクトは停止カーソル座標を含む.

formatters¶

property type: Dict ( String , Either ( Enum ( TooltipFieldFormatter ), Instance ( CustomJSHover ) ) )

データソース列を指定するフォーマット方式、例えば

tool.formatters = {"@date": "datetime"}

これにより、“DateTime”フォーマット方式に従って“Date”列のフォーマット仕様が解釈される。以下の方法が選択可能である。

"numeral": 様々な数字、通貨、バイト、時間、および百分率フォーマットが提供される。フルフォーマットで NumeralTickFormatter 文書を参照する。
"datetime": 日付と時間値のフォーマットを提供する。完全なフォーマットは DatetimeTickFormatter 文書を参照する。
"printf": Cスタイルと同様の“printf”タイプ説明子のフォーマットを提供します。ご参照ください PrintfTickFormatter 完全な詳細については、参照文書を参照されたい。

列名にフォーマットプログラムが指定されていなければ，デフォルトでは考えられる. "numeral" プログラムをフォーマットすると仮定する.

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

line_policy¶

属性タイプ： Enum (上·下·最近·中間·無)

線を表示するツール提示時には，ツール提示位置が線上の“上の”点か“次”の点か，現在のマウス位置から“最も近い”点か，沿線が現在のマウス位置まで“補間”されているかを指定する.

mode¶

属性タイプ： Enum (列挙(マウス、hline、vline))

ホバリングポインタを1つの点(x/y値)とするか、hまたはv方向のスパンとするか。

muted_policy¶

属性タイプ： Enum (表示·無視)

静音字形にツール提示を表示することを避けるかどうか.

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

names¶

属性タイプ： List () String ）

検索したい名前リストです。設定されている場合、それに一致する値のみを有するレンダラー name 属性が使用される。

point_policy¶

属性タイプ： Enum (列挙(Snap_to_Data，Follow_Mice，None))

ツール提示位置は、関連する字形に揃った“中心”(または他のアンカー)位置に対応するか、現在のマウスカーソル位置に常に追従するかである。

renderers¶

property type: Either ( Auto , List ( Instance ( Renderer ) ) )

これをテストする明示的レンダラーリスト。設定されていない場合は、デフォルトで描画上のすべてのレンダラーとする。

show_arrow¶

属性タイプ： Bool

ツールが提示する矢印を表示すべきかどうか.

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

toggleable¶

属性タイプ： Bool

この検査ツールのツールバーにはスイッチ/懸念スイッチが表示されるべきかどうかをチェックする.もし False この場合，描画ビューアはツールバーを用いてチェッカを開閉することができなくなる.

tooltips¶

property type: Either ( String , List ( Tuple ( String , String ) ) )

クリック時にホバリングツールが表示すべき内容を記述する(名前、フィールド)ペア。

“@で始まるフィールド名はデータソース上の列と解釈される.たとえば，“@temp”はデータソースの“temp”列から表示する値を探す.

“$”で始まるフィールド名は、特殊な既知フィールドである：

$インデックス: データソースにおける懸垂点のインデックス
$名: の値 name ホバリングした字形レンダラーの属性
$x: データ空間におけるカーソル下のX座標
$y: データ空間におけるカーソル下のY座標
$SX: スクリーン(キャンバス)空間におけるカーソル下のX座標
$SY: スクリーン(キャンバス)空間におけるカーソル下のY座標
$COLOR: データソースからの色データ文法は $color[options]:field_name それがそうです。利用可能なオプションは、より小さい色サンプルを同時に表示するために、“16進”(色を16進数値として表示する)および“色板”を含む。

先頭のフィールド名 @ 中の列は関連している. ColumnDataSource それがそうです。例えば、フィールド名 "@price" 表示されるのは "price" 列、ホバリングをトリガすればいいです。ホバリングが17番目の字形である場合、ホバリングツール提示は、それに応じて17番目の価格値を表示する。

列名にスペースが含まれている場合は、例えば、大きな括弧で囲まなければならないことに注意されたい @{{adjusted close}} 名前の列中の値を表示する "adjusted close" それがそうです。

(特にスタックグラフに対して)列の名前を間接的に指定することを許す必要がある場合がある.フィールド名 @$name 異なる点は調べてみることです name フィールドは、その値を列名として使用する。例えば、ユーザが名前を使用してホバリングしている場合 "US East" そして、そして @$name 相等しい. @{{US East}} それがそうです。

デフォルトの場合、フィールドの値(例えば、 @foo )を基本デジタル形式で表示します。しかしながら、値のフォーマットをより正確に制御することができる。フィールドは、括弧内で指定されたフォーマットを末尾に追加することによって修正されてもよい。以下にいくつかの例を示す.

"@foo{0,0.000}"    # formats 10000.1234 as: 10,000.123

"@foo{(.00)}"      # formats -10000.1234 as: (10000.123)

"@foo{($ 0.00 a)}" # formats 1230974 as: $ 1.23 m

書式を指定する {{safe}} フィールド名の後、上書きツールは、データソースの自動転送を提示する。データタグ中のどのHTMLタグも，生成されたHoverTool出力でHTMLとして表現される.見カスタムツール提示より詳細な例を表示します。

None ツール提示の有効値でもある.これはツール提示のレンダリングをオフにします。これは，コールバック属性によりホバリング時の他の操作を提供する際に最も有用である.

注釈

ツール提示属性には、例えば、マッピングタイプが構成されていてもよい dict あるいは…。 OrderedDict それがそうです。しかしもし1つが dict なお，視覚呈示順序は指定されていない.

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "anchor": "center",
  "attachment": "horizontal",
  "callback": null,
  "formatters": {},
  "id": "16310",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "line_policy": "nearest",
  "mode": "mouse",
  "muted_policy": "show",
  "name": null,
  "names": [],
  "point_policy": "snap_to_data",
  "renderers": "auto",
  "show_arrow": true,
  "subscribed_events": [],
  "tags": [],
  "toggleable": true,
  "tooltips": [
    [
      "index",
      "$index"
    ],
    [
      "data (x, y)",
      "($x, $y)"
    ],
    [
      "screen (x, y)",
      "($sx, $sy)"
    ]
  ]
}

class Inspection(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Gesture

“チェック”を実行するツールの基本クラス、例えば HoverTool それがそうです。

注釈

これは，Bokehモデルタイプの階層構造の組織を支援するための抽象基底クラスである. 単独インスタンス化は無駄である.

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

toggleable¶

属性タイプ： Bool

この検査ツールのツールバーにはスイッチ/懸念スイッチが表示されるべきかどうかをチェックする.もし False この場合，描画ビューアはツールバーを用いてチェッカを開閉することができなくなる.

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "id": "16329",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "toggleable": true
}

class LassoSelectTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Drag, bokeh.models.tools.SelectTool

ツールバーアイコン ：

ソケット選択ツールは，ユーザが描画領域上でマウスや指をドラッグすることで，自由に描画された“ロープ”領域を指示し，描画上で選択することができる.ドラッグイベントが終了すると、選択領域が完了したことを示します。

見選定された字形の選定と取り消し設定選定と未選定字形パターンに関する情報。

注釈

選択は、複数の領域から構成されてもよく、異なる選択ツールによって選択されてもよい。選択を行う際に<<Shift>>キーを押すと、存在し得る任意の以前の選択の後に新たな選択を追加することができる。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

mode¶

属性タイプ： Enum () SelectionMode ）

新たな選択を行う際に実行すべき操作を定義する.デフォルトの場合、既存の選択を置き換える。他のオプションは、選挙区に追加されるか、選挙区と交差するか、またはそこから減算されること

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

names¶

属性タイプ： List () String ）

検索したい名前リストです。設定されている場合、それに一致する値のみを有するレンダラー name 属性が使用される。

overlay¶

属性タイプ： Instance () PolyAnnotation ）

選択領域を指示するために描画されたシャドウアノテーション。

renderers¶

property type: Either ( Auto , List ( Instance ( Renderer ) ) )

これをテストする明示的レンダラーリスト。設定されていない場合は、デフォルトで描画上のすべてのレンダラーとする。

select_every_mousemove¶

属性タイプ： Bool

選択計算はマウスイベントごとに行うべきか，選択領域が完了したときに1回のみ行うべきか.

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "id": "16336",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "mode": "replace",
  "name": null,
  "names": [],
  "overlay": {
    "id": "16337"
  },
  "renderers": "auto",
  "select_every_mousemove": true,
  "subscribed_events": [],
  "tags": []
}

class LineEditTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.EditTool, bokeh.models.tools.Drag, bokeh.models.tools.Tap

ツールバーアイコン ：

LineEditToolは1つ以上のノードを編集することを許可する Line 字形です。編集する字は通過します renderers 属性と交差点のレンダリング器は intersection_renderer 属性(類似点の字形を提示しなければならない) XYGlyph ）。

このツールはデータソースを修正し x そして y 字形の値。新しいポイントを追加する際には、データソース内の他の任意の列は、宣言された``Empty_Value≡‘パディングを使用します。

サポートする操作には，

表示ノード：既存の線をダブルクリックする
移動点：既存の点をドラッグし，マウスキーを離して解放する.

custom_icon¶

属性タイプ： Image

ツールバーに表示されるアイコン。

このアイコンは、画像の文字列ファイル名、PILとして提供することができます Image オブジェクトまたはRGB(A)NumPy配列.

custom_tooltip¶

属性タイプ： String

デフォルト名を代替するためのカスタムツールは、タグを提示します。

dimensions¶

属性タイプ： Enum () Dimensions ）

この編集ツールは，どの次元で操作を実行するかに制約される.デフォルトでは、ライン編集ツールは、任意の次元で点を移動させることを可能にするが、描画幅上での水平移動のみを許可するように構成されてもよく、または描画高さにわたって垂直に移動してもよい。

empty_value¶

property type: Either ( Bool , Int , Float , Date , Datetime , Color , String )

属性に新しい字形を挿入する際には，非座標列に挿入する値を定義する. ColumnDataSource 列は、例えば、円形字形が“x”、“y”、“color”列を定義する場合、新たな点を追加すると“x”および“y”の列にxおよびy座標が追加され、色列は定義されたヌル値で満たされる。

intersection_renderer¶

属性タイプ： Instance () GlyphRenderer ）

選択されたラインの交点をレンダリングするレンダラー

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

renderers¶

属性タイプ： List () Instance () Renderer ））

編集可能な分散フォントに対応する明示的レンダラリスト。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "custom_icon": null,
  "custom_tooltip": null,
  "dimensions": "both",
  "empty_value": null,
  "id": "16348",
  "intersection_renderer": null,
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "renderers": [],
  "subscribed_events": [],
  "tags": []
}

class PanTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Drag

ツールバーアイコン ：

平行移動ツールは、ユーザがマウスを左キーでドラッグすることによって描画を平行移動させるか、またはタッチデバイス上で描画領域において指または指示ペンをドラッグすることによって描画を平行移動させることを可能にする。

並進ツールはまた、“一軸”並進を行うために、描画された境界領域を活性化することができる。例えば、垂直フレームまたは軸上でドラッグすることは、垂直方向の平行移動のみに影響を与え、水平サイズはそのままである。

dimensions¶

属性タイプ： Enum () Dimensions ）

並進ツールは、どの次元で動作を実行するかに制約される。デフォルトの場合、並進ツールは、任意の次元で平行移動するが、描画幅のみを水平に並進させるように構成されてもよく、または垂直並進描画高さとして構成されてもよい。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "dimensions": "both",
  "id": "16360",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class PointDrawTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.EditTool, bokeh.models.tools.Drag, bokeh.models.tools.Tap

ツールバーアイコン ：

PointDrawToolは、1つまたは複数のレンダラーに点状字形(すなわち``XYGlyph‘のサブクラス)を追加、ドラッグ、および削除することを可能にし、方法は編集ベースである。 ColumnDataSource データです。他の描画ツールと同様に、編集するレンダラは、リスト形式で明示的に提供されなければならない。新たに追加された点はいずれも挿入されます ColumnDataSource 最初のレンダラーを提供します。

このツールはデータソースを修正し x そして y 字形の値。データソース内の他の任意の列は所与のものを使用します empty_value 新しい点を追加する場合。

注釈

BokehJS側の編集操作では，データソース更新はデータ変更イベントをトリガし続ける.Bokehサーバアプリケーションでは，データソースは編集操作完了時に1回だけ同期する.

サポートする操作には，

追加ポイント：描画上の任意の位置をクリックする
移動点：既存の点を軽く触れてドラッグし，マウスキーを離すとその点は破棄される.
削除点：1つの点をクリックして選択し，マウスが描画領域に位置するときに<<backspace>>ボタンを押す.

add¶

属性タイプ： Bool

新しいクリックポイントイベントの追加を許可します。

custom_icon¶

属性タイプ： Image

ツールバーに表示されるアイコン。

このアイコンは、画像の文字列ファイル名、PILとして提供することができます Image オブジェクトまたはRGB(A)NumPy配列.

custom_tooltip¶

属性タイプ： String

デフォルト名を代替するためのカスタムツールは、タグを提示します。

drag¶

属性タイプ： Bool

平行移動イベント上の既存の点をドラッグすることを可能にする。

empty_value¶

property type: Either ( Bool , Int , Float , Date , Datetime , Color , String )

属性に新しい字形を挿入する際には，非座標列に挿入する値を定義する. ColumnDataSource 列は、例えば、円形字形が“x”、“y”、“color”列を定義する場合、新たな点を追加すると“x”および“y”の列にxおよびy座標が追加され、色列は定義されたヌル値で満たされる。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

num_objects¶

属性タイプ： Int

描画可能な点数制限を定義する.デフォルトでは、オブジェクトの数に制限はありませんが、有効にされている場合、最初に描画されたポイントは、新しいポイントのための空間を空けるために破棄されます。

renderers¶

属性タイプ： List () Instance () Renderer ））

編集可能な分散フォントに対応する明示的レンダラリスト。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "add": true,
  "custom_icon": null,
  "custom_tooltip": null,
  "drag": true,
  "empty_value": null,
  "id": "16367",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_objects": 0,
  "renderers": [],
  "subscribed_events": [],
  "tags": []
}

class PolyDrawTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.EditTool, bokeh.models.tools.Drag, bokeh.models.tools.Tap

ツールバーアイコン ：

PolyDrawToolは描画、選択、削除を許可 Patches そして MultiLine 1つ以上のレンダラー上のフォント、方法が編集ベース ColumnDataSource データです。他の描画ツールと同様に，編集するレンダラを明示的に提供しなければならない.

このツールはデータソースを修正し xs そして ys 字形の値。データソースの他の列は宣言されます empty_value 新しい点を追加した場合。

もし1つが vertex_renderer 類似点の字形が提供されていれば PolyDrawTool これを使用して、提供されたすべてのレンダラーにマルチラインまたはスライスの頂点を表示します。これにより、レンダリング時に既存の頂点を捉えることもできる。

サポートする操作には，

パッチまたは複数線を追加する：ダブルクリックして最初の頂点を追加し、その後、各後続の頂点をタップで追加して、描画操作を完了してダブルクリックして、最後の頂点を挿入するか、または<<Esc>キーを押す。
タブまたは複数線を移動させる：既存のタイル/マルチラインを軽くタッチしてドラッグし、マウスボタンを離すと、点が破棄される。
タイルまたは複数行を削除：タイル/複数行をクリックして選択し，マウスが描画領域にあるときに<<backspace>>ボタンを押す.

custom_icon¶

属性タイプ： Image

ツールバーに表示されるアイコン。

このアイコンは、画像の文字列ファイル名、PILとして提供することができます Image オブジェクトまたはRGB(A)NumPy配列.

custom_tooltip¶

属性タイプ： String

デフォルト名を代替するためのカスタムツールは、タグを提示します。

drag¶

属性タイプ： Bool

既存のタイルおよびマルチセグメントを平行移動イベントでドラッグすることを可能にする。

empty_value¶

property type: Either ( Bool , Int , Float , Date , Datetime , Color , String )

属性に新しい字形を挿入する際には，非座標列に挿入する値を定義する. ColumnDataSource 列は、例えば、円形字形が“x”、“y”、“color”列を定義する場合、新たな点を追加すると“x”および“y”の列にxおよびy座標が追加され、色列は定義されたヌル値で満たされる。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

num_objects¶

属性タイプ： Int

描画可能なパッチまたは複数のセグメント数の制限を定義する.デフォルトでは、オブジェクトの数に制限はないが、有効にされた場合、最初に描画されたタイルまたは複数の線は、新しいタイルまたは複数の線のための空間を空けるために破棄されるであろう。

renderers¶

属性タイプ： List () Instance () Renderer ））

編集可能な分散フォントに対応する明示的レンダラリスト。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

vertex_renderer¶

属性タイプ： Instance () GlyphRenderer ）

選択された直線または多角形の頂点をレンダリングするためのレンダラ。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "custom_icon": null,
  "custom_tooltip": null,
  "drag": true,
  "empty_value": null,
  "id": "16380",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "num_objects": 0,
  "renderers": [],
  "subscribed_events": [],
  "tags": [],
  "vertex_renderer": null
}

class PolyEditTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.EditTool, bokeh.models.tools.Drag, bokeh.models.tools.Tap

ツールバーアイコン ：

PolyEditToolは1つ以上の割引ポイントを編集することを可能にする Patches あるいは…。 MultiLine 字形です。編集する字は通過します renderers 属性、そして頂点のレンダラは vertex_renderer 属性(類似点の字形を提示しなければならない) XYGlyph ）。

このツールはデータソースを修正し xs そして ys 字形の値。新しいポイントを追加する際には、データソース内の他の任意の列は、宣言された``Empty_Value≡‘パディングを使用します。

サポートする操作には，

頂点表示：既存のパッチまたは複数のセグメントをダブルクリック
頂点追加：既存の頂点をダブルクリックして選択し，ツールは次の点を描画して新しい位置に追加する.編集を完了してポイントを追加するには、ダブルクリックしてください。そうでなければ<<Esc>キーを押してキャンセルします。
移動頂点：既存の頂点をドラッグし，マウスボタンを外して解放する.
頂点削除：1つまたは複数の頂点を選択した後，マウスカーソルが描画領域内にある場合に<<backspace>>を押す.

custom_icon¶

属性タイプ： Image

ツールバーに表示されるアイコン。

このアイコンは、画像の文字列ファイル名、PILとして提供することができます Image オブジェクトまたはRGB(A)NumPy配列.

custom_tooltip¶

属性タイプ： String

デフォルト名を代替するためのカスタムツールは、タグを提示します。

empty_value¶

property type: Either ( Bool , Int , Float , Date , Datetime , Color , String )

属性に新しい字形を挿入する際には，非座標列に挿入する値を定義する. ColumnDataSource 列は、例えば、円形字形が“x”、“y”、“color”列を定義する場合、新たな点を追加すると“x”および“y”の列にxおよびy座標が追加され、色列は定義されたヌル値で満たされる。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

renderers¶

属性タイプ： List () Instance () Renderer ））

編集可能な分散フォントに対応する明示的レンダラリスト。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

vertex_renderer¶

属性タイプ： Instance () GlyphRenderer ）

選択された直線または多角形の頂点をレンダリングするためのレンダラ。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "custom_icon": null,
  "custom_tooltip": null,
  "empty_value": null,
  "id": "16393",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "renderers": [],
  "subscribed_events": [],
  "tags": [],
  "vertex_renderer": null
}

class PolySelectTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Tap, bokeh.models.tools.SelectTool

ツールバーアイコン ：

ポリゴン選択ツールは，ユーザがマウスクリックによりポリゴン領域を指示し，描画上で選択することを可能にする.クリック(またはタップ)は、連続する点をポリゴンの定義に追加し、ダブルクリック(またはタップ)は、選択領域が整っていることを示します。

見選定された字形の選定と取り消し設定選定と未選定字形パターンに関する情報。

注釈

選択は、複数の領域から構成されてもよく、異なる選択ツールによって選択されてもよい。選択を行う際に<<Shift>>キーを押すと、存在し得る任意の以前の選択の後に新たな選択を追加することができる。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

mode¶

属性タイプ： Enum () SelectionMode ）

新たな選択を行う際に実行すべき操作を定義する.デフォルトの場合、既存の選択を置き換える。他のオプションは、選挙区に追加されるか、選挙区と交差するか、またはそこから減算されること

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

names¶

属性タイプ： List () String ）

検索したい名前リストです。設定されている場合、それに一致する値のみを有するレンダラー name 属性が使用される。

overlay¶

属性タイプ： Instance () PolyAnnotation ）

選択領域を指示するために描画されたシャドウアノテーション。

renderers¶

property type: Either ( Auto , List ( Instance ( Renderer ) ) )

これをテストする明示的レンダラーリスト。設定されていない場合は、デフォルトで描画上のすべてのレンダラーとする。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "id": "16404",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "mode": "replace",
  "name": null,
  "names": [],
  "overlay": {
    "id": "16405"
  },
  "renderers": "auto",
  "subscribed_events": [],
  "tags": []
}

class ProxyToolbar(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.ToolbarBase

複数の描画中のツールバーツールのツールバーの統合とエージェントを許す.

autohide¶

属性タイプ： Bool

デフォルトでツールバーが隠されているかどうか。デフォルト値：False。Trueであれば，カーソルがキャンバスにない場合にツールバーを隠す。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

logo¶

属性タイプ： Enum (エニュメレーション(通常，灰色))

ツールバーにはBokehロゴのバージョンが表示されます。“なし”に設定すると，ロゴは表示されない.

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

toolbars¶: 属性タイプ： List () Instance () Toolbar ））

tools¶

属性タイプ： List () Instance () Tool ））

描画中のツールリストに追加します。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "autohide": false,
  "id": "16415",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "logo": "normal",
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "toolbars": [],
  "tools": []
}

class RangeTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Drag

ツールバーアイコン ：

範囲ツールは、ユーザが対応する着色書き込みをドラッグすることによって、その境界を移動または変更することによって、xまたはy次元のうちの1つまたは2つの範囲オブジェクトを更新することを可能にする。

一般的な用例の1つは、このツールを大きな固定範囲を有する描画に追加することであるが、異なる描画構成ツールの範囲からである。ユーザがオーバーレイマップを操作すると、第2の描画の範囲が自動的に更新される。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

overlay¶

属性タイプ： Instance () BoxAnnotation ）

構成の範囲を示すために描画されたシャドウ注釈。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

x_interaction¶

属性タイプ： Bool

以下の動作を実行する際に水平平行移動に応答するか否か x_range 現場にいます。

デフォルトでは x_range したがって、範囲枠の水平位置は、枠内で水平に平行移動することによって、または枠の上部または底縁に沿って並進することによって調整することができる。このオプションを無効にし、範囲枠レベルを適切な位置に固定する場合は、Falseに設定してください。(もし x_range プログラミング方式で更新します。)

x_range¶

属性タイプ： Instance () Range1d ）

カバーするx次元に同期した範囲.そうでなければ，カバーはx次元全体にまたがる.

y_interaction¶

属性タイプ： Bool

以下の動作を実行する際に垂直並進に応答するか否か y_range 現場にいます。

デフォルトでは y_range したがって、範囲枠の垂直位置は、枠内で垂直に平行移動することによって、または枠の上縁または下縁に沿って平行移動することによって調整することができる。このオプションを無効にして固定範囲枠を垂直にする場合は、Falseに設定してください。(もし y_range プログラミング方式で更新します。)

y_range¶

属性タイプ： Instance () Range1d ）

カバーされたy次元と同期した範囲.そうでなければ，カバーはy次元全体にまたがる.

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "id": "16425",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "overlay": {
    "id": "16426"
  },
  "subscribed_events": [],
  "tags": [],
  "x_interaction": true,
  "x_range": null,
  "y_interaction": true,
  "y_range": null
}

class RedoTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Action

ツールバーアイコン ：

やり直しツールは，ツールが実行した前回の操作を破棄する.

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "id": "16437",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class ResetTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Action

ツールバーアイコン ：

ツールをリセットすることは操作である.ツールバーで起動すると，そのツールは描画されたデータ境界を最初に描画を作成したときの値にリセットする.

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "id": "16443",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class SaveTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Action

ツールバーアイコン ：

保存ツールは一種の操作である.アクティブになると、ツールは、描画された画像のコピーをPNG形式で保存することができるダウンロードダイアログを開きます。Webブラウザが自動ダウンロードをサポートしていない場合、ツールは、新しいタブまたはウィンドウで生成された画像を開いて返す。次いで、ユーザは、画像を右クリックし、“別の記憶”(または同様の)メニュー項目を選択することによって、手動で保存することができる。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "id": "16449",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class Scroll(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Gesture

ロールイベントに応答するツールの基本クラス.

注釈

これは，Bokehモデルタイプの階層構造の組織を支援するための抽象基底クラスである. 単独インスタンス化は無駄である.

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "id": "16455",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class Tap(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Gesture

イベントのツールの基本クラスをクリック/クリックします。

注釈

これは，Bokehモデルタイプの階層構造の組織を支援するための抽象基底クラスである. 単独インスタンス化は無駄である.

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "id": "16461",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class TapTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Tap, bokeh.models.tools.SelectTool

ツールバーアイコン ：

選択ツールをクリックすることで，ユーザはマウス左ボタンでクリックしたり，指でクリックしたりして一点で選択することができる.

見選定された字形の選定と取り消し設定選定と未選定字形パターンに関する情報。

注釈

選択は、複数の領域から構成されてもよく、異なる選択ツールによって選択されてもよい。選択を行う際に<<Shift>>キーを押すと、存在し得る任意の以前の選択の後に新たな選択を追加することができる。

behavior¶

属性タイプ： Enum (選択·チェック)

このツールは、関連するデータソースを選択またはチェックするように構成されてもよい。異なる点は、bokehと他のコンポーネント(例えば、選択フォント)との間に伝播される選択変更が通知される点である。検査の行為はそうではないので、それを構成するのは有用です callback 設定時 behavior='inspect' それがそうです。

callback¶

属性タイプ： Instance () Callback ）

実行するコールバック 字形が“撃たれる”たびに マウスでクリックしたりクリックしたりします。

これは通常正しいです OpenURL ユーザが特定のフォントをクリックまたはクリックすることによってURLのモデルを開きます。

しかしそれは CustomJS クリックまたはクリック字形に応答して、任意のJavaScriptコードを実行することができます。コールバックは、クリックまたはクリックされた各個々のフォントに対して実行され、受信されます。 TapTool モデルは cb_obj それがそうです。任意選択. cb_data このデータソースをこれとする. .source 属性と幾何学図形の選択 .geometries 属性です。

♪the .geometries 属性は5人のメンバである. .type 幾何学的な図形のタイプです .point 1回の打撃活動のための準備をする. .sx そして .sy タップが発生したスクリーンXとY座標です。 .x そして .y 選定された項の変換データ座標である.♪the .x そして .y 値は，その字形に指定された軸に基づく.

注釈

今回の調は実行する. not “クリック”の字の場合にのみ，クリックするたびに実行される.マウスをクリックするたびにコールバックを実行したい場合は、参照してくださいユーザインタラクションイベントのCustomJS それがそうです。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

mode¶

属性タイプ： Enum () SelectionMode ）

新たな選択を行う際に実行すべき操作を定義する.デフォルトの場合、既存の選択を置き換える。他のオプションは、選挙区に追加されるか、選挙区と交差するか、またはそこから減算されること

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

names¶

属性タイプ： List () String ）

検索したい名前リストです。設定されている場合、それに一致する値のみを有するレンダラー name 属性が使用される。

renderers¶

property type: Either ( Auto , List ( Instance ( Renderer ) ) )

これをテストする明示的レンダラーリスト。設定されていない場合は、デフォルトで描画上のすべてのレンダラーとする。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "behavior": "select",
  "callback": null,
  "id": "16467",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "mode": "replace",
  "name": null,
  "names": [],
  "renderers": "auto",
  "subscribed_events": [],
  "tags": []
}

class Tool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.model.Model

すべてのインタラクティブ·ツール·タイプの基本クラス。

注釈

これは，Bokehモデルタイプの階層構造の組織を支援するための抽象基底クラスである. 単独インスタンス化は無駄である.

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool [ソース]¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "id": "16478",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class Toolbar(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.ToolbarBase

単一の描画に表示するツールを収集する.

active_drag¶

property type: Either ( Auto , Instance ( Drag ) )

描画表示時にアクティブになるドラッグツールを指定する.

active_inspect¶

property type: Either ( Auto , Instance ( Inspection ), Seq ( Instance ( Inspection ) ) )

描画表示時に起動される検査ツールや検査ツールシーケンスを指定する.

active_multi¶

属性タイプ： Instance () Gesture ）

編集ツールまたは範囲ツールのようなアクティビティを指定するマルチジェスチャーツール。

マルチジェスチャーツールを起動することは、必要に応じて他のジェスチャーツールを停止することに注意してください。例えば、平行移動ツールがアクティブドラッグに設定されている場合、この属性は、 BoxEditTool インスタンスの場合、並進ツールは無効にされる(すなわち、マルチジェスチャーツールが優先される)。

active_scroll¶

property type: Either ( Auto , Instance ( Scroll ) )

描画を表示する際に活性化するスクロール/収縮ツールを指定する.

active_tap¶

property type: Either ( Auto , Instance ( Tap ) )

描画を表示する際に起動するタップ/クリックツールを指定します。

autohide¶

属性タイプ： Bool

デフォルトでツールバーが隠されているかどうか。デフォルト値：False。Trueであれば，カーソルがキャンバスにない場合にツールバーを隠す。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

logo¶

属性タイプ： Enum (エニュメレーション(通常，灰色))

ツールバーにはBokehロゴのバージョンが表示されます。“なし”に設定すると，ロゴは表示されない.

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

tools¶

属性タイプ： List () Instance () Tool ））

描画中のツールリストに追加します。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "active_drag": "auto",
  "active_inspect": "auto",
  "active_multi": null,
  "active_scroll": "auto",
  "active_tap": "auto",
  "autohide": false,
  "id": "16484",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "logo": "normal",
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "tools": []
}

class ToolbarBase(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.model.Model

異なるツールバーの基本クラスです

注釈

これは，Bokehモデルタイプの階層構造の組織を支援するための抽象基底クラスである. 単独インスタンス化は無駄である.

autohide¶

属性タイプ： Bool

デフォルトでツールバーが隠されているかどうか。デフォルト値：False。Trueであれば，カーソルがキャンバスにない場合にツールバーを隠す。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

logo¶

属性タイプ： Enum (エニュメレーション(通常，灰色))

ツールバーにはBokehロゴのバージョンが表示されます。“なし”に設定すると，ロゴは表示されない.

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

tools¶

属性タイプ： List () Instance () Tool ））

描画中のツールリストに追加します。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "autohide": false,
  "id": "16498",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "logo": "normal",
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "tools": []
}

class ToolbarBox(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.layouts.LayoutDOM

レイアウト可能なツールバーは、複数の描画ツールを受け入れることができ、これらのツールを1つのボタンに統合して使いやすいようにすることができる。

align¶

属性タイプ： Either () Enum () Align )、 Tuple () Enum () Align )、 Enum () Align ）．

親容器内の整列点。

この属性は、このコンポーネントがレイアウト(例えば、メッシュ)のサブ要素である場合にのみ有用である。親コンテナは、自己整列(例えば、グリッド軌跡整列)を覆うことができる。

aspect_ratio¶

属性タイプ： Either () Enum (エニュメレーション(自動))， Float ）

コンポーネントの幅と高さの間の比例関係を記述する.

コンポーネントの任意のサイズがサイズに柔軟である場合、この方法は有効である。数字に設定すると width / height = aspect_ratio 私たちの関係は維持されるだろう。そうでなければ "auto" コンポーネントの好ましい幅および高さは、アスペクト比を決定するために使用されるであろう(設定されていない場合、アスペクト比は保持されない)。

background¶

属性タイプ： Color

コンポーネントの背景。

css_classes¶

属性タイプ： List () String ）

このDOM要素のCSSクラス名リストに追加します。注意：クラス名はそのまま追加するだけであり，他の保証は提供しない.

タプルからの代入も許可されているが、これらのタプルは調整されており、この属性は常に1つのリストを含む。

disabled¶

属性タイプ： Bool

表示時にガジェットを無効にするかどうか。

もし True この場合、ウィジェットは灰色で表示され、UIイベントに応答しない。

height¶

属性タイプ： NonNegativeInt

コンポーネントの高さ(画素単位).

これは、固定高さであってもよく、第一選択高さであってもよく、特に高さ調整戦略に依存する。

height_policy¶

property type: Either ( Auto , Enum ( SizingPolicy ) )

コンポーネントがその高さをどのように維持すべきかを説明する。

"auto": コンポーネントを使用するためには、サイズ調整ポリシーが優先的である。
"fixed": 正確に使う height ピクセルです。コンポーネントは利用可能な垂直空間を入れることができないとあふれてしまう.
"fit": コンポーネントの好ましい高さ(設定されている場合)を使用し、設定されている場合、最小高さ限界および最大高さ限界内に利用可能な垂直空間を挿入することを可能にする。コンポーネントの高さは過度に最小化されることもなく，最大化されることもない.
"min": 最小高さ(設定すれば)以上の最小高さ以上の垂直空間を使用する。始点は第一選択高さ(設定すれば)である.親レイアウト、アスペクト比管理、および他の要因によっては、コンポーネントの高さが縮小または増大する可能性がある。
"max": 最大高さ(設定すれば)を超えないようにできるだけ多くの垂直空間を用いる.始点は第一選択高さ(設定すれば)である.親レイアウト、アスペクト比管理、および他の要因によっては、コンポーネントの高さが縮小または増大する可能性がある。

注釈

これは将来的に変わるかもしれない試験的な機能だ。自分でそれを使うかどうかを決めることができます。もっと使うのが好きです sizing_mode もしこのようなレベルの統制が厳格でなければ。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

margin¶

property type: Tuple ( Int , Int , Int , Int )

部品の周りに追加空間を作ることを可能にする。タプル中の値の順序は以下のとおりである：上距離，右距離，下距離，左距離は，CSS基準に類似している.負のエッジ距離値は、任意の方向から空間を縮小するために使用することができる。

max_height¶

属性タイプ： NonNegativeInt

高さが調整可能である場合、コンポーネントの最大高さ(画素単位)である。

max_width¶

属性タイプ： NonNegativeInt

幅が調整可能である場合、コンポーネントの最大幅(画素単位)である。

min_height¶

属性タイプ： NonNegativeInt

高さが調整可能である場合、コンポーネントの最小高さ(画素単位)である。

min_width¶

属性タイプ： NonNegativeInt

幅が調整可能である場合、コンポーネントの最小幅(画素単位)である。

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

sizing_mode¶

属性タイプ： Enum () SizingMode ）

コンポーネントは自身のサイズをどのように調整すべきか.

This is a high-level setting for maintaining width and height of the component. To gain more fine grained control over sizing, use width_policy, height_policy and aspect_ratio instead (those take precedence over sizing_mode).

起こりうる状況：

"fixed": コンポーネントは応答しません。後続のどのブラウザウィンドウサイズ調整イベントにもかかわらず、元の幅および高さを維持する。
"stretch_width": コンポーネントは、アスペクト比を維持することなく、それに応じてサイズを調整して利用可能な幅に延伸する。コンポーネントの高さはコンポーネントのタイプに依存し，固定されていてもよいし，コンポーネントの内容に適応してもよい.
"stretch_height": コンポーネントは、アスペクト比を維持することなく、それに応じてサイズを調整して利用可能な高さまで延伸する。コンポーネントの幅はコンポーネントのタイプに依存し，固定されていてもよいし，コンポーネントの内容に適していてもよい.
"stretch_both": コンポーネントは完全に応答して、幅および高さで独立しており、これがコンポーネントのアスペクト比を変更しても、利用可能なすべての水平空間および垂直空間を占有するであろう。
"scale_width": コンポーネントは、元のアスペクト比または提供されたアスペクト比を維持しながら、それに応じてサイズを調整して利用可能な幅に延伸する。
"scale_height": コンポーネントは、元のアスペクト比または提供されたアスペクト比を維持しながら、利用可能な高さまで延伸するために、それに応じてサイズを調整する。
"scale_both": コンポーネントは、元のアスペクト比または提供されたアスペクト比を維持しながら、応答してサイズを利用可能な幅および高さに調整する。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

toolbar¶

属性タイプ： Instance () ToolbarBase ）

すべてのツールを含む描画に関連するツールバー.

visible¶

属性タイプ： Bool

コンポーネントが見えるかどうか、およびレイアウトの一部であるかどうか。

width¶

属性タイプ： NonNegativeInt

コンポーネントの幅(画素単位)である.

これは、固定幅であってもよいし、好ましい幅であってもよく、具体的には、幅サイズ調整ポリシーに依存する。

width_policy¶

property type: Either ( Auto , Enum ( SizingPolicy ) )

コンポーネントがその幅をどのように維持すべきかを説明する。

"auto": コンポーネントを使用するためには、サイズ調整ポリシーが優先的である。
"fixed": 正確に使う width ピクセルです。コンポーネントは利用可能な水平空間を入れることができないとあふれてしまう.
"fit": コンポーネントの好ましい幅(設定されている場合)が使用され、設定されている場合、最小および最大幅限界(設定されている場合)内の利用可能な水平空間に適合することができる。コンポーネントの幅は過度に最小化されることもなく，最大化されることもない.
"min": できるだけ少ない水平空間を使用して、最小幅(設定すれば)以上である。始点は優先幅(設定すれば)である.親レイアウト、アスペクト比管理、および他の要因によっては、コンポーネントの幅が縮小または増大する可能性がある。
"max": できるだけ多くの水平空間を用いて，最大幅(設定すれば)を超えない.始点は優先幅(設定すれば)である.親レイアウト、アスペクト比管理、および他の要因によっては、コンポーネントの幅が縮小または増大する可能性がある。

注釈

これは将来的に変わるかもしれない試験的な機能だ。自分でそれを使うかどうかを決めることができます。もっと使うのが好きです sizing_mode もしこのようなレベルの統制が厳格でなければ。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "align": "start",
  "aspect_ratio": null,
  "background": null,
  "css_classes": [],
  "disabled": false,
  "height": null,
  "height_policy": "auto",
  "id": "16507",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "margin": [
    0,
    0,
    0,
    0
  ],
  "max_height": null,
  "max_width": null,
  "min_height": null,
  "min_width": null,
  "name": null,
  "sizing_mode": null,
  "subscribed_events": [],
  "tags": [],
  "toolbar": null,
  "toolbar_location": "right",
  "visible": true,
  "width": null,
  "width_policy": "auto"
}

class UndoTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Action

ツールバーアイコン ：

破棄ツールは，描画の以前の状態を回復することを可能にする.

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "id": "16530",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class WheelPanTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Scroll

ツールバーアイコン ：

ローラ並進ツールは、ユーザがローラを使用して構成されたサイズに沿って描画することを可能にする

dimension¶

属性タイプ： Enum () Dimension ）

制御ディスク並進ツールは、どの次元で動作を実行するかを制約する。デフォルトでは、ローラ並進ツールは、x軸に沿って平行移動して描画される。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "dimension": "width",
  "id": "16536",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class WheelZoomTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Scroll

ツールバーアイコン ：

ローラズームツールは，現在のマウス位置を中心に拡大して描画する.

ローラスケーリングツールはまた、“一軸”スケーリングを行うために、描画の境界領域を活性化することができる。例えば、垂直枠や軸のズームは垂直方向のスケーリングにのみ影響を与え、水平サイズはそのままである。

dimensions¶

属性タイプ： Enum () Dimensions ）

制御ディスク格納ツールは、どのサイズで動作を実行するかを制約する。デフォルトでは、ローラスケーリングツールは、任意の次元を拡大するが、描画幅のみを水平にスケーリングするか、または描画高さを垂直にスケーリングするように構成されてもよい。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

maintain_focus¶

属性タイプ： Bool

ズームツールがその焦点位置を保持しているかどうか。Falseを設定することは，より“スライド”する行為を招き，人間がより滑らかに縮小できるようにするが，コストは焦点位置を失うことである.

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

speed¶

属性タイプ： Float

ローラーズームの速度。デフォルト値は1/600です。最適範囲は0.001~0.09%であった。高値は裁断される。ブラウザ間の速度は非常に速いかもしれません。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

zoom_on_axis¶

属性タイプ： Bool

このサイズは、軸上でスクロールされるかどうか(中心描画領域の外)にスケーリングされるべきである。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "dimensions": "both",
  "id": "16543",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "maintain_focus": true,
  "name": null,
  "speed": 0.0016666666666666668,
  "subscribed_events": [],
  "tags": [],
  "zoom_on_axis": true
}

class ZoomInTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Action

ツールバーアイコン ：

拡大ツールは，ユーザがボタンをクリックして固定数の拡大を行うことを可能にする.

dimensions¶

属性タイプ： Enum () Dimensions ）

拡大ツールは、どのサイズで動作を実行するかに制限される。デフォルトでは、拡大ツールは、任意の次元を拡大するが、描画の幅のみを水平にスケーリングするか、または描画の高さを垂直にスケーリングするように構成されてもよい。

factor¶

属性タイプ： Percent

拡大ツールをクリックするたびのズーム率。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "dimensions": "both",
  "factor": 0.1,
  "id": "16553",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}

class ZoomOutTool(*args, **kwargs)[ソース]¶

ベースクラス: bokeh.models.tools.Action

ツールバーアイコン ：

縮小ツールにより、ユーザはボタンをクリックして固定数を縮小することができます。

dimensions¶

属性タイプ： Enum () Dimensions ）

縮小ツールは、どのサイズで動作を実行するかに制限される。デフォルトでは、縮小ツールは任意の次元を拡大するが、描画幅のみを水平にスケーリングするか、または描画高さを垂直にスケーリングするように構成されてもよい。

factor¶

属性タイプ： Percent

拡大ツールをクリックするたびのズーム率。

js_event_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)

js_property_callbacks¶

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)

name¶

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events¶

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags¶

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

apply_theme(property_values)¶

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ: property_values (dict) -- デフォルト値の代わりにテーマ値を使用します
戻り値: なし

classmethod dataspecs()¶

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前または名前 DataSpec 特性
戻り値の型: set[str]

classmethod dataspecs_with_props()¶

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 名前と名前のマッピング DataSpec 特性
戻り値の型: dict[str, DataSpec]

equals(other)¶

モデルの構造は平等である.

パラメータ: other (HasProps) -- 比較するもう一つの例は
戻り値: 属性が構造的に等しいならばTrue，そうでなければFalseとなる.

classmethod from_string(name: str) → bokeh.models.tools.Tool ¶: 文字列を取得し、対応するものを返す Tool 例を挙げましょう

js_link(attr, other, other_attr, attr_selector=None)¶

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

attr (str) -- このモデル上のBokeh属性の名前
other (Model) -- Self.attrにリンクされたBokehモデル
other_attr (str) -- 上の属性 other リンクがつながっている
attr_selector (Union[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, *callbacks)¶

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

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)

layout(side, plot)¶

classmethod lookup(name)¶

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ: name (str) -- 検索する属性の名前
戻り値: 名前の属性の記述子 name
戻り値の型: PropertyDescriptor

on_change(attr, *callbacks)¶

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

attr (str) -- このオブジェクトの属性名
*callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

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

classmethod properties(with_bases=True)¶

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ: with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)
戻り値: 属性名
戻り値の型: set[str]

classmethod properties_containers()¶

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 容器属性名
戻り値の型: set[str]

classmethod properties_with_refs()¶

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値: 引用の属性を持つ名前
戻り値の型: set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]¶

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ: include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)
戻り値: 属性名からその値へのマッピング
戻り値の型: dict

query_properties_with_values(query, include_defaults=True)¶

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す
include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()¶: すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)¶: この対象からコールバックを削除する

select(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ: selector (JSON-like) --
戻り値: 配列番号. [模型]

select_one(selector)¶

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値: 模型

set_from_json(name, json, models=None, setter=None)¶

JSONからこのオブジェクトの属性値を設定する.

パラメータ

name -- (Str)：設定する属性の名前
json -- (json-value)：設定する属性の値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)¶

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

パラメータ

selector (JSON-like) --
updates (dict) --

戻り値

なし

themed_values()¶

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値: DICTやNONE

to_json(include_defaults)¶

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)¶

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ: include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)¶

unapply_theme()¶

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値: なし

update(**kwargs)¶

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値: なし

サンプル

以下の内容は等価である.

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)

update_from_json(json_attributes, models=None, setter=None)¶

JSON属性辞書から対象の属性を更新する.

パラメータ

json_attributes -- (json-dict)：更新する属性と値
models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.
setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document¶: ♪the Document このモデルは添付されています None ）

property struct¶

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype

{
  "dimensions": "both",
  "factor": 0.1,
  "id": "16561",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}