carouFredSel advanced

Option Default value Datatype Description
items Object A map of the configuration for the items: visible, minimum, start, width, height and filter.
{
visible null Number The number of visible items.
If null, the number will be calculated (and set to "variable" if necessary).
String Enter "variable" to measure the number of visible items
(based on the available size).
Object A map for min and max.
String A string consisting of three sections:
  • base:"odd", "even" or ""(an empty string, default).
  • adjustment:"+" or "-".
  • amount:any number (1 by default)
For example: "odd+2" will measure the number of items needed to fill the available size, decrease it to an odd number and increase it by two.
Function A function that returns the number of visible items.
This function receives 1 parameter:
  • visibleItems: the number of items that would fit the available size.
minimum null Number The minimum number of items needed to create a carousel.
If null, the number for items.visible is inherited and increased by 1.
start 0 Number The nth item to start the carousel.
Hint: This can also be a negative number.
String Enter "random" to let the plugin pick a randon item to start the carousel.
String A jQuery-selector of the item to start the carousel.
For example: "#foo li:first".
jQuery-object A jQuery-object of the item to start the carousel.
For example: $("#foo li:first").
Boolean If true, the plugin will search for an item-anchor to start the carousel using the url-hashtag.
For example: http://domain.com#startitem
Array An array of the options above in the order they should be tested for a valid value.
width null Number The width of the items.
If null, the width will be measured (and set to "variable" if necessary).
String Enter "variable" to create a carousel that supports variable item-widths.
String Enter a percentage to automatically resize the width of the items onWindowResize.
Note: Only applies on responsive, vertical carousels.
For example: "50%".
height null Number The height of the items.
If null, the height will be measured (and set to "variable" if necessary).
String Enter "variable" to create a carousel that supports variable item-heights.
String Enter a percentage to automatically resize the height of the items onWindowResize.
Note: Only applies on responsive, horizontal carousels.
For example: "50%".
filter null String The selector elements should match to be considered an item.
If null, all elements inside the carousel will be considered to be an item.
If the carousel contains :hidden-elements, it is set to ":visible".
Note: this option is not (yet) compatible with non-circular carousels.
}
Number A number for items.visible.
String Enter "variable" for items.width, items.height and items.visible.
scroll Object A map of the configuration used for general scrolling: items, fx, easing, duration, pauseOnHover, queue, event, conditions, onBefore, onAfter and onEnd.
{
items null Number The number of items to scroll.
If null, the number of visible items is used.
String Enter "page" to scroll to the first item of the previous/next "page".
String A string consisting of three sections:
  • base:"odd", "even" or ""(an empty string, default).
  • adjustment:"+" or "-".
  • amount:any number (1 by default)
For example: "odd+2" will decrease the number of visible items to an odd number and increase it by two.
fx "scroll" String Indicates which effect to use for the transition.
Possible values: "none", "scroll", "directscroll", "fade", "crossfade", "cover", "cover-fade", "uncover" or "uncover-fade".
easing "swing" String Indicates which easing function to use for the transition. jQuery defaults: "linear" and "swing", built in: "quadratic", "cubic" and "elastic".
duration 500 Number Determines the duration of the transition in milliseconds.
If less than 10, the number is interpreted as a speed (pixels/millisecond).
This is probably desirable when scrolling items with variable sizes.
pauseOnHover false Boolean Determines whether the timeout between transitions should be paused "onMouseOver" (only applies when the carousel scrolls automatically).
String Enter "resume" to let the timeout resume instead of restart "onMouseOut".
String Enter "immediate" to immediately stop "onMouseOver" and resume "onMouseOut" a scrolling carousel.
String Enter "immediate-resume" for both the options above.
queue false Boolean Determines whether the scrolling should be queued if the carousel is currently being animated.
String Enter "first" to queue only the first scroll.
String Enter "last" to queue only the last scroll (all previous queued scroll will be removed).
event "click" String The event to trigger the prev-, next- and pagination-buttons/bullets.
conditions null Function Function that tests whether the carousel should start scrolling.
If it doesnt return true, the carousel will not scroll.
This function receives one parameter:
direction   //  The direction of the transition.
onBefore null Function Function that will be called right before the carousel starts scrolling.
This function receives a map of all data:
data = {
    width,         // The new width for the carousel.
    height,        // The new height for the carousel.
    items: {
        old,       // A jQuery-object of the items that are visible before scrolling.
        skipped,   // A jQuery-object of the items between the old and new items.
        visible    // A jQuery-object of the items that will be visible after scrolling.
    },
    scroll: {
        items,     //    The number of items scrolled.
        direction, //    The direction of the transition.
        duration   //    The duration of the transition.
    }
};
onAfter null Function Function that will be called right after the carousel finished scrolling.
This function receives the same parameter as the onBefore-callback function.
onEnd null Function Function to call when a non-circular carousel reaches its start or end.
This function receives one parameter:
direction   //  The direction of the transition.
}
Number A number for scroll.items or -if greater than 50- for scroll.duration.
String A string for scroll.easing.
auto Object A map of the configuration used for automatic scrolling: play, button, timeoutDuration, delay, progress, items, fx, easing, duration, pauseOnHover, pauseOnEvent, pauseOnResize, queue, event, conditions, onBefore, onAfter, onEnd, onTimeoutStart, onTimeoutEnd and onTimeoutPause.

