bokeh.models.annotations¶

Bokehブロックに様々な注釈を追加できるレンダラー

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

ベースクラス: bokeh.models.renderers.Renderer

すべてのアノテーションモデルの基底クラス.

注釈

これは，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)

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

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もいかなる理由でもこれらのラベルを直接使用することはない。

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)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となる.

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": "8835",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

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

ベースクラス: bokeh.models.annotations.Annotation

矢印を注釈にレンダリングする。

見矢.矢印刷矢印に関する情報は、参照されたい。

end¶

属性タイプ： Instance () ArrowHead ）

実例. ArrowHead それがそうです。

end_units¶

属性タイプ： Enum () SpatialUnits ）

End_xとend_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)

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

line_alpha¶

属性タイプ： NumberSpec

矢印本体の線Alpha値。

line_cap¶

属性タイプ： Enum () LineCap ）

矢印本体のキャップ値.

line_color¶

属性タイプ： ColorSpec

矢印本文の線色値。

line_dash¶

属性タイプ： DashPattern

矢印本体の線画値.

line_dash_offset¶

属性タイプ： Int

矢印本体のラインオフセット値。

line_join¶

属性タイプ： Enum () LineJoin ）

矢印本体の線接続値.

line_width¶

属性タイプ： NumberSpec

矢印本文の線幅値.

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もいかなる理由でもその名前を直接使用することはない。

source¶

属性タイプ： Instance () DataSource ）

書き込み時に使用するローカルデータソースを描画上に提示する.

start¶

属性タイプ： Instance () ArrowHead ）

実例. ArrowHead それがそうです。

start_units¶

属性タイプ： Enum () SpatialUnits ）

Start_xおよびstart_y属性の単位タイプ。デフォルトでは“データ空間”単位と解釈される.

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もいかなる理由でもこれらのラベルを直接使用することはない。

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x_end¶

属性タイプ： NumberSpec

矢印の末端のx座標を位置決めするために用いられる.

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

x_start¶

属性タイプ： NumberSpec

矢印の始点のx座標を位置決めするために用いられる.

y_end¶

属性タイプ： NumberSpec

矢印の末端のy座標を位置決めするために用いられる.

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)y範囲を計算するために使用される。設定されていない場合は、デフォルトのy範囲を使用します。

y_start¶

属性タイプ： NumberSpec

矢印の始点の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となる.

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

{
  "end": {
    "id": "8846"
  },
  "end_units": "data",
  "id": "8845",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "line_alpha": {
    "value": 1.0
  },
  "line_cap": "butt",
  "line_color": {
    "value": "black"
  },
  "line_dash": [],
  "line_dash_offset": 0,
  "line_join": "bevel",
  "line_width": {
    "value": 1
  },
  "name": null,
  "source": null,
  "start": null,
  "start_units": "data",
  "subscribed_events": [],
  "tags": [],
  "visible": true,
  "x_end": null,
  "x_range_name": "default",
  "x_start": null,
  "y_end": null,
  "y_range_name": "default",
  "y_start": null
}

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

ベースクラス: bokeh.models.annotations.Annotation

パディング領域タグ付けバーは、サイズに沿ってレンダリングされます。

見バンド.バンド印刷マーキング欄に関する情報は、参照されたい。

base¶

属性タイプ： PropertyUnitsSpec

上下値の直交座標。

dimension¶

属性タイプ： Enum () Dimension ）

この属性を“Height”に設定することで帯域の方向を指定することができる. (y 方向)または“幅” (x 方向)。

fill_alpha¶

属性タイプ： Percent

帯区の充填Alpha値。

fill_color¶

属性タイプ： Color

ゾーン付き充填色値。

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)

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

line_alpha¶

属性タイプ： Percent

添字欄の線Alpha値。

line_cap¶

属性タイプ： Enum () LineCap ）

添字欄のキャップ値。

line_color¶

属性タイプ： Color

添字欄の線色値。

line_dash¶

属性タイプ： DashPattern

添字欄の線画値。

line_dash_offset¶

属性タイプ： Int

添字欄のラインオフセット値。

line_join¶

属性タイプ： Enum () LineJoin ）

添字欄の線接続値.

line_width¶

属性タイプ： Float

帯の線幅値。

lower¶

属性タイプ： PropertyUnitsSpec

パッド領域はカラム下部の座標をマーキングする.

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もいかなる理由でもその名前を直接使用することはない。

source¶

属性タイプ： Instance () DataSource ）

書き込み時に使用するローカルデータソースを描画上に提示する.

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もいかなる理由でもこれらのラベルを直接使用することはない。

upper¶

属性タイプ： PropertyUnitsSpec

パッド領域はカラム上部の座標をマーキングする.

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)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となる.

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

{
  "base": null,
  "dimension": "height",
  "fill_alpha": 0.4,
  "fill_color": "#fff9ba",
  "id": "8872",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "line_alpha": 0.3,
  "line_cap": "butt",
  "line_color": "#cccccc",
  "line_dash": [],
  "line_dash_offset": 0,
  "line_join": "bevel",
  "line_width": 1,
  "lower": null,
  "name": null,
  "source": {
    "id": "8873"
  },
  "subscribed_events": [],
  "tags": [],
  "upper": null,
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

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

ベースクラス: bokeh.models.annotations.Annotation

着色矩形領域をアノテーションとしてレンダリングする.

見ブロック注釈. 印刷枠の注釈に関する情報は、以下の操作を実行してください。

bottom¶

property type: Either ( Auto , NumberSpec )

底辺のy座標をボックスに書き込む.

日時値も受け入れられるが，ただちに紀元以来のミリ秒数に変換されることに注意されたい.

bottom_units¶

属性タイプ： Enum () SpatialUnits ）

下部属性の単位タイプ。デフォルトでは“データ空間”単位と解釈される.

fill_alpha¶

属性タイプ： Percent

枠の充填Alpha値。

fill_color¶

属性タイプ： Color

枠の充填色値。

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)

left¶

property type: Either ( Auto , NumberSpec )

四角枠は左エッジのx座標を注入する.

日時値も受け入れられるが，ただちに紀元以来のミリ秒数に変換されることに注意されたい.

left_units¶

属性タイプ： Enum () SpatialUnits ）

左側属性の単位タイプ.デフォルトでは“データ空間”単位と解釈される.

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

line_alpha¶

属性タイプ： Percent

直方体の線Alpha値。

line_cap¶

属性タイプ： Enum () LineCap ）

枠のキャップの値。

line_color¶

属性タイプ： Color

枠の線色値。

line_dash¶

属性タイプ： DashPattern

枠の線の値。

line_dash_offset¶

属性タイプ： Int

枠のラインオフセット値。

line_join¶

