bokeh.models.formatters

Bokeh描画軸上の記号ラベルのテキストと視覚フォーマットを制御するためのモデル.

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

ベースクラス: bokeh.models.formatters.TickFormatter

デフォルトでは,連続範囲内の刻み値を“基本数字”として表示し,適切な場合には科学記数法を用いる.

js_event_callbacks

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

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

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

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

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

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

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

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

属性タイプ: String

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

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

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

注釈

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

power_limit_high

属性タイプ: Int

科学記数法の使用を以下の場合に制限する.

log(x) >= power_limit_high
power_limit_low

属性タイプ: Int

科学記数法の使用を以下の場合に制限する.

log(x) <= power_limit_low
precision

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

use_scientific

属性タイプ: Bool

科学的記数法を示す必要があるかどうか。もし True 科学的記数法がいつ使われるかは power_limit_low そして power_limit_high それがそうです。

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

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": "10150",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "power_limit_high": 5,
  "power_limit_low": -3,
  "precision": "auto",
  "subscribed_events": [],
  "tags": [],
  "use_scientific": true
}
class CategoricalTickFormatter(*args, **kwargs)[ソース]

ベースクラス: bokeh.models.formatters.TickFormatter

カテゴリ範囲における刻み値を文字列値として表示する.

js_event_callbacks

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

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

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

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

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

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

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

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

属性タイプ: String

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

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

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

注釈

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

subscribed_events

属性タイプ: List () String

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

tags

属性タイプ: List () Any

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

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

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

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

注釈

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

apply_theme(property_values)

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

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

パラメータ

property_values (dict) -- デフォルト値の代わりにテーマ値を使用します

戻り値

なし

classmethod dataspecs()

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

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

戻り値

名前または名前 DataSpec 特性

戻り値の型

set[str]

classmethod dataspecs_with_props()

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

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

戻り値

名前と名前のマッピング DataSpec 特性

戻り値の型

dict[str, DataSpec]

equals(other)

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

パラメータ

other (HasProps) -- 比較するもう一つの例は

戻り値

属性が構造的に等しいならばTrue,そうでなければFalseとなる.

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": "10160",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}
class DatetimeTickFormatter(*args, **kwargs)[ソース]

ベースクラス: bokeh.models.formatters.TickFormatter

A TickFormatter ある範囲で日時値をよく表示するために使用される。

DatetimeTickFormatter 異なる比率での軸記号のフォーマットを制御するために使用することができる以下の属性(およびそのデフォルト値を一緒に列挙する)を有する。

microseconds = ['%fus']

milliseconds = ['%3Nms', '%S.%3Ns']

seconds = ['%Ss']

minsec = [':%M:%S']

minutes = [':%M', '%Mm']

hourmin = ['%H:%M']

hours = ['%Hh', '%H:%M']

days = ['%m/%d', '%a%d']

months = ['%m/%Y', '%b %Y']

years = ['%Y']

各スケール属性は、“時間スケール”に含まれる日付時間刻み値をフォーマットするためのフォーマットまたはフォーマットリストとして設定されてもよい。デフォルトでは、時間刻みごとに転送される最初のフォーマット文字列のみが使用されます。デフォルトでは、フォーマットされたラベル上のすべてのプリアンブルゼロが除去されます。

このサポートされているリスト strftime フォーマットは以下のように転載される.

%a

現在のエリアに応じて設定されている曜日の略語です。

%A

現在のエリアに応じて設定された曜日のフルネーム。

%b

現在の地域に応じて設定された月の略語。

%B

現在の地域に応じて設定された完全月名。

%c

現在の領域設定の第1の日付および時間表示形式。

%C

2ビット整数形式の世紀数(年/100)。

%d

10進数字で表される月の日付(範囲01から31)。

%D

%m/%d/%yに相当する。(アメリカ人は、多くの他の国では、%d/%m/%yがかなり一般的であることに留意すべきである。これは,国際的な背景では,このフォーマットは曖昧であり,使用すべきではないことを意味する).

%e

%dと同様に、1ヶ月目の何日目は10進数ですが、プリアンブルゼロはスペースに置き換えられています。

%f

10進数で表されるマイクロ秒は、左がゼロになる(範囲000000-999999)。これは利用可能な命令セットの拡張である timezone それがそうです。

