Configuration

An object defining configuration options for the dxGallery widget.

animationDuration

The time, in milliseconds, spent on slide animation.

Type: Number
Default Value: 400

Show Example:
jQuery

clickAction

An action performed when a widget is clicked.

Type: Action
Default Value: null

Show Example:
jQuery

contentReadyAction

An action performed when widget content is ready.

Type: Action
Default Value: null

dataSource

A data source used to fetch data to be displayed by the widget.

Default Value: null

You can assign an array directly to this option as well as use the Data Layer provided by the PhoneJS library.

To display widget items, a default template can be used. This template is based on the data source fields that are listed below. Alternatively, you can implement a custom item template. For details refer to the Customize Widget Item Appearance topic.

Show Example:
jQuery

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

Type: Boolean
Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

Show Example:
jQuery

height

Specifies the height of the widget.

Type: Number|String|function
Return Value: Number|String

The widget height.

Default Value: undefined

The option can hold the following types of values.

  • numeric - the height of the widget in pixels
  • string - a CSS measurement of the widget height (e.g., "55px", "80%", "auto" and "inherit")
  • function - a function returning the widget height (e.g., height:function(){ return baseHeight - 10 + "%"; })

indicatorEnabled

A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator.

Type: Boolean
Default Value: true

Show Example:
jQuery

itemClickAction

An action performed when a collection item is clicked.

Type: Action
Default Value: null

An object passed to the action function assigned to this option can have the following fields besides the basic field set.

  • itemData - Contains an object representing the clicked item
  • itemElement - Contains an HTML element representing the clicked item

itemRender

A function used to render collection items.

Type: function
Function parameters:
itemData: Object

An object representing the item to be rendered.

itemIndex: Number

The index of the item to be rendered.

itemElement: Object

An HTML element containing the item to be rendered.

Return Value: String|DOM Node|jQuery

An HTML string, Element, or jQuery object representing the rendered item.

Default Value: null

As in all container widgets in PhoneJS, items of this widget are displayed by a default HTML template. This template is based on certain fields of the data source. You can define a custom item template that will use specific fields of the data source. To learn more about item templates, refer to the Customize Widget Item Appearance topic.

Implement the itemRender function to provide a custom item template for a given collection item. This function is called each time a collection item of the widget is rendered. The following data is passed as function parameters.

  1. itemData - An object representing the rendered item
  2. itemIndex - An index of the rendered item
  3. itemElement - A container element containing the rendered item

Return an HTML string, Element, or jQuery object representing the rendered item.

Alternatively, you can define the dxTemplate markup component within the widget element and set its name option to item. In this case, the markup enclosed into the dxTemplate component will be automatically applied as an item template. In addition, you may need to define several item templates and apply each of them when required. In this instance, use the itemTemplate option to set the required template.

Refer to the Customize Widget Item Appearance topic to learn more about ways to render collection items.

itemRenderedAction

An action performed after a collection item is rendered.

Type: Action
Default Value: null

An object passed to the action function assigned to this option can have the following fields in addition to the basic field set.

  • itemData - Contains an object representing the item
  • itemElement - Contains an HTML element representing the item

items

An array of items displayed by the widget.

Type: Array

You can use the dataSource option instead. Unlike the items option, the dataSource option can take on the DataSource configuration object as well as a simple array.

itemTemplate

The template to be used for rendering items.

Type: String|function|DOM Node|jQuery
Return Value: String|jQuery

A template name or a template container.

Default Value: "item"

As in all container widgets in PhoneJS, items of this widget are displayed by a default HTML template. This template is based on certain fields of the data source. You can define a custom item template that will use specific fields of the data source. To learn more about item templates, refer to the Customize Widget Item Appearance topic.

In a simple case, you can define a single custom template for widget items using the dxTemplate markup component within the widget's container. Set the name option of this component to 'item'. In this instance, this template will be automatically used as an item template, and you don't have to specify the itemTemplate option.

However, in some cases you may need to have several custom item templates defined within the widget's container and apply each of them in different scenarios. In this instance, use one of the following ways of setting the required template to the itemTemplate option.

  • Assign a string representing the name of the required template.
  • Assign a function that returns the name of the template as a result of a certain logic.

When you have several collection widgets, you may need to define a common template for them. For this purpose, factor out a template into a separate element, as demonstrated below.

HTML
<script type="text/html" id="person-template">
    <h3 data-bind="text: name"></h3>
    <p>Address: <span data-bind="text: address"></span></p>
</script>

To set the common template as a collection item template, assign one of the following values to the itemTemplate option.

  • Assign a jQuery object representing the template's container
  • Assign a DOM Node representing the template's container
  • Assign a function that returns the jQuery object or a DOM Node representing the template's container

loop

A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped.

Type: Boolean
Default Value: false

Show Example:
jQuery

selectedIndex

The index of the currently active gallery item.

Type: Number
Default Value: 0

showIndicator

A Boolean value specifying whether or not to display an indicator that points to the selected gallery item.

Type: Boolean
Default Value: true

Show Example:
jQuery

showNavButtons

A Boolean value that specifies the availability of navigation buttons.

Type: Boolean
Default Value: false

Show Example:
jQuery

slideshowDelay

The time interval in milliseconds, after which the gallery switches to the next item.

Type: Number
Default Value: 0

If the value is set to 0, the slide show is disabled.

Show Example:
jQuery

swipeEnabled

A Boolean value specifying whether or not to allow users to switch between items by swiping.

Type: Boolean
Default Value: true

Show Example:
jQuery

visible

A Boolean value specifying whether or not the widget is visible.

Type: Boolean
Default Value: true

width

Specifies the width of the widget.

Type: Number|String|function
Return Value: Number|String

The widget width.

Default Value: undefined

The option can hold the following types of values.

  • numeric - the widget width in pixels
  • string - a CSS measurement of the widget width (e.g., "55px", "80%", "auto" and "inherit")
  • function - the function returning the widget width (e.g., width:function(){ return baseWidth - 10 + "%"; })