属性タイプ： Enum () LineJoin ）

直方体の線接続値.

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もいかなる理由でもその名前を直接使用することはない。

render_mode¶

属性タイプ： Enum () RenderMode ）

枠がキャンバス要素として提示されるか，キャンバス上に覆われたCSS要素として提示されるかを指定する。デフォルトモードは“Canvas”である.

警告

RENDER_MODEが“CSS”に設定されている場合、line_dashおよびline_dash_Offset属性はサポートされていない

right¶

property type: Either ( Auto , NumberSpec )

ブロックは右エッジのx座標を指定する.

日時値も受け入れられるが，ただちに紀元以来のミリ秒数に変換されることに注意されたい.

right_units¶

属性タイプ： Enum () SpatialUnits ）

右側属性の単位タイプ.デフォルトでは“データ空間”単位と解釈される.

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もいかなる理由でもこれらのラベルを直接使用することはない。

top¶

property type: Either ( Auto , NumberSpec )

ボックス書き込みの上エッジのy座標.

日時値も受け入れられるが，ただちに紀元以来のミリ秒数に変換されることに注意されたい.

top_units¶

属性タイプ： Enum () SpatialUnits ）

トップ属性の単位タイプ。デフォルトでは“データ空間”単位と解釈される.

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)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となる.

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

{
  "bottom": null,
  "bottom_units": "data",
  "fill_alpha": 0.4,
  "fill_color": "#fff9ba",
  "id": "8897",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "left": null,
  "left_units": "data",
  "level": "annotation",
  "line_alpha": 0.3,
  "line_cap": "butt",
  "line_color": "#cccccc",
  "line_dash": [],
  "line_dash_offset": 0,
  "line_join": "bevel",
  "line_width": 1,
  "name": null,
  "render_mode": "canvas",
  "right": null,
  "right_units": "data",
  "subscribed_events": [],
  "tags": [],
  "top": null,
  "top_units": "data",
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

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

ベースクラス: bokeh.models.annotations.Annotation

カラーバーは、カラーマッパーに基づいてレンダリングされます。

見色条. カラーバーの印刷に関する情報は、参照されたい。

background_fill_alpha¶

属性タイプ： Percent

カラーバー背景パターンのパディングAlpha。

background_fill_color¶

属性タイプ： Color

カラーバー背景スタイルの充填色。

bar_line_alpha¶

属性タイプ： Percent

色スケールの輪郭の線Alpha。

bar_line_cap¶

属性タイプ： Enum () LineCap ）

色縮尺の輪郭の線帽子。

bar_line_color¶

属性タイプ： Color

カラーマークの輪郭のライン色。

bar_line_dash¶

属性タイプ： DashPattern

色縮尺の輪郭の線。

bar_line_dash_offset¶

属性タイプ： Int

カラーバーの輪郭のラインずれ量。

bar_line_join¶

属性タイプ： Enum () LineJoin ）

色縮尺輪郭の線が接続されている.

bar_line_width¶

属性タイプ： Float

カラーバーの輪郭の線幅。

border_line_alpha¶

属性タイプ： Percent

色欄枠の輪郭の線Alpha。

border_line_cap¶

属性タイプ： Enum () LineCap ）

色欄枠の輪郭のワイヤキャップ。

border_line_color¶

属性タイプ： Color

色欄枠の輪郭の線色。

border_line_dash¶

属性タイプ： DashPattern

色欄枠の輪郭の線。

border_line_dash_offset¶

属性タイプ： Int

色欄枠輪郭の線ずれ量。

border_line_join¶

属性タイプ： Enum () LineJoin ）

カラーバー枠の輪郭の線がつながっています。

border_line_width¶

属性タイプ： Float

色欄枠の輪郭の線幅。

color_mapper¶

属性タイプ： Instance () ContinuousColorMapper ）

レンダリングするカラーパレットを含む連続カラーマッパー。

警告

もし low そして high の属性 ColorMapper 目盛りや目盛りのラベルは表示されませんまたもし LogTicker 伝達することができます ticker パラメータおよび/または2つの対数のうちの1つまたは2つ low そして high Color_mapperの値は数字ではない(すなわち low=0 )であれば、目盛りや目盛りラベルはレンダリングされません。

formatter¶

属性タイプ： Instance () TickFormatter ）

A TickFormatter スケールの視覚的外観をフォーマットするために使われています

height¶

property type: Either ( Auto , Int )

色標が占めるべき高さ(画素単位)である.

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)

label_standoff¶

属性タイプ： Int

目盛線ラベルとカラーバーとの間の分離距離(画素単位)である.

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

location¶

property type: Either ( Enum ( LegendLocation ), Tuple ( Float , Float ) )

色バーは自分で描かなければならない位置です。これは以下の2つのうちの1つであることができる bokeh.core.enums.LegendLocation 枚挙値、または1つ (x, y) 画面座標における絶対位置(左下から始まる画素)の絶対位置を示すタプル。

警告

サイドパネルにカラーバーが配置されている場合には、位置を設定する必要がある場合があります (0,0) それがそうです。

major_label_overrides¶

property type: Dict ( Either ( Float , String ), String )

通常のフォーマットの代わりに特定の記号位置に明示的な記号ラベル値を提供する.

major_label_text_align¶

属性タイプ： Enum () TextAlign ）

主要記号ラベルのテキスト整列.

major_label_text_alpha¶

属性タイプ： Percent

主な記号ラベルのテキストAlpha.

major_label_text_baseline¶

属性タイプ： Enum () TextBaseline ）

主要記号ラベルのテキストベースライン

major_label_text_color¶

属性タイプ： Color

メインスケールラベルのテキスト色。

major_label_text_font¶

属性タイプ： String

メインスケールラベルのテキストフォント。

major_label_text_font_size¶

属性タイプ： FontSize

メイン目盛線ラベルのテキストフォントサイズ。

major_label_text_font_style¶

属性タイプ： Enum () FontStyle ）

主な記号ラベルのテキストフォントパターン.

major_label_text_line_height¶

属性タイプ： Float

メイン目盛りラベルのテキスト行の高さ。

major_tick_in¶

属性タイプ： Int

メイン目盛線は、主印刷領域までの距離(画素単位)まで延在すべきである。

major_tick_line_alpha¶

属性タイプ： Percent

主にマダニのAlpha線です

major_tick_line_cap¶

属性タイプ： Enum () LineCap ）

主にマダニの糸帽子です。

major_tick_line_color¶

属性タイプ： Color

メイン目盛りのライン色。

major_tick_line_dash¶

属性タイプ： DashPattern

主なダニの線。

major_tick_line_dash_offset¶

属性タイプ： Int

主目盛りの線線ずれ量。

major_tick_line_join¶

属性タイプ： Enum () LineJoin ）

