|
size
|
integer
|
Number of existing <li> elements if size is not passed explicitly
|
The number of total items.
|
|
scroll
|
integer
|
3
|
The number of items to scroll by.
|
|
visible
|
integer
|
null
|
If passed, the width/height of the items will be calculated and set depending on
the width/height of the clipping, so that exactly that number of items will be visible.
|
|
animation
|
mixed
|
"fast"
|
The speed of the scroll animation as string in jQuery terms ("slow"
or "fast") or milliseconds as integer (See
jQuery Documentation). If set to 0, animation is turned off.
|
|
easing
|
string
|
null
|
The name of the easing effect that you want to use (See
jQuery Documentation).
|
|
auto
|
integer
|
0
|
Specifies how many seconds to periodically autoscroll the content. If set to 0
(default) then autoscrolling is turned off.
|
|
wrap
|
string
|
null
|
Specifies whether to wrap at the first/last item (or both) and jump back to the
start/end. Options are "first", "last"
or "both" as string. If set to null, wrapping
is turned off (default). You can also pass "circular" as
option to enable support for circular carousels.
|
|
initCallback
|
function
|
null
|
JavaScript function that is called right after initialisation of the carousel. Two
parameters are passed: The instance of the requesting carousel and the state of
the carousel initialisation (init, reset or reload)
|
|
itemLoadCallback
|
function
|
null
|
JavaScript function that is called when the carousel requests a set of items to
be loaded. Two parameters are passed: The instance of the requesting carousel and
the state of the carousel action (prev, next or init). Alternatively, you can pass
a hash of one or two functions which are triggered before and/or after animation:
itemLoadCallback: {
onBeforeAnimation: callback1,
onAfterAnimation: callback2
}
|
|
itemFirstInCallback
|
function
|
null
|
JavaScript function that is called (after the scroll animation) when an item becomes
the first one in the visible range of the carousel. Four parameters are passed:
The instance of the requesting carousel and the <li> object itself,
the index which indicates the position of the item in the list and the state of
the carousel action (prev, next or init). Alternatively, you can pass a hash of
one or two functions which are triggered before and/or after animation:
itemFirstInCallback: {
onBeforeAnimation: callback1,
onAfterAnimation: callback2
}
|
|
itemFirstOutCallback
|
function
|
null
|
JavaScript function that is called (after the scroll animation) when an item isn't
longer the first one in the visible range of the carousel. Four parameters are passed:
The instance of the requesting carousel and the <li> object itself,
the index which indicates the position of the item in the list and the state of
the carousel action (prev, next or init). Alternatively, you can pass a hash of
one or two functions which are triggered before and/or after animation:
itemFirstOutCallback: {
onBeforeAnimation: callback1,
onAfterAnimation: callback2
}
|
|
itemLastInCallback
|
function
|
null
|
JavaScript function that is called (after the scroll animation) when an item becomes
the last one in the visible range of the carousel. Four parameters are passed: The
instance of the requesting carousel and the <li> object itself,
the index which indicates the position of the item in the list and the state of
the carousel action (prev, next or init). Alternatively, you can pass a hash of
one or two functions which are triggered before and/or after animation:
itemLastInCallback: {
onBeforeAnimation: callback1,
onAfterAnimation: callback2
}
|
|
itemLastOutCallback
|
function
|
null
|
JavaScript function that is called when an item isn't longer the last one in the
visible range of the carousel. Four parameters are passed: The instance of the requesting
carousel and the <li> object itself, the index which indicates
the position of the item in the list and the state of the carousel action (prev,
next or init). Alternatively, you can pass a hash of one or two functions which
are triggered before and/or after animation:
itemLastOutCallback: {
onBeforeAnimation: callback1,
onAfterAnimation: callback2
}
|
|
itemVisibleInCallback
|
function
|
null
|
JavaScript function that is called (after the scroll animation) when an item is
in the visible range of the carousel. Four parameters are passed: The instance of
the requesting carousel and the <li> object itself, the index
which indicates the position of the item in the list and the state of the carousel
action (prev, next or init). Alternatively, you can pass a hash of one or two functions
which are triggered before and/or after animation:
itemVisibleInCallback: {
onBeforeAnimation: callback1,
onAfterAnimation: callback2
}
|
|
itemVisibleOutCallback
|
function
|
null
|
JavaScript function that is called (after the scroll animation) when an item isn't
longer in the visible range of the carousel. Four parameters are passed: The instance
of the requesting carousel and the <li> object itself, the index
which indicates the position of the item in the list and the state of the carousel
action (prev, next or init). Alternatively, you can pass a hash of one or two functions
which are triggered before and/or after animation:
itemVisibleOutCallback: {
onBeforeAnimation: callback1,
onAfterAnimation: callback2
}
|
|
buttonNextCallback
|
function
|
null
|
JavaScript function that is called when the state of the 'next' control is changing.
The responsibility of this method is to enable or disable the 'next' control. Three
parameters are passed: The instance of the requesting carousel, the control element
and a flag indicating whether the button should be enabled or disabled.
|
|
buttonPrevCallback
|
function
|
null
|
JavaScript function that is called when the state of the 'previous' control is changing.
The responsibility of this method is to enable or disable the 'previous' control.
Three parameters are passed: The instance of the requesting carousel, the control
element and a flag indicating whether the button should be enabled or disabled.
|
|
buttonNextHTML
|
string
|
<div></div>
|
The HTML markup for the auto-generated next button. If set to null,
no next-button is created.
|
|
buttonPrevHTML
|
string
|
<div></div>
|
The HTML markup for the auto-generated prev button. If set to null,
no prev-button is created.
|
|
buttonNextEvent
|
string
|
"click"
|
Specifies the event which triggers the next scroll.
|
|
buttonPrevEvent
|
string
|
"click"
|
Specifies the event which triggers the prev scroll.
|