This article describes the API migration process of DropDownList component from Essential JS 1 to Essential JS 2.
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: dataSource var sample = new ej.DropDownList($('#dropdown1'),{dataSource: List}); |
Property: dataSource let dropDownListObject = new DropDownList({dataSource: sportsData,});dropDownListObject.appendTo('#ddlelement'); |
Fields for mapping | Property: fields var sample = new ej.DropDownList($('#dropdown1'),{fields: {text: "text",value: "country",},}); |
Property: fields let dropDownListObject = new DropDownList({fields: { text: 'Game', value: 'Id' },});dropDownListObject.appendTo('#ddlelement'); |
Query | Property: query var sample = new ej.DropDownList($('#dropdown1'),{query: ej.Query().requiresCount();}); |
Property: querylet dropDownListObject = new DropDownList({query: new Query().from('Customers').select(['ContactName', 'CustomerID']).take(6),});dropDownListObject.appendTo('#ddlelement'); |
Begin event | Event :actionBegin var sample = new ej.DropDownList($('#dropdown1'),{actionBegin : function (args) {/*Do your changes */}}); |
Event : actionBegin let dropDownListObject = new DropDownList({actionBegin: "actionBegin"});dropDownListObject.appendTo('#ddlelement'); |
Complete event | Event: actionComplete var sample = new ej.DropDownList($('#dropdown1'),{actionComplete : function (args) {/*Do your changes */}}); |
Event: actionComplete let dropDownListObject = new DropDownList({actionComplete: "actionComplete"});dropDownListObject.appendTo('#ddlelement'); |
Failure event | Event: actionFailure var sample = new ej.DropDownList($('#dropdown1'),{actionFailure : function (args) {/*Do your changes */}}); |
Event: actionFailure let dropDownListObject = new DropDownList({actionFailure: "actionFailure"});dropDownListObject.appendTo('#ddlelement'); |
Success event | Event: actionSuccess var sample = new ej.DropDownList($('#dropdown1'),{actionSuccess : function (args) {/*Do your changes */}}); |
Not Applicable |
Data binding event | Event: dataBound var sample = new ej.DropDownList($('#dropdown1'),{dataBound : function (args) {/*Do your changes */}}); |
Event: dataBind let dropDownListObject = new DropDownList({dataBind: "dataBind"});dropDownListObject.appendTo('#ddlelement'); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: enableFilterSearch var sample = new ej.DropDownList($('#dropdown1'),{enableFilterSearch : true,}); |
Property: allowFiltering let dropDownListObject = new DropDownList({allowFiltering: true});dropDownListObject.appendTo('#ddlelement'); |
Server filtering | Property: enableServerFiltering var sample = new ej.DropDownList($('#dropdown1'),{enableServerFiltering : true,}); |
Property: allowFiltering let dropDownListObject = new DropDownList({allowFiltering: true});dropDownListObject.appendTo('#ddlelement'); |
Filter type | Property: filterType var sample = new ej.DropDownList($('#dropdown1'),{fiterType : ej.FilterType.Contains,}); |
https://ej2.syncfusion.com/javascript/demos/#/material/drop-down-list/filtering.html |
No Records Template | Not Applicable | Property: noRecordsTemplate let dropDownListObject = new DropDownList({noRecordsTemplate: "<span class='norecord'> NO DATA AVAILABLE</span>"});dropDownListObject.appendTo('#ddlelement'); |
Filter Bar watermark text | Not Applicable | Property: filterBarPlaceholder let dropDownListObject = new DropDownList({filterBarPlaceholder: "search"});dropDownListObject.appendTo('#ddlelement'); |
Ignore casing and diacritics | Not Applicable | Property: ignoreAccentlet dropDownListObject = new DropDownList({ignoreAccent: true});dropDownListObject.appendTo('#ddlelement'); |
Incremental search | Property: enableIncrementalSearchvar sample = new ej.DropDownList($('#dropdown1'),{enableIncrementalSearch : true,}); |
By default it is true |
Case sensitivity | Property: caseSensitiveSearchvar sample = new ej.DropDownList($('#dropdown1'),{caseSensitiveSearch : true,}); |
https://ej2.syncfusion.com/javascript/demos/#/material/drop-down-list/filtering.html |
Search event | Event: search var sample = new ej.DropDownList($('#dropdown1'),{search : function (args) {/*Do your changes */}}); |
Event: filtering let dropDownListObject = new DropDownList({filtering: "search"});dropDownListObject.appendTo('#ddlelement'); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: template var sample = new ej.DropDownList($('#dropdown1'),{template: '<div class="flag ${flag}"> </div>' + '<div class="txt"> ${text} </div>', width: "200px"}); |
Property: itemTemplatelet dropDownListObject = new DropDownList({itemTemplate: "<span><span class='name'>${FirstName}</span><span class ='city'>${City}</span></span>"});dropDownListObject.appendTo('#ddlelement'); |
Group Template | Not Applicable | Property: groupTemplate let dropDownListObject = new DropDownList({ groupTemplate: "<strong>${City}</strong>"});dropDownListObject.appendTo('#ddlelement'); |
ValueTemplate | Not Applicable | Property: valueTemplate let dropDownListObject = new DropDownList({valueTemplate: "<span>${FirstName} - ${City}</span>"});dropDownListObject.appendTo('#ddlelement'); |
Header Template | Property: headerTemplate var sample = new ej.DropDownList($('#dropdown1'),{ headerTemplate: "<div class='header'><span class='flag-head'>Flag</span> <span class='con-head'>Countries</span> </div>"}); |
Property: headerTemplate let dropDownListObject = new DropDownList({headerTemplate: "<span class='head'><span class='name'>Name</span><span class='city'>City</span></span>",});dropDownListObject.appendTo('#ddlelement'); |
FooterTemplate | Not applicable | Property: footerTemplate let dropDownListObject = new DropDownList({footerTemplate: "<span class='foot'> Total list items: " + sportsData.length + "</span>"});dropDownListObject.appendTo('#ddlelement'); |
No records Template | Not applicable | Property: noRecordsTemplate let dropDownListObject = new DropDownList({noRecordsTemplate: "<span class='norecord'> NO DATA AVAILABLE</span>"});dropDownListObject.appendTo('#ddlelement'); |
Action failure Template | Not applicable | Property: actionFailureTemplate let dropDownListObject = new DropDownList({actionFailureTemplate: "<span class='action-failure'> Data fetch get fails</span>"});dropDownListObject.appendTo('#ddlelement'); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: allowVirtualScrolling var sample = new ej.DropDownList($('#dropdown1'),{allowVirtualScrolling : true,}); |
Not applicable |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: cssClass var sample = new ej.DropDownList($('#dropdown1'),{cssClass : "customClass",}); |
Property: cssClass let dropDownListObject = new DropDownList({cssClass: "customClass"});dropDownListObject.appendTo('#ddlelement'); |
showRoundedCorner | Property: showRoundedCorner var sample = new ej.DropDownList($('#dropdown1'),{showRoundedCorner : true,}); |
Property: cssClass let dropDownListObject = new DropDownList({cssClass: "customClass"});dropDownListObject.appendTo('#ddlelement'); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: enableSorting var sample = new ej.DropDownList($('#dropdown1'),{enableSorting : true,}); |
Acheivable through sortOrder property |
Order of sorting | Property: sortOrder var sample = new ej.DropDownList($('#dropdown1'),{sortOrder : ej.sortOrder.Descending,}); |
Property: sortOrder let dropDownListObject = new DropDownList({sortOrder: "Ascending"});dropDownListObject.appendTo('#ddlelement'); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Popup height | Property: popupHeight var sample = new ej.DropDownList($('#dropdown1'),{popupHeight : "500px",}); |
Property: popupHeight let dropDownListObject = new DropDownList({popupHeight: "300px"});dropDownListObject.appendTo('#ddlelement'); |
Popup width | Property: popupWidth var sample = new ej.DropDownList($('#dropdown1'),{popupWidth : "500px",}); |
Property: popupWidth let dropDownListObject = new DropDownList({popupWidth: "400px"});dropDownListObject.appendTo('#ddlelement'); |
Popup show on load | Property: showPopupOnLoad var sample = new ej.DropDownList($('#dropdown1'),{showPopupOnLoad : true,}); |
By default, the data load on demand. |
enableAnimation | Property: enableAnimation var sample = new ej.DropDownList($('#dropdown1'),{enableAnimation : true,}); |
Not applicable |
Popup resizing | Property: enablePopupResize var sample = new ej.DropDownList($('#dropdown1'),{enablePopupResize : true,}) |
Not applicable |
Maximum Popup height | Property: maxPopupHeight var sample = new ej.DropDownList($('#dropdown1'),{maxPopupHeight : "500px",}); |
Not applicable |
Minimum Popup height | Property: minPopupHeightvar sample = new ej.DropDownList($('#dropdown1'),{minPopupHeight : "500px",}); }); |
Not applicable |
Maximum Popup width | Property: maxPopupWidth var sample = new ej.DropDownList($('#dropdown1'),{maxPopupWidth : "500px",}); |
Not applicable |
Minimum Popup width | Property: minPopupWidth var sample = new ej.DropDownList($('#dropdown1'),{minPopupWidth : "500px",}); |
Not applicable |
Loading data | Property: loadOnDemand var sample = new ej.DropDownList($('#dropdown1'),{loadOnDemand : true,}); |
By default, it is true |
Popup showing manually | Method: showPopup var sample = new ej.DropDownList($('#dropdown1'),{'showPopup'}) |
Method: showPopup let dropDownListObject = new DropDownList();dropDownListObject.appendTo('#ddlelement') dropDownListObject.showPopup(); |
Popup hiding manually | Method: hidePopup var sample = new ej.DropDownList($('#dropdown1'),{'hidePopup'}) |
Method: hidePopuplet dropDownListObject = new DropDownList();dropDownListObject.appendTo('#ddlelement') dropDownListObject.hidePopup(); |
Before Popup hide event | Event: beforePopupHide var sample = new ej.DropDownList($('#dropdown1'),{beforePopupHide : function (args) {/*Do your changes */}}); |
Not applicable |
Before Popup shown event | Event: beforePopupShownvar sample = new ej.DropDownList($('#dropdown1'),{beforePopupShown : function (args) {/*Do your changes */}}); |
Event: beforeOpen var sample = new ej.DropDownList($('#dropdown1'),{beforeOpen: "open"});dropDownListObject.appendTo('#ddlelement'); |
Popup hide event | Event: popupHidevar sample = new ej.DropDownList($('#dropdown1'),{popupHide : function (args) {/*Do your changes */}}); |
Event: close let dropDownListObject = new DropDownList({close: "close"});dropDownListObject.appendTo('#ddlelement'); |
Popup resize event | Event: popupResizevar sample = new ej.DropDownList($('#dropdown1'),{popupResize : function (args) {/*Do your changes */}}); |
Not applicable |
Popup resize start event | Event: popupResizeStartvar sample = new ej.DropDownList($('#dropdown1'),{popupResizeStart : function (args) {/*Do your changes */}}); |
Not applicable |
Popup resize stop event | Event: popupResizeStopvar sample = new ej.DropDownList($('#dropdown1'),{popupResizeStop : function (args) {/*Do your changes */}}); |
Not applicable |
Popup shown event | Event: popupShownvar sample = new ej.DropDownList($('#dropdown1'),{popupShown : function (args) {/*Do your changes */}}); |
Event: openlet dropDownListObject = new DropDownList({open: "open"});dropDownListObject.appendTo('#ddlelement'); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Watermark text | Property: watermarkText var sample = new ej.DropDownList($('#dropdown1'),{watermarkText : "Select"}); |
Property: placeholder let dropDownListObject = new DropDownList({placeholder: "select"});dropDownListObject.appendTo('#ddlelement'); |
Floating of watermark text | Not applicable | Property: floatLabelType let dropDownListObject = new DropDownList({floatLabelType: "Auto"});dropDownListObject.appendTo('#ddlelement'); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Default | Property: fields.groupBy var sample = new ej.DropDownList($('#dropdown1'),{fields: {groupBy: "text"},}); |
Property: fields.groupBylet dropDownListObject = new DropDownList({fields: { groupBy: 'ContactName',}});dropDownListObject.appendTo('#ddlelement'); |
Group Template | Not applicable | Property: groupTemplatelet dropDownListObject = new DropDownList({ groupTemplate: "<strong>${City}</strong>"});dropDownListObject.appendTo('#ddlelement'); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Globalization | Property: localevar sample = new ej.DropDownList($('#dropdown1'), {locale: "fr-FE"}); |
Property: localelet dropDownListObject = new DropDownList({ locale: "fr-FE"});dropDownListObject.appendTo('#ddlelement'); |
Rtl support | Property: enableRTLvar sample = new ej.DropDownList($('#dropdown1'),{enableRTL: true,}); |
Property: enableRtllet dropDownListObject = new DropDownList({ enableRtl: true});dropDownListObject.appendTo('#ddlelement'); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Enable/disable | Property: enabledvar sample = new ej.DropDownList($('#dropdown1'),{enabled: true,}); |
Property: enabled let dropDownListObject = new DropDownList({ enabled: true});dropDownListObject.appendTo('#ddlelement'); |
Read only | Property: readOnly var sample = new ej.DropDownList($('#dropdown1'),{readOnly: true,}); |
Property: readOnly let dropDownListObject = new DropDownList({ readOnly: true});dropDownListObject.appendTo('#ddlelement'); |
Persistence of data | Property: enablePersistencevar sample = new ej.DropDownList($('#dropdown1'),{enablePersistence: true,}); |
Property: enablePersistencelet dropDownListObject = new DropDownList({ enablePersistence: true});dropDownListObject.appendTo('#ddlelement'); |
Disable | Method: disablevar sample = new ej.DropDownList($('#dropdown1'),{'disable'}) |
Property: enabledlet dropDownListObject = new DropDownList({ enabled:false});dropDownListObject.appendTo('#ddlelement'); |
Enable | Method: enablevar sample = new ej.DropDownList($('#dropdown1'),{'enable'}) |
Property: enabledlet dropDownListObject = new DropDownList({ enabled: true});dropDownListObject.appendTo('#ddlelement'); |
Height | Property: height var sample = new ej.DropDownList($('#dropdown1'),{height: "500px",}); |
Property: height let dropDownListObject = new DropDownList({ height: "300px"});dropDownListObject.appendTo('#ddlelement'); |
Width | Property: width var sample = new ej.DropDownList($('#dropdown1'),{width: "500px",}); |
Property: width let dropDownListObject = new DropDownList({ width: "300px"});dropDownListObject.appendTo('#ddlelement'); |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Selecting particular index | Property: selectedIndexvar sample = new ej.DropDownList($('#dropdown1'),{selectedIndex: 3,}); |
Property: indexlet dropDownListObject = new DropDownList({ index: 3});dropDownListObject.appendTo('#ddlelement'); |
Selecting particular value | Property: valuevar sample = new ej.DropDownList($('#dropdown1'),{value: "data",}); |
Property: valuelet dropDownListObject = new DropDownList({ value: "data"});dropDownListObject.appendTo('#ddlelement'); |
Selecting particular text | Property: text var sample = new ej.DropDownList($('#dropdown1'),{text: "data",}); |
Property: textlet dropDownListObject = new DropDownList({ text: "data"});dropDownListObject.appendTo('#ddlelement'); |
Target id | Property: targetId var sample = new ej.DropDownList($('#dropdown1'),{targetId: "Id",}); |
Not applicable |
Selecting item using text | Method: selectItemByText var sample = new ej.DropDownList($('#dropdown1'),{'selectItemByText','car'}) |
Not applicable |
Unselect item using text | Method: unselectItemByTextvar sample = new ej.DropDownList($('#dropdown1'),{'unselectItemByText','car'}) |
Not applicable |
Selecting item using value | Method: selectItemByValuevar sample = new ej.DropDownList($('#dropdown1'),{'selectItemByValue','car'}) |
Not applicable |
Getting data by using value | Method: getItemDataByValuevar sample = new ej.DropDownList($('#dropdown1'),{'unselectItemByValue','car'}) |
Method: getDataByValuelet dropDownListObject = new DropDownList();dropDownListObject.appendTo('#ddlelement') dropDownListObject.getDataByValue(); |
Get selected value | Method: getSelectedItemvar sample = new ej.DropDownList($('#dropdown1'),{'getSelectedItem'}) |
Not applicable |
Get selected text | Method: getSelectedTextvar sample = new ej.DropDownList($('#dropdown1'),{'getSelectedText'}) |
Property: textlet dropDownListObject = new DropDownList({text="data"});dropDownListObject.appendTo('#ddlelement') |
Select event | Event: selectvar sample = new ej.DropDownList($('#dropdown1'),{select : function (args) {/*Do your changes */}}); |
Event: selectlet dropDownListObject = new DropDownList({select: "onSelect"});dropDownListObject.appendTo('#ddlelement') |
Addition of Html attributes | Property: htmlAttributesvar sample = new ej.DropDownList($('#dropdown1'),{htmlAttributes: { disabled: "disabled"},}); |
Property: htmlAttributeslet dropDownListObject = new DropDownList({htmlAttributes:{ disabled: "disabled"}});dropDownListObject.appendTo('#ddlelement') |
Behavior | API in Essential JS 1 | API in Essential JS 2 |
---|---|---|
Adding new item | Method : addItemvar sample = new ej.DropDownList($('#dropdown1'),{"addItem", {text:"India"}}); |
Method: addItemlet dropDownListObject = new DropDownList();dropDownListObject.appendTo('#ddlelement') dropDownListObject.addItem("data"); |
Clearing the text | Method : clearTextvar sample = new ej.DropDownList($('#dropdown1'),{'clearText'}) |
Property: valuelet dropDownListObject = new DropDownList({value:""});dropDownListObject.appendTo('#ddlelement') |
Destroy the component | Method : destroyvar sample = new ej.DropDownList($('#dropdown1'),{'destroy'}) |
Method: destroylet dropDownListObject = new DropDownList();dropDownListObject.appendTo('#ddlelement') dropDownListObject.destroy(); |
Getting the data | Method : getListDatavar sample = new ej.DropDownList($('#dropdown1'),{'getListData'}) |
Method : getItemslet dropDownListObject = new DropDownList();dropDownListObject.appendTo('#ddlelement') dropDownListObject.getItems(); |
Create event | Event: createvar sample = new ej.DropDownList($('#dropdown1'),{create : function (args) {/*Do your changes */}}); |
Event: createdlet dropDownListObject = new DropDownList({created:"create"});dropDownListObject.appendTo('#ddlelement') |
Destroy event | Event: destroyvar sample = new ej.DropDownList($('#dropdown1'),{destroy : function (args) {/*Do your changes */}}); |
Event: destroyedlet dropDownListObject = new DropDownList({destroyed:"create"});dropDownListObject.appendTo('#ddlelement') |
Cascade event | Event: cascadevar sample = new ej.DropDownList($('#dropdown1'),{cascade : function (args) {/*Do your changes */}}); |
https://ej2.syncfusion.com/javascript/demos/#/material/drop-down-list/cascading.html |
Change event | Event: changevar sample = new ej.DropDownList($('#dropdown1'),{change : function (args) {/*Do your changes */}}); |
Event: changelet dropDownListObject = new DropDownList({change:"create"});dropDownListObject.appendTo('#ddlelement') |
Focus out event | Event: focusOutvar sample = new ej.DropDownList($('#dropdown1'),{focusOut : function (args) {/*Do your changes */}}); |
Event: blurlet dropDownListObject = new DropDownList({blur:"create"});dropDownListObject.appendTo('#ddlelement') |
Focus in event | Event: focusInvar sample = new ej.DropDownList($('#dropdown1'),{focusIn : function (args) {/*Do your changes */}}); |
Event: focuslet dropDownListObject = new DropDownList({focus:"create"});dropDownListObject.appendTo('#ddlelement') |