文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

让我们看看成员行中的各个部分

  • 展开/折叠 - 在成员行的左侧是用于展开和折叠每个成员行以显示/隐藏成员详细信息的控件。
  • 成员名称 - 类成员的名称(在本例中为 lookupComponent
  • 方法参数 - 方法使用的任何必需或可选参数(或传递给事件处理程序方法)将在括号中列在方法名称旁边(在本例中为 ( item )
  • 返回类型 - 方法或属性返回的类实例或 JavaScript 对象(在本例中为 Ext.Component)。对于不返回 undefined 的方法,可以省略此类型,或者可能显示多个可能的值,这些值用正斜杠 / 分隔,表示返回的内容可能取决于方法调用的结果(即,如果 get 方法调用成功,则方法可能返回一个组件,如果失败则返回 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 文档页面的类名下方,有一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员数(此计数在应用筛选器时更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示一个弹出菜单,其中包含该类型的所有成员,以便快速导航。

获取器和设置器方法

与类配置选项相关的获取器和设置器方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中,位于它们处理的配置下方。获取器和设置器方法文档将位于配置行中,以便于参考。

历史记录栏

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

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

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

搜索和筛选器

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

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

API 类导航树底部的复选框筛选类列表,以包括或排除私有类。

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

API 文档类元数据

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

  • 备用名称 - 一个或多个其他类名同义词(在 Ext JS 6.0.0 中,Ext.button.Button 类有一个备用类名 Ext.Button)。备用类名通常用于向后兼容。
  • 层次结构 - 层次结构视图列出了当前类的继承链,从其祖先类一直到根基类。
  • Mixin - 混合到当前类中的类列表
  • 继承的 Mixin - 混合到当前类祖先中的类列表
  • 需要 - 实例化类所需的已定义的所有类
  • 使用 - 类在其生命周期的某个时刻可能使用的类列表,但对于最初实例化类来说不一定需要
  • 子类 - 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

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

查看类源

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

Architect 4.3


顶部

Architect 4.3.5 中的新增内容

支持 Ext JS 7.8 和以前版本

Architect 4.3.5 支持在最新的 Ext JS 7.8 及更早版本的框架上创建应用程序。

支持 Cmd 7.8

Architect 现在可以使用 Cmd 7.8,详情请见。

Architect 4.3.4 中的新增功能

支持 Ext JS 7.7 及更早版本

Architect 4.3.4 支持在最新的 Ext JS 7.7 及更早版本的框架上创建应用程序。查看我们的更改日志,了解完整的更改列表。

轻量级安装程序

默认情况下,最新版本将打包在安装程序中,而所有旧版本将根据用户需求下载,以保持安装程序轻量级。

支持 Cmd 7.7

Architect 现在可以使用 Cmd 7.7,详情请参阅 Cmd 7.7 功能

Architect 4.3.2 中的新增功能

支持 Ext JS 7.6

Architect 4.3.2 支持创建支持 Ext JS 7.6 框架的单个版本的应用程序。查看我们的更改日志,了解完整的更改列表。

支持 Cmd 7.6

Architect 现在可以使用 Cmd 7.6,详情请参阅 Cmd 7.6 功能

Architect 4.3.0 中的新增功能

支持 ExtJs 7.4

Sencha Architect 4.3.0 支持使用包含新功能的最新 Ext JS 7.4 框架创建应用程序。

Architect 提供对构建具有以下功能的应用程序的支持

  • 网格多级分组 - 多分组网格功能允许网格面板显示按多个分组器分组的存储数据。以下是如何显示它的示例
  • 网格筛选栏 - 此经典和现代工具包插件将在网格标题下方添加一个停靠栏,并且根据网格列配置,将添加筛选字段。
  • 网格汇总和分组总计 - 快速定义聚合函数,例如按列求和、最小值、最大值计数等。
  • 网格分组面板插件 - 此插件允许最终用户将网格列拖放到网格面板上方可见的分组面板部分。

支持 Cmd 7.4

Architect 4.3.0 现在可以使用 Cmd 7.4,详情请参阅 Cmd 7.4 功能

更多功能和性能改进

  • Architect 4.3 具有更新的 Electron(版本 11.3),可提供性能改进和稳定性。
  • Mac M1 处理器 - 已为 Electron 添加对 arm64 的支持。

Architect 4.2.7 中的新增功能

支持 ExtJs 7.1

Architect 4.2.7 支持使用最新的 Ext JS 7.1 框架创建应用程序。

支持 Cmd 7.1

Architect 现在可以使用 Cmd 7.1,详情请参阅 Cmd 7.1 功能

Architect 4.2.6 中的新增功能

支持 Ext JS 7.0

Architect 4.2.6 支持使用最新的 Ext JS 7.0 框架创建应用程序。

支持 Cmd 7.0

Architect 现在可以使用 Cmd 7.0,详情请参阅 Cmd 7.0 功能

Architect 4.2.5 中的新增功能

支持 Ext JS 6.7

Sencha Architect 4.2.5 支持包含新功能的 Ext JS 6.7。Architect 提供对构建具有以下组件的应用程序的支持

  • 网格筛选 - 轻松显示满足文本、布尔值、日期、数字筛选的多个条件的网格记录
  • 锁定网格 - 类似于 Excel,锁定左侧或右侧区域中的列
  • 多选组合框 - 具有选择多个芯片功能的组合框
  • 多选选择 - 在选择字段中轻松选择多个值
  • 颜色选择器 - 具有 HSVA 和 RGB 选项的漂亮颜色选择器

支持 Cmd 6.7

Architect 现在可以使用 Cmd 6.7。有关详细信息,请参阅 Cmd 6.7 功能

Architect 4.2.4 的新增功能

我们很高兴地宣布 Sencha Architect 4.2.4 现已全面可用,它为 Ext JS 6.6 和 Cmd 6.6 提供支持。使用 Architect 4.2.4,你可以使用新的 Ext JS 6.6 组件(例如时间面板和时间字段)以可视化方式构建应用,并使用漂亮的新 Graphite 主题,以及使用 Cmd 6.6 构建项目。此版本将使你能够使用 Ext JS 6.6 快速构建复杂的 Web 应用程序。

使用新的 Ext JS 组件以可视化方式构建 Ext JS 视图

你可以使用 Architect 拖放新的时间面板和时间字段组件并生成应用程序代码。你可以访问组件的所有配置参数、设置布局、添加自定义配置、添加事件并使用最少的代码手动覆盖。

轻松将内置的 Graphite 无障碍主题应用到你的应用

Architect 4.2.4 支持新的无障碍 Graphite 主题。你可以轻松地拖放主题,将其应用到你的应用程序,并自定义主题。

轻松迁移到 Ext JS 6.6 框架

Architect 提供了选项,可以轻松地将使用较旧版本的框架构建的应用程序升级到 Ext JS 6.6。当你在 Sencha Architect 的“资源”部分右键单击“库”时,你可以升级到最新版本的 Ext JS 框架。

Architect 4.2.3 的新增功能

Architect 4.2.3 支持 Ext JS 6.5.3 和 Cmd 6.5.3。

查看我们的 更改日志,了解完整更改列表。

Ext JS 6.5.3

Architect 现在可以使用 Ext JS 6.5.3。Ext JS 6.5.3 包含 许多新功能

Cmd 6.5.3

Architect 现在可以使用 Cmd 6.5.3。有关详细信息,请参阅 Cmd 6.5.3 功能

在 Architect 中轻松导入高级附加组件

Architect 4.x 支持所有 Sencha 高级软件包,以便你可以在基于现代和经典工具包的应用程序中使用 D3、日历、透视网格和导出器。使用 Architect 4.2.3,你可以轻松地在 Architect 项目中导入高级附加组件。

Architect 4.2 的新增功能

Architect 4.2 为 Ext JS 6.5 和 Cmd 6.5 提供支持,添加了一个新的现代项目模板,并包含了一些新的菜单项,以便更轻松地进行项目管理。

查看我们的 更改日志,了解完整更改列表。

Ext JS 6.5.0

Architect 现在可以使用 Ext JS 6.5.0。Ext JS 6.5.0 包含 许多新功能,尤其是在现代工具包中。

Cmd 6.5.0

Architect 现在可以使用 Cmd 6.5.0。Cmd 6.5.0 现在支持 ES6 语法、动态软件包加载以及 更多内容

重新启动应用监视

用户现在可以在每次保存后无需运行时停止应用监视。用户还可以在出现构建问题时重新启动应用监视。

注意:应用监视在项目打开时自动启动。

重新初始化 Cmd

用户现在可以通过单击一下从其项目中删除并再次添加 Sencha Cmd。有时可以通过删除并再次添加 Cmd 来解决问题。

注意:这将删除所有 Sencha Cmd 相关文件,例如 app.json 和其他文件。

离线许可证

用户现在可以通过文件选择器选择其离线许可证,而不是手动放置其文件。

Electron 封装

Architect 的 Electron 封装已更新到版本 1.6.2。

Architect 4.3