This object is the same as the scroll object, except for play, button, timeoutDuration, delay, progress, pauseOnEvent, pauseOnResize, onTimeoutStart, onTimeoutEnd and onTimeoutPause. What is not specified in this object, will be inherited from the scroll object.

{
play true Boolean Determines whether the carousel should scroll automatically or not.
button null String A jQuery-selector for the HTML element that should toggle the carousel between playing and paused.
jQuery-object A jQuery-object of the HTML element that should toggle the carousel between playing and paused.
Function A function that returns any of the other valid values.
timeoutDuration 5 * [auto.duration] Number The amount of milliseconds the carousel will pause.
If auto.duration is less then 10 -to use a speed (in pixels/milliseconds) instead of a duration-, the default value is 2500.
delay 0 Number Additional delay in milliseconds before the carousel starts scrolling the first time.
Hint: This can also be a negative number.
progress false Object A map for bar, updater and interval.
{
     bar null String A jQuery-selector for the HTML element that should be passed to the updater-callback function.
jQuery-object A jQuery-object for the HTML element that should be passed to the updater-callback function.
     updater $.fn.carouFredSel.progressbarUpdater Function Function that will be called to update the progressbar.
This function receives one parameter:
percentage        // A percentage of the time passed in the timeout (from 0 to 100).
     interval 50 Number The amount of milliseconds the between triggering the updater-callback function.
}
String A string for auto.progress.bar.
jQuery-object A jQuery-object for auto.progress.bar.
items [scroll.items] See the description for scroll.items.
fx [scroll.fx] See the description for scroll.fx.
easing [scroll.easing] See the description for scroll.easing.
duration [scroll.duration] See the description for scroll.duration.
pauseOnHover [scroll.pauseOnHover] See the description for scroll.pauseOnHover.
pauseOnEvent false Boolean Determines whether the timeout between transitions should be paused when the event on the button is triggered.
See the description for scroll.pauseOnHover.
pauseOnResize true Boolean Determines whether the timeout between transitions should be paused when resizing the window.
Note: Only applies on responsive carousels.
queue [scroll.queue] See the description for scroll.queue.
event [scroll.event] See the description for scroll.event.
conditions [scroll.conditions] See the description for scroll.conditions.
onBefore [scroll.onBefore] See the description for scroll.onBefore.
onAfter [scroll.onAfter] See the description for scroll.onAfter.
onEnd [scroll.onEnd] See the description for scroll.onEnd.
onTimeoutStart null Function Function that will be called when starting the pausing-timer.
This function receives 2 parameters:
  • percentage: The percentage the auto.timeoutDuration is at.
  • duration: The remaining time left in milliseconds.
onTimeoutEnd null Function Function that will be called when ending the pausing-timer.
Functionality is the same as for the onTimeoutStart-function.
onTimeoutPause null Function Function that will be called when pausing the pausing-timer.
Functionality is the same as for the onTimeoutStart-function.
}
Boolean True or false for auto.play.
Number A number for auto.timeoutDuration.
prev Object A map of the configuration used for scrolling backwards using the "previous" button or key: button, key, items, fx, easing, duration, pauseOnHover, queue, event, conditions, onBefore, onAfter and onEnd.

