文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private(私有)或 protected(受保护的)。否则,类/成员为 public(公共)。Publicprotectedprivate 是访问描述符,用于传达应如何以及何时使用类或类成员。

成员类型

成员语法

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

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

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

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

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

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示一个框架类

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

- 一个组件类型的框架类(Ext JS 框架中任何继承自 Ext.Component 的类)

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

成员图标

- 表示类型为 config 的类成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

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

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

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

类成员快速导航菜单

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

Getter 和 Setter 方法

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

历史记录栏

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

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

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

搜索和过滤器

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

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

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

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

API 文档类元数据

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

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源码

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

Ext JS 7.8.0


顶部

步骤 1:解压 Ext JS 试用 zip 文件

此处下载您的 30 天试用版。

解压缩下载的 zip 文件并打开文件夹。

步骤 2:安装 Sencha Cmd CLI

'Sencha Cmd' 是用于创建 Ext JS 应用程序的命令行工具。

  • 对于 MacOS: 右键单击并打开在上一步中解压缩的 .app 文件。如果您看到以下消息,请单击“打开”并继续。该应用程序可以安全使用。

macOS

  • 对于 Linux: 右键单击并打开 .sh 文件,然后继续执行安装步骤。
  • 对于 Windows: 右键单击以打开 .exe 文件。如果您看到以下消息,请选择“更多信息”,然后单击“仍然运行”。该应用程序可以安全使用。

安装继续进行,并出现以下窗口:单击下一步>

installation step 1

选择“我接受”,然后单击下一步>

installation step 2

选择目标目录,然后单击下一步>

installation step 3

选择要安装的组件,然后单击下一步> 或单击 <上一步 更改您的设置。

installation step 4

如果您要执行其他步骤,请选择,然后单击下一步>

installation step 5

安装过程完成后,单击完成

installation step 6

installation step 7

您现在可以开始创建您的第一个 Ext JS 应用程序了

步骤 3:打开并探索您的新 Ext JS 应用程序

  • 启动您的终端/命令窗口
  • 将目录更改为您要创建新应用程序的文件夹

    cd <folder-to-create-the-app>

如果您是试用客户

Ext JS 30 天试用包可从 Sencha CDN 安装。使用以下命令安装最新的 Ext JS 试用版。--ext 将强制 CMD 从我们的 cdn 下载 sdk。

  • 生成应用程序

    sencha generate app --ext MyApp ./MyApp

如果您是活跃客户

Ext JS 和所有相关的商业软件包都托管在支持门户上。使用您的凭据登录门户并下载所需的 SDK zip 文件。

  • 下载所需的 SDK zip 文件。
  • 生成应用程序

    sencha -sdk /path/to/downloaded/sdk generate app modern MyApp ./MyApp

现在打开并探索您的应用程序

  • 导航到新的应用程序文件夹

    cd MyApp

  • 运行应用程序:sencha app watch

Sencha 命令将构建您的应用程序。完成后,命令窗口将记录以下消息

等待更改...

  • 在浏览器中运行应用程序。打开任何浏览器窗口并在 https://127.0.0.1:1841/ 查看应用程序

恭喜!您现在已成功使用 Ext JS 构建了一个应用程序!

下一步:

既然您已成功开始构建 Ext JS 应用程序,请花一些时间探索如何使用数百个 UI 组件、设计、测试和调试工具来增强您的应用程序。

Ext JS 7.8.0