Move

v3用のドキュメントを参照しています

概要

Moveコンポーネントは、リスト要素のにスタイルを適用することで、スライダーを実際に動かします。トランジションコンポーネントは、このコンポーネントが呼び出します。

メソッド

`move()`

move( dest: number, index: number, prev: number ): void

与えられたdestインデックスに向かい、トランジションコンポーネントを用いてスライダーを動かします。このメソッドはインデックスの更新などを行いませんので、基本的には直接使用せず、Controller#goを利用してください。

引数

`dest`	目的地となるインデックスで、クローンのインデックスも受け付ける
`index`	目的地となるスライドのインデックス。ループモード以外では`dest`と一致する
`prev`	移動前の現在のインデックス

`jump()`

jump( index: number ): void

トランジションなしで、目的のインデックスに直接移動します。

引数

`index`	移動先のインデックス

`translate()`

translate( position: number ): void

与えられたポジションにスライダーを移動させます。

引数

`position`	目的地をピクセルで指定

`cancel()`

cancel(): void

トランジションを中断します。

`toIndex()`

toIndex( position: number ): number

与えられたポジションに最も近いスライドのインデックスを返します。

引数

`position`	変換するポジション

返値

与えられたポジションに最も近いスライドのインデックス

`toPosition()`

toPosition( index: number, trimming?: boolean ): number

与えられたインデックスをポジションに変換します。

引数

`index`	変換するインデックス
`trimming`	省略可。両端の余白を取り除いた結果を返すかどうかを決める

返値

与えられたインデックスが対応するポジション

`getPosition()`

getPosition(): number

現在のポジションを取得します。

返値

リスト要素の現在の位置をピクセルで返す

`getLimit()`

getLimit( max: boolean ): number

スライダーが移動できる限界値を返します。

引数

`max`	最大値を返すか、あるいは最小値を返すかを決める

返値

限界の値をピクセルで返す

`isBusy()`

isBusy(): boolean

スライダーが現在移動可能かどうかを確認します。

返値

移動可能な場合はtrueを、そうでない場合はfalseを返す

`exceededLimit()`

exceededLimit( max?: boolean | undefined, position?: number ): boolean

スライダーが限界値を超えているかどうかを判定します。

引数

`max`	省略可。`true`の場合は最大値を、`false`の場合は最小値を、`undefined`の場合はその両方をテストする
`position`	省略可。テスト対象となるポジションを明示的に指定する。省略した場合、現在地が使われる

返値

限界値を超えている場合はtrueを、そうでない場合はfalseを返す