%F

%Y-%m-%d(ISO 8601日付フォーマット)に相当します。

%G

ISO 8601周をベースとした年は,世紀を10進数としている。ISO周号に対応する4桁の年(%Vを参照)。これは、ISO週数が前年または次の年に属する場合に使用される点で、%Yと同じフォーマットおよび値を有する。

%g

%Gと同様であるが、世紀がない、すなわち2桁の年(00-99)である。

%h

%bに相当する.

%H

時間は10進数であり,24時間制(範囲は00から23)を用いた.

%i

時間は10進数であり,12時間制(範囲01から12)を用いた.

%j

10進数字で表される1年間の日付(範囲は001から366まで)。

%k

10進数字で表される時間(24時間制)(範囲は0から23)である。一つの数字の前にスペースがあります。(%Hを参照。)

%l

10進制数字で表される時間(12時間制)(範囲は1から12)である。一つの数字の前にスペースがあります。(%Iを参照)(TZ)

%m

10進数字で表される月(範囲01から12)。

%M

10進数で示した分(範囲は00から59まで).

%n

改行符。Bokehテキストは現在、改行をサポートしていません。

%N

10進数で表されるナノ秒は、左をゼロで充填しています(範囲0000000-999999999)。パディング幅説明子、すなわち%3 Nは、最も左の3桁の数字を表示します。しかし,以下の制限により,ミリ秒レベルまでしか精度が得られない. timezone それがそうです。

%p

“AM”または“PM”は、所与の時間値に応じて選択されるか、または現在の領域に設定された対応する文字列に応じて“AM”または“PM”が選択される。昼は“PM”、真夜中は“AM”とされる。

%P

%pと同様であるが、小文字:“am”または“pm”または現在の領域に対応して設定された文字列である。

%r

午前の時間です。あるいは午後記号です。POSIX領域設定では、これは%i:%M:%S%pと等価である。

%R

24時間記法で示した時間(%H:%M).秒を含むバージョンについては、以下の%Tを参照されたい。

%s

紀元以来の秒数は,1970−01−01 00:00:00+0000(UTC)であった。

%S

2つ目は10進数(範囲は00から60)である.(範囲は最高60秒で、たまのうるう秒をサポートします。)

%t

表札を作る。Bokehテキストは現在タブをサポートしていません。

%T

24時間記法で表された時間(%H:%M:%S)。

%u

小数で表される曜日は,範囲は1から7,月曜日は1である.%wを参照してください。

%U

10進数で示した当年の週数は,00から53までの範囲であり,第1日曜日から01週目の初日とした。また%Vおよび%Wを参照されたい。

%V

10進数で表される当年ISO 8601週番号(備考参照)は,01から53の範囲であり,そのうち1週目は新年の少なくとも4日の第1週である。また%Uおよび%Wを参照されたい。

%w

小数は曜日を表し,範囲は0から6,日曜日は0である.また%uを参照してください。

%W

10進数で示した当年の週号は,00から53の範囲であり,第1月曜日から01週目の初日とした。

%x

時間を持たない現在の領域に設定された第1の日付表示形態。

%X

日付を持たない現在の領域設定の第1の時間表示形式。

%y

世紀を持たない10進制数字で表された年(範囲は00から99まで).

%Y

10進数字で表される年は、世紀を含む。

%z

+hmmまたは-hmmデジタルタイムゾーン(すなわち、UTCとの時間および分オフセット)。

%Z

タイムゾーンの名前または略語です。

%%

原義‘%’文字。

警告

クライアントライブラリBoehJS使用 timezone ライブラリは日時をフォーマットします。次のリストに入るのは,このような説に基づいている timezone “GNU日付フォーマット説明子の完璧な補完”をサポートさせる.しかし、この表現はこのリストについて詳細に検証されていない。フォーマットが予定通りに動作していないことが発見された場合は、提出してください github issue 文書が適切に更新できるようにする。

days

属性タイプ: List () String

コントロールに日付値が表示されるフォーマット days 射程。

ご参照ください DatetimeTickFormatter サポートされているすべてのフォーマットリストに関するヘルプ情報。

hourmin

属性タイプ: List () String

コントロールに日付値が表示されるフォーマット hourmin (時間と分の合計)範囲。

