wijgallery jQuery Widget

Display images in a customizable slideshow collection and animate transitions between images, display previous and next thumbnail images, add captions, and more.

Syntax

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

Javascript (Usage)

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

Javascript (Specification)
function wijgallery() : any;

Browser Compatibility

Options

	Name	Description
	autoPlay	Default value: false Allows pictures to be played automatically.
	autoPlayMovies	Default value: true Determines whether to turn on the autoplay option in movie player.
	control	Default value: "" Determines the innerHTML of the custom control.
	controlPosition	A value that indicates the position settings for the custom control.
	counter	Default value: '[i] of [n]' Determines the text format of counter.
	data	Default value: [] An object collection that contains the data of the gallery.
	flashInstall	Default value: 'player\\\\expressInstall.swf' The relative path and name of the flash installation guide.
	flashParams	A hash object that contains parameters for flash object.
	flashVars	A hash object that contains variants for flash object.
	flashVersion	Default value: '9.0.115' Version of flash object.
	flvPlayer	Default value: 'player\\\\player.swf' The relative path and name of the flash vedio player.
	interval	Default value: 5000 Determines the time span between 2 pictures showing in autoplay mode.
	mode	Default value: 'img' Determines the display mode of the gallery. Possible values: "img", "iframe", "swf", "flv"
	pagingPosition	Determines the position of the pager.
	scrollWithSelection	Default value: false If set to true, the thumbnails will auto scrolled after you select the image.
	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: true Determines whether the controls should be shown after the dom element is created or hovered on.
	showCounter	Default value: true Determines whether the controls should be shown after the dom element is created or hovered on.
	showMovieControls	Default value: false Determines whether to turn on the movie controls in movie player.
	showPager	Default value: false Determines if the pager should be shown.
	showThumbnailCaptions	Default value: false Determines whether to show captions for the thumbnails in the gallery.
	showTimer	Default value: true Determines if the timer bar should be shown.
	thumbnailDirection	Default value: 'after' Determines the direction of the thumbnails. Possible values are: "before" and "after".
	thumbnailOrientation	Default value: 'horizontal' Determines the orientation of the thumbnails. Possible values are: "vertical" and "horizontal".
	thumbsDisplay	Default value: 5 Determines how many thumbnails should be displayed.
	thumbsLength	Default value: 100 Determines the length of the thumbnails.
	transitions	A value that determines the settings of the animation effect to be used when the wijgallery is scrolling.

Top

Methods

	Name	Description
	add	Adds a custom item with specified index. The first parameter is the new item to add, it should be a jQuery Element or HTML string. The second parameter is the index of item to add , If no index specified the item will be added at the last of item collection.
	count	Returns a count of the number of items in the gallery.
	destroy	Removes the wijgallery 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.
	remove	Removes the item at specified index. The parameter is the index of item to add , If no index specified the last item will be removed.
	show	Shows the picture at the specified index.
	widget	Returns a jQuery object containing the original element or other relevant generated element.

Top

Events

	Name	Description
	afterTransition	The afterTransition event handler. A function called after the transition is over.
	beforeTransition	This is the beforeTransition event handler. It is a function called before transitioning to another image.
	loadCallback	The loadCallback event handler. A function called after the dom element is created.

Top

See Also

Widgets

Reference