Options

Edgar Gonzalez edited this page Jun 3, 2013 · 15 revisions

This is the list of options available for the jQuery Rambling Slider. Any of them can be read by calling:

$('#slider').ramblingSlider('option', name)

And can be set when initializing with:

$('#slider').ramblingSlider({name1: value1, name2: value2})

Or after initialized with:

$('#slider').ramblingSlider('option', name, value)

You can also set more than one option at a time after initialized with:

$('#slider').ramblingSlider('option', {name1: value1, name2: value2})

There are two types of options:

  • Read Write
  • Readonly

The read write options can be read or written any time during or after initialization. This includes:

Option Default value Possible values Description
effect 'random' Any of these: 'sliceDown', 'sliceDownRight', 'sliceDownLeft', 'sliceDownRandom', 'sliceDownOutIn', 'sliceDownInOut', 'sliceUp', 'sliceUpRight', 'sliceUpLeft', 'sliceUpRandom', 'sliceUpOutIn', 'sliceUpInOut', 'sliceUpDown', 'sliceUpDownRight', 'sliceUpDownLeft', 'sliceUpDownRandom', 'sliceUpDownOutIn', 'sliceUpDownInOut', 'sliceFade', 'sliceFadeRight', 'sliceFadeLeft', 'sliceFadeOutIn', 'sliceFadeInOut', 'sliceFadeRandom', 'fold', 'foldRight', 'foldLeft', 'foldRandom', 'foldOutIn', 'foldInOut', 'fade', 'slideIn', 'slideInRight', 'slideInLeft', 'rollover', 'rolloverRight', 'rolloverLeft', 'boxRandom', 'boxRain', 'boxRainReverse', 'boxRainOutIn', 'boxRainInOut', 'boxGrow', 'boxGrowReverse. 'boxGrowOutIn', 'boxGrowInOut',
Or combined: 'fade,boxRain,fold' *
</td>
<td>The effect or effects to run as a transition between slides.</td>
slices 15 Any positive number. Number of slices for the slices effects.
boxCols 8 Any positive number. Number of columns to place boxes in for the boxes effects.
boxRows 4 Any positive number. Number of rows to place boxes in for the boxes effects.
speed 500 Any positive number. Transition effects speed.
pauseTime 3000 Any positive number. Time to remain on one slide.
manualAdvance false true, false Turns on or off the manual advance between sliders. If set to true, the slider only advances when clicking the 'Previous' or 'Next' buttons.
captionOpacity '0.8' Any number between 0 and 1, surrounded by '' Opacity for the caption showed over the slide if there is any.
theme default Any string. Selected theme for the slider.
alignBottom false true, false When set to true, aligns the bottom right corner of the scaled images with the bottom right corner of the slider. Otherwise, the images are aligned to the top left of the slider.
\*__Note__: For all the applicable effects, a group can be invoked with just `x`. For example the `sliceUp` value is equivalent to `sliceUpRight,sliceUpLeft,sliceUpRandom,sliceUpOutIn,sliceUpInOut`.

The readonly options are the ones that can only be specified when initializing the slider. They can be read at any moment after initialization. This includes:

Option Default value Possible values Description
startSlide 0 Any non negative number. Index of slide to start with.
directionNav true true, false Show direction navigation ('Previous' and 'Next' buttons).
directionNavHide true true, false Show direction navigation on hover only.
controlNav true true, false Show control navigation.
controlNavThumbs false true, false Show thumbnails on the control navigation.
controlNavThumbsFromRel false true, false Get thumbnails url for rel.
controlNavThumbsSearch '.jpg' Image files suffix. ('.jpg','.gif','.png') Pattern to be replaced for the thumbnail url.
controlNavThumsReplace '_thumb.jpg' String with image file suffix ('.jpg','.gif','.png') Pattern that replaces the one searched for the thumbnail url.
adaptImages false true, false When set to true, uses images instead of backgrounds for the animations, and scales images to the maximum dimension available.
useLargerImage true true, false When set to true, uses the larger image's dimension as the maximum dimension available. Otherwise, it uses the slider width and height as the maximum dimension available.
keyboardNav true true, false Enable keyboard navigation.
pauseOnHover true true, false Pause slider on hover.
prevText 'Prev' Any string. Text for the 'Previous' button.
nextText 'Next' Any string. Text for the 'Next' button.
imageTransitions null Object with specific format. See Adding and Overriding Transitions for more details. Additional image transitions.
flashTransitions null Object with specific format. See Adding and Overriding Transitions for more details. Additional flash transitions.
imageFlashTransitions null Object with specific format. See Adding and Overriding Transitions for more details. Additional transitions from image to flash element.
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.