方法
本节介绍用于操作Accordion UI组件的成员。
beginUpdate()
推迟可能对性能产生负面影响的呈现,直到调用endUpdate() 方法。
在额外的渲染会对性能产生负面影响的情况下,beginUpdate()和endUpdate()方法可以减少渲染的次数。
collapseItem(index)
折叠具有特定索引的项。
- Parameters:
- index:
- 项目的索引。
- Return Value:Promise<void> (或)
- 一个Promise,在元素折叠时解决,否则拒绝。当使用jQuery时,它是一个 或。
提示:当可折叠属性设置为true时,此方法将应用。
defaultOptions(rule)
指定此组件的与设备相关的默认配置属性。
- Parameters:
- rule:Object
- 组件的默认设备属性。
- 目标结构:
名称 | 类型 | 描述 |
---|---|---|
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组件元素。
- Return Value:HTMLElement | jQuery
- HTML元素或jQuery元素(当您使用jQuery时)。
endUpdate()
在调用beginUpdate()方法后刷新UI组件。
在额外的渲染会对性能产生负面影响的情况下,beginUpdate()和endUpdate()方法可以减少渲染的次数。
expandItem(index)
用特定索引展开项。
- Parameters:
- index: Number
- 项目的索引。
- Return Value:Promise (jQuery或native)
- 如果item被扩展则解决,否则拒绝Promise,当使用jQuery时,它是一个 native Promise或jQuery.Promise。
focus()
将焦点设置在UI组件上。
getDataSource()
获取数据源实例。
- Return Value: DataSource
- 数据源实例。
即使UI组件的DataSource属性是一个简单的数组,这个方法也会返回DataSource实例。
getInstance(element)
获取使用其DOM节点找到的UI组件的实例。
- Parameters:
- element: |
- UI组件的容器。
- Return Value:
- 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组件的其他方法。
- Return Value:
- 这个UI组件的实例。
off(eventName)
从单个事件分离所有事件处理程序。
- Parameters:
- eventName:
- 事件的名称。
- Return Value:
- 为其调用此方法的对象。
off(eventName, eventHandler)
从单个事件分离特定事件处理程序。
- Parameters:
- eventName:
- 事件的名称。
- eventHandler:
- 事件的处理程序。
- Return Value:
- 为其调用此方法的对象。
on(eventName, eventHandler)
订阅一个事件。
- Parameters:
- eventName:
- 事件的名称。
- eventHandler:
- 事件的处理程序。
- Return Value:
- 为其调用此方法的对象。
使用此方法订阅events部分中列出的事件之一。
on(events)
订阅事件。
- Parameters:
- eventName:
- 事件及其处理程序:{"eventName1": handler1, "eventName2": handler2,…}
- Return Value:
- 为其调用此方法的对象。
使用此方法可以通过一个方法调用订阅多个事件。事件部分列出了可用的事件。
选项()
获取所有UI组件属性。
- Return Value:
- UI组件的属性。
选项(optionName)
获取单个属性的值。
- Parameters:
- optionName:
- 属性的名称或完整路径。
- Return Value:any
- 这个属性的值。
选项(optionName,optionValue)
更新单个属性的值。
- Parameters:
- optionName:
- 属性的名称或完整路径。
- optionValue:any
- 属性的新值。
选项(选项)
更新几个属性的值。
- Parameters:
- options: Object
- 选项及其新值。
egisterKeyHandler(关键,处理程序)
注册当用户按下特定键时要执行的处理程序。
- Parameters:
- key:String
- 一个密钥。
- handler: Function
- 接受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)
将属性重置为默认值。
- Parameters:
- optionName:
- 属性的名称。
updateDimensions ()
更新UI组件内容的维度。
- Return Value: Promise (or)
- 更新完成后解析的承诺,当使用jQuery时,它是一个native Promise或jQueryPromise。
在UI组件的大小(size)被更改后,使用这个方法使UI组件的内容与UI组件的大小相匹配。