Default Item Template

This section lists the fields that are used in a default template for widget 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 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

disabled

Specifies whether or not a widget item must be displayed disabled.

Type: Boolean
Default Value: false

html

Specifies html code inserted into the widget item element.

Type: String

location

Specifies the item location and size against the widget grid.

Type: Object|Array

If you need to specify different locations for different screens, pass an array of objects with the same structure to the location field.

HTML
<div data-options="dxItem: { 
    location: [
        { row: 0, col: 0, colspan: 3, screen: 'lg'},
        { row: 0, col: 0, colspan: 2, screen: 'xs sm md'}
    ]
}"> <p>Header</p> </div>

template

Specifies an item template that should be used to render this item only.

Type: template
Return Value: String|jQuery

A template name or a template container.

Whether you use a default or a custom template for widget items, you can specify a specific template for a particular item. To do so, set the template field for the data source object of this item. The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a jQuery object of the template's container.
  • Assign a DOM Node of the template's container.
  • Assign a function that returns the jQuery object or a DOM Node of the template's container.
See Also

text

Specifies text displayed for the widget item.

Type: String

visible

Specifies whether or not a widget item must be displayed.

Type: Boolean
Default Value: true