文档帮助

内容

术语、图标和标签访问级别成员类型成员语法成员标志类图标成员图标导航和功能类成员快速导航菜单 Getter 和 Setter 方法历史记录栏搜索和过滤器 API 文档类元数据展开和折叠示例和类成员桌面视图 -vs- 移动视图查看类源

术语、图标和标签

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

访问级别

框架类或其成员可以指定为私有或受保护。否则，类/成员为公共。公共、受保护和私有是访问描述符，用于传达如何以及何时使用类或类成员。

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

成员类型

配置 - 类的配置选项。
属性 - 类实例化后设置一次。*请参见下面的只读。
方法 - 类可以执行的操作。方法应作为实例方法读取，并且只能从给定类的实例调用。可以从类本身直接调用的静态方法将在方法名称旁边有一个静态标签。*请参见下面的静态。
事件 - 事件特定于框架事件系统，允许类以编程方式引发一个事件，以便由一个或多个事件处理程序方法处理。DOM 事件虽然由框架事件系统处理，但不会在 API 文档中具体描述。*有关 DOM 事件，请参阅 MDN 的事件参考页面。
主题变量 - 框架采用的视觉主题引擎使用的变量。
主题混合 - 框架采用的视觉主题引擎使用的函数，并且可以使用在各种主题变量中设置的值。

成员语法

下面是一个示例类成员，我们可以对其进行剖析以显示类成员的语法（在本例中，是从 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）
自（示例中未显示） - 某些成员将在成员描述后显示产品首次引入成员的版本（即 自 3.4.0 起可用 - 示例中未显示）
默认（示例中未显示） - 配置通常显示要应用于类实例的默认配置值，如果未覆盖（即 默认为：false）

成员标志

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

必需 - 实例化类时的必需配置
可绑定 - 配置具有一个 setter，允许通过 ViewModel 绑定设置此配置
只读 - 可以读取该属性，但不能用于在运行时配置/重新配置类实例
单例 - 单例类在定义后立即实例化，并且不能手动实例化
静态 - 静态方法或属性是属于类本身的方法或属性，而不是类的实例
可链接 - 指在调用时返回类实例的方法。
这允许链接方法调用，如：classInstance.method1().method2().etc();
已弃用 - 计划在未来框架版本中删除的类或成员，并在当前版本中提供以保持向后兼容性。
已弃用的类和成员将有一条消息，指导您将来使用首选类/方法。
已删除 - 仅在文档中作为框架版本之间升级的用户参考而存在的已删除类或成员
模板 - 在基类中定义的方法，旨在被子类覆盖
抽象 - 类或成员可以定义为抽象。抽象类和成员建立类结构并提供有限的代码（如果有）。类特定代码将通过子类中的覆盖来提供。
可预防 - 标记为可预防的事件如果从事件处理程序返回 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 基本类型页面除外）都有一个与该类相关的元数据的菜单视图。此元数据视图将包含以下一项或多项

备用名称 - 一个或多个其他类名同义词（在 Ext JS 6.0.0 中，Ext.button.Button 类的备用类名为 Ext.Button）。备用类名通常用于保持向后兼容性。
层次结构 - 层次结构视图列出了当前类的继承链，从其祖先类一直到根基类。
Mixins - 混合到当前类中的类列表
继承的 Mixins - 混合到当前类祖先中的类列表
Requires - 实例化类所需的已定义的所有类
Uses - 在其生命周期的某个时刻可能由类使用的类列表，但对于最初实例化类来说并非必需
子类 - 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

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

查看类源

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

Cmd

显示私有类

顶部

内容

先决条件使用生成自定义引导程序在导出加载程序路径使用更改格式导出文件名导出定义

生成元数据

Sencha Cmd 编译器跟踪的元数据有多种用途，其中一些将在本指南中进行探讨。为了支持这些用途，编译器可以以多种不同的方式导出和格式化此元数据，我们也会在此处介绍这些方式。

先决条件

建议在继续之前阅读以下指南

Sencha 编译器参考

使用 `meta` 生成输出

