メインコンテンツまでスキップ

getProperty

ウィジェット本体のプロパティ値を名前で読み取ります。setPropertyと同じ対象(ウィジェット本体のプロパティ)を扱います。

備考

すべてのウィジェットが共通で使用するWidget Controlです。以下の例のwidgetIDはキャンバスでウィジェットに指定した名前(ID)で、スクリプトではwidgetID.memberの形式でアクセスします。

  • Parameters
    • name (string): 読み取るウィジェットプロパティの名前
  • Returns: any - プロパティの値。その名前のプロパティが存在しない場合はnull。カラーや列挙型系のプロパティは文字列として返されます。

Example

const t = textID.getProperty("text");
警告

存在しないプロパティ名は、エラーにならずnullを返します。そのため、値が実際に空なのか名前が間違っているのかは、戻り値だけでは区別できません。使用できるプロパティ名はウィジェットごとに異なるため、対象ウィジェットのプロパティ名を確認してから使用してください。