方法
本節(jié)介紹用于操作Accordion UI組件的成員。
beginUpdate()
推遲可能對性能產(chǎn)生負(fù)面影響的呈現(xiàn),直到調(diào)用endUpdate() 方法。
在額外的渲染會對性能產(chǎn)生負(fù)面影響的情況下,beginUpdate()和endUpdate()方法可以減少渲染的次數(shù)。
collapseItem(index)
折疊具有特定索引的項。
- Parameters:
- index:Number
- 項目的索引。
- Return Value:Promise<void> (jQuery或native)
- 一個Promise,在元素折疊時解決,否則拒絕。當(dāng)使用jQuery時,它是一個 native Promise或jQuery.Promise。
提示:當(dāng)可折疊屬性設(shè)置為true時,此方法將應(yīng)用。
defaultOptions(rule)
指定此組件的與設(shè)備相關(guān)的默認(rèn)配置屬性。
- Parameters:
- rule:Object
- 組件的默認(rèn)設(shè)備屬性。
- 目標(biāo)結(jié)構(gòu):
名稱 | 類型 | 描述 |
---|---|---|
device |
設(shè)備參數(shù)。 當(dāng)指定一個函數(shù)時,從參數(shù)中獲取有關(guān)當(dāng)前設(shè)備的信息。如果屬性應(yīng)應(yīng)用于設(shè)備,則返回true。 |
|
options | Object | 選擇應(yīng)用。 |
defaultOptions是UI組件類支持的靜態(tài)方法。下面的代碼演示了如何為桌面上執(zhí)行的應(yīng)用程序中的Accordion UI組件的所有實例指定默認(rèn)屬性。
DevExpress.ui.dxAccordion.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Accordion properties } });
dispose()
處置分配給Accordion實例的所有資源。
調(diào)用此方法后,移除與UI組件關(guān)聯(lián)的DOM元素:
$("#myAccordion").dxAccordion("dispose"); $("#myAccordion").remove();
只有當(dāng)UI組件是用jQuery或純JavaScript創(chuàng)建時才使用此方法,在Angular、Vue和React中使用條件渲染:
element()
獲取根UI組件元素。
- Return Value:HTMLElement | jQuery
- HTML元素或jQuery元素(當(dāng)您使用jQuery時)。
endUpdate()
在調(diào)用beginUpdate()方法后刷新UI組件。
在額外的渲染會對性能產(chǎn)生負(fù)面影響的情況下,beginUpdate()和endUpdate()方法可以減少渲染的次數(shù)。
expandItem(index)
用特定索引展開項。
- Parameters:
- index: Number
- 項目的索引。
- Return Value:Promise (jQuery或native)
- 如果item被擴(kuò)展則解決,否則拒絕Promise,當(dāng)使用jQuery時,它是一個 native Promise或jQuery.Promise。
focus()
將焦點(diǎn)設(shè)置在UI組件上。
getDataSource()
獲取數(shù)據(jù)源實例。
- Return Value: DataSource
- 數(shù)據(jù)源實例。
即使UI組件的DataSource屬性是一個簡單的數(shù)組,這個方法也會返回DataSource實例。
getInstance(element)
獲取使用其DOM節(jié)點(diǎn)找到的UI組件的實例。
- Return Value:Object
- UI組件的實例。
getInstance是UI組件類支持的靜態(tài)方法,下面的代碼演示了如何獲取ID為myAccordion的元素中的Accordion實例:
// Modular approach import Accordion from "devextreme/ui/accordion"; ... let element = document.getElementById("myAccordion"); let instance = Accordion.getInstance(element) as Accordion; // Non-modular approach let element = document.getElementById("myAccordion"); let instance = DevExpress.ui.dxAccordion.getInstance(element);
實例()
獲取UI組件的實例,使用它來訪問UI組件的其他方法。
- Return Value:Accordion
- 這個UI組件的實例。
off(eventName)
從單個事件分離所有事件處理程序。
- Parameters:
- eventName:String
- 事件的名稱。
- Return Value:Accordion
- 為其調(diào)用此方法的對象。
off(eventName, eventHandler)
從單個事件分離特定事件處理程序。
- Parameters:
- eventName: String
- 事件的名稱。
- eventHandler: Function
- 事件的處理程序。
- Return Value:Accordion
- 為其調(diào)用此方法的對象。
on(eventName, eventHandler)
訂閱一個事件。
- Parameters:
- eventName: String
- 事件的名稱。
- eventHandler: Function
- 事件的處理程序。
- Return Value:Accordion
- 為其調(diào)用此方法的對象。
使用此方法訂閱events部分中列出的事件之一。
on(events)
訂閱事件。
- Parameters:
- eventName: Object
- 事件及其處理程序:{"eventName1": handler1, "eventName2": handler2,…}
- Return Value:Accordion
- 為其調(diào)用此方法的對象。
使用此方法可以通過一個方法調(diào)用訂閱多個事件。事件部分列出了可用的事件。
選項()
獲取所有UI組件屬性。
- Return Value: Object
- UI組件的屬性。
選項(optionName)
獲取單個屬性的值。
- Parameters:
- optionName: String
- 屬性的名稱或完整路徑。
- Return Value:any
- 這個屬性的值。
選項(optionName,optionValue)
更新單個屬性的值。
- Parameters:
- optionName: String
- 屬性的名稱或完整路徑。
- optionValue:any
- 屬性的新值。
選項(選項)
更新幾個屬性的值。
- Parameters:
- options: Object
- 選項及其新值。
egisterKeyHandler(關(guān)鍵,處理程序)
注冊當(dāng)用戶按下特定鍵時要執(zhí)行的處理程序。
- Parameters:
- key:String
- 一個密鑰。
- handler: Function
- 接受keydown事件作為參數(shù),當(dāng)使用jQuery時,它是一個EventObject或jQuery.Event 。
key參數(shù)接受以下值之一:
-
"backspace"
-
"tab"
-
"enter"
-
"escape"
-
"pageUp"
-
"pageDown"
-
"end"
-
"home"
-
"leftArrow"
-
"upArrow"
-
"rightArrow"
-
"downArrow"
-
"del"
-
"space"
-
"F"
-
"A"
-
"asterisk"
- "minus"
鍵的自定義處理程序?qū)⑷∠随I的默認(rèn)處理程序。
repaint()
在不重新加載數(shù)據(jù)的情況下重新繪制UI組件,調(diào)用它來更新UI組件的標(biāo)記。
該方法重新繪制工具欄并重新初始化其所有項。
resetOption (optionName)
將屬性重置為默認(rèn)值。
- Parameters:
- optionName: String
- 屬性的名稱。
updateDimensions ()
更新UI組件內(nèi)容的維度。
- Return Value: Promise (jQuery or native)
- 更新完成后解析的承諾,當(dāng)使用jQuery時,它是一個native Promise或jQueryPromise。
在UI組件的大小(size)被更改后,使用這個方法使UI組件的內(nèi)容與UI組件的大小相匹配。