Configuration

An object defining configuration options for the widget.

cols

Specifies the collection of columns for the grid used to position layout elements.

Type:

Array

An item of an array passed to this options can include the following fields.

  • baseSize
    The base width of the column.

  • ratio
    The column width ratio.

  • screen
    The screen factor or factors by which the current column is used. If this field is not defined, the column is used by all screen factors.

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

Show Example:
AngularJS
Knockout
jQuery

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 Source provided by the DevExtreme library.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API. Alternatively, you can implement a custom item template.

See Also

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.

height

Specifies the height of the widget.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget height.

Default Value: '100%'

The option can hold a value of the following types.

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

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

Type:

Boolean

Default Value: false

itemHoldTimeout

The time period in milliseconds before the onItemHold event is raised.

Type:

Number

Default Value: 750

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.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API. Alternatively, you can implement a custom item template.

See Also

itemSelectAction

Deprecated

Use the onSelectionChanged option instead.

A function performed when a widget item is selected.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

itemData:

Object

The data that is bound to the selected item.

itemElement:

jQuery

An HTML element representing the item.

itemIndex:

Number

Specifies the index of the just selected item.

Default Value: null

Assign a function to perform a custom action when a widget item is selected.

Alternatively, you can assign a URL to which the browser will navigate when a widget item is selected.

itemTemplate

The template to be used for rendering items.

Function parameters:
itemData:

Object

The item object to be rendered.

itemIndex:

Number

The index of the item to be rendered.

itemElement:

jQuery

An HTML element of the item to be rendered.

Return Value:

String

|

DOM Node

|

jQuery

A template name or a template container.

Default Value: "item"
See Also
NOTE
A binding context of an item template is the data source object that corresponds to the currently rendered item. So, you can bind template elements to the item object's fields directly (see the code above). To access another binding context within an item template, use Knockout/Angular binding variables.

onContentReady

A handler for the contentReady event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

Default Value: null

Assign a function to perform a custom action when widget content is ready.

onDisposing

A handler for the disposing event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

Default Value: null

onInitialized

A handler for the initialized event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

Default Value: null

Assign a function to perform a custom action when the widget is initialized.

onItemClick

A handler for the itemClick event.

Type:

function

|

String

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

itemData:

Object

The data that is bound to the clicked item.

itemElement:

jQuery

An HTML element of the item.

itemIndex:

Number

Specifies the index of the clicked item.

jQueryEvent:

jQuery.Event

Specifies the jQuery event that caused action execution.

Default Value: null

Assign a function to perform a custom action when a widget item is clicked.

To navigate to a specific URL when the itemClick event fires, assign that URL or the anchor part (#) of that URL directly to this option as a string.

onItemContextMenu

A handler for the itemContextMenu event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

itemData:

Object

The data that is bound to the item.

itemElement:

jQuery

An HTML element of the item.

itemIndex:

Number

Specifies the index of the item.

jQueryEvent:

jQuery.Event

Specifies the jQuery event that caused action execution.

Default Value: null

Assign a function to perform a custom action when 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.

onItemHold

A handler for the itemHold event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

itemData:

Object

The data that is bound to the item being held.

itemElement:

jQuery

An HTML element of the item.

itemIndex:

Number

Specifies the index of the item being held.

Default Value: null

Assign a function to perform a custom action when the widget's collection item is being held for a specified time period (see the itemHoldTimeout option).

onItemRendered

A handler for the itemRendered event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data available for binding against the element. Available only in the Knockout and AngularJS approaches.

itemData:

Object

The data that is bound to the item to be rendered.

itemElement:

jQuery

An HTML element of the item.

itemIndex:

Number

Specifies the index of the rendered item.

Default Value: null

Assign a function to perform a custom action after a collection item is rendered.

onOptionChanged

A handler for the optionChanged event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget instance.

name:

String

Specifies the name of the option whose value is changed.

fullName:

String

Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.

value: any

Specifies a new value for the option.

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

rows

Specifies the collection of rows for the grid used to position layout elements.

Type:

Array

An item of an array passed to these options can include the following fields.

  • baseSize
    The base height of the row.

  • ratio
    The row height ratio.

  • screen
    The screen factor or factors by which the current row is used. If this field is not defined, the row is used by all screen factors.

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

Show Example:
AngularJS
Knockout
jQuery

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

Type:

Boolean

Default Value: false

If you need to switch the display of this DevExtreme component to right-to-left, enable a specifically designed configuration option - rtlEnabled. When this option is set to true, the text flows from right to left, and the layout the component's elements is reversed. To switch the entire application/site to a right-to-left representation, use the static DevExpress.rtlEnabled field.

screenByWidth

Specifies the function returning the screen factor depending on the screen width.

Type:

function

The function passed to this option should take on the screen width as a parameter and return a string containing the appropriate screen factor.

JavaScript
var responsiveBoxOptions: {
    screenByWidth: function(width) {
        if( width < 768 )
            return 'xs';
        if( width < 992 )
            return 'sm';
        if( width < 1200 )
            return 'md';
        return 'lg';
    }
}

singleColumnScreen

Specifies the screen factor with which all elements are located in a single column.

Type:

String

Default Value: 'xs' or the smallest screen factor when screenByWidth function specified

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: '100%'

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. For example, see the following code.

    JavaScript
    width: function () { 
        return baseWidth - 10 + "%";
    }