NestedScroll (중첩 스크롤) Widget Control

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

備考

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

Widget Control一覧

Widget Control	種類	シグネチャ	説明
scrollToMax	Method	scrollToMax(duration?)	最下部（後方のpinnedヘッダーの直前）までスクロール
scrollToTop	Method	scrollToTop(duration?)	最上部までスクロール
onStartScroll	Event	onStartScroll = (isVertical, position) => { ... }	スクロールが開始されたときに実行
onUpdateScroll	Event	onUpdateScroll = (isVertical, position) => { ... }	スクロール中に継続して実行
onStopScroll	Event	onStopScroll = (isVertical, position) => { ... }	スクロールが停止したときに実行
onScrollEnd	Event	onScrollEnd = (isVertical) => { ... }	コンテンツの末尾（最下部）に到達したときに実行

Property

備考

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

Method

scrollToMax

ビューの最下部までスクロールします。後方に連続して配置されたpinnedヘッダーがある場合は、その直前までのみ移動し、内側のスクロール位置は最上部にリセットします。

• 種類: Method
• Parameters: duration（数値、省略可） - アニメーション時間（ミリ秒）。デフォルトは300です。0以下の場合は、アニメーションなしで即時に移動します。
• Returns: なし（void）

Example

nestedscrollID.scrollToMax(300);

scrollToTop

ビューの最上部までスクロールします。

• 種類: Method
• Parameters: duration（数値、省略可） - アニメーション時間（ミリ秒）。デフォルトは300です。0以下の場合は、アニメーションなしで即時に移動します。
• Returns: なし（void）

Example

nestedscrollID.scrollToTop(300);

Event

onStartScroll

スクロールが開始されたときに実行されます。

• 種類: Event
• Parameters: isVertical（真偽値） - スクロール軸が縦の場合はtrue。position（数値） - 現在のスクロール位置（ピクセル）。
• Returns: なし

Example

nestedscrollID.onStartScroll = (isVertical, position) => {
  // スクロール開始時に実行するコード
};

onUpdateScroll

スクロール中に継続して実行されます。

• 種類: Event
• Parameters: isVertical（真偽値） - 縦軸の場合はtrue。position（数値） - 現在のスクロール位置（ピクセル）。
• Returns: なし

Example

nestedscrollID.onUpdateScroll = (isVertical, position) => {
  // スクロール中に実行するコード
};

onStopScroll

スクロールが停止したときに実行されます。

• 種類: Event
• Parameters: isVertical（真偽値） - 縦軸の場合はtrue。position（数値） - 現在のスクロール位置（ピクセル）。
• Returns: なし

Example

nestedscrollID.onStopScroll = (isVertical, position) => {
  // スクロール停止時に実行するコード
};

onScrollEnd

スクロールがコンテンツの末尾（最下部）に到達したときに1回実行されます。最下部から離れたあと再び到達すると、もう一度実行されます。

• 種類: Event
• Parameters: isVertical（真偽値） - 縦軸の場合はtrue。
• Returns: なし

Example

nestedscrollID.onScrollEnd = (isVertical) => {
  // 最下部に到達したときに実行するコード
};

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

注記

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