文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
protected

在初始化items配置期间,或添加新项目时,将原始配置对象添加到此容器时调用added), or {@link #insert inserted.

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

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

参数

item :  Object

要添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

- 组件类型框架类(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 原语页面)都具有与该类相关的元数据的菜单视图。此元数据视图将具有以下一项或多项

展开和折叠示例和类成员

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

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

桌面与移动视图

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

查看类源代码

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

Ext JS 7.8.0


顶部

ViewModel 内部

既然您已经看到了ViewModel 可以做什么,让我们深入了解一下幕后发生了什么。了解基本机制将有助于您诊断问题,因为您将知道 ViewModel 如何处理您的声明。

ViewModel 有两个不同的工作:管理对数据对象的更改以及在数据更改时调度绑定。

ViewModel 数据和继承

ViewModel 类管理一个“数据”对象,它利用 JavaScript 原型链来提供值继承。用图片形式来说

这意味着所有组件都可以读取由顶层容器设置的属性(存储在其数据对象“数据 1”中)。假设我们在容器 1 中有以下内容

viewModel: {
    data: {
        foo: 42
    }
}

这允许所有组件绑定到{foo}。这通常用于跟踪在应用程序的多个级别都需要的重要记录(例如“currentUser”)。事实上,由于使用 JavaScript 原型链来表示数据,因此在 ViewModel 中发布对象通常是一个好主意,如果要共享属性的更改也是如此。为了了解原因,请考虑对{foo}进行双向绑定,但在容器 2 的子级中

{
    xtype: 'textfield',
    bind: '{foo}'
}

文本字段将通过数据 2 的原型链最终从数据 1 接收“42”。但是,此组件所做的更改将存储在数据 2 上。这是因为这些组件绑定到它们的 ViewModel 及其数据对象,这意味着绑定的双向性质将有效地调用 ViewModel 2 上的set,它作为正常的 JavaScript 对象,调用在数据 2 上设置foo。这种“分叉”可以成为初始化然后由视图分离的值的一种有用方法。

要通过继承共享“实时”属性,应将对象存储在根 ViewModel 中

viewModel: {
    data: {
        stuff: {
            foo: 42
        }
    }
}

现在,双向绑定将更新共享“stuff”对象上的“foo”属性

{
    xtype: 'textfield',
    bind: '{stuff.foo}'
}

调度和依赖项

使数据绑定快速的关键是避免冗余或不必要的计算。
为了管理这一点,ViewModel 跟踪数据之间的依赖关系。每个绑定和公式都会引入一个依赖关系。在幕后,ViewModel 一次将这些依赖关系分解为一个间接级别,并创建一个线性调度。当数据发生更改时,此调度将在延迟后处理。

因此,如果您在 ViewModel 中设置值或更改记录的字段,您无需担心会立即发生大量重新计算。同样,如果一个公式依赖于 7 个值,并且您需要更改所有这些值,则该公式只会重新计算一次。更进一步,如果您有 7 个公式,每个公式都使用另一个公式(因此深度为 7 的链),并且每个公式都依赖于 7 个其他值,则更改所有 49 个值将导致每个公式只重新计算一次。

为了实现这一点,这些依赖项必须为 ViewModel 所知,并且它们必须是无环的。依赖关系图中的循环将被报告为错误。在这个人为的例子中很容易看到这一点

Ext.define('App.view.broken.BrokenModel', {
    extend: 'Ext.app.ViewModel',

    formulas: {
        bar: function (get) {
            return get('foo') / 2;
        },
        foo: function (get) {
            return get('bar') * 2;
        }
    }
});

在实际应用中,这些错误可能不会那么明显,但很明显“foo”和“bar”相互依赖,因此不可能找到一个对这两个方法进行评估的顺序,从而得到正确的答案。

公式依赖项

当一个公式使用显式绑定时,它的依赖项是显而易见的。当一个公式只提供一个函数或一个get方法时,ViewModel 会解析函数的文本,寻找属性引用。虽然这非常方便,并确保你不会忘记在显式绑定中列出依赖项,但这种方法也有一些局限性。有关公式解析的详细信息,请参见Ext.app.bind.Formula

Ext JS 7.8.0