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 Layer provided by the PhoneJS library.

To display widget items, a default template can be used. This template is based on the data source fields that are listed below. Alternatively, you can implement a custom item template. For details, refer to the Customize Widget Item Appearance topic.

Show Example:
jQuery

disabled

Specifies whether a widget item must be displayed disabled.

Type: Boolean
Default Value: false

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that items are displayed disabled or enabled according to the specified value.

heightRatio

Specifies a multiplier for the baseItemHeight option value (for the purpose of obtaining the actual item height).

Type: Number
Default Value: 1

Whether you use a default or a custom template for widget items, their height will be determined according to the value specified for the heightRatio field in the item data source object.

html

Specifies html code inserted into the widget item element.

Type: String

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that the required markup is used to display the widget items.

template

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

Type: String|function|DOM Node|jQuery
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 representing the name of the required template
  • Assign a jQuery object representing the template's container
  • Assign a DOM Node representing the template's container
  • Assign a function that returns the jQuery object or a DOM Node representing the template's container

To learn more about item templates, refer to the Customize Widget Item Appearance topic.

text

Specifies text displayed for the widget item.

Type: String

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that the required text is displayed for the widget items.

visible

Specifies whether a widget item must be displayed.

Type: Boolean
Default Value: true

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that items are visible or not according to the specified value.

widthRatio

Specifies a multiplier for the baseItemWidth option value (for the purpose of obtaining the actual item width).

Type: Number
Default Value: 1

Whether you use a default or a custom template for widget items, their width will be determined according to the value specified for the widthRatio field in the item data source object.