webcface.field module
- class webcface.field.Field(data: ClientData | None, member: str, field: str = '')[source]
Bases:
FieldBase- canvas2d(field: str = '', width: SupportsFloat | None = None, height: SupportsFloat | None = None) Canvas2D[source]
Canvas2Dオブジェクトを生成(ver3.1〜 / ver3.0までMemberクラスのメソッド)
- Parameters:
height (width,) – Canvas2Dのサイズを指定して初期化する
- canvas2d_entries() Iterable[Canvas2D][source]
「(thisの名前).(追加の名前)」で公開されているcanvas2dをすべて取得する (ver3.1〜 / ver3.0までMemberクラスのメソッド)
- canvas3d_entries() Iterable[Canvas3D][source]
「(thisの名前).(追加の名前)」で公開されているcanvas3dをすべて取得する (ver3.1〜 / ver3.0までMemberクラスのメソッド)
- child(field: str) Field[source]
「(このFieldの名前).(追加の名前)」を新しい名前とするField (ver3.1〜)
このFieldの名前が空文字列の場合はピリオドをつけず新しい名前とする。
- children(recurse=False) Iterable[Field][source]
「(thisの名前).(追加の名前)」で公開されているデータをすべて取得する (ver3.1〜)
データ型を問わずすべてのデータを列挙する。
recurseがFalseの場合、名前にさらにピリオドが含まれる場合はその前までの名前を返す。
同名で複数のデータが存在する場合も1回のみカウントする。
- func(arg: str = '', **kwargs) Func[source]
Funcオブジェクトを生成(ver3.1〜 / ver3.0までMemberクラスのメソッド)
- member.func(arg: str)
指定した名前のFuncオブジェクトを生成・参照する。
- @member.func(arg: str, [**kwargs])
デコレータとして使い、デコレートした関数を指定した名前でセットする。
デコレート後、関数は元のまま返す。
- @member.func([**kwargs])
3と同じだが、名前はデコレートした関数から自動で取得される。
2, 3 の場合のkwargsは Func.set() を参照。
- func_entries() Iterable[Func][source]
「(thisの名前).(追加の名前)」で公開されているfuncをすべて取得する (ver3.1〜 / ver3.0までMemberクラスのメソッド)
- func_listener(field: str = '') FuncListener[source]
FuncListenerオブジェクトを生成(ver3.1〜 / ver3.0までMemberクラスのメソッド)
- image_entries() Iterable[Image][source]
「(thisの名前).(追加の名前)」で公開されているimageをすべて取得する (ver3.1〜 / ver3.0までMemberクラスのメソッド)
- log(field: str = 'default') Log[source]
Logオブジェクトを生成(ver3.1〜 / ver3.0までMemberクラスのメソッド)
- Parameters:
field – (ver2.1〜) Logの名前を指定可能(省略すると”default”)
- log_entries() Iterable[Log][source]
「(thisの名前).(追加の名前)」で公開されているlogをすべて取得する (ver3.1〜 / ver2.1〜3.0までMemberクラスのメソッド)
- property name: str
field名を返す (ver3.1〜)
- text_entries() Iterable[Text][source]
「(thisの名前).(追加の名前)」で公開されているtextをすべて取得する (ver3.1〜 / ver3.0までMemberクラスのメソッド)