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

Component (컴포넌트) Widget Control

Componentウィジェットをスクリプトから制御するときに使用するWidget Control（Property · Method · Event）の一覧です。ウィジェットの概要と使い方はComponentドキュメントを参照してください。

備考

以下の例のcomponentIDは、キャンバスでComponentウィジェットに指定した名前（ID）です。スクリプトではwidgetID.memberの形式でアクセスします。

Widget Control一覧​

Widget Control種類シグネチャ説明
getVarMethodcomponentID.getVar(name)コンポーネントが外部に公開した変数の値を読み取る
setVarMethodcomponentID.setVar(name, value)読み取り/書き込み（readwrite）変数の値を変更する
onVarChangedEventcomponentID.onVarChanged = (name, value, prev) => { ... }公開された変数が変わったときに実行する

Property​

備考

該当なし — Componentウィジェットにはスクリプト専用のPropertyがありません。スクリプトでは、以下の共通Widget Control（getProperty / setProperty）で値を読み書きします。

Method​

getVar​

コンポーネントが外部に公開した（readable · readwrite）変数の現在の値を読み取ります。存在しない名前の場合や非公開（private）変数の場合はnullを返します。

  • 種類: Method
  • Parameters: name（string）— 読み取る変数名
  • Returns: 変数の値（任意の型）。不明な変数または非公開変数の場合はnull

Example

const checked = componentID.getVar("checked");

setVar​

コンポーネントの読み取り/書き込み（readwrite）変数の値を変更します。不明な変数、非公開（private）変数、読み取り専用（readable）変数の場合は何も行いません。

  • 種類: Method
  • Parameters: name（string）— 変数名 / value（任意の型）— 新しい値
  • Returns: なし

Example

componentID.setVar("checked", true);

Event​

onVarChanged​

コンポーネントが公開した変数のいずれかの値が変わると実行されます。ハンドラーは、変わった変数名・新しい値・以前の値を引数として受け取ります。

  • 種類: Event
  • ハンドラー引数: name（変数名）/ value（新しい値）/ prev（以前の値）
  • Returns: なし

Example

componentID.onVarChanged = (name, value, prev) => {
  if (name === "checked") {
    // 変更時に実行するコード
  }
};

共通Widget Control（すべてのウィジェット）​

注記

すべてのウィジェットでは、setProperty / getProperty / setStylePropertyのような名前ベースの共通Widget Control（Method）を使用できます。共通リファレンスドキュメント（作成予定）を参照してください。