wijcarousel jQuery Widget

Display a list of images in an image slider with previous and next buttons.

Syntax

Javascript (Usage)
$(function () { var options; // Type: wijmo.carousel.wijcarousel.options $(".selector").wijcarousel(options); });

Javascript (Usage)

$(function () {
    var options; // Type:  wijmo.carousel.wijcarousel.options
     
    $(".selector").wijcarousel(options);
});

Javascript (Specification)
function wijcarousel() : any;

Browser Compatibility

Options

	Name	Description
	animation	The animation option determines whether and how images are scroll in the carousel. It defines the animation effect and controls other aspects of the widget's animation, such as duration and easing. Set the disable attribute to true in order to disable the animation effect. For a live example, see the Carousel Animation page in the Explore sample.
	auto	Default value: false Allows pictures to be played automatically.
	buttonPosition	Default value: 'inside' Determines the position value for next button and previous button. Possible values are: "inside" and "outside".
	control	Default value: "" Determines the innerHtml of the custom control.
	controlPosition	A value that indicates the position settings for the custom control.
	data	Default value: [] An object collection that contains the data of the carousel.
	display	Default value: 1 Determines how many images should be shown in the view area.
	interval	Default value: 5000 Determines the time span between two pictures showing in autoplay mode.
	loop	Default value: true Allows the carousel to loop back to the beginning.
	nextBtnClass	Type: wijmo.carousel.btn_class_option Determines the class of custom previous button. Includes the following sub-options "defaultClass", "hoverClass", "disableClass".
	orientation	Default value: 'horizontal' Determines the orientation of the pager. Possible values are: "vertical" & "horizontal"
	pagerPosition	A value that indicates the position settings for the pager.
	pagerType	Default value: 'numbers' Determines the type of the pager in the carousel. Possible values are: "slider", "numbers", "dots", "thumbnails". For a live example, see the Carousel Paging page in the Explore sample.
	prevBtnClass	Type: wijmo.carousel.btn_class_option Determines the class of custom previous button. Includes the following sub-options "defaultClass", "hoverClass", "disableClass".
	preview	Default value: false Determines if we should preview the last and next images. loop == false , orintation == "horizontal",display == 1.
	showCaption	Default value: true Determines whether the caption of items should be shown.
	showControls	Default value: false Determines whether the custom control should be shown.
	showControlsOnHover	Default value: false Determines whether the controls should be shown after created or when hovering on the dom element.
	showPager	Default value: false Determines whether to show the pager element. By default, if showPager is set to true, the pager will appear at the bottom right of the widget and allows run time carousel item navigation. You can customize the location and appearance of the pager by using the pagerPosition and pagerType options.
	showTimer	Default value: false Determines if the timer of the carousel should be shown. If true, the timer appears by default at the top of the carousel with a play/pause button allowing carousel items to be automatically cycled through at run time.
	sliderOrientation	Default value: 'horizontal' Determines the orientation of the slider. Possible values are: "vertical" & "horizontal"
	start	Default value: 0 Determines the custom start position of the image list in wijcarousel.
	step	Default value: 1 Determines how many images will be scrolled when you click the Next/Previous button.
	thumbnails	Determines the thumbnails list for a pager when pagerType is "thumbnails".

Top

Methods

	Name	Description
	add	Add a custom item with specified index.
	destroy	Removes the wijcarousel functionality completely. This returns the element to its pre-init state.
	next	Shows the next picture.
	pause	Stops automatically displaying the images in order.
	play	Starts automatically displaying each of the images in order.
	previous	Shows the previous picture.
	refresh	Refresh the carousel layout.Reset the layout, scrolled.
	remove	Remove the item at specified index.
	scrollTo	Scrolls to the picture at the specified index.
	widget	Returns a jQuery object containing the original element or other relevant generated element.

Top

Events

	Name	Description
	afterScroll	This is the afterScroll event handler. It is a function called after scrolling to another image.
	beforeScroll	This is the beforeScroll event handler. It is a function called before scrolling to another image.
	itemClick	This is the itemClick event handler. It is a function called when the image is clicked.
	loadCallback	This is the loadCallback event handler. It is a function called after creating the dom element.

Top

See Also

Widgets

Reference