ご参照ください DatetimeTickFormatter サポートされているすべてのフォーマットリストに関するヘルプ情報。

hours

属性タイプ: List () String

コントロールに日付値が表示されるフォーマット hours 射程。

ご参照ください DatetimeTickFormatter サポートされているすべてのフォーマットリストに関するヘルプ情報。

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)
microseconds

属性タイプ: List () String

コントロールに日付値が表示されるフォーマット microseconds 射程。

ご参照ください DatetimeTickFormatter サポートされているすべてのフォーマットリストに関するヘルプ情報。

milliseconds

属性タイプ: List () String

コントロールに日付値が表示されるフォーマット milliseconds 射程。

ご参照ください DatetimeTickFormatter サポートされているすべてのフォーマットリストに関するヘルプ情報。

minsec

属性タイプ: List () String

コントロールに日付値が表示されるフォーマット minsec (分と秒の合計)範囲。

ご参照ください DatetimeTickFormatter サポートされているすべてのフォーマットリストに関するヘルプ情報。

minutes

属性タイプ: List () String

コントロールに日付値が表示されるフォーマット minutes 射程。

ご参照ください DatetimeTickFormatter サポートされているすべてのフォーマットリストに関するヘルプ情報。

months

属性タイプ: List () String

コントロールに日付値が表示されるフォーマット months 射程。

ご参照ください DatetimeTickFormatter サポートされているすべてのフォーマットリストに関するヘルプ情報。

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

seconds

属性タイプ: List () String

コントロールに日付値が表示されるフォーマット seconds 射程。

ご参照ください DatetimeTickFormatter サポートされているすべてのフォーマットリストに関するヘルプ情報。

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

years

属性タイプ: List () String

コントロールに日付値が表示されるフォーマット years 射程。

ご参照ください DatetimeTickFormatter サポートされているすべてのフォーマットリストに関するヘルプ情報。

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

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
{
  "days": [
    "%m/%d",
    "%a%d"
  ],
  "hourmin": [
    "%H:%M"
  ],
  "hours": [
    "%Hh",
    "%H:%M"
  ],
  "id": "10166",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "microseconds": [
    "%fus"
  ],
  "milliseconds": [
    "%3Nms",
    "%S.%3Ns"
  ],
  "minsec": [
    ":%M:%S"
  ],
  "minutes": [
    ":%M",
    "%Mm"
  ],
  "months": [
    "%m/%Y",
    "%b %Y"
  ],
  "name": null,
  "seconds": [
    "%Ss"
  ],
  "subscribed_events": [],
  "tags": [],
  "years": [
    "%Y"
  ]
}
class FuncTickFormatter(*args, **kwargs)[ソース]

ベースクラス: bokeh.models.formatters.TickFormatter

ユーザ定義関数でフォーマットされたスケール値を表示する.

警告

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

args

property type: Dict ( String , AnyRef )

Pythonオブジェクトへの名前のマッピング。特にポークのモデルかもしれませんこれらのオブジェクトは,コールバックの名前パラメータ値としてフォーマットされたプログラムのコードセグメントに提供することができる.

code

属性タイプ: String

個々の目盛りを必要なフォーマットのJavaScriptコードセグメントに再フォーマットする.変数 tick フォーマットされていない刻み値が含まれ、レンダリング時にコードセグメント命名空間に現れることが予想される。

他の利用可能な変数は:

  • ticks 自動受信機で配置されたすべての軸目盛りの配列は

  • index 、の位置 tick はい。 ticks そして、

  • 重要なのは args マッピング(あれば).

自分が高価なものをキャッシュする必要があることを発見しました ticks -計算に依存して、ストレージに格納することができます this 変数です。

例:

code = '''
this.precision = this.precision || (ticks.length > 5 ? 1 : 2);
return Math.floor(tick) + " + " + (tick % 1).toFixed(this.precision);
'''
js_event_callbacks

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

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

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

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

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

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

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

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

属性タイプ: String

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

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

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

注釈

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

subscribed_events

属性タイプ: List () String

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

tags

属性タイプ: List () Any

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

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

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

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

注釈

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

apply_theme(property_values)

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

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

パラメータ

property_values (dict) -- デフォルト値の代わりにテーマ値を使用します

戻り値

なし

classmethod dataspecs()

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

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

戻り値

名前または名前 DataSpec 特性