This object is the same as the scroll object, except for button and key. What is not specified in this object, will be inherited from the scroll object.

{
button null String A jQuery-selector for the HTML element that should scroll the carousel backward.
jQuery-object A jQuery-object of the HTML element that should scroll the carousel backward.
Function A function that returns any of the other valid values.
key null Number The keyCode of the keyboard-key that should scroll the carousel backward.
String Can be: "up", "down", "left" or "right".
items [scroll.items] See the description for scroll.items.
fx [scroll.fx] See the description for scroll.fx.
easing [scroll.easing] See the description for scroll.easing.
duration [scroll.duration] See the description for scroll.duration.
String Enter "auto" to let the plugin calculate a speed for the transition instead of using a duration. This could be desirable when using the slideTo event.

Note: The speed is calculated by deviding scroll.duration by scroll.items and multiplying it with the amount of items to scroll.

pauseOnHover [scroll.pauseOnHover] See the description for scroll.pauseOnHover.
queue [scroll.queue] See the description for scroll.queue.
event [scroll.event] See the description for scroll.event.
conditions [scroll.conditions] See the description for scroll.conditions.
onBefore [scroll.onBefore] See the description for scroll.onBefore.
onAfter [scroll.onAfter] See the description for scroll.onAfter.
onEnd [scroll.onEnd] See the description for scroll.onEnd.
}
String Any valid string for prev.button or prev.key.
Number A number for prev.key.
next Object A map of the configuration used for scrolling forward using the "next" button or key: button, key, items, fx, easing, duration, pauseOnHover, queue, event, conditions, onBefore, onAfter and onEnd.

This object is the same as the scroll object, except for button and key. What is not specified in this object, will be inherited from the scroll object.

{
button null String A jQuery-selector for the HTML element that should scroll the carousel forward.
jQuery-object A jQuery-object of the HTML element that should scroll the carousel forward.
Function A function that returns any of the other valid values.
key null Number The keyCode of the keyboard-key that should scroll the carousel forward.
String Can be: "up", "down", "left" or "right".
items [scroll.items] See the description for scroll.items.
fx [scroll.fx] See the description for scroll.fx.
easing [scroll.easing] See the description for scroll.easing.
duration [scroll.duration] See the description for scroll.duration.
String Enter "auto" to let the plugin calculate a speed for the transition instead of using a duration. This could be desirable when using the slideTo event.

Note: The speed is calculated by deviding scroll.duration by scroll.items and multiplying it with the amount of items to scroll.

pauseOnHover [scroll.pauseOnHover] See the description for scroll.pauseOnHover.
queue [scroll.queue] See the description for scroll.queue.
event [scroll.event] See the description for scroll.event.
conditions [scroll.conditions] See the description for scroll.conditions.
onBefore [scroll.onBefore] See the description for scroll.onBefore.
onAfter [scroll.onAfter] See the description for scroll.onAfter.
onEnd [scroll.onEnd] See the description for scroll.onEnd.
}
String Any valid string for next.button or next.key.
Number A number for next.key.
pagination Object A map of the configuration used for scrolling via the "pagination" buttons/bullets or keys: container, keys, anchorBuilder, items, deviation, fx, easing, duration, pauseOnHover, queue, event, conditions, onBefore, onAfter and onEnd.

This object is the same as the scroll object, except for container, keys, anchorBuilder and deviation. What is not specified in this object, will be inherited from the scroll object.