编译器提供的主要新维度之一是它能够以各种格式导出元数据。此功能用于生成 ext.js “引导程序”文件，其中包含各种类和有关框架中所有文件的一块元数据。

编译器可以使用 meta 命令导出多种形式的元数据

类别名
备用类名
加载程序路径
文件名
定义

生成自定义引导程序

注意。此过程由 Sencha Cmd 生成的应用程序自动处理。如果您未使用 Sencha Cmd 生成的应用程序，本部分将介绍如何手动实现相同的结果。

meta 命令的主要用途是创建您自己的“引导程序”文件。此文件使框架对您的应用程序代码的了解程度与对框架代码本身的了解程度相同。

管理引导文件的最简单方法是将其与标记文件一起存储。如果该方法不适合您，请继续阅读以了解如何管理相对路径。如果您的标记文件位于 classpath 中的源文件夹中，则需要告诉编译器忽略引导文件。使用 -ignore 开关执行此操作

sencha compile -classpath=sdk/src,app -ignore bootstrap.js \
    ...

在 `requires` 中启用通配符支持

"ext-debug.js" 的末尾包含这两个函数调用

Ext.ClassManager.addNameAlternateMappings({
    "Ext.draw.engine.ImageExporter": [],
    "Ext.layout.component.Auto": [],
    ...
});

Ext.ClassManager.addNameAliasMappings({
    "Ext.draw.engine.ImageExporter": [],
    "Ext.layout.component.Auto": [
        "layout.autocomponent"
    ],
    ...
});

这两个元数据的存在允许在 requires 语句中使用通配符。即

Ext.define('MyApp.App', {
    requires: [
        'Ext.grid.*'
    ],
    ...
});

在您自己的代码中使用通配符所需做的就是为您的应用提供相同的引导数据。

此命令将生成一个执行此操作的文件

sencha compile -classpath=app \
    meta -alias -out bootstrap.js and \
    meta -alt -append -out bootstrap.js

上述命令行告诉编译器读取 app 文件夹中的源代码并生成两个元数据。第二个元数据将写入与第一个相同的文件，但使用 -append 选项追加到文件而不是替换它。

获得 "bootstrap.js" 文件后，像这样更改您的页面以将其添加到 x-bootstrap 部分

<html>
    <head>
        <!-- <x-compile> -->
            <!-- <x-bootstrap> -->
                <script src="../sdk/ext-dev.js" type="text/javascript"></script>

                <script src="bootstrap.js" type="text/javascript"></script>
            <!-- </x-bootstrap> -->

            <script src="app/app.js" type="text/javascript"></script>
        <!-- </x-compile> -->
    </head>
    <body></body>
</html>

如果您执行以下任何操作，则需要重新生成 "bootstrap.js" 文件

添加一个类
删除一个类
更改类别名
更改类备用名称

可以通过多种方式处理引导数据的此重建，但基本问题是将这些文件保留在源代码管理中还是要求开发人员在本地生成它们。两种方法都可行，并且可以在一定程度上实现自动化。

注意。对于由 Sencha Cmd 生成的应用程序，这作为 sencha app build 构建过程的一部分进行处理。或者，通过 sencha app refresh 命令刷新引导程序而不是执行完全构建。

导出加载器路径

在大型应用程序中，使用多个源树来组织命名空间可能会有所帮助。事实上，Ext JS 本身使用三个源树。然而，这种方法一直给动态加载器带来问题，需要手动配置加载器路径来解决问题。但是，编译器完全了解类到文件的关系，因为 classpath 中的所有源代码。并且 meta 命令可以导出该数据以在您的应用程序中使用。

如果您已经确定上述内容以创建 "bootstrap.js"，则可以通过添加一个 meta 命令来添加此数据（当然，在这种情况下，classpath 将包含多个文件夹）

sencha compile -classpath=src1,src2,src3 \
    meta -alias -out bootstrap.js and \
    meta -alt -append -out bootstrap.js and \
    meta -loader -append -out bootstrap.js

现在，"bootstrap.js" 文件解决了这两个问题。使用此方法，以下内容也需要您重建 "bootstrap.js"