メイン目盛りの線がつながっています。

major_tick_line_width¶

属性タイプ： Float

メイン目盛りの線幅。

major_tick_out¶

属性タイプ： Int

メイン目盛線は、主印刷領域外までの距離(画素単位)まで延在すべきである。

margin¶

属性タイプ： Int

色欄外部周囲のエッジ距離(画素単位)である.

minor_tick_in¶

属性タイプ： Int

サブ目盛線は、主描画領域までの距離(画素単位)まで延びるべきである。

minor_tick_line_alpha¶

属性タイプ： Percent

小刻み線のAlpha線です。

minor_tick_line_cap¶

属性タイプ： Enum () LineCap ）

小刻み線の帽子。

minor_tick_line_color¶

属性タイプ： Color

副次的な目盛りの線色。

minor_tick_line_dash¶

属性タイプ： DashPattern

小さな目盛りの線に線を引く。

minor_tick_line_dash_offset¶

属性タイプ： Int

サブ目盛線の線ずれ量。

minor_tick_line_join¶

属性タイプ： Enum () LineJoin ）

二次目盛線の接続線。

minor_tick_line_width¶

属性タイプ： Float

二次目盛線の線幅。

minor_tick_out¶

属性タイプ： Int

メイン目盛線は、主印刷領域外までの距離(画素単位)まで延在すべきである。

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もいかなる理由でもその名前を直接使用することはない。

orientation¶

属性タイプ： Enum () Orientation ）

色欄は垂直であるべきか水平方向であるべきか。

padding¶

属性タイプ： Int

カラーマークとカラーバー枠との間の充填量(画素単位)。

scale_alpha¶

属性タイプ： Float

色標を表現するためのAlphaです

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もいかなる理由でもこれらのラベルを直接使用することはない。

ticker¶

属性タイプ： Instance () ContinuousTicker ）

軸モジュールの位置を計算するためのタイマ.

title¶

属性タイプ： String

タイトルテキストを提示します。

title_standoff¶

属性タイプ： Int

見出しと色欄の区切り距離(画素単位)

title_text_align¶

属性タイプ： Enum () TextAlign ）

テキストはタイトルテキストの値を整列させる.

title_text_alpha¶

属性タイプ： Percent

タイトルテキストのテキストAlpha値.

title_text_baseline¶

属性タイプ： Enum () TextBaseline ）

見出しテキストのテキストベースライン値.

title_text_color¶

属性タイプ： Color

タイトルテキストのテキスト色値。

title_text_font¶

属性タイプ： String

見出しテキストのテキストフォント値.

title_text_font_size¶

属性タイプ： FontSize

見出しテキストのテキストフォントのサイズ値.

title_text_font_style¶

属性タイプ： Enum () FontStyle ）

見出しテキストのテキストフォントスタイル値.

title_text_line_height¶

属性タイプ： Float

見出しテキストのテキスト行高さ値

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

width¶

property type: Either ( Auto , Int )

色標が占めるべき幅(画素単位)である.

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)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となる.

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

{
  "background_fill_alpha": 0.95,
  "background_fill_color": "#ffffff",
  "bar_line_alpha": 1.0,
  "bar_line_cap": "butt",
  "bar_line_color": null,
  "bar_line_dash": [],
  "bar_line_dash_offset": 0,
  "bar_line_join": "bevel",
  "bar_line_width": 1,
  "border_line_alpha": 1.0,
  "border_line_cap": "butt",
  "border_line_color": null,
  "border_line_dash": [],
  "border_line_dash_offset": 0,
  "border_line_join": "bevel",
  "border_line_width": 1,
  "color_mapper": null,
  "formatter": {
    "id": "8926"
  },
  "height": "auto",
  "id": "8925",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "label_standoff": 5,
  "level": "annotation",
  "location": "top_right",
  "major_label_overrides": {},
  "major_label_text_align": "center",
  "major_label_text_alpha": 1.0,
  "major_label_text_baseline": "middle",
  "major_label_text_color": "#444444",
  "major_label_text_font": "helvetica",
  "major_label_text_font_size": "11px",
  "major_label_text_font_style": "normal",
  "major_label_text_line_height": 1.2,
  "major_tick_in": 5,
  "major_tick_line_alpha": 1.0,
  "major_tick_line_cap": "butt",
  "major_tick_line_color": "#ffffff",
  "major_tick_line_dash": [],
  "major_tick_line_dash_offset": 0,
  "major_tick_line_join": "bevel",
  "major_tick_line_width": 1,
  "major_tick_out": 0,
  "margin": 30,
  "minor_tick_in": 0,
  "minor_tick_line_alpha": 1.0,
  "minor_tick_line_cap": "butt",
  "minor_tick_line_color": null,
  "minor_tick_line_dash": [],
  "minor_tick_line_dash_offset": 0,
  "minor_tick_line_join": "bevel",
  "minor_tick_line_width": 1,
  "minor_tick_out": 0,
  "name": null,
  "orientation": "vertical",
  "padding": 10,
  "scale_alpha": 1.0,
  "subscribed_events": [],
  "tags": [],
  "ticker": {
    "id": "8927"
  },
  "title": null,
  "title_standoff": 2,
  "title_text_align": "left",
  "title_text_alpha": 1.0,
  "title_text_baseline": "bottom",
  "title_text_color": "#444444",
  "title_text_font": "helvetica",
  "title_text_font_size": "13px",
  "title_text_font_style": "italic",
  "title_text_line_height": 1.2,
  "visible": true,
  "width": "auto",
  "x_range_name": "default",
  "y_range_name": "default"
}

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

ベースクラス: bokeh.models.annotations.TextAnnotation

単一のテキストラベルを書き込みとしてレンダリングする.

Label 与えられた位置に単一のテキストタグが提示される x そして y 座標は、スクリーン(画素)空間であってもよいし、データ(軸範囲)空間であってもよい。

スクリーン空間オフセットを使用してラベルを構成することもできます x そして y 使用することで x_offset そして y_offset 財産です。

またラベルは angle 財産です。

また，テキストの外観，背景，矩形境界枠枠を制御するために標準的なテキスト，フィラー，線属性がある.

見ラベル印刷ラベルに関する情報は、参照されたい。

angle¶

属性タイプ： Angle

回転テキストの角度は、水平方向から測定する。

警告

CanvasとCSS Render_Modesは回転中心が異なる.上の render_mode="canvas" タグは書き込みの左上から回転しています render_mode="css" アノテーションはその中心の周りを回転する.

angle_units¶

属性タイプ： Enum () AngleUnits ）

単位の受信可能値は "rad" そして "deg"

background_fill_alpha¶

属性タイプ： Percent

テキストフレームのフィラーAlpha値.

