wijlightbox jQuery Widget

Overlay images on the current page, give focus to an image, autoplay through images, play flash videos, show animated transitions, and more.

Syntax

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

Javascript (Usage)

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

Javascript (Specification)
function wijlightbox() : any;

Browser Compatibility

Options

	Name	Description
	autoPlay	Default value: false Determines whether pages are automatically displayed in order.
	autoPlayMovies	Default value: true Determines whether to turn on the autoplay option in movie player.
	autoSize	Default value: true A value determines whether to auto-size to keep the original width/height ratio of content.
	clickPause	Default value: false Determines whether to pause the auto-play when clicking the content.
	closeOnEscape	Default value: true Determines whether to close the pop-up window when a user presses the ESC key.
	closeOnOuterClick	Default value: true Determines whether to close the pop-up window when user clicks on the outside of content.
	controlsPosition	Default value: 'inside' Determines the position of control buttons.
	cookie	Default value: null Store the latest active index in a cookie. The cookie is then used to determine the initially active index
	counterFormat	Default value: '[i] of [n]' Determines the text format of counter. '[i]' and '[n]' are built-in parameters represents the current page index and the number of pages.
	counterLimit	Default value: 10 Determines the maximum number of digit buttons in sequence counter type.
	counterType	Default value: 'default' Determines the type counter style. Possible values are: 'default', 'sequence'
	ctrlButtons	Default value: "" Determines the visibility of the control buttons. Possible values are: 'play', 'stop' separated by '\|'.
	delay	Default value: 2000 Determines the time span in milliseconds between panels in autoplay mode.
	dialogButtons	Default value: 'close' Determines the visibility of the dialog buttons. Possible values are: 'close', 'fullSize' separated by '\|'.
	flashInstall	Default value: 'player\\\\expressInstall.swf' Determines the relative path and name of the flash installation guide.
	flashParams	Determines a hash object that contains parameters for a flash object.
	flashVars	Determines a hash object that contains variants for a flash object.
	flashVersion	Default value: '9.0.115' Version of Flash object.
	flvPlayer	Default value: 'player\\\\player.swf' Determines the relative path and name of the flash vedio player.
	groupItems	Default value: null Determines the array of data items.
	height	Default value: 400 Determines the maximum height of the content.
	keyNav	Default value: false Determines whether to allow keyboard navigation.
	loop	Default value: true Determines whether start from the first page when reaching the end in autoplay mode.
	modal	Default value: false Determines whether the window is modal.
	player	Default value: "" Determines the name of player to host the content. Possible values are: 'inline', 'iframe', 'img', 'swf', 'flv', 'wmp', 'qt', 'wijvideo'
	position	Determines the pop-up position of content window. Please see jquery.ui.position for possible options.
	resizeAnimation	Determines the animation style when resizing.
	rootUrl	Default value: "" Determines the root url for each item.
	showControlsOnHover	Default value: true Determines whether to display the control buttons only when hovering the mouse over the content.
	showCounter	Default value: true Determines whether to display the counter.
	showMovieControls	Default value: true Determines whether to turn on the movie controls in movie player.
	showNavButtons	Default value: true Determines whether to display the navigation buttons.
	showTimer	Default value: false Determines whether to display the time bar.
	slideDirection	Default value: 'horizontal' Determines the slide direction. Possible values are: 'horizontal', 'vertical'
	textHideOption	Determines the animation style when hidding the text.
	textPosition	Default value: 'overlay' Determines the position of text description. Possible values are: 'inside', 'outside', 'overlay', 'titleOverlay' and 'none'
	textShowOption	Determines the animation style when showing the text.
	transAnimation	Determines the animation style when switching between pages. Possible values are 'slide', 'fade', 'none'
	width	Default value: 600 Determines the maximum width of the content.
	zIndex	Default value: 1000 Determines the z-index of popup container.

Top

Methods

	Name	Description
	adjustPosition	Adjust the position of lightbox according to the "position" option set it originally to a new location. . It is usually called after window resized.
	back	Moves to the previous panel.
	destroy	Destroys wijlightbox widget and reset the DOM element.
	isPlaying	Determines whether the lightbox is currently displaying images automatically.See the play method for more information.
	next	Moves to the next panel.
	play	Starts displaying the images in order automatically.
	show	Shows the content in specified index.
	stop	Stops the slide playing mode.
	widget	Returns a jQuery object containing the original element or other relevant generated element.

Top

Events

	Name	Description
	beforeClose	The showbeforeClose event handler. A function called before the popped up container is closed.
	beforeShow	The beforeShow event handler. A function called before a page's content is shown.
	close	The close event handler. A function called after the popped up container is closed.
	open	The open event handler. A function called after the popped up container is opened.
	show	The show event handler. A function called after a page's content is shown.

Top

See Also

Widgets

Reference