bokeh.core.has_props

宣言的,類型化,直列化可能な属性を持つことができるオブジェクトに基底クラスを提供する.

注釈

これらのクラスは,Bokehモデルと属性システムを実現する非常に下位の機器の一部を構成している.これらのクラスまたはそれらの方法のいずれも、任意の標準的な用法に適用される可能性はあまりなく、またはBokeh自身のインフラ上で直接開発された誰でもない。

class HasProps(**properties)[ソース]

Bokeh属性を持つすべてのクラスタイプの基底クラス.

__init__(**properties)[ソース]
apply_theme(property_values)[ソース]

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

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

パラメータ

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

戻り値

なし

classmethod dataspecs()[ソース]

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

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

戻り値

名前または名前 DataSpec 特性

戻り値の型

set[str]

classmethod dataspecs_with_props()[ソース]

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

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

戻り値

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

戻り値の型

dict[str, DataSpec]

equals(other)[ソース]

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

パラメータ

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

戻り値

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

classmethod lookup(name)[ソース]

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

パラメータ

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

戻り値

名前の属性の記述子 name

戻り値の型

PropertyDescriptor

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

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サーバアプリケーションのコンテキストでは,入力された属性更新は,更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

themed_values()[ソース]

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

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

戻り値

DICTや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サーバアプリケーションのコンテキストでは,入力された属性更新は,更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

class MetaHasProps(class_name, bases, class_dict)[ソース]

…を専門に建設する. HasProps 授业。

この種類は metaclass 上の HasProps これは作成と追加を担当しています PropertyDescriptor 検証と序列化を依頼する Property 属性です。

abstract(cls)[ソース]

派生自標 HasProps それがそうです。

accumulate_dict_from_superclasses(cls, propname)[ソース]

クラスの階層構造を繰り返して特殊な辞書を蓄積する MetaHasProps クラスの店:

パラメータ

name (str) --

収集する特殊な属性の名前.

Typically meaningful values are: __dataspecs__, __overridden_defaults__

accumulate_from_superclasses(cls, propname)[ソース]

クラスの階層構造を繰り返し,特殊な名称セットを蓄積する. MetaHasProps クラスの店:

パラメータ

name (str) --

収集する特殊な属性の名前.

Typically meaningful values are: __container_props__, __properties__, __properties_with_refs__