Defaults
$('#default').microfiche();
Options
$('#cyclic').microfiche({ cyclic: true });
$('#buttons').microfiche({ buttons: false });
$('#bullets').microfiche({ bullets: false });
$('#keyboard').microfiche({ keyboard: true });
$('#click').microfiche({ clickToAdvance: true });
Commands
Commands are passed to the microfiche method as options, and may be passed at any point.
In this example, the slideByPages(1)
command is performed immediately
after Microfiche has finished setting up.
$('#commands').microfiche({ slideByPages: 1 });
$('#commands').microfiche({ slideByPages: -1 })
$('#commands').microfiche({ slideByPages: 1 })
$('#commands').microfiche({ slideToPoint: 0 })
$('#commands').microfiche({ jumpToPoint: 0 })
$('#commands').microfiche({ jumpToPage: 2 })
Events
Microfiche emits the following events:
'microfiche:willMove'
'microfiche:didMove'
You can listen for them in the usual way:
$('#events').microfiche().on('microfiche:willMove microfiche:didMove', function(event) { $('#events-console').html(event.type); });
Event received: -
Talking to Microfiche Directly
Microfiche has some useful methods that return values, and so cannot
be used through the aforementioned jQuery style syntax. The microfiche
object itself is available via jQuery’ data
method.
$('.my-element').data('microfiche');
Methods
var m = $('#methods').microfiche().data('microfiche'); m.currentPageIndex() // returns 0-index of the current page m.totalPageCount() // returns the number of pages as an integer m.min() // returns the minimum (left-most) position m.max() // returns the maximum (right-most) position
Autoplay
To have Microfiche pause rotation when the user hovers over the
carousel, set autopause
to true
.
$('#autoplay').microfiche({ cyclic: true, autoplay: 3, autopause: true });