TileView

A widget displaying several blocks of data as tiles.

Included in: dx.phonejs.js, dx.webappjs.js, dx.all.js

The dxTileView widget displays objects of a different size and reorders them so that they fit on the screen.

You can create a widget using one of the following approaches.

jQuery
Use the dxTileView jQuery plug-in.

HTML

<div id="tileView"></div>

JavaScript

var tileViewData = [
    { name: "Alabama", capital: "Montgomery", population: 4822023, area: 135765 },
    { name: "Alaska", capital: "Juneau", population: 731449, area: 1717854 },
    { name: "Arizona", capital: "Phoenix", population: 6553255, area: 295254 },
    ...
];
$("#tileView").dxTileView({
    dataSource: tileViewData,
    itemMargin: 20,
    baseItemHeight: 130,
    baseItemWidth: 180
});

Knockout
Add a div element and apply the dxTileView binding to this element.

HTML

<div data-bind="dxTileView: {
    dataSource: tileViewData,
    itemMargin: 20,
    baseItemHeight: 130,
    baseItemWidth: 180
}"></div>

Angular
Add a div element and apply the dx-tile-view directive to this element.

HTML

<div dx-tile-view="{
    dataSource: tileViewData,
    itemMargin: 20,
    baseItemHeight: 130,
    baseItemWidth: 180
}"></div>

Note that DevExtreme widgets require you to link the jQuery and Globalize libraries to your application. If you use the Knockout or Angular approach, the Knockout or Angular library is also required.

Configuration

An object defining configuration options for the dxTileView widget.

Name	Description
accessKey	Specifies a shortcut key that sets focus on the widget element.
activeStateEnabled	A Boolean value specifying whether or not the widget changes its state when interacting with a user.
baseItemHeight	Specifies the height of the base tile view item.
baseItemWidth	Specifies the width of the base tile view item.
dataSource	A data source used to fetch data to be displayed by the widget.
disabled	A Boolean value specifying whether or not the widget can respond to user interaction.
focusStateEnabled	Specifies whether or not the widget can be focused.
height	Specifies the height of the widget.
hint	Specifies the text of the hint displayed for the widget.
hoverStateEnabled	A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.
itemHoldTimeout	The time period in milliseconds before the onItemHold event is raised.
itemMargin	Specifies the distance in pixels between adjacent tiles.
items	An array of items displayed by the widget.
itemTemplate	The template to be used for rendering items.
noDataText	The text or HTML markup displayed by the widget if the item collection is empty.
onContentReady	A handler for the contentReady event.
onDisposing	A handler for the disposing event.
onInitialized	A handler for the initialized event.
onItemClick	A handler for the itemClick event.
onItemContextMenu	A handler for the itemContextMenu event.
onItemHold	A handler for the itemHold event.
onItemRendered	A handler for the itemRendered event.
onOptionChanged	A handler for the optionChanged event.
rtlEnabled	Specifies whether or not the current component supports a right-to-left representation.
showScrollbar	A Boolean value specifying whether or not to display a scrollbar.
tabIndex	Specifies the widget tab index.
visible	A Boolean value specifying whether or not the widget is visible.
width	Specifies the width of the widget.

Methods

This section describes members used to manipulate the widget.

Name	Description
beginUpdate()	Prevents the component from refreshing until the endUpdate method is called.
defaultOptions(rule)	Specifies the device-dependent default configuration options for this component.
element()	Returns the root HTML element of the widget.
endUpdate()	Enables the component to refresh after the beginUpdate method call.
focus()	Sets focus on the widget.
instance()	Returns an instance of this component class.
off(eventName)	Detaches all event handlers from the specified event.
off(eventName, eventHandler)	Detaches a particular event handler from the specified event.
on(eventName, eventHandler)	Subscribes to a specified event.
on(events)	Subscribes to the specified events.
option()	Returns the configuration options of this component.
option(optionName)	Gets the value of the specified configuration option of this component.
option(optionName, optionValue)	Sets a value to the specified configuration option of this component.
option(options)	Sets one or more options of this component.
registerKeyHandler(key, handler)	Registers a handler when a specified key is pressed.
repaint()	Redraws the widget.
scrollPosition()	Returns the current scroll position of the widget content.

Events

This section describes events exposed by this widget.

Name	Description
contentReady	Fires when widget content is ready.
disposing	Fires when the widget is being removed.
initialized	Fires when the widget is initialized.
itemClick	Fires when a widget item is clicked.
itemContextMenu	Fires when the the right mouse button is clicked when the pointer is over a widget item, or when the "sustained" (also known as a long press) touch action is performed.
itemHold	Fires when the widget's collection item is being held for the time period specified by the itemHoldTimeout option.
itemRendered	Fires after a collection item is rendered.
optionChanged	Fires after an option of the component is changed.

Default Item Template

This section lists the data source fields that are used in a default template for tile view items.

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 a 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.

TileView

See Also

Configuration

Methods

Events

See Also

Default Item Template

See Also