文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private 或 protected。否则，类/成员为 public。Public、protected 和 private 是访问描述符，用于传达类或类成员应该如何以及何时使用。

Public（公共） 类和类成员可供任何其他类或应用程序代码使用，并且在主要产品版本中可以作为稳定和持久的内容依赖。公共类和成员可以通过子类安全地扩展。
Protected（受保护的） 类成员是稳定的 public 成员，旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
Private（私有的） 类和类成员在框架内部使用，不供应用程序开发人员使用。私有类和成员可能会在任何时候更改或从框架中省略，恕不另行通知，并且不应在应用程序逻辑中依赖它们。

成员类型

Config（配置） - 类的配置选项。
Property（属性） - 类实例化后设置。*见下文只读。
Method（方法） - 类可以执行的操作。方法应被理解为实例方法，并且只能从给定类的实例调用。可以直接从类本身调用的静态方法将在方法名称旁边带有 static 标签。*见下文静态。
Event（事件） - 事件是框架事件系统特有的，允许类以编程方式引发事件，以便由一个或多个事件处理程序方法处理。DOM 事件虽然由框架事件系统处理，但未在 API 文档中专门描述。*对于 DOM 事件，请参阅 MDN 的事件参考页面。
Theme Variable（主题变量） - 框架使用的可视化主题引擎使用的变量。
Theme Mixin（主题 Mixin） - 框架使用的可视化主题引擎使用的函数，可以使用在各种主题变量中设置的值。

成员语法

下面是一个类成员示例，我们可以对其进行剖析，以展示类成员的语法（在本例中为 Ext.button.Button 类中查看的 lookupComponent 方法）。

Ext.container.Container

查看源码

lookupComponent ( item ) : Ext.Component

受保护的

