Interface RoundaboutSettings

When true, Roundabout will automatically advance the moving elements to the next child at a regular interval (settable as autoplayDuration).

The length of time (in milliseconds) between animation triggers when a Roundabout's autoplay is playing.

The length of time (in milliseconds) to delay the start of Roundabout's configured autoplay option. This only works with setting autoplay to true, and only on the first start of autoplay.

When true, Roundabout will pause autoplay when the user moves the cursor over the Roundabout container.

The starting direction in which Roundabout should face relative to the focusBearing.

A jQuery selector of page elements that, when clicked, will trigger the Roundabout to animate to the next moving element.

A function that will be called once the animation triggered by a btnNext-related click has finished.

A jQuery selector of page elements that, when clicked, will trigger the Roundabout to animate to the previous moving element.

A function that will be called once the animation triggered by a btnPrev-related click has finished.

A jQuery selector of page elements that, when clicked, will start the Roundabout's autoplay feature (if it's currently stopped).

A jQuery selector of page elements that, when clicked, will stop the Roundabout's autoplay feature (if it's current playing).

A jQuery selector of page elements that, when clicked, will toggle the Roundabout's autoplay state (either starting or stopping).

A jQuery selector of child elements within the elements Roundabout is called upon that will become the moving elements within Roundabout. By default, Roundabout works on unordered lists, but it can be changed to work with any nested set of child elements.

When true, Roundabout will bring non-focused moving elements into focus when they're clicked. Otherwise, click events won't be captured and will be passed through to the moving child elements.

A function that will be called once the clickToFocus animation has completed.

When true, Roundabout will replace the contents of moving elements with information about the moving elements themselves.

The axis along which drag events are measured.

Alters the rate at which dragging moves the Roundabout's moving elements. Higher numbers will cause the moving elements to move less.

The animation method to use when a dragged Roundabout is dropped.

A function that will be called once the dropped animation has completed.

The length of time (in milliseconds) the animation will take to animate Roundabout to the appropriate child when the Roundabout is “dropped.”

The easing function to use when animating Roundabout after it has been “dropped.” With no other plugins, the standard jQuery easing functions are available. When using the jQuery easing plugin all of its easing functions will also be available.

The length of time Roundabout will take to move from one child element being in focus to another (when an animation is triggered). This value acts as the default for Roundabout, but each animation action can be given a custom duration for that animation.

The easing function to use when animating Roundabout. With no other plugins, the standard jQuery easing functions are available. When using the jQuery easing plugin, all of its easing functions will also be available.

Requires event.drag and event.drop plugins by ThreeDubMedia. Allows a user to rotate Roundabout be clicking and dragging the Roundabout area itself.

The maximum distance two values can be from one another to still be considered equal by Roundabout's standards. This prevents JavaScript rounding errors.

The bearing that Roundabout will use as the focus point. All animations that move Roundabout between children will animate the given child element to this bearing.

The greatest opacity that will be assigned to a moving element. This occurs when the moving element is at the same bearing as the focusBearing.

The greatest size (relative to its starting size) that will be assigned to a moving element. This occurs when the moving element is at the same bearing as the focusBearing.

The greatest z-index that will be assigned to a moving element. This occurs when the moving element is at the same bearing as the focusBearing.

The lowest opacity that will be assigned to a moving element. This occurs when the moving element is opposite of (that is, 180° away from) the focusBearing.

The lowest size (relative to its starting size) that will be assigned to a moving element. This occurs when the moving element is opposite of (that is, 180° away from) the focusBearing.

The lowest z-index that will be assigned to a moving element. This occurs when the moving element is opposite of (that is, 180° away from) the focusBearing.

When true, reverses the direction in which Roundabout will operate. By default, next animations will rotate moving elements in a clockwise direction and previous animations will be counterclockwise. Using reflect will flip the two.

When true, attaches a resize event onto the window and will automatically relayout Roundabout's child elements as the holder element changes size.

The path that moving elements follow. By default, Roundabout comes with one shape, which is lazySusan. When using Roundabout with the Roundabout Shapes plugin, there are many other shapes available.

The child element that will start at the Roundabout's focusBearing on load. This is a zero-based counter based on the order of markup.

Slightly alters the calculations of moving elements. In the default shape, it adjusts the apparent tilt. Other shapes will differ.

When true, a blur event will be triggered on the child element that moves out of the focused position when it does so.

When true, a focus event will be triggered on the child element that moves into focus when it does so.