戻り値の型

set[str]

classmethod dataspecs_with_props()

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

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

戻り値

名前と名前のマッピング DataSpec 特性

戻り値の型

dict[str, DataSpec]

equals(other)

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

パラメータ

other (HasProps) -- 比較するもう一つの例は

戻り値

属性が構造的に等しいならばTrue,そうでなければFalseとなる.

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

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

パラメータ
  • attr (str) -- このモデル上のBokeh属性の名前

  • other (Model) -- Self.attrにリンクされたBokehモデル

  • other_attr (str) -- 上の属性 other リンクがつながっている

  • attr_selector (Union[int, str]) -- 購読可能表中の項目をリンクするためのインデックス attr

バージョン1.1での追加

例外

ValueError --

サンプル

このコードには js_link

select.js_link('value', plot, 'sizing_mode')

以下と同等である.

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

また,範囲スライダの左側をattr_selectorを用いて描画のx_rangeに付加する:

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

これは以下のようなものです

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)
js_on_change(event, *callbacks)

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

BokehJS側では,モデル属性の変更イベントの形式は "change:property_name" それがそうです。便宜上,このメソッドに渡されるイベント名もモデル上の属性の名前であれば, "change:" 自動:

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

しかし,属性変更イベントに加えて,他のタイプのイベントに応答することも可能である.例えば、データがストリーミングされる限り ColumnDataSource 使用、使用 "stream" 源上の事件:

source.js_on_change('streaming', callback)
layout(side, plot)
classmethod lookup(name)

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

パラメータ

name (str) -- 検索する属性の名前

戻り値

名前の属性の記述子 name

戻り値の型

PropertyDescriptor

on_change(attr, *callbacks)

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

パラメータ
  • attr (str) -- このオブジェクトの属性名

  • *callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例:

widget.on_change('value', callback1, callback2, ..., callback_n)
classmethod properties(with_bases=True)

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

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

パラメータ

with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値:TRUE)

戻り値

属性名

戻り値の型

set[str]

classmethod properties_containers()

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

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

戻り値

容器属性名

戻り値の型

set[str]

classmethod properties_with_refs()

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

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

戻り値

引用の属性を持つ名前

戻り値の型

set[str]

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

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

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

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

パラメータ

include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値:TRUE)

戻り値

属性名からその値へのマッピング

戻り値の型

dict

query_properties_with_values(query, include_defaults=True)

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

パラメータ
  • query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す

  • include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値:true)が含まれているかどうか

戻り値

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

戻り値の型

dict

references()

すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)

この対象からコールバックを削除する

select(selector)

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

パラメータ

selector (JSON-like) --

戻り値

配列番号. [模型]

select_one(selector)

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

戻り値

模型

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

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

パラメータ
  • name -- (Str):設定する属性の名前

  • json -- (json-value):設定する属性の値

  • models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値:なし)更新する属性も参照する値を持つ場合には,このオプションが必要となる.

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

戻り値

なし

set_select(selector, updates)

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

パラメータ
  • selector (JSON-like) --

  • updates (dict) --

戻り値

なし

themed_values()

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

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

戻り値

DICTやNONE

to_json(include_defaults)

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

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

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

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

パラメータ

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

to_json_string(include_defaults)

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

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

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

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

パラメータ

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

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

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

戻り値

なし

update(**kwargs)

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

戻り値

なし

サンプル

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

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)
update_from_json(json_attributes, models=None, setter=None)

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

パラメータ
  • json_attributes -- (json-dict):更新する属性と値

  • models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値:なし)更新する属性も参照する値を持つ場合には,このオプションが必要となる.

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

戻り値

なし

property document

♪the Document このモデルは添付されています None

property struct

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

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

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

JSON Prototype
{
  "args": {},
  "code": "",
  "id": "10182",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}
class LogTickFormatter(*args, **kwargs)[ソース]

ベースクラス: bokeh.models.formatters.TickFormatter

連続範囲内の刻み幅値をある基数のべき乗として示す.

通常は LogTicker それがそうです。

js_event_callbacks

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

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

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

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

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

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

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

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

属性タイプ: String

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

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

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

注釈

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

subscribed_events

属性タイプ: List () String

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

tags

属性タイプ: List () Any

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

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

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

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

注釈

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

