文档帮助

术语、图标和标签

许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 别名(如果类扩展了 Ext.Component,则为 xtype)。别名/xtype 列在适用类的类名旁边,以供快速参考。

访问级别

框架类或其成员可以指定为 privateprotected。否则,类/成员是 publicPublicprotectedprivate 是访问描述符,用于传达应如何以及何时使用类或类成员。

成员类型

成员语法

下面是一个示例类成员,我们可以对其进行剖析,以显示类成员的语法(在本例中,从 Ext.button.Button 类查看的 lookupComponent 方法)。

lookupComponent ( item ) : Ext.Component
受保护的

当原始配置对象在初始化 items 配置期间,或者当新项目被 added) 或 {@link #insert 插入 到此容器时调用。

此方法将传递的对象转换为实例化的子组件。

当需要对子创建应用特殊处理时,可以在子类中覆盖此方法。

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

让我们看一下成员行的每个部分

成员标志

API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。

类图标

- 表示框架类

- Singleton 框架类。*有关更多信息,请参阅 singleton 标志

- 组件类型框架类(Ext JS 框架中扩展 Ext.Component 的任何类)

- 表示类、成员或指南在当前查看的版本中是新的

成员图标

- 表示类型为 config 的类成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

- 表示类型为 theme variable 的类成员

- 表示类型为 theme mixin 的类成员

- 表示类、成员或指南在当前查看的版本中是新的

类成员快速导航菜单

在 API 文档页面上的类名正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员计数(此计数在应用过滤器后会更新)。单击按钮会将您导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。

Getter 和 Setter 方法

与类配置选项相关的 Getter 和 setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中,就在它们工作的配置下方。Getter 和 setter 方法文档将在配置行中找到,以便于参考。

历史记录栏

您的页面历史记录保存在本地存储中,并在顶部标题栏正下方显示(使用可用的实际空间)。默认情况下,显示的唯一搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选选项来扩展显示的内容。这将显示所有产品/版本在历史记录栏中的所有最近页面。

在历史记录配置菜单中,您还将看到最近页面访问的列表。结果按“当前产品/版本”和“全部”单选选项过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。

如果在历史记录配置菜单中选择“全部”,则将启用“在历史记录栏中显示产品详细信息”复选框选项。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会以工具提示形式显示产品/版本。

搜索和过滤器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上,还有一个过滤器输入字段,用于使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读过滤类成员。这是通过使用页面顶部的复选框完成的。

API 类导航树底部的复选框过滤类列表以包含或排除私有类。

单击空的搜索字段将显示您最近 10 次搜索,以便快速导航。

API 文档类元数据

每个 API 文档页面(JavaScript 原始页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

展开和折叠示例和类成员

可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或全局使用右上角的展开/折叠全部切换按钮来展开和折叠成员。

桌面 -vs- 移动视图

在较窄的屏幕或浏览器上查看文档将导致针对较小尺寸优化的视图。桌面视图和“移动”视图之间的主要区别在于

查看类源代码

可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。

Ext JS 7.8.0


顶部

数据网格渲染 & 滚动

数据渲染、分页和滚动操作。

示例

关于

有时您的数据集太大,无法在一个页面上全部显示。Ext.grid.Panel 支持使用 Ext.toolbar.Paging 显示数据集中的单个页面,它使用上一个/下一个按钮加载页面。

Store 设置

Ext.grid.Panel 上设置分页之前,我们必须配置 Ext.data.Store 以支持分页。在下面的示例中,我们向 Ext.data.Store 添加了 Ext.data.Store#cfg-pageSize,并使用 Ext.data.reader.Reader#cfg-totalProperty 配置了我们的 Ext.data.reader.Reader

Ext.create('Ext.data.Store', {
    model: 'User',
    autoLoad: true,
    pageSize: 100,
    proxy: {
        type: 'ajax',
        url : 'data/users.json',
        reader: {
            type: 'json',
            rootProperty: 'users',
            totalProperty: 'total'
        }
    }
});

Ext.data.reader.Reader#totalProperty 配置告诉 Ext.data.reader.Json 从哪里获取 JSON 响应中的结果总数。此 Ext.data.Store 配置为使用类似于以下的 JSON 响应

{
    "success": true,
    "total": 4,
    "users": [
        { "name": "Lisa", "email": "[email protected]", "phone": "555-111-1224" },
        { "name": "Bart", "email": "[email protected]", "phone": "555-222-1234" },
        { "name": "Homer", "email": "[email protected]", "phone": "555-222-1244" },
        { "name": "Marge", "email": "[email protected]", "phone": "555-222-1254" }
    ]
}

分页工具栏

现在我们已经设置了 Ext.data.Store 以支持分页,剩下的就是配置 Ext.toolbar.Paging。您可以将 Ext.toolbar.Paging 放置在应用程序布局中的任何位置,但通常它会停靠在 Ext.grid.Panel

Ext.create('Ext.grid.Panel', {
    store: userStore,
    columns: ...,
    dockedItems: [{
        xtype: 'pagingtoolbar',
        store: userStore,   // same store GridPanel is using
        dock: 'bottom',
        displayInfo: true
    }]
});

有关工作示例,请参阅 分页网格

缓冲渲染

网格和树启用超大数据集的缓冲渲染,作为使用分页工具栏的替代方案。您的用户可以滚动浏览数千条记录,而不会因一次渲染屏幕上的所有记录而导致性能下降。

仅渲染足够的行以填充 Grid 的可见区域,并在任一侧留有少量的 Ext.grid.Panel#cfg-leadingBufferZone 溢出,以允许滚动。随着滚动的进行,新行在滚动方向上渲染,而行从表格的后退侧移除。

网格默认使用缓冲渲染,因此您不再需要将插件添加到您的 Grid 组件。

有关工作示例,请参阅 大数据过滤树

嵌入式组件。

自 ExtJS 5.0 以来,开发人员可以使用 Widget Column 类 在网格单元格中嵌入组件。

在 6.2.0 之前的版本中,以这种方式嵌入的组件无法访问网格的 Ext.app.ViewModel。列的 dataIndex 引用的字段绑定到组件的 defaultBindProperty

在 6.2.0+ 中,嵌入在网格中的组件可以访问 ViewModel 及其中的所有数据。ViewModel 包含两个特定于行的属性

record
recordIndex

自 ExtJS 6.2.0 以来,开发人员可以配置组件以显示在数据行下方(或可配置地,上方)的展开行中。

嵌入式组件可以访问网格的 ViewModel。

有关更多详细信息,请参阅 在网格中使用组件 指南。

Ext JS 7.8.0