Class: Fx.Scroll

Прокручує будь-який елемент з overflow, включаючи елемент window.

Примітка:

• Fx.Scroll вимагає, щоб сторінка була в Standards Mode.

Extends

• Fx

Fx.Scroll Method: constructor

Синтаксис:

var myFx = new Fx.Scroll(element[, options]);

Аргументи:

1. element - (mixed) Рядок з id for або Element або посилання на Element для прокручування.
2. options - (object, опціонально) Всі Fx опції крім offset та wheelStops.

Опції:

1. offset - (object: defaults to {'x': 0, 'y': 0}) Об'єкт з властивостями x та y відстані для прокручування всередині Element.
2. wheelStops - (boolean: defaults to true) Якщо false, колесо миші не зупинить перехід.

Повертає:

• (object) Екземпляр new Fx.Scroll.

Приклад:

var myFx = new Fx.Scroll('myElement', {
    offset: {
        x: 0,
        y: 100
    }
}).toTop();

Примітка:

• Fx.Scroll перехід зупиниться при русі колеса миші if опція wheelStops не встановлена на false. Це для того, щоб дозволити користувачам контролювати свій веб-досвід.
• Fx.Scroll є безкорисним for Element без смуг прокручування.

Fx.Scroll Method: set

Прокручує вказаний Element до координат x/y негайно.

Синтаксис:

myFx.set(x, y);

Аргументи:

1. x - (number) Координата x для прокручування Element.
2. y - (number) Координата y для прокручування Element.

Повертає:

• (object) Цей екземпляр Fx.Scroll.

Приклад:

var myElement = $(document.body);
var myFx = new Fx.Scroll(myElement).set(0, 0.5 * document.body.offsetHeight);

Fx.Scroll Method: start

Прокручує вказаний Element до наданих координат x/y.

Синтаксис:

myFx.start(x, y);

Аргументи:

1. x - (number) Координата x для прокручування Element.
2. y - (number) Координата y для прокручування Element.

Повертає:

• (object) Цей екземпляр Fx.Scroll.

Приклад:

var myElement = $(document.body);
var myFx = new Fx.Scroll(myElement).start(0, 0.5 * document.body.offsetHeight);

Примітка:

• Прокручування до від'ємних координат неможливе.

Fx.Scroll Method: toTop

Прокручує вказаний Element до його максимального верху.

Синтаксис:

myFx.toTop();

Повертає:

• (object) Цей екземпляр Fx.Scroll.

Приклад:

//Scrolls "myElement" 200 pixels down from its top and, after 1.5 seconds,
//back to the top.
var myFx = new Fx.Scroll('myElement', {
    onComplete: function(){
        this.toTop.delay(1500, this);
    }
}).scrollTo(0, 200).chain(function(){
    this.scrollTo(200, 0);
});

Fx.Scroll Method: toBottom

Прокручує вказаний Element до його максимального низу.

Синтаксис:

myFx.toBottom();

Повертає:

• (object) Цей екземпляр Fx.Scroll.

Приклад:

//Scrolls the window to the bottom and, after one second, to the top.
var myFx = new Fx.Scroll(window).toBottom().chain(function(){
    this.toTop.delay(1000, this);
});

Fx.Scroll Method: toLeft

Прокручує вказаний Element до його максимального лівого краю.

Синтаксис:

myFx.toLeft();

Повертає:

• (object) Цей екземпляр Fx.Scroll.

Приклад:

//Scrolls "myElement" 200 pixels to the right and then back.
var myFx = new Fx.Scroll('myElement').scrollTo(200, 0).chain(function(){
    this.toLeft();
});

Fx.Scroll Method: toRight

Прокручує вказаний Element до його максимального правого краю.

Синтаксис:

myFx.toRight();

Повертає:

• (object) Цей екземпляр Fx.Scroll.

Приклад:

//Scrolls "myElement" to the right edge and then to the bottom.
var myFx = new Fx.Scroll('myElement', {
    duration: 5000,
    wait: false
}).toRight();
 
myFx.toBottom.delay(2000, myFx);

Fx.Scroll Method: toElement

Прокручує елемент, поки вказаний елемент не буде зверху/зліва. Якщо вказана вісь, прокручує лише вздовж цієї осі.

Синтаксис:

myFx.toElement(el[, axes]);

Аргументи:

1. el - (mixed) Рядок з id Element або посилання на Element для прокручування.
2. axes - (array or string, optional) Масив або рядок, що вказує, по яких осях прокручувати, може бути 'x', 'y' або ['x', 'y']. За замовчуванням - обидві осі.

Повертає:

• (object) Цей екземпляр Fx.Scroll.

Приклад:

//Scrolls the "myElement" to the top left corner of the window.
var myFx = new Fx.Scroll(window).toElement('myElement');
 
//Scrolls the "myElement" to the top corner of the window.
//Does not scroll horizontally.
var myFx = new Fx.Scroll(window).toElement('myElement', 'y');

Примітка:

• Див. Element:getPosition for труднощі з позицією.

Fx.Scroll Method: toElementEdge

Прокручує елемент, поки вказаний елемент не стане видимим вздовж вказаних осей.

Синтаксис:

myFx.toElementEdge(el[, axes]);

Аргументи:

1. el - (mixed) Рядок з id Element або посилання на Element для прокручування.
2. axes - (array or string, optional) Масив або рядок, що вказує, по яких осях прокручувати, може бути 'x', 'y' або ['x', 'y']. За замовчуванням - обидві осі.

Повертає:

• (object) Цей екземпляр Fx.Scroll.

Приклад:

//Scrolls the window until "myElement" is visible, scrolling in whatever direction
//is required.
var myFx = new Fx.Scroll(window).toElementEdge('myElement');
 
//Same as above but only scrolls the window up or down.
var myFx = new Fx.Scroll(window).toElementEdge('myElement', 'y');

Fx.Scroll Method: toElementCenter

Прокручує елемент, поки вказаний елемент не стане відцентрованим вздовж вказаних осей.

Синтаксис:

myFx.toElementCenter(el[, axes]);

Аргументи:

1. el - (mixed) Рядок з id Element або посилання на Element для прокручування.
2. axes - (array or string, optional) Масив або рядок, що вказує, по яких осях прокручувати, може бути 'x', 'y' або ['x', 'y']. За замовчуванням - обидві осі.

Повертає:

• (object) Цей екземпляр Fx.Scroll.

Приклад:

//Scrolls the window until "myElement" is centered in the window,
//scrolling in whatever direction is required.
var myFx = new Fx.Scroll(window).toElementCenter('myElement');
 
//Same as above but only scrolls the window up or down.
var myFx = new Fx.Scroll(window).toElementCenter('myElement', 'y');