ticker

属性タイプ: Instance () Ticker

そのぶん LogTicker 使用する正しいベースを決定するために使用される。設定されていない場合、フォーマットプログラムは、デフォルト値として基数10を使用する。

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

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": "10190",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "ticker": null
}
class MercatorTickFormatter(*args, **kwargs)[ソース]

ベースクラス: bokeh.models.formatters.BasicTickFormatter

A TickFormatter Webインクカートリッジ単位に用いられる値.

いくつかの地図描画タイプは,内部にWebMercatorを用いて座標,描画境界などを記述する.これらの職場はあまり人間的ではない.この度フォーマットプログラムは,WebMercator単位を緯度と経度に変換して軸上に表示する.

dimension

属性タイプ: Enum () LatLon

緯度記号形式を設定するか経度記号形式を設定するかを指定する.

投影座標は不可分であり,Webメルカトルから緯度と経度記号ラベルを計算するには,この2次元の座標を同時に考慮する必要がある.この属性を用いてどの結果を用いて表示すべきかを指定する.

一般に、フォーマットプログラムがx軸に使用される場合、次元は "lon" プログラムがy軸のためにフォーマットされている場合、次元は "lat" `.

デバッグが困難なエラーを防ぐために、サイズにデフォルト値はありません。未構成の MercatorTickFormatter 検証エラーとJavaScriptコンソールエラーが発生します。

js_event_callbacks

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

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

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

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

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

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

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

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

属性タイプ: String

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

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

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

注釈

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

power_limit_high

属性タイプ: Int

科学記数法の使用を以下の場合に制限する.

log(x) >= power_limit_high
power_limit_low

属性タイプ: Int

科学記数法の使用を以下の場合に制限する.

log(x) <= power_limit_low
precision

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

use_scientific

属性タイプ: Bool

科学的記数法を示す必要があるかどうか。もし True 科学的記数法がいつ使われるかは power_limit_low そして power_limit_high それがそうです。

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

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": null,
  "id": "10197",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "power_limit_high": 5,
  "power_limit_low": -3,
  "precision": "auto",
  "subscribed_events": [],
  "tags": [],
  "use_scientific": true
}
class NumeralTickFormatter(*args, **kwargs)[ソース]

ベースクラス: bokeh.models.formatters.TickFormatter

人間可読フォーマット文字列に基づくスケールフォーマットプログラム。

format

属性タイプ: String

次の表で定義されるデジタルフォーマット:

NUMBERS

番号をつける

フォーマット

ひも.

10000

'0,0.0000'

10,000.0000

10000.23

“0,0”

10,000

10000.23

‘+0,0’

+10,000

-10000

'0,0.0'

-10,000.0

10000.1234

'0.000'

10000.123

10000.1234

'0[.]00000'

10000.12340

-10000

‘(0,0.0000)’

(10,000.00)

-0.23

'.00'

-23だ

-0.23

‘(.00)’

(.23)

0.23

'0.00000'

0.23000

0.23

'0.0[0000]'

0.23

1230974

'0.0a'

1.2m

1460

“0 a”

1 kg

-104000

“0 a”

-104 k

1

“0 o”

第一

52

“0 o”

52位

23

“0 o”

23日.

100

“0 o”

100位

CURRENCY

番号をつける

フォーマット

ひも.

1000.234

'$0,0.00'

$1,000.23

1000.2

‘0,0 [.] 00$‘

1000.20ドル

1001

‘$0,0 [.] 00‘

1001ドル

-1000.234

‘($0,0)’

(1,000ドル)

-1000.234

'$0.00'

-$1000.23

1230974

“(1件あたり0.00ドル)”

123万ドル

BYTES

番号をつける

フォーマット

ひも.

100

“0 b”

1,000億

2048

“%0%b”

2 KB

7884486213

'0.0b'

7.3GB

3467479682787

“0.000 b”

3.154 TB

PERCENTAGES

番号をつける

フォーマット

ひも.

1

‘0%’

100%

0.974878234

'0.000%'

97.488%

-0.43

‘0%’

-43%

0.43

‘(0.0%)’

43.000%

TIME

番号をつける

フォーマット

ひも.

25

‘00:00:00’

0:00:25

238

‘00:00:00’

0:03:58

63846

‘00:00:00’

17:44:06

完全仕様については、http://numbroji.com/format.htmlをご覧ください。

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)
language

属性タイプ: Enum () NumeralLanguage

言語固有の機能をフォーマットするための言語(例えば、千ビットデリミタ)。

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

rounding

属性タイプ: Enum () RoundingFunction

丸め関数(四捨五入,四捨五入,天井)とその類義語(最も近い,四捨五入,四捨五入).

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

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
{
  "format": "0,0",
  "id": "10208",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "language": "en",
  "name": null,
  "rounding": "round",
  "subscribed_events": [],
  "tags": []
}
class PrintfTickFormatter(*args, **kwargs)[ソース]

ベースクラス: bokeh.models.formatters.TickFormatter

Printfスタイル形式文字列に基づくスケールフォーマットプログラム。

format

属性タイプ: String

デジタルフォーマットは、以下のように定義される:フォーマット文字列中の占位子は%でマークされ、これらの要素の1つまたは複数の後に続く、順序は以下のとおりである。

  • オプションの + サイン

    結果の前に数値のプラスまたはマイナスを持たせる.デフォルトの場合は - 符号は負に用いられる.

  • オプションの充填説明子

    パディングに用いる文字(あれば)を指定する.可能な値は0か前にあります ' (単引用符)。デフォルト設定はスペースで充填されています。

  • オプションの - サイン

    Spintfをこの占位子の結果を左に整列させる.デフォルト設定は右アライメント結果です。

  • オプションの数字

    指定結果にはいくつの文字が含まれるべきかを指定する.返される値がこの数字より小さければ、結果をパディングする。

  • オプション精度修飾子

    1つから . (点)後と数字は,浮動小数点数として何桁表示すべきかを指定する.文字列上で使用される場合、結果が切断されることになります。

  • タイプ説明子

    以下のいずれかであってもよい。

    • % -文字を生成する % 性格

    • b -2進数として整数を生成

    • c -AISCII値を有する文字として整数を生成

    • d あるいは…。 i -シンボル10進数として整数を生成

    • e -科学記数法を使用した浮動小数点数の生成

    • u -符号なし10進数形式の整数を生成する

    • f -浮動小数点数をそのまま生成

    • o -8進数として整数を生成

    • s -文字列をそのまま生成

    • x -16進数形式の整数(小文字)を生成する

    • X -16進数形式の整数(大文字)を生成

js_event_callbacks

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

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

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

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

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

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

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

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

属性タイプ: String

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

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

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

注釈

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

subscribed_events

属性タイプ: List () String

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

tags

属性タイプ: List () Any

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

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

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

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

注釈

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

apply_theme(property_values)

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

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

パラメータ

property_values (dict) -- デフォルト値の代わりにテーマ値を使用します

戻り値

なし

classmethod dataspecs()

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

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

戻り値

名前または名前 DataSpec 特性

戻り値の型

set[str]

classmethod dataspecs_with_props()

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

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

戻り値

名前と名前のマッピング DataSpec 特性

戻り値の型

dict[str, DataSpec]

equals(other)

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

パラメータ

other (HasProps) -- 比較するもう一つの例は

戻り値

属性が構造的に等しいならばTrue,そうでなければFalseとなる.

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
{
  "format": "%s",
  "id": "10217",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}
class TickFormatter(*args, **kwargs)[ソース]

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

プログラムタイプの基本クラスをすべてダイヤルでフォーマットする.

注釈

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

js_event_callbacks

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

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

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

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

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

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

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

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

属性タイプ: String

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

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

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

注釈

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

subscribed_events

属性タイプ: List () String

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

tags

属性タイプ: List () Any

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

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

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

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

注釈

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

apply_theme(property_values)

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

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

パラメータ

property_values (dict) -- デフォルト値の代わりにテーマ値を使用します

戻り値

なし

classmethod dataspecs()

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

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

戻り値

名前または名前 DataSpec 特性

戻り値の型

set[str]

classmethod dataspecs_with_props()

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

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

戻り値

名前と名前のマッピング DataSpec 特性

戻り値の型

dict[str, DataSpec]

equals(other)

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

パラメータ

other (HasProps) -- 比較するもう一つの例は

戻り値

属性が構造的に等しいならばTrue,そうでなければFalseとなる.

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": "10224",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": []
}