方法

---

立即下載DevExtreme

本節介紹用于操作Accordion UI組件的成員。

beginUpdate()

推遲可能對性能產生負面影響的呈現，直到調用endUpdate() 方法。

 在額外的渲染會對性能產生負面影響的情況下，beginUpdate()和endUpdate()方法可以減少渲染的次數。

collapseItem(index)

折疊具有特定索引的項。

1. Parameters：
2. index：
3. 項目的索引。

1. Return Value：Promise<void> (或)
2. 一個Promise，在元素折疊時解決，否則拒絕。當使用jQuery時，它是一個 或。

提示：當可折疊屬性設置為true時，此方法將應用。

defaultOptions(rule)

指定此組件的與設備相關的默認配置屬性。

1. Parameters：
2. rule：Object
3. 組件的默認設備屬性。
4. 目標結構：

名稱	類型	描述
device	|	設備參數。 當指定一個函數時，從參數中獲取有關當前設備的信息。如果屬性應應用于設備，則返回true。
options		選擇應用。

 defaultOptions是UI組件類支持的靜態方法。下面的代碼演示了如何為桌面上執行的應用程序中的Accordion UI組件的所有實例指定默認屬性。

DevExpress.ui.dxAccordion.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Accordion properties
}
});

dispose()

處置分配給Accordion實例的所有資源。

調用此方法后，移除與UI組件關聯的DOM元素：

$("#myAccordion").dxAccordion("dispose");
$("#myAccordion").remove();

 只有當UI組件是用jQuery或純JavaScript創建時才使用此方法，在Angular、Vue和React中使用條件渲染：

element()

獲取根UI組件元素。

1. Return Value：HTMLElement | jQuery
2. HTML元素或jQuery元素(當您使用jQuery時)。

endUpdate()

在調用beginUpdate()方法后刷新UI組件。

 在額外的渲染會對性能產生負面影響的情況下，beginUpdate()和endUpdate()方法可以減少渲染的次數。

expandItem(index)

用特定索引展開項。

1. Parameters：
2. index： Number
3. 項目的索引。

1. Return Value：Promise (jQuery或native)
2. 如果item被擴展則解決，否則拒絕Promise，當使用jQuery時，它是一個 native Promise或jQuery.Promise。

focus()

將焦點設置在UI組件上。

getDataSource()

獲取數據源實例。

1. Return Value： DataSource
2. 數據源實例。

 即使UI組件的DataSource屬性是一個簡單的數組，這個方法也會返回DataSource實例。

getInstance(element)

獲取使用其DOM節點找到的UI組件的實例。

1. Parameters：
2. element： |
3. UI組件的容器。

1. Return Value：
2. UI組件的實例。

 getInstance是UI組件類支持的靜態方法，下面的代碼演示了如何獲取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組件的其他方法。

1. Return Value：
2. 這個UI組件的實例。

off(eventName)

從單個事件分離所有事件處理程序。

1. Parameters：
2. eventName：
3. 事件的名稱。

1. Return Value：
2. 為其調用此方法的對象。

off(eventName, eventHandler)

從單個事件分離特定事件處理程序。

1. Parameters：
2. eventName：
3. 事件的名稱。

1. eventHandler：
2. 事件的處理程序。

1. Return Value：
2. 為其調用此方法的對象。

on(eventName, eventHandler)

訂閱一個事件。

1. Parameters：
2. eventName：
3. 事件的名稱。

1. eventHandler：
2. 事件的處理程序。

1. Return Value：
2. 為其調用此方法的對象。

使用此方法訂閱events部分中列出的事件之一。

on(events)

訂閱事件。

1. Parameters：
2. eventName：
3. 事件及其處理程序：{"eventName1": handler1， "eventName2": handler2，…}

1. Return Value：
2. 為其調用此方法的對象。

使用此方法可以通過一個方法調用訂閱多個事件。事件部分列出了可用的事件。

選項()

獲取所有UI組件屬性。

1. Return Value：
2. UI組件的屬性。

選項(optionName)

獲取單個屬性的值。

1. Parameters：
2. optionName：
3. 屬性的名稱或完整路徑。

1. Return Value：any
2. 這個屬性的值。

選項(optionName,optionValue)

更新單個屬性的值。

1. Parameters：
2. optionName：
3. 屬性的名稱或完整路徑。

1. optionValue：any
2. 屬性的新值。

選項(選項)

更新幾個屬性的值。

1. Parameters：
2. options： Object
3. 選項及其新值。

egisterKeyHandler(關鍵,處理程序)

注冊當用戶按下特定鍵時要執行的處理程序。

1. Parameters：
2. key：String
3. 一個密鑰。

1. handler： Function
2. 接受keydown事件作為參數，當使用jQuery時，它是一個EventObject或。

key參數接受以下值之一：

• "backspace"
  
• "tab"
  
• "enter"
  
• "escape"
  
• "pageUp"
  
• "pageDown"
  
• "end"
  
• "home"
  
• "leftArrow"
  
• "upArrow"
  
• "rightArrow"
  
• "downArrow"
  
• "del"
  
• "space"
  
• "F"
  
• "A"
  
• "asterisk"
  
• "minus"

鍵的自定義處理程序將取消此鍵的默認處理程序。

repaint()

在不重新加載數據的情況下重新繪制UI組件，調用它來更新UI組件的標記。

該方法重新繪制工具欄并重新初始化其所有項。

resetOption (optionName)

將屬性重置為默認值。

1. Parameters：
2. optionName：
3. 屬性的名稱。

updateDimensions ()

更新UI組件內容的維度。

1. Return Value： Promise (or)
2. 更新完成后解析的承諾，當使用jQuery時，它是一個native Promise或jQueryPromise。

在UI組件的大小(size)被更改后，使用這個方法使UI組件的內容與UI組件的大小相匹配。