Combobox API

Methods
clear clears the value set in the Combo Box
destructor removes a ComboBox instance and releases occupied resources
disable disables ComboBox on a page
enable enables a disabled ComboBox
focus sets focus in the input without opening a popup with options
getValue gets id(s) of items from data collection selected in ComboBox
isDisabled checks whether a combobox is disabled
paint repaints a Combo Box
setValue selects option(s) in ComboBox

Data Collection

add adds a new item to the component
copy creates a copy of an item at the defined position
exists checks whether the specified item exists in the component
filter filters items in the component by the specified key
find finds an item that corresponds to the specified parameters
findAll finds all the items that correspond to the specified parameters
getId returns the id of the item by its index
getIndex returns the index of the item by its id
getItem returns the object of an item by its id
load loads data from an external file
map iterates through all items of the component
move moves an item to the defined position
parse loads data from a local data source
remove deletes the specified item from the component
removeAll deletes all the items from the component
serialize serializes data of the component into an array of JSON objects
sort sorts data items in a component
update updates properties of the item
Events
afterClose fires after closing a list with options
beforeClose fires before closing a list with options
change fires when a new option is selected
close fires when a list with options is closed
input fires on typing text in an input of Combobox
open fires when a list with options is opened

Data Collection

afterAdd fires after adding a new item into a data collection
afterRemove fires after removing a new item from a data collection
beforeAdd fires before adding a new item into a data collection
beforeRemove fires before removing an item from a data collection
change fires when a data collection is modified
load fires when items are loaded in a data collection
loadError fires when loading of data fails
removeAll fires when all items are removed from a data collection
Properties
cellHeight sets the height of a cell in the list of options
css adds style classes to ComboBox
data specifies an array of data objects to set into the combobox
disabled makes Combo Box disabled
filter sets a custom function for filtering Combo Box options
help adds an icon with a question mark next to the Combo input
helpMessage adds an icon with a question mark next to the Combo input
hiddenLabel adds a hidden label for a Combo box input that will be used while sending a form to the server
itemHeight sets the height of an item in the list of options
itemsCount shows the total number of selected options
label adds a label for ComboBox
labelInline defines whether a label will be placed in one line with ComboBox
labelPosition defines the position of a label of a combobox
labelWidth sets the width of a label
listHeight sets the height of the list of options
multiselection enables selection of multiple options in ComboBox
placeholder sets a placeholder in the input of Combo
readonly makes Combo Box readonly
selectAllButton defines whether the Select All button should be shown
showItemsCount shows the total number of selected options
template sets a template of displaying options in the popup list
virtual enables dynamic loading of data on scrolling the list of options
Back to top