JavaScript/jQuery Gallery API
The Gallery is a widget that displays a collection of images in a carousel. The widget is supplied with various navigation controls that allow a user to switch between images.
See Also
- Set Up DevExtreme: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Options
| Name | Description |
|---|---|
| accessKey |
Specifies the shortcut key that sets focus on the widget. |
| animationDuration |
The time, in milliseconds, spent on slide animation. |
| animationEnabled |
Specifies whether or not to animate the displayed item change. |
| dataSource |
Binds the widget to data. |
| disabled |
Specifies whether the widget responds to user interaction. |
| elementAttr |
Specifies the attributes to be attached to the widget's root element. |
| focusStateEnabled |
Specifies whether the widget can be focused using keyboard navigation. |
| height |
Specifies the widget's height. |
| hint |
Specifies text for a hint that appears when a user pauses on the widget. |
| hoverStateEnabled |
Specifies whether the widget changes its state when a user pauses on it. |
| indicatorEnabled |
A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. |
| initialItemWidth |
Specifies the width of an area used to display a single image. |
| itemComponent |
An alias for the itemTemplate option specified in React. Accepts a custom component. Refer to Using a Custom Component for more information. |
| itemHoldTimeout |
The time period in milliseconds before the onItemHold event is raised. |
| itemRender |
An alias for the itemTemplate option specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information. |
| items |
An array of items displayed by the widget. |
| itemTemplate |
Specifies a custom template for items. |
| loop |
A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. |
| onContentReady |
A function that is executed when the widget's content is ready and each time the content is changed. |
| onDisposing |
A function that is executed before the widget is disposed of. |
| onInitialized |
A function used in JavaScript frameworks to save the widget instance. |
| onItemClick |
A function that is executed when a collection item is clicked or tapped. |
| onItemContextMenu |
A function that is executed when a collection item is right-clicked or pressed. |
| onItemHold |
A function that is executed when a collection item has been held for a specified period. |
| onItemRendered |
A function that is executed after a collection item is rendered. |
| onOptionChanged |
A function that is executed after a widget option is changed. |
| onSelectionChanged |
A function that is executed when a collection item is selected or selection is canceled. |
| rtlEnabled |
Switches the widget to a right-to-left representation. |
| selectedIndex |
The index of the currently active gallery item. |
| selectedItem |
The selected item object. |
| showIndicator |
A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. |
| showNavButtons |
A Boolean value that specifies the availability of the "Forward" and "Back" navigation buttons. |
| slideshowDelay |
The time interval in milliseconds, after which the gallery switches to the next item. |
| stretchImages |
Specifies if the widget stretches images to fit the total gallery width. |
| swipeEnabled |
A Boolean value specifying whether or not to allow users to switch between items by swiping. |
| tabIndex |
Specifies the number of the element when the Tab key is used for navigating. |
| visible |
Specifies whether the widget is visible. |
| width |
Specifies the widget's width. |
| wrapAround |
Specifies whether or not to display parts of previous and next images along the sides of the current image. |
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Methods
| Name | Description |
|---|---|
| beginUpdate() |
Prevents the widget from refreshing until the endUpdate() method is called. |
| defaultOptions(rule) |
Specifies the device-dependent default configuration options for this component. |
| dispose() |
Disposes of all the resources allocated to the Gallery instance. |
| element() |
Gets the root widget element. |
| endUpdate() |
Refreshes the widget after a call of the beginUpdate() method. |
| focus() |
Sets focus on the widget. |
| getDataSource() |
Gets the DataSource instance. |
| getInstance(element) |
Gets the instance of a widget found using its DOM node. |
| goToItem(itemIndex, animation) |
Shows a specific image. |
| instance() |
Gets the widget's instance. Use it to access other methods of the widget. |
| nextItem(animation) |
Shows the next image. |
| off(eventName) |
Detaches all event handlers from a single event. |
| off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) |
Subscribes to an event. |
| on(events) |
Subscribes to events. |
| option() |
Gets all widget options. |
| option(optionName) |
Gets the value of a single option. |
| option(optionName, optionValue) |
Updates the value of a single option. |
| option(options) |
Updates the values of several options. |
| prevItem(animation) |
Shows the previous image. |
| registerKeyHandler(key, handler) |
Registers a handler to be executed when a user presses a specific key. |
| repaint() |
Repaints the widget without reloading data. Call it to update the widget's markup. |
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Events
| Name | Description |
|---|---|
| contentReady |
Raised when the widget's content is ready. |
| disposing |
Raised before the widget is disposed of. |
| initialized |
Raised only once, after the widget is initialized. |
| itemClick |
Raised when a collection item is clicked or tapped. |
| itemContextMenu |
Raised when a collection item is right-clicked or pressed. |
| itemHold |
Raised when a collection item has been held for a specified period. |
| itemRendered |
Raised after a collection item is rendered. |
| optionChanged |
Raised after a widget option is changed. |
| selectionChanged |
Raised when a collection item is selected or selection is canceled. |
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Default Item Template
By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is the list of these fields. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.