background_fill_color¶

属性タイプ： Color

テキスト枠の埋め込み色値。

border_line_alpha¶

属性タイプ： Percent

テキスト枠の線Alpha値。

border_line_cap¶

属性タイプ： Enum () LineCap ）

テキストフレームのキャップ値。

border_line_color¶

属性タイプ： Color

テキスト枠の線色値。

border_line_dash¶

属性タイプ： DashPattern

テキストフレームの線画値。

border_line_dash_offset¶

属性タイプ： Int

テキストフレームのラインオフセット値。

border_line_join¶

属性タイプ： Enum () LineJoin ）

テキスト枠の線リンク値。

border_line_width¶

属性タイプ： Float

テキストフレームの線幅値。

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)

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

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もいかなる理由でもその名前を直接使用することはない。

render_mode¶

属性タイプ： Enum () RenderMode ）

テキストがキャンバス要素として提示されるか，キャンバス上にカバーされたCSS要素として提示されるかを指定する。デフォルトモードは“Canvas”である.

注釈

CSSタグは“保存”ツールを用いた出力には現れない.

警告

RENDER_MODEが“CSS”に設定されている場合、すべての視覚スタイル属性がサポートされているわけではありません。BORDER_LINE_DASH属性は完全にサポートされておらず、BORDER_LINE_DASH_OFFSETは全くサポートされていません。テキストに加えて、text_alphaを設定すると、背景枠や枠全体の不透明度が修正されます。最後に，“CSS”モードは描画領域内でラベルアノテーションを裁断することをサポートしていない.

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もいかなる理由でもこれらのラベルを直接使用することはない。

text¶

属性タイプ： String

提示するテキスト値です

text_align¶

属性タイプ： Enum () TextAlign ）

テキストはテキストの値を揃える.

text_alpha¶

属性タイプ： Percent

テキストのテキストAlpha値.

text_baseline¶

属性タイプ： Enum () TextBaseline ）

テキストのテキストベースライン値.

text_color¶

属性タイプ： Color

テキストのテキスト色値。

text_font¶

属性タイプ： String

テキストのテキストフォント値.

text_font_size¶

属性タイプ： FontSize

テキストのテキストフォントのサイズ値.

text_font_style¶

属性タイプ： Enum () FontStyle ）

テキストのテキストフォントスタイル値。

text_line_height¶

属性タイプ： Float

テキストのテキスト行高さ値

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x¶

属性タイプ： Float

テキストアンカーの位置を特定するための画面座標におけるx座標。

日時値も受け入れられるが，ただちに紀元以来のミリ秒数に変換されることに注意されたい.

x_offset¶

属性タイプ： Float

X座標のオフセット値に適用する.

例えば、テキストを所与のデータ位置から画面単位で距離を“フローティング”する必要がある場合、これは有用である。

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

x_units¶

属性タイプ： Enum () SpatialUnits ）

X属性の単位タイプ.デフォルトでは“データ空間”単位と解釈される.

y¶

属性タイプ： Float

画面座標におけるy座標は、テキストアンカーを位置させるために使用される。

日時値も受け入れられるが，ただちに紀元以来のミリ秒数に変換されることに注意されたい.

y_offset¶

属性タイプ： Float

Y座標のオフセット値に適用する.

例えば、テキストを所与のデータ位置から画面単位で距離を“フローティング”する必要がある場合、これは有用である。

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)y範囲を計算するために使用される。設定されていない場合は、デフォルトのy範囲を使用します。

y_units¶

属性タイプ： Enum () SpatialUnits ）

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となる.

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

{
  "angle": 0,
  "angle_units": "rad",
  "background_fill_alpha": 1.0,
  "background_fill_color": null,
  "border_line_alpha": 1.0,
  "border_line_cap": "butt",
  "border_line_color": null,
  "border_line_dash": [],
  "border_line_dash_offset": 0,
  "border_line_join": "bevel",
  "border_line_width": 1,
  "id": "9001",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "name": null,
  "render_mode": "canvas",
  "subscribed_events": [],
  "tags": [],
  "text": null,
  "text_align": "left",
  "text_alpha": 1.0,
  "text_baseline": "bottom",
  "text_color": "#444444",
  "text_font": "helvetica",
  "text_font_size": "16px",
  "text_font_style": "normal",
  "text_line_height": 1.2,
  "visible": true,
  "x": null,
  "x_offset": 0,
  "x_range_name": "default",
  "x_units": "data",
  "y": null,
  "y_offset": 0,
  "y_range_name": "default",
  "y_units": "data"
}

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

ベースクラス: bokeh.models.annotations.TextAnnotation

複数のテキストタグを書き込みとして提示する.

LabelSet 所与の位置に複数のテキストタグが提示される x そして y 座標は、スクリーン(画素)空間であってもよいし、データ(軸範囲)空間であってもよい。この場合(単一の場合とは) Label モデル)、 x そして y そうでもいい ColumnDataSource この場合，ラベルは指定された列中の座標値を用いて“ベクトル化”を行う.

スクリーン空間オフセットを使用してラベルを構成することもできます x そして y 使用することで x_offset そして y_offset 財産です。これらのオフセットは、データソース列の名前を与えることによってベクトル化することができる。

またラベルは angle 属性(列名であってもよい.

また，テキストの外観，背景，矩形境界枠枠を制御するために標準的なテキスト，フィラー，線属性がある.

データソースは設定によって source 財産です。

angle¶

属性タイプ： AngleSpec

回転テキストの角度は、水平方向から測定する。

警告

CanvasとCSS Render_Modesは回転中心が異なる.上の render_mode="canvas" タグは書き込みの左上から回転しています render_mode="css" アノテーションはその中心の周りを回転する.

background_fill_alpha¶

属性タイプ： NumberSpec

テキストフレームのフィラーAlpha値.

background_fill_color¶

属性タイプ： ColorSpec

テキスト枠の埋め込み色値。

border_line_alpha¶

属性タイプ： NumberSpec

テキスト枠の線Alpha値。

border_line_cap¶

属性タイプ： Enum () LineCap ）

テキストフレームのキャップ値。

border_line_color¶

属性タイプ： ColorSpec

テキスト枠の線色値。

border_line_dash¶

属性タイプ： DashPattern

テキストフレームの線画値。

border_line_dash_offset¶

属性タイプ： Int

テキストフレームのラインオフセット値。

border_line_join¶

属性タイプ： Enum () LineJoin ）

テキスト枠の線リンク値。

border_line_width¶

属性タイプ： NumberSpec

テキストフレームの線幅値。

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)

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

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もいかなる理由でもその名前を直接使用することはない。

render_mode¶

属性タイプ： Enum () RenderMode ）

