Box Default Item Template

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

See Also

baseSize

Specifies the base size of an item element along the main direction.

Type: Number
Default Value: 0

Refer to the Layout Widgets guide to learn how to specify an element size.

box

Holds a Box configuration object for the item.

Type: dxBox options
Default Value: undefined

Use this field to make the item a nested Box widget.

Show Example:
AngularJS
Knockout
jQuery
<div ng-controller="demoController" style="height: 100%;">
    <div class="box" dx-box="{
        height: '70%',
        width: '90%',
        bindingOptions: {
            direction: 'directionValue'
        }
    }">
        <div id="item1" data-options="dxItem:{ ratio: 1, baseSize: 10 }"><p></p></div>
        <div id="item2" data-options="dxItem:{ ratio: 3, box: { direction: 'col' }}">
            <div class="subitem" data-options="dxItem:{ ratio: 3 }"><p></p></div>
            <div class="subitem" data-options="dxItem:{ ratio: 4 }"><p></p></div>
            <div class="subitem" data-options="dxItem:{ ratio: 5 }"><p></p></div>
        </div>
        <div id="item3" data-options="dxItem:{ ratio: 2, baseSize: 20 }"><p></p></div>
    </div>
    <div class="dx-fieldset">
      <div class="dx-field">
        <div class="dx-field-label">direction</div>
          <div class="dx-field-value" ng-model="directionValue" dx-select-box="{
            dataSource: directionValues
        }"></div>
      </div>
    </div>
</div>
var myApp = angular.module('myApp', ['dx']);
myApp.controller("demoController", function ($scope) {
    $scope.directionValues = ['row', 'col'];
    $scope.directionValue = 'row'
});
angular.element(document).ready(function () {
    angular.bootstrap(document, ['myApp']);
});
body {
    text-align: center;
}
.box{
    margin: 10px auto;
    border: solid 2px;
}
.subitem{
    border: solid 1px blue;
    background-color: white;
    margin: 10px 10px 0 10px;
}
#item1{ 
    background-color: #f39e6c; 
}
#item2{ 
    background-color: #f5e5a6;
    padding-bottom: 10px;
}
#item3{ 
    background-color: #94d7c7; 
}
<div class="box" data-bind="dxBox:{
    direction: directionValue,
    height: '70%',
    width: '90%'
}">
    <div id="item1" data-options="dxItem:{ ratio: 1, baseSize: 10}"><p></p></div>
    <div id="item2" data-options="dxItem:{ ratio: 3, box: { direction: 'col' }}">
        <div class="subitem" data-options="dxItem:{ ratio: 3 }"><p></p></div>
        <div class="subitem" data-options="dxItem:{ ratio: 4 }"><p></p></div>
        <div class="subitem" data-options="dxItem:{ ratio: 5 }"><p></p></div>
    </div>
    <div id="item3" data-options="dxItem:{ ratio: 2, baseSize: 20}"><p></p></div>
</div>
<div class="dx-fieldset">
  <div class="dx-field">
    <div class="dx-field-label">direction</div>
    <div class="dx-field-value" data-bind="dxSelectBox: { value: directionValue, dataSource: directionValues }"></div>
  </div>
</div>
var myViewModel = {
    directionValues: ['row', 'col'],
    directionValue: ko.observable('row')
}
ko.applyBindings(myViewModel);
body {
    text-align: center;
}
.box{
    margin: 10px auto;
    border: solid 2px;
}
.subitem{
    border: solid 1px blue;
    background-color: white;
    margin: 10px 10px 0 10px;
}
#item1{ 
    background-color: #f39e6c; 
}
#item2{ 
    background-color: #f5e5a6;
    padding-bottom: 10px;
}
#item3{ 
    background-color: #94d7c7; 
}
<div class="box" id="myBox">
    <div id="item1" data-options="dxItem:{ ratio: 1, baseSize: 10 }"><p></p></div>
    <div id="item2" data-options="dxItem:{ ratio: 3, box: { direction: 'col' }}">
        <div class="subitem" data-options="dxItem:{ ratio: 3 }"><p></p></div>
        <div class="subitem" data-options="dxItem:{ ratio: 4 }"><p></p></div>
        <div class="subitem" data-options="dxItem:{ ratio: 5 }"><p></p></div>
    </div>
    <div id="item3" data-options="dxItem:{ ratio: 2, baseSize: 20 }"><p></p></div>
</div>
<div class="dx-fieldset">
  <div class="dx-field">
    <div class="dx-field-label">direction</div>
    <div class="dx-field-value" id="directionSelector"></div>
  </div>
</div>
$("#myBox").dxBox({
    height: '70%',
    width: '90%'
});
$("#directionSelector").dxSelectBox({
    value: 'row',
    dataSource: ['row', 'col'],
    onValueChanged: function (e) {
        $("#myBox").dxBox("instance").option("direction", e.value);
    }
});
body {
    text-align: center;
}
.box{
    margin: 10px auto;
    border: solid 2px;
}
.subitem{
    border: solid 1px blue;
    background-color: white;
    margin: 10px 10px 0 10px;
}
#item1{ 
    background-color: #f39e6c; 
}
#item2{ 
    background-color: #f5e5a6;
    padding-bottom: 10px;
}
#item3{ 
    background-color: #94d7c7; 
}

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

ratio

Specifies the ratio value used to count the item element size along the main direction.

Type: Number|String
Default Value: 0
Accepted Values: 'auto'

Refer to the Layout Widgets guide to learn how to specify an element size.

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