MasonryGrid (메이슨리그리드) Widget Control
MasonryGridウィジェットをスクリプトから制御するときに使うWidget Control(Property・Method・Event)の一覧です。ウィジェットの紹介と使い方はMasonryGridドキュメントをご覧ください。
以下の例のmasonrygridIDは、キャンバスでMasonryGridウィジェットに指定した名前(ID)です。スクリプトではウィジェットID.メンバーの形式でアクセスします。
Widget Control一覧
| Widget Control | 種類 | シグネチャ | 説明 |
|---|---|---|---|
count | Property | masonrygridID.count (get/set int) | 繰り返し項目の数を読み取り・設定 |
current | Property | masonrygridID.current (get/set int) | バインディングスコープとして使う現在の項目インデックス |
select | Property | masonrygridID.select (get/set int) | 選択された項目のインデックス |
add | Method | masonrygridID.add() | 末尾に項目を追加(追加されたインデックスを返す) |
insert | Method | masonrygridID.insert(index) | 指定した位置に項目を挿入 |
remove | Method | masonrygridID.remove(index) | 指定したインデックスの項目を削除 |
clear | Method | masonrygridID.clear() | すべての項目を削除 |
setState | Method | masonrygridID.setState(index, function) | 特定の項目のみ更新 |
onSelected | Event | masonrygridID.onSelected = (index) => { ... } | 項目をタップしたときに実行 |
Property
count
繰り返される項目の数です。値を書き込むと、バインディングされたデータの一覧がその数に合わせて増減し、再描画されます。読み取ると現在の項目数を返します。
- 種類: Property(読み取り/書き込み)
- 型:
int - 読み取り: 現在の繰り返し項目数を返します
- 書き込み: 項目数を指定した値に合わせます
Example
masonrygridID.count = 10;
const n = masonrygridID.count;
current
バインディングスコープとして使う現在の項目インデックスです。以降のプロパティの書き込みは、この項目の行を対象とします。
- 種類: Property(読み取り/書き込み)
- 型:
int - 読み取り: 現在の項目インデックスを返します(設定されていない場合は
-1) - 書き込み: バインディングスコープとして使う項目インデックスを指定します
Example
masonrygridID.current = 0;
select
選択された項目のインデックスです。
- 種類: Property(読み取り/書き込み)
- 型:
int - 読み取り: 選択された項目のインデックスを返します(選択がない場合は
-1) - 書き込み: 選択する項目のインデックスを指定します
Example
masonrygridID.select = 2;
Method
add
末尾に空の項目を追加して再描画します。
- Parameters: なし
- Returns:
int- 新しく追加された項目のインデックス
Example
const i = masonrygridID.add();
insert
指定したインデックスに空の項目を挿入して再描画します。
- Parameters:
index(int)- 挿入する位置 - Returns: なし
Example
masonrygridID.insert(0);
remove
指定したインデックスの項目を削除して再描画します。インデックスが範囲外の場合は何も行いません。
- Parameters:
index(int)- 削除する項目のインデックス - Returns: なし
Example
masonrygridID.remove(0);
clear
すべての項目を削除して再描画します。
- Parameters: なし
- Returns: なし
Example
masonrygridID.clear();
setState
指定したインデックスをバインディングスコープに設定した状態でコールバックを実行し、その項目のみを再描画します。1つの項目のバインディングプロパティだけを更新するときに使用します。
- Parameters:
index(int)- 更新する項目のインデックス /function(コールバック関数)- そのインデックスが有効な間に実行するコールバック - Returns: なし
Example
masonrygridID.setState(0, () => {
// 項目0のバインディングプロパティを更新
});
Event
onSelected
ユーザーが項目をタップしたときに実行されます。
- 種類: Event
- ハンドラー引数:
index- タップした項目のインデックス - Returns: なし
Example
masonrygridID.onSelected = (index) => {
// タップした項目のindexを処理
};
共通Widget Control(すべてのウィジェット)
すべてのウィジェットでは、setProperty/getProperty/setStylePropertyのような名前ベースの共通Widget Control(Method)を使用できます。共通リファレンスドキュメント(作成予定)をご覧ください。