テキストがキャンバス要素として提示されるか，キャンバス上にカバーされたCSS要素として提示されるかを指定する。デフォルトモードは“Canvas”である.

注釈

CSSタグは“保存”ツールを用いた出力には現れない.

警告

RENDER_MODEが“CSS”に設定されている場合、すべての視覚スタイル属性がサポートされているわけではありません。BORDER_LINE_DASH属性は完全にサポートされておらず、BORDER_LINE_DASH_OFFSETは全くサポートされていません。テキストに加えて、text_alphaを設定すると、背景枠や枠全体の不透明度が修正されます。最後に，“CSS”モードは描画領域内でラベルアノテーションを裁断することをサポートしていない.

source¶

属性タイプ： Instance () DataSource ）

書き込み時に使用するローカルデータソースを描画上に提示する.

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もいかなる理由でもこれらのラベルを直接使用することはない。

text¶

属性タイプ： StringSpec

提示するテキスト値です

text_align¶

属性タイプ： Enum () TextAlign ）

テキストはテキストの値を揃える.

text_alpha¶

属性タイプ： NumberSpec

テキストのテキストAlpha値.

text_baseline¶

属性タイプ： Enum () TextBaseline ）

テキストのテキストベースライン値.

text_color¶

属性タイプ： ColorSpec

テキストのテキスト色値。

text_font¶

属性タイプ： String

テキストのテキストフォント値.

text_font_size¶

属性タイプ： FontSizeSpec

テキストのテキストフォントのサイズ値.

text_font_style¶

属性タイプ： Enum () FontStyle ）

テキストのテキストフォントスタイル値。

text_line_height¶

属性タイプ： Float

テキストのテキスト行高さ値

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x¶

属性タイプ： NumberSpec

テキストアンカーのx座標の位置を特定するために使用される。

x_offset¶

属性タイプ： NumberSpec

X座標のオフセット値に適用する.

例えば、テキストを所与のデータ位置から画面単位で距離を“フローティング”する必要がある場合、これは有用である。

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

x_units¶

属性タイプ： Enum () SpatialUnits ）

単位タイプです。 xs 属性です。デフォルトでは“データ空間”単位と解釈される.

y¶

属性タイプ： NumberSpec

Y座標は、テキストアンカーの位置を特定する。

y_offset¶

属性タイプ： NumberSpec

Y座標のオフセット値に適用する.

例えば、テキストを所与のデータ位置から画面単位で距離を“フローティング”する必要がある場合、これは有用である。

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)y範囲を計算するために使用される。設定されていない場合は、デフォルトのy範囲を使用します。

y_units¶

属性タイプ： Enum () SpatialUnits ）

単位タイプです。 ys 属性です。デフォルトでは“データ空間”単位と解釈される.

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

{
  "angle": {
    "units": "rad",
    "value": 0
  },
  "background_fill_alpha": {
    "value": 1.0
  },
  "background_fill_color": {
    "value": null
  },
  "border_line_alpha": {
    "value": 1.0
  },
  "border_line_cap": "butt",
  "border_line_color": {
    "value": null
  },
  "border_line_dash": [],
  "border_line_dash_offset": 0,
  "border_line_join": "bevel",
  "border_line_width": {
    "value": 1
  },
  "id": "9038",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "name": null,
  "render_mode": "canvas",
  "source": {
    "id": "9039"
  },
  "subscribed_events": [],
  "tags": [],
  "text": {
    "field": "text"
  },
  "text_align": "left",
  "text_alpha": {
    "value": 1.0
  },
  "text_baseline": "bottom",
  "text_color": {
    "value": "#444444"
  },
  "text_font": "helvetica",
  "text_font_size": {
    "value": "16px"
  },
  "text_font_style": "normal",
  "text_line_height": 1.2,
  "visible": true,
  "x": null,
  "x_offset": {
    "value": 0
  },
  "x_range_name": "default",
  "x_units": "data",
  "y": null,
  "y_offset": {
    "value": 0
  },
  "y_range_name": "default",
  "y_units": "data"
}

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

ベースクラス: bokeh.models.annotations.Annotation

描画の情報性グラフの例をレンダリングする.

見伝説印刷図の例に関する情報は、参照されたい。

background_fill_alpha¶

属性タイプ： Percent

背景パターンのパディングAlphaを例に示す.

background_fill_color¶

属性タイプ： Color

図例背景パターンのフィラー色.

border_line_alpha¶

属性タイプ： Percent

図の枠の輪郭の線Alpha。

border_line_cap¶

属性タイプ： Enum () LineCap ）

図例枠の輪郭のワイヤキャップ。

border_line_color¶

属性タイプ： Color

図例枠の輪郭の線色。

border_line_dash¶

属性タイプ： DashPattern

図の枠の輪郭の線。

border_line_dash_offset¶

属性タイプ： Int

図例枠輪郭の線ずれ量.

border_line_join¶

属性タイプ： Enum () LineJoin ）

図例枠の輪郭の線がつながっている。

border_line_width¶

属性タイプ： Float

図例枠輪郭の線幅。

click_policy¶

属性タイプ： Enum () LegendClickPolicy ）

Lengendの項目をクリックしたときに発生する場合を定義する.

glyph_height¶

属性タイプ： Int

レンダリングされたインスタンスフラグ記号が占めるべき高さ(画素単位)である.

glyph_width¶

属性タイプ： Int

レンダリングされたインスタンスフラグ記号が占めるべき幅(画素単位)である.

inactive_fill_alpha¶

属性タイプ： Percent

図例項パターンが非アクティブ状態にある場合のパディングAlpha.これらは、対応するフォントが非アクティブ状態(例えば、半透明にすることによって)にあるときに、アイテムを遮蔽するために使用することができるアイテム上のカバレッジを制御する。

inactive_fill_color¶

属性タイプ： Color

図例項パターンが非アクティブ状態にある場合のパディング色.これらは、対応するフォントが非アクティブ状態(例えば、半透明にすることによって)にあるときに、アイテムを遮蔽するために使用することができるアイテム上のカバレッジを制御する。

items¶

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

1部の明細書. LegendItem 図の例に示す例。

これは、例えば、明示的に指定することができる。

legend = Legend(items=[
    LegendItem(label="sin(x)"   , renderers=[r0, r1]),
    LegendItem(label="2*sin(x)" , renderers=[r2]),
    LegendItem(label="3*sin(x)" , renderers=[r3, r4])
])

しかしながら、便宜上、タプルリストの形態でより簡潔に与えられてもよい。

legend = Legend(items=[
    ("sin(x)"   , [r0, r1]),
    ("2*sin(x)" , [r2]),
    ("3*sin(x)" , [r3, r4])
])

ここで、各タプルの形態は： (ラベル、レンダラー) それがそうです。

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)