{
container null String A jQuery-selector for the HTML element that should contain the pagination-links.
jQuery-object A jQuery-object of the HTML element that should contain the pagination-links.
Function A function that returns any of the other valid values.
keys false Boolean Determines whether the carousel can be controlled via the keyboard-key 1-9.
Note: any page after page 9 will not be accessible via the keyboard.
anchorBuilder null Function Function to use for building the anchors of the pagination.
If null, the public method pageAnchorBuilder is used:
$.fn.carouFredSel.pageAnchorBuilder: function(nr, item) {
    return <a href="#+nr+"><span>+nr+</span></a>;
};

This function receives 1 parameter:
nr  //  The page number.
                                
Boolean If false, instead of building the pagination, the elements allready available in the container will be used as anchors.
items [items.visible] The number of items per page.
deviation 0 The number to deviate the selected bullet.
fx [scroll.fx] See the description for scroll.fx.
easing [scroll.easing] See the description for scroll.easing.
duration [scroll.duration] See the description for scroll.duration.
String Enter "auto" to let the plugin calculate a speed for the transition instead of using a duration.

Note: The speed is calculated by deviding scroll.duration by scroll.items and multiplying it with the amount of items to scroll.

pauseOnHover [scroll.pauseOnHover] See the description for scroll.pauseOnHover.
queue [scroll.queue] See the description for scroll.queue.
event [scroll.event] See the description for scroll.event.
conditions [scroll.conditions] See the description for scroll.conditions.
onBefore [scroll.onBefore] See the description for scroll.onBefore.
onAfter [scroll.onAfter] See the description for scroll.onAfter.
onEnd [scroll.onEnd] See the description for scroll.onEnd.
}
String Any valid string for pagination.container.
Boolean True or false for pagination.keys.
swipe Object A map of the configuration used for scrolling via swiping (on touch-devices) or dragging (using a mouse): onTouch, onMouse, options, items, fx, easing, duration, pauseOnHover, queue, conditions, onBefore, onAfter and onEnd.

This object is the same as the scroll object, except for onTouch, onMouse and options. What is not specified in this object, will be inherited from the prev or next object.

To enable this feature, youll need to include the jQuery.touchSwipe-plugin.

{
onTouch false Boolean Determines whether the carousel should scroll via swiping gestures (on touch-devices only).
onMouse false Boolean Determines whether the carousel should scroll via dragging (on non-touch-devices only).
options null Object A map of the configuration used for the touchSwipe-plugin.
items [scroll.items] See the description for scroll.items.
fx [scroll.fx] See the description for scroll.fx.
easing [scroll.easing] See the description for scroll.easing.
duration [scroll.duration] See the description for scroll.duration.
String Enter "auto" to let the plugin calculate a speed for the transition instead of using a duration. This could be desirable when using the slideTo event.

Note: The speed is calculated by deviding scroll.duration by scroll.items and multiplying it with the amount of items to scroll.

pauseOnHover [scroll.pauseOnHover] See the description for scroll.pauseOnHover.
queue [scroll.queue] See the description for scroll.queue.
conditions [scroll.conditions] See the description for scroll.conditions.
onBefore [scroll.onBefore] See the description for scroll.onBefore.
onAfter [scroll.onAfter] See the description for scroll.onAfter.
onEnd [scroll.onEnd] See the description for scroll.onEnd.
}
Boolean True or false for swipe.onTouch.
Number A number for swipe.items.
mousewheel Object A map of the configuration used for scrolling via the mousewheel: items, fx, easing, duration, pauseOnHover, queue, conditions, onBefore, onAfter and onEnd.

This object is the same as the scroll object. What is not specified in this object, will be inherited from the prev or next object.

To enable this feature, youll need to include the jQuery.mousewheel-plugin.

