bokeh.core.property.bases¶

Bokeh Propertyシステムに基底クラスを提供する.

注釈

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

exception DeserializationError[ソース]¶

class ContainerProperty(default=None, help=None, serialized=None, readonly=False)[ソース]¶: クラスコンテナタイプ属性の基底クラス.

class PrimitiveProperty(default=None, help=None, serialized=None, readonly=False)[ソース]¶

単純属性タイプの基底クラス

サブクラスはクラス属性を定義すべきである _underlying_type これは、この属性の許容可能なタイプ値のタプルである。

例を引く

些細なバージョンです Float 属性は以下のようになる可能性がある：

class Float(PrimitiveProperty):
    _underlying_type = (numbers.Real,)

from_json(json, models=None)[ソース]¶

JSONと互換性のある値をその属性の値に変換する.

JSONと互換性のある値は，LIST，DICT，NUMBER，STRING，BOOL，NONEである.

validate(value, detail=True)[ソース]¶

この値からこの属性を設定できるかどうかを判断する。

検証はTransform()の前に行う

パラメータ

value (obj) -- この属性タイプを検証するための値
detail (bool, options) -- 詳細な例外生成を構造しているかどうか詳細なタイプ検証エラーメッセージはコストが高い可能性がある.内部でタイプチェックを実行する際に、ユーザが異常から脱出しない場合には、この値をfalse(デフォルト値：true)に設定することで、これらのメッセージをスキップすることができる。

戻り値

なし

例外

ValueError if the value is not valid for this property type --

class Property(default=None, help=None, serialized=None, readonly=False)[ソース]¶

Bokeh Propertyインスタンスの基底クラスは，Bokehモデルに加えることができる.

パラメータ

default (obj or None, optional) -- この属性から作成された属性のデフォルト値(デフォルト値：なし)
help (str or None, optional) -- この属性の文書文字列それは自動的に bokeh_prop Spinx文書を生成する際の拡張子.(デフォルト値：なし)
serialized (bool, optional) -- この属性から作成された属性が直列化に含まれるべきかどうか(デフォルト：true)
readonly (bool, optional) -- この属性から作成された素性が読み専用であるかどうか.(デフォルト値：FALSE)

__init__(default=None, help=None, serialized=None, readonly=False)[ソース]¶: Selfを初期化する.正確な署名については，ヘルプ(キー入力(Self))を参照されたい.

__str__()[ソース]¶: Str(Self)を返す.

accepts(tp, converter)[ソース]¶

他のタイプは，そのための属性タイプを変換できることを宣言する.

パラメータ

tp (Property) -- この属性タイプのタイプを自動的に変換することができる.
converter (callable) -- 受容関数です value この属性タイプに値を変換するには，以下の操作を実行してください.

戻り値

自性.

asserts(fn, msg_or_fn)[ソース]¶

用意された値が与えられた条件を満たすと断言する.

アサートは，簡単な値タイプ検証以外の強制条件に用いられる.例えば、この方法は、アサートのために使用することができる ColumnDataSource すべての全体はいつでも同じ長さを持っている。

パラメータ

fn (callable) -- 受容関数です (obj, value) 値がアサートされればTrueを返し，そうでなければFalseを返す.
msg_or_fn (str or callable) -- 失敗したときに印刷するメッセージ、または関数が受け入れると断言する (obj, name, value) アサートに失敗した場合に呼び出す.

戻り値

自性.

from_json(json, models=None)[ソース]¶

JSONと互換性のある値をその属性の値に変換する.

JSONと互換性のある値は，LIST，DICT，NUMBER，STRING，BOOL，NONEである.

is_valid(value)[ソース]¶

この値が検証されたかどうか

パラメータ: value (obj) -- この属性タイプを検証するための値
戻り値: 有効であればTrue，そうでなければFalseである.

make_descriptors(base_name)[ソース]¶

戻ります。 BasicPropertyDescriptor インスタンスは、この属性に対する特性アクセスを委任するために使用される。

パラメータ: name (str) -- これらの記述子が用いる属性の名前
戻り値: 明細書. [BasicPropertyDescriptor]

戻り記述子は MetaHasProps メタクラスを追加します HasProps クラス作成中のサブクラス。

matches(new, old)[ソース]¶

2つのパラメータが値に一致するかどうか。

もしどれかがあれば new あるいは…。 old NumPy配列またはPandas SeriesまたはIndexであれば np.array_equal これらの値が一致するかどうかが決定される.

そうでなければ、標準Pythonに等しい結果が返されます。

戻り値: 新旧一致すればTrue，そうでなければFalseとなる.

serialize_value(value)[ソース]¶: この値をJSON直列化可能フォーマットに変更する.

themed_default(cls, name, theme_overrides)[ソース]¶: デフォルト値は、PREPARE_VALUE()および主題オーバーレイによって変換される。

transform(value)[ソース]¶

値をその属性の仕様形式に変更する.

パラメータ: value (obj) -- これに変換の値を適用する.
戻り値: 転化価値.
戻り値の型: obj

validate(value, detail=True)[ソース]¶

この値からこの属性を設定できるかどうかを判断する。

検証はTransform()の前に行う

パラメータ

value (obj) -- この属性タイプを検証するための値
detail (bool, options) -- 詳細な例外生成を構造しているかどうか詳細なタイプ検証エラーメッセージはコストが高い可能性がある.内部でタイプチェックを実行する際に、ユーザが異常から脱出しない場合には、この値をfalse(デフォルト値：true)に設定することで、これらのメッセージをスキップすることができる。

戻り値

なし

例外

ValueError if the value is not valid for this property type --

classmethod wrap(value)[ソース]¶: いくつかの属性タイプは、それらの値を特殊な容器に包装する必要がある、など。

property readonly¶

この属性は読みのみであるかどうかである.

読み取り専用属性は、クライアントによってのみ修正される(すなわち、ブラウザ内のBokehJSによって修正される)。

property serialized¶

オブジェクトを直列化する際に属性を直列化すべきかどうか.

たとえば，他の属性に既存の情報を繰り返す“仮想”や“便利”属性については偽である.

validation_on()[ソース]¶

属性をチェックして、現在アクティブ状態にあるかどうかを確認する

戻り値: ブール.