label_height¶

属性タイプ： Int

図例タグが占めるべき領域の最小高さ(画素単位)である.

label_standoff¶

属性タイプ： Int

ラベルとその関連字形を区切る距離(画素単位)である.

label_text_align¶

属性タイプ： Enum () TextAlign ）

テキストはインスタンスラベルと整列する.

label_text_alpha¶

属性タイプ： Percent

グラフラベルのテキストAlpha.

label_text_baseline¶

属性タイプ： Enum () TextBaseline ）

図例ラベルのテキストベースライン.

label_text_color¶

属性タイプ： Color

インスタンスラベルのテキスト色.

label_text_font¶

属性タイプ： String

図例ラベルのテキストフォント.

label_text_font_size¶

属性タイプ： FontSize

図例ラベルのテキストフォントサイズ.

label_text_font_style¶

属性タイプ： Enum () FontStyle ）

図例ラベルのテキストフォントパターン.

label_text_line_height¶

属性タイプ： Float

図例ラベルのテキスト行高さ.

label_width¶

属性タイプ： Int

図例ラベルが占めるべき領域の最小幅(画素単位)である.

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

location¶

property type: Either ( Enum ( LegendLocation ), Tuple ( Float , Float ) )

図例は自身の位置を描画すべきである.これは以下の2つのうちの1つであることができる bokeh.core.enums.LegendLocation 枚挙値、または1つ (x, y) 画面座標における絶対位置(左下から始まる画素)の絶対位置を示すタプル。

margin¶

属性タイプ： Int

図例周囲のページ辺距離.

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もいかなる理由でもその名前を直接使用することはない。

orientation¶

属性タイプ： Enum () Orientation ）

図面エントリを描画する際には、垂直に配置するか水平に配置するか。

padding¶

属性タイプ： Int

例の内容周囲の充填量を示す.枠が見える場合にのみ適用され、そうでなければ0に折り畳まれる。

spacing¶

属性タイプ： Int

図のエントリ間の間隔(画素単位)である。

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もいかなる理由でもこれらのラベルを直接使用することはない。

title¶

属性タイプ： String

タイトルテキストを提示します。

title_standoff¶

属性タイプ： Int

タイトルと図例との距離(画素単位)である。

title_text_align¶

属性タイプ： Enum () TextAlign ）

テキストはタイトルテキストの値を整列させる.

title_text_alpha¶

属性タイプ： Percent

タイトルテキストのテキストAlpha値.

title_text_baseline¶

属性タイプ： Enum () TextBaseline ）

見出しテキストのテキストベースライン値.

title_text_color¶

属性タイプ： Color

タイトルテキストのテキスト色値。

title_text_font¶

属性タイプ： String

見出しテキストのテキストフォント値.

title_text_font_size¶

属性タイプ： FontSize

見出しテキストのテキストフォントのサイズ値.

title_text_font_style¶

属性タイプ： Enum () FontStyle ）

見出しテキストのテキストフォントスタイル値.

title_text_line_height¶

属性タイプ： Float

見出しテキストのテキスト行高さ値

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)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となる.

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

{
  "background_fill_alpha": 0.95,
  "background_fill_color": "#ffffff",
  "border_line_alpha": 0.5,
  "border_line_cap": "butt",
  "border_line_color": "#e5e5e5",
  "border_line_dash": [],
  "border_line_dash_offset": 0,
  "border_line_join": "bevel",
  "border_line_width": 1,
  "click_policy": "none",
  "glyph_height": 20,
  "glyph_width": 20,
  "id": "9076",
  "inactive_fill_alpha": 0.7,
  "inactive_fill_color": "white",
  "items": [],
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "label_height": 20,
  "label_standoff": 5,
  "label_text_align": "left",
  "label_text_alpha": 1.0,
  "label_text_baseline": "middle",
  "label_text_color": "#444444",
  "label_text_font": "helvetica",
  "label_text_font_size": "13px",
  "label_text_font_style": "normal",
  "label_text_line_height": 1.2,
  "label_width": 20,
  "level": "annotation",
  "location": "top_right",
  "margin": 10,
  "name": null,
  "orientation": "vertical",
  "padding": 10,
  "spacing": 3,
  "subscribed_events": [],
  "tags": [],
  "title": null,
  "title_standoff": 5,
  "title_text_align": "left",
  "title_text_alpha": 1.0,
  "title_text_baseline": "bottom",
  "title_text_color": "#444444",
  "title_text_font": "helvetica",
  "title_text_font_size": "13px",
  "title_text_font_style": "italic",
  "title_text_line_height": 1.2,
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

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

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

index¶

属性タイプ： Int

代表的な項を描画するための列データインデックス.

None(デフォルト値)であれば，Bokehは使用するインデックスを自動的に選択する.ラベルがデータ列名を参照していない場合、これは、一般に、データソース内の第1のデータ点である。そうでなければ、ラベルが列名を参照している場合、図例は“GROUPBY”動作を有し、列の各“グループ”から代表点を選択して表示する。

1つの数字に設定されている場合、Boehはすべての場合にインデックスとして使用される。

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)

label¶

属性タイプ： StringSpec

この伝説のラベル。文字列であってもよいし，ColumnDataSourceの列であってもよい.もし label フィールドであれば、レンダラのdata_sourceに位置しなければならない。

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 () GlyphRenderer ））

図の例では、字形のレンダラーのリストを作成します。もし label フィールドであれば、レンダラのすべてのdata_sourceは同じでなければならない。

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

{
  "id": "9127",
  "index": null,
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "label": null,
  "name": null,
  "renderers": [],
  "subscribed_events": [],
  "tags": []
}

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

ベースクラス: bokeh.models.annotations.Annotation

着色ポリゴン領域をアノテーションとしてレンダリングする.

fill_alpha¶

属性タイプ： Percent

ポリゴンのパディングAlpha値.

fill_color¶

属性タイプ： Color

ポリゴンの埋め込み色値.

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)

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

line_alpha¶

属性タイプ： Percent

ポリゴンの線Alpha値。

line_cap¶

属性タイプ： Enum () LineCap ）

ポリゴンのキャップ値。

line_color¶

属性タイプ： Color

ポリゴンの線色値。

line_dash¶

属性タイプ： DashPattern

ポリゴンの線割値.

line_dash_offset¶

属性タイプ： Int

ポリゴンのラインオフセット値。

line_join¶

属性タイプ： Enum () LineJoin ）

ポリゴンの線接続値.

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もいかなる理由でもこれらのラベルを直接使用することはない。

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

xs¶

属性タイプ： Seq () Float ）

描画する領域のx座標.

xs_units¶

属性タイプ： Enum () SpatialUnits ）

