Configuration

An object defining configuration options for the dxTileView widget.

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

Type: Boolean
Default Value: true

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

Show Example:
jQuery

baseItemHeight

Specifies the height of the base tile view item.

Type: Number
Default Value: 100

The actual item height equals the heightRatio field value of an item multiplied by the value of this option.

Show Example:
jQuery

baseItemWidth

Specifies the width of the base tile view item.

Type: Number
Default Value: 100

The actual item width equals the widthRatio value of an item multiplied by the value of this option.

Show Example:
jQuery

bounceEnabled

A Boolean value specifying whether to enable or disable the bounce-back effect.

Type: Boolean
Default Value: true

If the option is set to true, you can scroll the widget content even if you have reached the boundary. But when you release the content, it returns to the bound position. If the option value is false, you can scroll the widget content until you reach the boundary.

Show Example:
jQuery

clickAction

An action performed when the widget is clicked.

Type: Action
Default Value: null

Show Example:
jQuery

dataSource

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

Type: Object
Default Value: null

The default template of a data source item object may contain the following fields.

  • text - specifies the text inserted into the item element
  • heightRatio - used as a multiplier for the baseItemHeight option value (for the purpose of obtaining the actual item height)
  • widthRatio - used as a multiplier for the baseItemWidth option value (for the purpose of obtaining the actual item width)

Refer to the Data-Bound Application tutorial for more information.

Show Example:
jQuery

disabled

A Boolean value specifying whether or not a component 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 component at runtime.

Show Example:
jQuery

height

Specifies the height of the widget.

Type: Number|String|function
Default Value: undefined

The option can hold a value of the following types:

  • 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 + "%"; }).

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

itemMargin

Specifies the distance in pixels between adjacent tiles.

Type: Number
Default Value: 20

Show Example:
jQuery

itemRender

A function used to render collection items.

Type: function
Default Value: null

The rendering function should have the following parameters, and return an HTML string, element, or jQuery object representing the rendered item.

  • itemData - an object representing the rendered item
  • itemIndex - an index of the rendered item
  • itemElement - a container element containing the rendered item

The following is an example of a function used to render an item.

itemRenderedAction

An action performed after a collection item is rendered.

Type: Action
Default Value: null

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 name of the template used to render widget items, or the function returning the template name.

Type: String|function
Default Value: "item"

listHeight

The maximum total height, in pixels, of tile view elements located in a single column.

Type: Number|String
Default Value: 500

Show Example:
jQuery

noDataText

The text displayed by the widget if the item collection is empty.

Type: String
Default Value: "No data to display"

showScrollbar

A Boolean value specifying whether or not to display a scrollbar.

Type: Boolean
Default Value: false

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
Default Value: undefined

The option can hold a value of the following types:

  • 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 + "%"; }).