Scrollerインスタンスを作成します。 コンテキストとなるElementをこの時点で指定するか否かは任意です。
任意です。ScrollerSettingか Element(or cssクエリセレクタ文字列)を直接指定します。この時点でElementを指定しない場合は、setElementを実行するまでインスタンスは動作しません。
縦、横のどちらのスクロールを基準とするかを示します。
デフォルトはyです。
この設定はScroller.toElementのデフォルト値にも影響します。
スクロールを検知してから、移動がなくなった際に、何ms後にスクロール終了と判定するかのインターバル値を示します。 デフォルトは500です。
Scrollerの状態を示すenum値です。
Scrollerクラスの状態を監視&同期するオブジェクトが 保有すべきプロパティ一のキーの配列です。
スクロール要素の高さを示します。
スクロール要素の幅を示します。
設定されたElement要素です。 初期化が完了していない時には本getterはundefinedを返却する事に注意してください。
インスタンスが破棄済みである場合trueを示します。
未初期化である場合trueを示します。
初期化済み&停止状態である場合trueを示します。
初期化済み&動作中である場合trueを示します。
最後に検知したスクロールの軸を示します。
最後に検知したスクロールの方向を示します。
最後に検知したスクロールにより通知した情報を示します。
最後に検知したスクロールの水平方向を示します。
最後に検知したスクロールの垂直方向を示します。
現在スクロール中である場合trueを示します。
現在の下辺からのスクロール量を示します。
下辺からのスクロール量を設定します。
スクロールの有効状態を取得します
スクロール要素内のコンテンツの高さを示します。
現在の左辺からのスクロール量を示します。
左辺からのスクロール量を設定します。
現在の右辺からのスクロール量を示します。
右辺からのスクロール量を設定します。
現在の上辺からのスクロール量を示します。
上辺からのスクロール量を設定します。
スクロール要素内のコンテンツの幅を示します。
x軸にスクロール可能な場合trueを示します
y軸にスクロール可能な場合trueを示します
現在の状態です。
x, yの差分pxを指定しスクロールします。 メソッド、パラメータの詳細はscrollByを参照してください。
横移動量
縦移動量
スクロール中であった場合、スクロールをキャンセルします。
インスタンスの動作を停止し、内部情報を完全に破棄します。 これに伴い、スクロール中であった場合にはキャンセルされ、以後イベント通知は完全に行われません。 またScroller.startメソッドでの再利用も不可となります。 本インスタンスの利用を完全に停止する場合に必ず実行し、利用側のオブジェクト等において本インスタンスへの参照を完全に削除してください。 本メソッドはSPA等でのサービスにおいては意識的に実行する事を強く推奨します。
Emit event.
Create and return listener instance by type, handler. This will be done immediately. When registering this hook, do not expect the payload to be passed to the callback method.
本インスタンスの情報を購読するためのオブジェクトを設定する事で、 インスタンスの内部情報が変更される度にパラメータが同期されます。 設定するオブジェクトはScrollerObserverのインターフェースを満たしていれば内容は問いません。 本機能により同期される方法は単純にオブジェクトプロパティへの変数代入です。 従って対象となるプロパティをgetterとして実装(Ex: Vue computed等、、)しておく事により、 同期を受け取るオブジェクト側でパラメータ変更後の動作をリアクティブに実装可能です。
同期させたいオブジェクト
unobserve 同期を停止するためのメソッド
Remove listener by type
Remove listener by type and handler.
Remove listener by type and option.
Remove listener by handler.
Remove listener by option(tag, handler, tag).
Remove all listener instances.
Create and return listener instance by type, handler.
Create and return listener instance by type, handler, option.
Create and return listener instance by type, handler, option.
Create and return listener instance by type, handler, once.
Create and return listener instance by type, option.
Create and return listener instance by option.
Create and return listener instance by type, handler. This listener is deleted when it detects an event only once.
Create and return listener instance by type, handler, option. This listener is deleted when it detects an event only once.
Create and return listener instance by type, option. This listener is deleted when it detects an event only once.
Create and return listener instance by option. This listener is deleted when it detects an event only once.
スクロールの停止を要求します。
インスタンスが実行可能になった際にresolveされるPromiseインスタンスを返却します。
スクロールの停止要求を解除します。
別のプロセスにより異なるScrollStopperが登録されている場合、
スクロールは再開されない事に注意してください。
インスタンスにElementを設定します。特別な理由(SSRの利用等)によりコンストラクタでElementを指定できない場合、 本メソッドを利用しブラウザコンテキスト配下で本メソッドを実行してください。
Element、もしくはCSSクエリセレクタ文字列を指定します。
インスタンスの動作を開始します。本インスタンスはElementが設定され初期化された際に自動で動作を開始しますが、 Scroller.stopメソッドを利用し動作を停止した後に再開する場合に本メソッドを利用します。
インスタンスの動作(スクロール、リサイズイベントの検知等)を停止します。 何らかの理由で動作を停止させたい場合に利用してください。 本メソッドを実行後もインスタンス内の状態は保持されたままです。 完全にインスタンスを破棄するためにはScroller.destroyを利用してください。
指定の座標をスクロールします。 メソッド、パラメータの詳細はscrollToを参照してください。
下辺へスクロールします。 メソッド、パラメータの詳細はscrollToBottomを参照してください。
指定の要素の位置へスクロールします。 メソッド、パラメータの詳細はscrollToElementを参照してください。 オプションのx, yが未設定であった場合、Scroller.baseAxisにより自動設定されます。
インスタンス内の情報をjsonオブジェクトとして返却します。 情報の詳細はScrollerObserverを参照してください。
左辺へスクロールします。 メソッド、パラメータの詳細はscrollToLeftを参照してください。
左下コーナーへスクロールします。 メソッド、パラメータの詳細はscrollToLeftBottomを参照してください。
左上コーナーへスクロールします。 メソッド、パラメータの詳細はscrollToLeftTopを参照してください。
右辺へスクロールします。 メソッド、パラメータの詳細はscrollToRightを参照してください。
右下コーナーへスクロールします。 メソッド、パラメータの詳細はscrollToRightBottomを参照してください。
右上コーナーへスクロールします。 メソッド、パラメータの詳細はscrollToRightTopを参照してください。
指定の辺へスクロールします。 メソッド、パラメータの詳細はscrollToSideを参照してください。
Scroller.toJSONの情報を文字列として返却します。
上辺へスクロールします。 メソッド、パラメータの詳細はscrollToTopを参照してください。
Scroller.observeでパラメータ同期中のオブジェクトを停止します。 Scroller.destroy実行時にも、同期中のオブジェクトは全停止されますが、destroy前に任意のタイミングで停止したい場合 本メソッドを利用します。
同期中のオブジェクト
インスタンス内部のスクロール量や、Elementのサイズを強制的に更新します。 基本的に利用が必要なケースはありませんが、何らかの理由で更新をトリガーしたい場合に利用します。
スクロール系メソッドScroller.to等を利用する際のデフォルトの設定を示します。
Scroller.toElementのデフォルトオプションの設定を示します。
Generated using TypeDoc
任意のElement(or HTML Document)のスクロールやサイズ変更を監視し、その情報を通知するクラスです。
EVを継承しており、イベントの購読Scroller.on等のインターフェースを利用するか、 Scroller.observeメソッドを利用します。
Scroller.on、Scroller.onceで購読可能なイベントについてはScrollerEventMapを参照してください。