単位タイプです。 xs 属性です。デフォルトでは“データ空間”単位と解釈される.

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)y範囲を計算するために使用される。設定されていない場合は、デフォルトのy範囲を使用します。

ys¶

属性タイプ： Seq () Float ）

描画する領域のy座標。

ys_units¶

属性タイプ： Enum () SpatialUnits ）

単位タイプです。 ys 属性です。デフォルトでは“データ空間”単位と解釈される.

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

{
  "fill_alpha": 0.4,
  "fill_color": "#fff9ba",
  "id": "9136",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "line_alpha": 0.3,
  "line_cap": "butt",
  "line_color": "#cccccc",
  "line_dash": [],
  "line_dash_offset": 0,
  "line_join": "bevel",
  "line_width": 1,
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "xs": [],
  "xs_units": "data",
  "y_range_name": "default",
  "ys": [],
  "ys_units": "data"
}

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

ベースクラス: bokeh.models.annotations.Annotation

斜線を注釈にレンダリングする。

見斜面.坂勾配の描画については、参照のこと。

gradient¶

属性タイプ： Float

線の勾配は，データ単位で表される

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)

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

line_alpha¶

属性タイプ： Percent

線のAlpha値。

line_cap¶

属性タイプ： Enum () LineCap ）

線のキャップ値。

line_color¶

属性タイプ： Color

線の線色値。

line_dash¶

属性タイプ： DashPattern

線の線画値。

line_dash_offset¶

属性タイプ： Int

直線の直線破線オフセット値。

line_join¶

属性タイプ： Enum () LineJoin ）

線の線の接続値。

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もいかなる理由でもこれらのラベルを直接使用することはない。

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

y_intercept¶

属性タイプ： Float

回線のy切片は，データ単位で表される

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)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となる.

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

{
  "gradient": null,
  "id": "9159",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "line_alpha": 1.0,
  "line_cap": "butt",
  "line_color": "black",
  "line_dash": [],
  "line_dash_offset": 0,
  "line_join": "bevel",
  "line_width": 1,
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_intercept": null,
  "y_range_name": "default"
}

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

ベースクラス: bokeh.models.annotations.Annotation

水平線または垂直線の幅をレンダリングします。

見スパン.スパン描画スパンに関する情報は、参照されたい。

dimension¶

属性タイプ： Enum () Dimension ）

この属性を“Height”に設定することでスパンの方向を指定することができる. (y 方向)または“幅” (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)

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

line_alpha¶

属性タイプ： Percent

スパンの線Alpha値です

line_cap¶

属性タイプ： Enum () LineCap ）

スパンのキャップ値。

line_color¶

属性タイプ： Color

スパンの線色値。

line_dash¶

属性タイプ： DashPattern

スパンの線画値。

line_dash_offset¶

属性タイプ： Int

スパンのラインオフセット値。

line_join¶

属性タイプ： Enum () LineJoin ）

スパンの線接続値。

line_width¶

属性タイプ： Float

スパンの線幅値。

location¶

属性タイプ： Float

幅のある位置に沿って dimension それがそうです。

日時値も受け入れられるが，ただちに紀元以来のミリ秒数に変換されることに注意されたい.

location_units¶

属性タイプ： Enum () SpatialUnits ）

位置属性の単位タイプ.デフォルトでは“データ空間”単位と解釈される.

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もいかなる理由でもその名前を直接使用することはない。

render_mode¶

属性タイプ： Enum () RenderMode ）

スパンがキャンバス要素として提示されるか，キャンバス上に覆われたCSS要素として提示されるかを指定する。デフォルトモードは“Canvas”である.

警告

RENDER_MODEが“CSS”に設定されている場合、line_dashおよびline_dash_Offset属性はサポートされていない

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もいかなる理由でもこれらのラベルを直接使用することはない。

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)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となる.

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": "9178",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "line_alpha": 1.0,
  "line_cap": "butt",
  "line_color": "black",
  "line_dash": [],
  "line_dash_offset": 0,
  "line_join": "bevel",
  "line_width": 1,
  "location": null,
  "location_units": "data",
  "name": null,
  "render_mode": "canvas",
  "subscribed_events": [],
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

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

ベースクラス: bokeh.models.annotations.Annotation

テキスト書き込みモデル(たとえばラベルや見出し)の基底クラス.

注釈

これは，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)

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

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もいかなる理由でもその名前を直接使用することはない。

render_mode¶

属性タイプ： Enum () RenderMode ）

テキストがキャンバス要素として提示されるか，キャンバス上にカバーされたCSS要素として提示されるかを指定する。デフォルトモードは“Canvas”である.

注釈

CSSタグは“保存”ツールを用いた出力には現れない.

警告

RENDER_MODEが“CSS”に設定されている場合、すべての視覚スタイル属性がサポートされているわけではありません。BORDER_LINE_DASH属性は完全にサポートされておらず、BORDER_LINE_DASH_OFFSETは全くサポートされていません。テキストに加えて、text_alphaを設定すると、背景枠や枠全体の不透明度が修正されます。最後に，“CSS”モードは描画領域内でラベルアノテーションを裁断することをサポートしていない.

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もいかなる理由でもこれらのラベルを直接使用することはない。

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)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となる.

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": "9199",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "name": null,
  "render_mode": "canvas",
  "subscribed_events": [],
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

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

ベースクラス: bokeh.models.annotations.TextAnnotation

単一のタイトルボックスが注釈として提示される。

見職務上の呼び名印刷タイトルに関する情報は、参照されたい。

align¶

属性タイプ： Enum () TextAlign ）

テキストの閉鎖空間での整列は 沿って テキストの方向。

background_fill_alpha¶

属性タイプ： Percent

テキストフレームのフィラーAlpha値.

background_fill_color¶

属性タイプ： Color

テキスト枠の埋め込み色値。

border_line_alpha¶

属性タイプ： Percent

テキスト枠の線Alpha値。

border_line_cap¶

属性タイプ： Enum () LineCap ）

テキストフレームのキャップ値。

border_line_color¶

属性タイプ： Color

テキスト枠の線色値。

border_line_dash¶

属性タイプ： DashPattern

テキストフレームの線画値。

border_line_dash_offset¶

属性タイプ： Int

テキストフレームのラインオフセット値。

border_line_join¶

属性タイプ： Enum () LineJoin ）

テキスト枠の線リンク値。

border_line_width¶

属性タイプ： Float

テキストフレームの線幅値。

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)

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

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もいかなる理由でもその名前を直接使用することはない。

offset¶

属性タイプ： Float

テキストを一定数の画素(正の数であっても負であってもよい)だけオフセットする.タイトルの位置に応じてテキストを異なる方向に移動させる：

上図：右シフト見出し

右：タイトル下へ

