methods
Methods are actions taken on Scregal instances:
var $container = $('.gallery-box'); //container must be a jQuery object
var scregal = new Scregal(container, { /* options */ });
scregal.method();
If you do not have an instance of Scregal, you can get it at any time:
var scregal = $container.data('scregal');
scregal.method();
.init()
Parameters:- Example:
scregal.init();
Initialize Scregal manually.
.openGallery(elem)
Parameters:elem: jQuery object Example:
scregal.openGallery($('#autorun'));
.closeGallery()
Parameters:- Example:
scregal.closeGallery();
Close your opened gallery at any time
.updateOptions(options)
Parameters:options: {} Example:
scregal.updateOptions({
addFront: false,
maxWidth: 200
});
.append(elems)
Parameters:elem: jQuery object or objects Example:
scregal.append($('.just-added'));
Apend another element or group of elements to the gallery
.remove(elems)
Parameters:elem: jQuery object or objects Example:
scregal.remove($('.just-added'));
Remove element or group of elements from the gallery
.appearNavigation()
Parameters:- Example:
scregal.appearNavigation();
Call this function if You want to appear Your navigation elements which are currently hidden.
.disappearFront()
Parameters:- Example:
scregal.disappearFront();
Call this function if You want to disappear Your front box which is currently visible.
.appearFront()
Parameters:- Example:
scregal.appearFront();
Call this function if You want to appear Your front box which is currently hidden.
.autoGalleryInit()
Parameters:- Example:
scregal.autoGalleryInit();
Start Your auto gallery after delay you set in options:
runAutoGalleryAfterDelay:
.autoGalleryStart()
Parameters:- Example:
scregal.autoGalleryStart();
Start Your auto gallery immediately.
.autoGalleryStop()
Parameters:- Example:
scregal.autoGalleryStop();
Stop Your auto gallery immediately.
.on(eventName, listener)
Parameters:eventName: String, listener: Function Example:
function scregalAppeared() {
console.log('scregal appeared');
}
scregal.on('scregalAppeared', scregalAppeared);
Add an event listener for certain events
.off(eventName, listener)
Parameters:eventName: String, listener: Function Example:
scregal.off('scregalAppeared', scregalAppeared);
Remove an event listener.