当原始配置对象添加到此容器时调用，无论是在初始化 items 配置期间，还是在 added 或 {@link #insert inserted} 新项时。

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

当需要对子组件创建应用特殊处理时，可以在子类中重写此方法。

参数

item : Object

正在添加的配置对象。

返回值

Ext.Component

要添加的组件。

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

展开/折叠 - 在成员行的左侧是一个控件，用于展开和折叠每个成员行以显示/隐藏成员详细信息。
成员名称 - 类成员的名称（本例中为 lookupComponent）
方法参数 - 方法使用的任何必需或可选参数（或传递给事件处理程序方法的参数）将列在方法名称旁边的括号内（本例中为 ( item )）
返回类型 - 方法或属性返回的类实例或 javascript 对象（本例中为 Ext.Component）。对于不返回除 undefined 以外的任何内容的方法，可以省略此项，或者可以显示为用斜杠 / 分隔的多个可能值，表示返回的内容可能取决于方法调用的结果（即，如果 get 方法调用成功，方法可能会返回 Component，如果失败，则返回 false，这将显示为 Ext.Component/Boolean）。
标志 - 适用于成员的任何标志都将显示在旁边（本例中为 PROTECTED - 请参阅下面的标志部分）
成员来源 - 在成员行的右侧是最初描述成员的类（本例中为 Ext.container.Container）。如果成员源自当前类，则源类将显示为蓝色链接；如果成员继承自祖先类或混合类，则显示为灰色。
成员源码 - 在成员来源类右侧下方是查看成员源码的链接（示例中为 查看源码）
参数列表 - 类方法的每个参数都将使用上面括号中找到的相同名称、预期的类或对象类型以及参数的描述列出（示例中为 item : Object）。
返回值 - 如果类返回除 undefined 以外的值，“返回值”部分将注明返回的类或对象类型以及描述（示例中为 Ext.Component）
Since（始于）（示例中未显示）- 某些成员将显示该成员首次引入的产品版本（即 Available since 3.4.0 - 示例中未显示），紧跟在成员描述之后
Default（默认值）（示例中未显示）- Configs 通常显示要应用于类实例的默认配置值（如果未被覆盖）（即 Defaults to: false）

成员标志

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

Required（必需） - 实例化类时必需的配置
Bindable（可绑定） - 配置具有 setter，允许通过 ViewModel 绑定设置此配置
Read Only（只读） - 属性可以读取，但不能用于在运行时配置/重新配置类实例
Singleton（单例） - 单例类在定义后立即实例化，不能手动实例化
Static（静态） - 静态方法或属性是属于类本身的方法或属性，而不是类的实例
Chainable（可链式调用） - 指的是在调用时返回类实例的方法。
这使得可以进行链式方法调用，例如：classInstance.method1().method2().etc();
Deprecated（已弃用） - 计划在未来的框架版本中删除的类或成员，在当前版本中提供是为了向后兼容。
已弃用的类和成员将有一条消息，指示您将来首选的类/方法。
Removed（已移除） - 已移除的类或成员，仅在文档中作为在框架版本之间升级的用户的参考而存在
Template（模板） - 在基类中定义的方法，旨在由子类重写
Abstract（抽象） - 类或成员可以定义为抽象的。抽象类和成员建立类结构并提供有限的（如果有的话）代码。特定于类的代码将通过子类中的覆盖来提供。
Preventable（可阻止） - 如果从事件处理程序返回 false，则标记为可阻止的事件将不会触发

类图标

- 表示框架类

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

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

Alternate Name（备用名称） - 一个或多个附加类名同义词（在 Ext JS 6.0.0 中，Ext.button.Button 类具有 Ext.Button 的备用类名）。备用类名通常为了向后兼容性而维护。
Hierarchy（层级结构） - 层级结构视图列出了当前类的继承链，从祖先类一直到根基类。
Mixins（混合） - 混合到当前类中的类列表
Inherited Mixins（继承的混合） - 混合到当前类的祖先中的类列表
Requires（需要） - 实例化类所需定义的所有类
Uses（使用） - 类在其生命周期中的某个时刻可能使用的类列表，但不一定是类最初实例化所必需的
Subclasses（子类） - 扩展当前类的类

展开和折叠示例及类成员

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

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

桌面与移动视图

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

全局导航将位于左侧菜单中，可通过汉堡菜单图标访问。菜单包含以下内容（在大多数页面上）
- 当前产品的名称（作为指向产品着陆页面的链接）
- 用于导航回文档主页的 Sencha 图标
- 产品菜单下拉按钮
- API 文档和指南的导航树选项卡
当前上下文导航和工具位于右侧，可通过齿轮图标访问。上下文菜单包含以下内容
- 全局搜索输入字段
- （API 文档）“过滤器”选项卡，其中包含成员过滤器、展开/折叠所有示例按钮、展开/折叠所有成员行按钮、访问级别过滤器复选框以及每个成员的计数
- （API 文档）“相关类”选项卡，其中包含与当前类相关的元数据菜单
- （指南）指南的目录

查看类源码

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

Cmd

显示私有类

顶部

Sencha Cmd 6.5 新特性

简介

Sencha Cmd 6.5 具有多项主要和次要功能和增强功能，这些功能和增强功能将帮助简化您的开发流程，并利用最新的 Web 技术，并充分利用 Ext JS 6.5。

ECMAScript 2015 (或 ES6)

使用 Sencha Cmd 6.5，您可以使用箭头函数、let 关键字、对象解构以及 ES6 中几乎所有很酷的新功能来编写代码。Sencha Cmd 将编译您的代码以在任何地方运行。这种转换称为“转译器”，在底层，Sencha Cmd 使用 Google 的 Closure Compiler 来转译您的代码。

Cmd 还利用 Closure 提供的所有 poly-fills，因此您也可以使用这些花哨的新 Array 方法，而不必担心哪些浏览器支持它们。

在某些情况下，您不需要所有这些转译。也许您的目标是 Electron，或者您只支持具有所有这些功能的现代浏览器。您可以禁用转译器，并且仍然可以使用 Sencha Cmd 代码压缩器来压缩您的原生 ES6 代码。只需调整一下 app.json 文件，就可以告别转译器及其 polyfills

"output": {
    "js": {
        "version": "ES6"
    }
}

动态包加载

Sencha Cmd 多年来一直支持包的概念，大型应用程序通常利用包来封装类、样式和资源。然后，Sencha Cmd 将所有这些部分构建到您的应用程序中。现在，您可以以全新的方式动态使用这些包。

如果您今天正在使用包，您会在 app.json “requires”数组中看到它们

requires: [
    'dashboard',
    'settings',
    'users'
]

要切换到动态加载，只需将其中一些或全部移动到“uses”数组中，并在“requires”中添加一个新包

requires: [
    'package-loader'
],
uses: [
    'dashboard',
    'settings',
    'users'
]

在进行这些更改后，当 Sencha Cmd 构建您的应用程序时，它将为应用程序和每个使用的包生成单独的捆绑包。当您的应用程序加载时，它将仅包含其代码和所需包中的代码，但不包含使用的包。相反，这些使用的包的 JavaScript、CSS 和资源将位于应用程序的构建文件夹中，就像图像或其他资源一样。

然后，当您准备好使用包时，Ext.Package.load() 方法使加载包变得非常简单。包加载器处理包的 JavaScript 和 CSS 资源，以及递归加载它可能需要的任何包。

如果您正在使用 Ext JS 路由，您可能会执行类似这样的操作来加载包

routes: {
    ':type': {
        before: 'loadPackage',
        action: 'showView'
    }
},

loadPackage: function (type, action) {
    var view = this.getView(),
        pkg = this.getPackageForType(type);

    if (!pkg || Ext.Package.isLoaded(pkg)) {
        action.resume();
    }
    else {
        view.setMasked({
            message: 'Loading Package...'
        });

        Ext.Package.load(pkg).then(function () {
            view.setMasked(null);

            action.resume();
        });
    }
},

使用动态包加载可以为您的用户节省大量时间。他们不再需要等待应用程序的每个字节都加载完毕，而实际上他们只需要大约 20% 的字节。它还可以为开发人员节省时间，因为 Sencha Cmd 不再需要加载他们的所有代码来制作“dev”构建或同时监视他们的所有代码。

“app build”和“app watch”命令有许多新的命令行开关，使您可以控制要构建或监视哪些外部包（如果有）。这些使您可以通过将构建限制为仅限于您当前正在处理的包来大幅缩短构建时间。

实际应用

为了帮助您入门，我们编写了一个演示应用程序，该应用程序在一些实际场景中使用了一些包。查看 GitHub 仓库。

渐进式 Web 应用

渐进式 Web 应用 (PWA) 使用现代 Web 技术提供接近原生应用的体验。借助 PWA，您可以显示一个横幅，邀请 Android 用户将您的应用安装到他们的主屏幕上。通过服务工作线程及其缓存的魔力（目前在 Chrome 和 Firefox 中受支持），您的应用甚至可以离线运行。

Sencha Cmd 通过提供预构建的服务工作线程（基于 Google 的 https://github.com/GoogleChrome/sw-toolbox ）简化了构建过程。服务工作线程可以在 app.json 中配置，其缓存清单可以由 Sencha Cmd 使用源代码中的 @sw-cache 注释来扩充。这些注释告诉 Cmd 您需要缓存特定资源，并且还可以配置应如何管理每个资源。

PWA 示例

我们整理了一个渐进式 Web 应用程序示例，向您展示它是如何工作的。查看 GitHub 仓库并按照 README 说明开始操作。GitHub 仓库包含 Ext JS 应用程序和基于 Node.js 的后端服务器。

项目结构

使用 Sencha Cmd 6.5，生成的应用程序不再包含 “sencha app build” 命令使用的构建脚本。这些脚本不再放在本地 .sencha 文件夹中，而是从 Sencha Cmd 安装目录加载。

应用程序也不再生成 “sass” 目录。相反，您可以将 *.scss 文件放在与 JavaScript 文件相同的目录中。换句话说，对于 Foo 视图，您可能会拥有所有这些文件

foo/
    Foo.js
    Foo.scss
    FooController.js
    FooModel.js

建议将通用或全局样式放在 app/Application.scss 中，或从那里导入的文件中。

框架管理

为了简化新项目的设置，您可以利用新的 “sencha app init” 和 “sencha app install” 命令及其 “workspace” 对等命令 “sencha workspace init” 和 “sencha workspace install”（如果您有多个应用程序）。

所有这些命令都接受您提取 Ext JS 的路径。如果您下载并将所有 Sencha SDK 提取到一个文件夹中，则可以像这样简化这些命令

$ sencha config --prop sencha.sdk.path=~/sencha-sdks --save

在 Windows 上，路径的 “~” 部分将被替换为类似 “C:\Users\Me\” 的内容。

现在 “sencha-sdks” 包含您下载和提取的所有 SDK zip 文件，并且您已使用 “sencha config --save” 保存了该路径，您将不需要将 --frameworks 传递给任何 init 或 install 命令。

已知问题

某些用户在升级到 Cmd 6.5.0 后可能难以构建其原生 Cordova 应用程序。如果您收到任何与 Cordova 平台配置相关的错误，请手动创建一个名为 cordova.local.properties 的文件（如果不存在）。然后将以下代码放入文件中并再次尝试构建

cordova.platforms=${app.cordova.config.platforms}

注意： cordova.local.properties 应放置在项目的根目录中。

目录