ListBoxItem Class

A List Box dashboard item that allows end users to filter other dashboard items.

Declaration

export class ListBoxItem extends FilterElementItemBase

Remarks

The List Box dashboard allows end users to filter other dashboard items by selecting a value(s) from the list.

wdd-list-box-checked-type

Refer to Filter Elements Overview to learn more about filter elements.

Example

The following example shows how to create the List Box dashboard item, bind it to data and add to the existing dashboard.

Create data items (dimensions) and use the DataItem.dataMember property to bind them to the existing data source’s columns. Then use the created dimensions in the dashboard item to bind it to data.

After you add the created dashboard item to the Dashboard.items collection, call the Dashboard.rebuildLayout method to rebuild the dashboard layout and display changes.

// Use the line below for a modular approach:
// import * as Model from 'devexpress-dashboard/model'
// Use the line below for an approach with global namespaces:
// var Model = DevExpress.Dashboard.Model;

// ...
public creatListBox() { 
    // Create data items for the ListBox.
    var listBoxCountry = new Model.Dimension();
    listBoxCountry.dataMember("Country");
    var listBoxFullName = new Model.Dimension();
    listBoxFullName.dataMember("FullName");

    // Create the ListBox dashboard item and bind it to data.
    var listBoxItem = new Model.ListBoxItem();
    listBoxItem.name('listBox');
    listBoxItem.dataSource(sqlDataSource.componentName());
    listBoxItem.dataMember(sqlDataSource.queries()[0].name());

    listBoxItem.filterDimensions.push(listBoxCountry);
    listBoxItem.filterDimensions.push(listBoxFullName);

    listBoxItem.listBoxType('Radio');

    control.dashboard().items.push(listBoxItem);
    // ...
    control.dashboard().rebuildLayout();
}

Inherited Members

DevExpress.Dashboard.Model.DataDashboardItem.componentName
DevExpress.Dashboard.Model.DataDashboardItem.customProperties
DevExpress.Dashboard.Model.DataDashboardItem.name
DevExpress.Dashboard.Model.DataDashboardItem.parentContainer
DevExpress.Dashboard.Model.DataDashboardItem.showCaption
DevExpress.Dashboard.Model.DataDashboardItem.getInfo
DevExpress.Dashboard.Model.DataDashboardItem.getUniqueNamePrefix
See Also

constructor

Initializes a new instance of the ListBoxItem class.

Declaration

constructor(
    dashboardItemJSON?: any,
    serializer?: ModelSerializer
)

Parameters

Name Type Description
dashboardItemJSON any

A JSON object used for dashboard deserialization. Do not pass this parameter directly.

serializer ModelSerializer

An object used for dashboard deserialization. Do not pass this parameter directly.

Properties

listBoxType Property

Specifies the type of the List Box dashboard item.

Declaration

listBoxType: ko.Observable<ListBoxDashboardItemType>

Property Value

Type Description
Observable<ListBoxDashboardItemType>

A ListBoxDashboardItemType enumeration value that specifies the type of the List Box dashboard item.

showAllValue Property

Declaration

showAllValue: ko.Observable<boolean>

Property Value

Type
Observable<boolean>