重命名文件或文件夹
重新组织 classpath
重新组织任何源树的内容

注意。此部分也由 Sencha Cmd 生成的应用程序自动处理。

使用 `-base-path` 解析相对路径

出于很多充分的理由，路径需要是相对的。但是，每当您处理相对路径时，您都需要解决这些相对路径基于何处的问题。在上述示例中，我们作弊了一点，并将 "bootstrap.js" 文件放在标记文件旁边。这利用了 meta 命令将基本文件夹默认为输出文件的位置这一事实。

如果不是这种情况，您需要告诉 meta 命令确定相对路径的基础。假设我们想将 "bootstrap.js" 文件移到 "build" 文件夹中（也许是因为我们没有将其保留在源代码管理中）。由于我们的页面在当前文件夹中，而我们的源代码在 "app" 文件夹中，这将生成正确的相对路径

sencha compile -classpath=src1,src2,src3 \
    meta -alias -out build/bootstrap.js and \
    meta -alt -append -out build/bootstrap.js and \
    meta -loader -append -base-path . -out build/bootstrap.js

由于 -alias 和 -alt 模式不处理路径，因此 -base-path 选项仅在 meta 命令的 -loader 使用中需要。

更改格式

默认情况下，meta 命令使用适用于所请求元数据类型的函数调用包装器，以 JSONP 格式导出元数据。如果您希望使用其他函数调用或希望以 JSON 格式获取数据，您可以在 meta 命令中提出此请求。

在下面的示例中，aliases.json 文件将以 JSON 格式包含别名数据。您不能在此情况下使用 -append，因为 JSON 格式需要一个单一的顶级对象或数组。

sencha compile -classpath=src1,src2,src3 \
    meta -alias -json -out aliases.json

在下一个示例中，我们通过提供要调用的函数来定制 JSONP 包装

sencha compile -classpath=src1,src2,src3 \
    meta -alias -jsonp Foo.bar.doAliases -out aliases.js

此表单可以与 -append 配合使用，因为它生成 JavaScript 代码。上述输出大致如下所示

Foo.bar.doAliases(
    // ... the JSON data ...
);

导出文件名

meta 命令支持的一种偶尔有用的元数据形式是文件名数据。即，按正确的依赖顺序排列的文件列表。在许多方面，这与其他元数据形式相同，因为此数据可以以 JSON 或 JSONP 格式导出，并且可以使用 -append 进行合并。

与 -filenames 的第一个区别在于，默认格式为文本。要生成 JSON 或 JSONP，您必须指定 -json 或 -jsonp 选项之一。

在文本的默认模式下，文件名被写为文本行，每行一个文件名。以下命令将创建 "filenames.txt"

sencha compile -classpath=src1,src2,src3 \
    meta -filenames -out filenames.txt

可以使用 -tpl 选项装饰文件中的每一行。由于此示例需要特殊字符，因此我们使用响应文件来保存模板。我们将其放入 "template.txt" 中，如下所示

<script src="{0}" type="text/javascript"></script>

然后运行以下命令。

sencha compile -classpath=src1,src2,src3 \
    meta -filenames -tpl @template.txt -out filenames.txt

我们现在有了一段标记，它将按正确的顺序“脚本标记”所有文件。

例如

<script src="ext/src/ShadowPool.js" type="text/javascript"></script>
<script src="ext/src/Shadow.js" type="text/javascript"></script>

导出定义

编译器通常通过解析源代码来读取元数据，例如类、命名空间和依赖项。在隐藏此类信息的情况下，例如，混淆库时，编译器将不知道任何已定义的类或其依赖项。

此元数据导出形式可用于为此类库提供“符号”，以便用户仍可以使用 Sencha Cmd 编译其应用程序。

sencha compile -classpath=src1,src2,src3 \
    meta -definitions -out symbols.js

上述操作将创建一个包含类似指令的文件

// @define Foo.bar.Thing
// @require Ext.panel.Panel
// @uses Ext.layout.container.HBox

编译器识别这些指令，并引入用户代码编译所需的符号名称。应将这些符号添加到混淆的库文件中，以确保库代码按正确的顺序连接。

内容