{
items [scroll.items] See the description for scroll.items.
fx [scroll.fx] See the description for scroll.fx.
easing [scroll.easing] See the description for scroll.easing.
duration [scroll.duration] See the description for scroll.duration.
String Enter "auto" to let the plugin calculate a speed for the transition instead of using a duration. This could be desirable when using the slideTo event.

Note: The speed is calculated by deviding scroll.duration by scroll.items and multiplying it with the amount of items to scroll.

pauseOnHover [scroll.pauseOnHover] See the description for scroll.pauseOnHover.
queue [scroll.queue] See the description for scroll.queue.
conditions [scroll.conditions] See the description for scroll.conditions.
onBefore [scroll.onBefore] See the description for scroll.onBefore.
onAfter [scroll.onAfter] See the description for scroll.onAfter.
onEnd [scroll.onEnd] See the description for scroll.onEnd.
}
Boolean True to copy all options from the scroll object.
Number A number for mousewheel.items.

Custom Events

After the plugin has been executed, a series of custom events are available for the carousel.

Event ( Parameters ) Default value Datatype Description
> play
Click to showhide the parameters for this event.
Triggering this event will restart/resume the timeout between transitions after pausing (only applies when the carousel scrolls automatically).
(
direction null String The direction to scroll the carousel. Possible values: "prev" or "next".
If null, the direction of the configuration is inherited.
delay 0 Number Additional delay in milliseconds before the carousel starts scrolling.
Hint: This can also be a negative number.
resumeStopped false Boolean If set to true, the timeout between transitions of a stopped carousel will restart.
Note: The order of these options is not important, they are sorted automatically based on the datatype.
)
> pause
Click to showhide the parameters for this event.
Triggering this event will pause the timeout between transitions
(only applies when the carousel scrolls automatically).
(
immediate false Boolean If set to true, the carousel will immediately stop scrolling.
resume false Boolean If set to true, the timeout will resume instead of restart.
)
> stop
Click to showhide the parameters for this event.
Triggering this event will stop the carousel from scrolling.
A stopped carousel can only be restarted by triggering the play-event with true as a parameter.
(
immediate false Boolean If set to true, the carousel will immediately stop scrolling.
)
finish Triggering this event will immediately finish the transition,
triggering all callback-functions.
resume Triggering this event will immediately resume the transition.
> prev
Click to showhide the parameters for this event.
Triggering this event will scroll the carousel backward.
(
options null Object A map of the configuration used for the scrolling (similar to the prev object passed in the configuration).
What is not specified in this object, will be inherited from the configuration prev object.
items null Number The number of items to scroll.
If null, the value for items in the options object is used.
onAfter null Function Function that will be called right after the carousel finished scrolling.
See the description for scroll.onAfter on the configuration-page.
If null, the value for onAfter in the options object is used.
queue null Boolean Determines whether the scrolling should be queued if the carousel is currently being animated.
If null, the value for queue in the options object is used.
Note: The order of these options is not important, they are sorted automatically based on the datatype.
)
> next
Click to showhide the parameters for this event.
Triggering this event will scroll the carousel forward.
(
options null See the description for the options-parameter in the prev-custom event.
items null See the description for the items-parameter in the prev-custom event.
onAfter null See the description for the onAfter-parameter in the prev-custom event.
queue null See the description for the queue-parameter in the prev-custom event.
Note: The order of these options is not important, they are sorted automatically based on the datatype.
)
> slideTo
Click to showhide the parameters for this event.
Triggering this event will scroll the carousel to the designated item.
(
destination (required) null Number The nth item to where the carousel should scroll.
String A jQuery-selector of the item to where the carousel should scroll.
For example: "#foo li:first".
jQuery-object A jQuery-object of the item to where the carousel should scroll.
For example: $("#foo li:first").
deviation 0 Number Deviation of the destination.
For example: -2 makes the carousel not end at destination, but 2 items to the left of it.
origOrder null Boolean Determines if the position of destination is relative to the original order of the items (true) or to the current order of the items (false).
If null, the value is determined by the given value for destination.
options null See the description for the options-parameter in the prev-custom event.
onAfter null See the description for the onAfter-parameter in the prev-custom event.
direction null String The direction to scroll the carousel. Possible values: "prev" or "next".
If null, the carousel will choose the shortest route.
Note: The order of these options is not important, they are sorted automatically based on the datatype.
)
> prevPage
Click to showhide the parameters for this event.
Triggering this event will scroll the carousel one page backward.
(
options null See the description for the options-parameter in the prev-custom event.
onAfter null See the description for the onAfter-parameter in the prev-custom event.
Note: The order of these options is not important, they are sorted automatically based on the datatype.
)
> nextPage
Click to showhide the parameters for this event.
Triggering this event will scroll the carousel one page forward.
(
options null See the description for the options-parameter in the prev-custom event.
onAfter null See the description for the onAfter-parameter in the prev-custom event.
Note: The order of these options is not important, they are sorted automatically based on the datatype.
)
> slideToPage
Click to showhide the parameters for this event.
Triggering this event will scroll the carousel to the passed page.
(
page null The page to scroll to.
If null, the carousel will scroll to the first item of the current page.
options null See the description for the options-parameter in the prev-custom event.
onAfter null See the description for the onAfter-parameter in the prev-custom event.
Note: The order of these options is not important, they are sorted automatically based on the datatype.
)
> queue
Click to showhide the parameters for this event.
Triggering this event will add a scroll in the queue to be executed after the next natural scroll.
Note: The queue is only processed if the scroll.queue option is set to true.
(
direction / scrolls / fn null String The direction to scroll the carousel. Possible values: "prev" or "next".
Array The queue of scrolls to set, removing all previously added scrolls.
Function Callback-function to get the queue.
This function receives 1 parameter:
  • queue: the queue.
options null Array An array containing the options to pass to the prev or next event (options, items and onAfter).
)
> insertItem
Click to showhide the parameters for this event.
Triggering this event will insert item(s) into the carousel.
(
items (required) null String A string of HTML to insert into the carousel.
For example: "<li>X</li>"
String A jQuery-selector of the item(s) to insert into the carousel.
For example: "#foo li:first"
jQuery-object A jQuery-object of the item(s) to insert into the carousel.
For example: $("#foo li:first")
destination "end" String The position where to insert the new item(s).
Number The nth item where to insert the new item(s).
String A jQuery-selector of the item where to insert the new item(s).
For example: "#foo li:first"
jQuery-object A jQuery-object of the item where to insert the new item(s).
For example: $("#foo li:first")
origOrder null Boolean Determines if the position of destination is relative to the original order of the items (true) or to the current order of the items (false).
If null, the value is determined by the given value for destination.
deviation 0 Number Deviation of the destination.
For example: -2 inserts the new item(s) not at destination, but 2 items to the left of it.
Note: The order of these options is not important, they are sorted automatically based on the datatype.
)
> removeItem
Click to showhide the parameters for this event.
Triggering this event will remove an item from the carousel.
(
items (required) 0 Number The nth item to be removed.
String A jQuery-selector of the item(s) to be removed.
For example: "#foo li:first"
jQuery-object A jQuery-object of the item(s) to be removed.
For example: $("#foo li:first")
origOrder null Boolean Determines if the position of items is relative to the original order of the items (true) or to the current order of the items (false).
If null, the value is determined by the given value for items.
deviation 0 Number Deviation of the items.
For example: -2 doesnt remove the item at items, but the one that is two items to the left of it.
Note: The order of these options is not important, they are sorted automatically based on the datatype.
)
> onBefore
Click to showhide the parameters for this event.
Trigger this event to add a new function to the next onBefore-callback.
(
callback / callbacks null Function Function to add to the callback.
This function receives 4 parameters:
  • oldItems: a jQuery-object of the items that were visible before scrolling.
  • newItems: a jQuery-object of the items that are visible after scrolling.
  • newSizes: a map of the new sizes of the carousel:
     newSizes.width and newSizes.height
  • duration: the duration of the transition.
Array An array of functions to add, removing all previously added callback functions.
)
> onAfter
Click to showhide the parameters for this event.
Trigger this event to add a new function to the next onAfter-callback.
(
callback / callbacks null Function Function to add to the callback.
See the description for the onAfter-parameter in the prev-custom event.
Array An array of functions to add, removing all previously added callback functions.
)
> configuration
Click to showhide the parameters for this event.
Trigger this event to dynamically get or set a configuration option.
(
option / options null String The option to set (if the second parameter is a value) or get (is the second parameter is a function).
Object A map of the options to set.
value / fn null String The value to set for the option.
Function Callback-function to get the value for the option.
This function receives 1 parameter:
  • value: the value for the option.

Note: If the callback-function is the first parameter, value will be the entire configuration object.

reInit true Boolean Determines if the carousel should "re-init" (re-callculate sizes etc.).
)
> synchronise
Click to showhide the parameters for this event.
Trigger this event to synchronise the given carousels.
(
options null Any valid value for the synchronise option in the configuration.
If null, the value for synchronise in the configuration is used.
)
> linkAnchors
Click to showhide the parameters for this event.
Trigger this event to automatically bind the slideTo-event to any HTML-element that links to an item inside the carousel.
Note: This method is executed on every <a class="caroufredsel">-tag after creating the carousel and after calling the insertItem and removeItem custom events by default.
(
container "body" String A jQuery-selector of the HTML-element to search in.
selector "a.caroufredsel" String A jQuery-selector of the HTML-element to search for.
For example: "a.cfs_link" will search for <a class="cfs_link">-tags.
)
updateSizes Trigger this event to immediately set the correct sizes to the carousel.
> currentPosition
Click to showhide the parameters for this event.
Triggering this event will return the position of the first visible item (the current position) in the callback-function or (when calling the triggerHandler-method) the return value.
(
fn null Function Callback-function to get the current position.
This function receives 1 parameter:
  • position: the current position of the carousel.
)
> currentPage
Click to showhide the parameters for this event.
Triggering this event will return the current page number in the callback-function or (when calling the triggerHandler-method) the return value.
(
fn null Function Callback-function to get the current page number.
This function receives 1 parameter:
  • page: the current page of the carousel.
)
> currentVisible
Click to showhide the parameters for this event.
Triggering this event will return a jQuery-object of the current visible items in the callback-function or (when calling the triggerHandler-method) the return value.
(
fn null Function Callback-function to get the current visible items.
This function receives 1 parameter:
  • items: the current visible items in the carousel.
)
> slice
Click to showhide the parameters for this event.
Triggering this event will return a jQuery-object of the matching elements in the callback-function or (when calling the triggerHandler-method) the return value.
Its behavior is the same as jQueries slice-method if the order of the items would not have been changed by the plugin.
(
start 0 Number The 0-based position at which the elements begin to be selected. If negative, it indicates an offset from the end of the set.
end null Number The 0-based position at which the elements stop being selected. If negative, it indicates an offset from the end of the set.
If null, the range continues until the end of the set.
fn null Function Callback-function to get the current visible items.
This function receives 1 parameter:
  • items: the selected items.
)
> isScrolling
Click to showhide the parameters for this event.
Trigger this event to find out whether the carousel is scrolling using either the callback-function or (when calling the triggerHandler-method) the return value.
(
fn null Function Callback-function to find out whether the carousel is scrolling.
This function receives 1 parameter:
  • isScrolling: true or false.
)
> isPaused
Click to showhide the parameters for this event.
Trigger this event to find out whether the carousel is paused using either the callback-function or (when calling the triggerHandler-method) the return value.
(
fn null Function Callback-function to find out whether the carousel is paused.
This function receives 1 parameter:
  • isPaused: true or false.
)
> isStopped
Click to showhide the parameters for this event.
Trigger this event to find out whether the carousel is stopped using either the callback-function or (when calling the triggerHandler-method) the return value.
(
fn null Function Callback-function to find out whether the carousel is stopped.
This function receives 1 parameter:
  • isStopped: true or false.
)
> destroy
Click to showhide the parameters for this event.
Remove the carousel functionality completely.
This will return the element back to its pre-init state.
(
origOrder false Boolean Determines if the items should be put back in the original order (true) or stay in the current order (false).
)