Wijmo UI for the Web
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
$(function () {
    var options; // Type:  wijmo.lightbox.wijlightbox.options
     
    $(".selector").wijlightbox(options);
});
function wijlightbox() : any;
Options
 NameDescription
public Option

Default value: false

Determines whether pages are automatically displayed in order.

 
public Option

Default value: true

Determines whether to turn on the autoplay option in movie player.

 
public Option

Default value: true

A value determines whether to auto-size to keep the original width/height ratio of content.

 
public Option

Default value: false

Determines whether to pause the auto-play when clicking the content.

 
public Option

Default value: true

Determines whether to close the pop-up window when a user presses the ESC key.

 
public Option

Default value: true

Determines whether to close the pop-up window when user clicks on the outside of content.

 
public Option

Default value: 'inside'

Determines the position of control buttons.

 
public Option

Default value: null

Store the latest active index in a cookie. The cookie is then used to determine the initially active index

 
public Option

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.

 
public Option

Default value: 10

Determines the maximum number of digit buttons in sequence counter type.

 
public Option

Default value: 'default'

Determines the type counter style. Possible values are: 'default', 'sequence'

 
public Option

Default value: ""

Determines the visibility of the control buttons. Possible values are: 'play', 'stop' separated by '|'.

 
public Option

Default value: 2000

Determines the time span in milliseconds between panels in autoplay mode.

 
public Option

Default value: 'close'

Determines the visibility of the dialog buttons. Possible values are: 'close', 'fullSize' separated by '|'.

 
public Option

Default value: 'player\\\\expressInstall.swf'

Determines the relative path and name of the flash installation guide.

 
public Option

Determines a hash object that contains parameters for a flash object.

 
public Option

Determines a hash object that contains variants for a flash object.

 
public Option

Default value: '9.0.115'

Version of Flash object.

 
public Option

Default value: 'player\\\\player.swf'

Determines the relative path and name of the flash vedio player.

 
public Option

Default value: null

Determines the array of data items.

 
public Option

Default value: 400

Determines the maximum height of the content.

 
public Option

Default value: false

Determines whether to allow keyboard navigation.

 
public Option

Default value: true

Determines whether start from the first page when reaching the end in autoplay mode.

 
public Option

Default value: false

Determines whether the window is modal.

 
public Option

Default value: ""

Determines the name of player to host the content. Possible values are: 'inline', 'iframe', 'img', 'swf', 'flv', 'wmp', 'qt', 'wijvideo'

 
public Option

Determines the pop-up position of content window. Please see jquery.ui.position for possible options.

 
public Option

Determines the animation style when resizing.

 
public Option

Default value: ""

Determines the root url for each item.

 
public Option

Default value: true

Determines whether to display the control buttons only when hovering the mouse over the content.

 
public Option

Default value: true

Determines whether to display the counter.

 
public Option

Default value: true

Determines whether to turn on the movie controls in movie player.

 
public Option

Default value: true

Determines whether to display the navigation buttons.

 
public Option

Default value: false

Determines whether to display the time bar.

 
public Option

Default value: 'horizontal'

Determines the slide direction. Possible values are: 'horizontal', 'vertical'

 
public Option

Determines the animation style when hidding the text.

 
public Option

Default value: 'overlay'

Determines the position of text description. Possible values are: 'inside', 'outside', 'overlay', 'titleOverlay' and 'none'

 
public Option

Determines the animation style when showing the text.

 
public Option

Determines the animation style when switching between pages. Possible values are 'slide', 'fade', 'none'

 
public Option

Default value: 600

Determines the maximum width of the content.

 
public Option

Default value: 1000

Determines the z-index of popup container.

 
Top
Methods
 NameDescription
public MethodAdjust the position of lightbox according to the "position" option set it originally to a new location. . It is usually called after window resized.  
public MethodMoves to the previous panel.  
public MethodDestroys wijlightbox widget and reset the DOM element.  
public MethodDetermines whether the lightbox is currently displaying images automatically.See the play method for more information.  
public MethodMoves to the next panel.  
public MethodStarts displaying the images in order automatically.  
public MethodShows the content in specified index.  
public MethodStops the slide playing mode.  
public MethodReturns a jQuery object containing the original element or other relevant generated element.  
Top
Events
 NameDescription
public EventThe showbeforeClose event handler. A function called before the popped up container is closed.  
public EventThe beforeShow event handler. A function called before a page's content is shown.  
public EventThe close event handler. A function called after the popped up container is closed.  
public EventThe open event handler. A function called after the popped up container is opened.  
public EventThe show event handler. A function called after a page's content is shown.  
Top
See Also

Widgets

LightBox

Reference

wijlightbox jQuery Widget