When true, Roundabout will automatically advance the moving elements to the next child at a regular interval (settable as autoplayDuration).
Defaults to false.
The length of time (in milliseconds) between animation triggers when a Roundabout's autoplay is playing.
Defaults to 1000.
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.
Defaults to 0.
When true, Roundabout will pause autoplay when the user moves the cursor over the Roundabout container.
Defaults to false.
The starting direction in which Roundabout should face relative to the focusBearing.
Defaults to 0.0.
A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.
A jQuery selector of page elements that, when clicked, will trigger the Roundabout to animate to the next moving element.
Defaults to null.
A function that will be called once the animation triggered by a btnNext-related click has finished.
Defaults to function() {}.
A jQuery selector of page elements that, when clicked, will trigger the Roundabout to animate to the previous moving element.
Defaults to null.
A function that will be called once the animation triggered by a btnPrev-related click has finished.
Defaults to function() {}.
A jQuery selector of page elements that, when clicked, will start the Roundabout's autoplay feature (if it's currently stopped).
Defaults to null.
A jQuery selector of page elements that, when clicked, will stop the Roundabout's autoplay feature (if it's current playing).
Defaults to null.
A jQuery selector of page elements that, when clicked, will toggle the Roundabout's autoplay state (either starting or stopping).
Defaults to null.
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.
Defaults to li.
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.
Defaults to true.
A function that will be called once the clickToFocus animation has completed.
Defaults to function() {}.
When true, Roundabout will replace the contents of moving elements with information about the moving elements themselves.
Defaults to false.
The axis along which drag events are measured.
Defaults to x.
Alters the rate at which dragging moves the Roundabout's moving elements. Higher numbers will cause the moving elements to move less.
Defaults to 4.
The animation method to use when a dragged Roundabout is dropped.
Defaults to nearest.
A function that will be called once the dropped animation has completed.
Defaults to function() {}.
The length of time (in milliseconds) the animation will take to animate Roundabout to the appropriate child when the Roundabout is “dropped.”
Defaults to 600.
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.
Defaults to swing.
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.
Defaults to 600.
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.
Defaults to swing.
Requires event.drag and event.drop plugins by ThreeDubMedia. Allows a user to rotate Roundabout be clicking and dragging the Roundabout area itself.
Defaults to false.
The maximum distance two values can be from one another to still be considered equal by Roundabout's standards. This prevents JavaScript rounding errors.
Defaults to 0.001.
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.
Defaults to 0.0.
ID of the form to use for AJAX requests.
The client-side ID of the widget, with all parent naming containers, such as
myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs
multiple container elements (such as Paginator), this may also be an array if IDs.
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.
Defaults to 1.0.
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.
Defaults to 1.0.
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.
Defaults to 280.
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.
Defaults to 0.4.
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.
Defaults to 0.4.
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.
Defaults to 100.
An optional callback that is invoked
after this widget was created successfully, at the end of the init method. This is
usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called
during a refresh (AJAX update).
An optional callback that is invoked after
this widget was refreshed after an AJAX update, at the end of the refresh method.
This is usually specified via the widgetPostRefresh attribute on the JSF component.
An optional callback that is invoked before
this widget is about to be destroyed, e.g. when the component was removed at the end of an AJAX update. This is
called at the beginning of the destroy method. This is usually specified via the
widgetPreDestroy attribute on the JSF component.
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.
Defaults to false.
When true, attaches a resize event onto the window and will automatically relayout Roundabout's child elements as the holder element changes size.
Defaults to false.
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.
Defaults to lazySusan.
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.
Defaults to 0.
Slightly alters the calculations of moving elements. In the default shape, it adjusts the apparent tilt. Other shapes will differ.
Defaults to 0.0.
When true, a blur event will be triggered on the child element that moves out of the focused position when it does so.
Defaults to true.
When true, a focus event will be triggered on the child element that moves into focus when it does so.
Defaults to true.
The name of the widget variables of this widget. The widget variable can be used to
access a widget instance by calling PF("myWidgetVar").
Generated using TypeDoc
The configuration for the Ring widget. You can access this configuration via BaseWidget.cfg. Please note that this configuration is usually meant to be read-only and should not be modified.