次の図：右シフトタイトル

左：タイトルを上に移す

render_mode¶

属性タイプ： Enum () RenderMode ）

テキストがキャンバス要素として提示されるか，キャンバス上にカバーされたCSS要素として提示されるかを指定する。デフォルトモードは“Canvas”である.

注釈

CSSタグは“保存”ツールを用いた出力には現れない.

警告

RENDER_MODEが“CSS”に設定されている場合、すべての視覚スタイル属性がサポートされているわけではありません。BORDER_LINE_DASH属性は完全にサポートされておらず、BORDER_LINE_DASH_OFFSETは全くサポートされていません。テキストに加えて、text_alphaを設定すると、背景枠や枠全体の不透明度が修正されます。最後に，“CSS”モードは描画領域内でラベルアノテーションを裁断することをサポートしていない.

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もいかなる理由でもこれらのラベルを直接使用することはない。

text¶

属性タイプ： String

提示するテキスト値です

text_alpha¶

属性タイプ： NumberSpec

テキストを充填するためのAlpha値.

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

text_color¶

属性タイプ： ColorSpec

テキストを充填するための色。

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

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間の整数である。

text_font¶

属性タイプ： String

Name of a font to use for rendering text, e.g., 'times', 'helvetica'.

text_font_style¶

属性タイプ： Enum () FontStyle ）

テキストを提示するためのスタイル。

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

'normal' 普通のテキスト
'italic' italic text
'bold' bold text

text_line_height¶

属性タイプ： Float

タイトルにどのくらいの追加的な空間が割り当てられなければならない。この値は数字の形で提供されるが、フォントサイズのパーセンテージとみなされなければならない。デフォルト値は100%であり、これは追加の空間が使用されないことを意味します。

vertical_align¶

属性タイプ： Enum () VerticalAlign ）

テキストの閉鎖空間での整列は 横断する. テキストの方向。

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)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となる.

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": "left",
  "background_fill_alpha": 1.0,
  "background_fill_color": null,
  "border_line_alpha": 1.0,
  "border_line_cap": "butt",
  "border_line_color": null,
  "border_line_dash": [],
  "border_line_dash_offset": 0,
  "border_line_join": "bevel",
  "border_line_width": 1,
  "id": "9210",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "name": null,
  "offset": 0,
  "render_mode": "canvas",
  "subscribed_events": [],
  "tags": [],
  "text": null,
  "text_alpha": {
    "value": 1.0
  },
  "text_color": {
    "value": "#444444"
  },
  "text_font": "helvetica",
  "text_font_size": {
    "value": "13px"
  },
  "text_font_style": "bold",
  "text_line_height": 1.0,
  "vertical_align": "bottom",
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

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

ベースクラス: bokeh.models.annotations.Annotation

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)

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

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もいかなる理由でもこれらのラベルを直接使用することはない。

toolbar¶

属性タイプ： Instance () Toolbar ）

表示するツールバー。

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)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となる.

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": "9239",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "annotation",
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "toolbar": null,
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

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

ベースクラス: bokeh.models.annotations.Annotation

レンダリングツール提示。

注釈

このモデルは現在BokehJSによって管理されており、pythonから直接使用することはできません。

attachment¶

属性タイプ： Enum () TooltipAttachment ）

ツール提示は，カーソル位置の左側または右側に表示すべきか，カーソル位置の上方または下方に表示すべきか，あるいは自動的に水平または垂直次元に置くべきかどうかである.

inner_only¶

属性タイプ： Bool

中央印刷フレーム領域外に表示されているか否か。

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)

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

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もいかなる理由でもその名前を直接使用することはない。

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もいかなる理由でもこれらのラベルを直接使用することはない。

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)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となる.

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

{
  "attachment": "horizontal",
  "id": "9250",
  "inner_only": true,
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "overlay",
  "name": null,
  "show_arrow": true,
  "subscribed_events": [],
  "tags": [],
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}

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

ベースクラス: bokeh.models.annotations.Annotation

次元に沿ってひげをレンダリングする。

見ひげ. 髭を描く情報を知っています

base¶

属性タイプ： PropertyUnitsSpec

上下値の直交座標。

dimension¶

属性タイプ： Enum () Dimension ）

この属性を“Height”に設定することでひげの方向を指定することができる (y 方向)または“幅” (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)

level¶

属性タイプ： Enum () RenderLevel ）

レンダラを描画するレベルを指定します。

line_alpha¶

属性タイプ： NumberSpec

ひげ本体の線Alpha値。

line_cap¶

属性タイプ： Enum () LineCap ）

ひげ本体のコード値。

line_color¶

属性タイプ： ColorSpec

ひげ本体の線色値。

line_dash¶

属性タイプ： DashPattern

ひげ本体の線割値。

line_dash_offset¶

属性タイプ： Int

ひげ本体の線オフセット値。

line_join¶

属性タイプ： Enum () LineJoin ）

この線はひげ本体の値を結んでいる。

line_width¶

属性タイプ： NumberSpec

ひげ本体の線幅値。

lower¶

属性タイプ： PropertyUnitsSpec

ひげの下端の座標。

lower_head¶

属性タイプ： Instance () ArrowHead ）

実例. ArrowHead それがそうです。

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もいかなる理由でもその名前を直接使用することはない。

source¶

属性タイプ： Instance () DataSource ）

書き込み時に使用するローカルデータソースを描画上に提示する.

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もいかなる理由でもこれらのラベルを直接使用することはない。

upper¶

属性タイプ： PropertyUnitsSpec

ひげの上端の座標。

upper_head¶

属性タイプ： Instance () ArrowHead ）

実例. ArrowHead それがそうです。

visible¶

属性タイプ： Bool

レンダラが見えるかどうか。

x_range_name¶

属性タイプ： String

描画上に字形が表示されている場合には、画面位置の特定(命名)x範囲を計算するために使用される。設定されていない場合は、デフォルトのx範囲を使用します。

y_range_name¶

属性タイプ： String

描画上にフォントを提示する際には、画面位置の特定(命名)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となる.

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

{
  "base": null,
  "dimension": "height",
  "id": "9263",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "level": "underlay",
  "line_alpha": {
    "value": 1.0
  },
  "line_cap": "butt",
  "line_color": {
    "value": "black"
  },
  "line_dash": [],
  "line_dash_offset": 0,
  "line_join": "bevel",
  "line_width": {
    "value": 1
  },
  "lower": null,
  "lower_head": {
    "id": "9265"
  },
  "name": null,
  "source": {
    "id": "9266"
  },
  "subscribed_events": [],
  "tags": [],
  "upper": null,
  "upper_head": {
    "id": "9264"
  },
  "visible": true,
  "x_range_name": "default",
  "y_range_name": "default"
}