|
options
|
Description
|
extrabuttons
|
Optional. The basic options that govern the behavior of Extra Buttons for this slideshow. All it's properties are also optional.
But some depend upon others having been specified. Their order is not important. Example Syntax:
extrabuttons: {pause: 6000, pauseplay: true, pend: '.bob', nextprevresume: false, navaction: 'mouseenter'}
The properties, are all optional:
|
onbeforeslide
|
Optional. Custom function to execute just before the image changes. The index parameter represents the 0 based index of which image the show will change to.
The keyword this initially refers to the fadeslideshow instance. Example Syntax:
onbeforeslide: function(index){
var lng = this.setting.imagearray.length;
this.setting.$nav.removeClass('highlight').each(function(i){
if(i % lng === index){
this.className += ' highlight';
}
});
}
The above would add the highlight class to the active navbut button.
|
onpauseplayswitch
Requires pauseplay button(s)
|
Optional - requires pauseplay button(s) - pauseplay classed button(s) in the toggler division(s) markup OR a valid extrabuttons.pend value and extrabuttons.pauseplay: true.
Custom function to execute when pauseplay button(s) change. The pauseplaybuts parameter represents the jQuery object containing any and all pauseplay buttons for this slideshow.
The keyword this initially refers to the fadeslideshow instance. Example Syntax:
onpauseplayswitch: function(pauseplaybuts){
var ppstatus = this.setting.$togglerdiv.find('.pauseplaystatus');
if(pauseplaybuts.hasClass('running')){
ppstatus.html('running');
} else {
ppstatus.html('paused');
}
}
The above would populate span(s) and/or division(s) within the toggler division(s) that have a class of pauseplaystatus with the paused/running state of the slideshow.
|
running
Requires a valid extrabuttons.pend and extrabuttons.pauseplay: true
|
Optional. When using extrabuttons.pend and extrabuttons.pauseplay, this is a string representing the markup for the auto-generated pauseplay button(s) when the slideshow is running.
Example:
running: '<img src="pause.gif" alt="pause" title="Pause">'
Defaults to:
'<input type="button" value="Pause" />'
|
paused
Requires a valid extrabuttons.pend and extrabuttons.pauseplay: true
|
Optional. When using extrabuttons.pend and extrabuttons.pauseplay, this is a string representing the markup for the auto-generated pauseplay button(s) when the slideshow is paused.
Example:
paused: '<img src="resume.gif" alt="play" title="Play">'
Defaults to:
'<input type="button" value="Play" />'
|
stopbut
Requires a valid extrabuttons.pend and extrabuttons.pauseplay: false or omitted
|
Optional. When using extrabuttons.pend and not extrabuttons.pauseplay, this is a string representing the markup for the auto-generated stop button(s).
Example:
stopbut: '<img src="stop.gif" alt="stop" title="Stop">'
Defaults to:
'<input type="button" value="Stop" />'
|
gobut
Requires a valid extrabuttons.pend and extrabuttons.pauseplay: false or omitted
|
Optional. When using extrabuttons.pend and not extrabuttons.pauseplay, this is a string representing the markup for the auto-generated go button(s).
Example:
gobut: '<img src="go.gif" alt="go" title="Go">'
Defaults to:
'<input type="button" value="Go" />'
|
navbut
Requires a valid extrabuttons.pend
|
Optional. When using extrabuttons.pend, this is a string representing the markup for the auto-generated navigation buttons.
Example:
navbut: '<img src="navimage_%i.gif" alt="goto image %c" title="Image #%c">'
Defaults to:
'<input type="button" value="%c" />'
The %c token will be replaced by the current image count
(count of the images from 1 to whatever). The %i token will do the same, but with the current image index starting at 0.
|