许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 别名
(如果类扩展了 Ext.Component,则为 xtype
)。别名/xtype 列在适用类的类名旁边,以供快速参考。
框架类或其成员可以指定为 private
或 protected
。否则,类/成员为 public
。Public
、protected
和 private
是访问描述符,用于传达应如何以及何时使用类或类成员。
Public 类和类成员可供任何其他类或应用程序代码使用,并且在主要产品版本中可以作为稳定且持久的内容被依赖。Public 类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的 public
成员,旨在供拥有类或其子类使用。Protected 成员可以通过子类安全地扩展。
Private 类和类成员供框架内部使用,不供应用程序开发人员使用。Private 类和成员可能会随时更改或从框架中省略,恕不另行通知,并且不应在应用程序逻辑中依赖它们。
static
标签。*请参阅下面的静态。下面是一个类成员示例,我们可以剖析它来展示类成员的语法(在本例中是从 Ext.button.Button 类查看的 lookupComponent 方法)。
让我们看一下成员行的每个部分
lookupComponent
)( item )
)Ext.Component
)。对于不返回任何内容(除了 undefined
)的方法,可能会省略此项,或者可能会显示为以斜杠 /
分隔的多个可能值,表示返回的内容可能取决于方法调用的结果(即,如果 get 方法调用成功,方法可能会返回 Component,如果失败则返回 false
,这将显示为 Ext.Component/Boolean
)。PROTECTED
- 请参阅下面的标志部分)Ext.container.Container
)。如果成员源自当前类,则源类将显示为蓝色链接,如果它继承自祖先类或混入类,则显示为灰色。view source
)item : Object
)。undefined
以外的值,“返回值”部分将注明返回的类或对象类型以及描述(示例中的 Ext.Component
)Available since 3.4.0
- 示例中未显示),紧随成员描述之后Defaults to: false
)API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。
classInstance.method1().method2().etc();
false
,则标记为 preventable 的事件将不会触发- 表示框架类
- Singleton 框架类。*有关更多信息,请参阅 singleton 标志
- 组件类型框架类(Ext JS 框架中扩展 Ext.Component 的任何类)
- 表示类、成员或指南是当前查看版本中的新增内容
- 表示 config
类型的类成员
- 表示 property
类型的类成员
- 表示 method
类型的类成员
- 表示 event
类型的类成员
- 表示 theme variable
类型的类成员
- 表示 theme mixin
类型的类成员
- 表示类、成员或指南是当前查看版本中的新增内容
在 API 文档页面上的类名正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮都显示按类型划分的成员计数(此计数会随着应用过滤器而更新)。单击按钮会将您导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。
与类配置选项相关的 Getter 和 setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中,就在它们与之配合使用的配置下方。Getter 和 setter 方法文档将在配置行中找到,以便于参考。
您的页面历史记录保存在本地存储中,并显示在顶部标题栏正下方(使用可用的实际空间)。默认情况下,显示的唯一搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选按钮来扩展显示的内容。这将显示所有产品/版本在历史记录栏中的所有最近页面。
在历史记录配置菜单中,您还将看到最近访问页面的列表。结果按“当前产品/版本”和“全部”单选按钮过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。
如果在历史记录配置菜单中选择“全部”,则将启用“在历史记录栏中显示产品详细信息”的复选框选项。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。
可以使用页面顶部的搜索字段搜索 API 文档和指南。
在 API 文档页面上,还有一个过滤器输入字段,该字段使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读过滤类成员。这是通过使用页面顶部的复选框完成的。
API 类导航树底部的复选框过滤类列表,以包含或排除私有类。
单击空的搜索字段将显示您最近 10 次搜索,以便快速导航。
每个 API 文档页面(Javascript 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项
Ext.button.Button
类具有 Ext.Button
的备用类名称)。备用类名称通常为了向后兼容性而维护。可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。
类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或右上角的展开/折叠全部切换按钮全局展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小尺寸优化的视图。桌面和“移动”视图之间的主要区别在于
可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“view source”链接来查看类成员的源代码。
以下是一些 npm (node package manager) 故障排除的技巧和窍门。
Ext JS 30 天试用包可从公共 npm 安装。使用以下命令安装最新的 Ext JS 版本,然后跳到步骤 2。
$ npm install -g @sencha/ext-gen
Ext JS 和所有相关的商业包都托管在 Sencha 的私有 npm 注册表中。使用以下命令登录注册表,该命令将 npm 配置为从 Sencha 的注册表下载 @sencha 范围内的包。
用户名注意
在支持门户激活期间(购买许可证后)使用的电子邮件和密码将用于登录 Sencha 的 NPM 仓库。用户名与使用的电子邮件相同,但是,@
字符替换为 '..' 两个句点。例如 [email protected]
转换为用户名:name..gmail.com
$ npm login --registry=https://npm.sencha.com/ --scope=@sencha
$ npm install -g @sencha/ext-gen
https://extjs.cn/extjs/7.0.0-CE/index.html
如果遇到身份验证问题 (403) 或校验和错误,可以使用这些步骤来重置 npm 系统。
rm ~/.npmrc
- 删除存储的 npm 仓库凭据。此位置在您的系统上可能有所不同。npm cache clean --force
或 rm -rf ~/.npm
- 通过删除 npm 包缓存来清理它。npm login --registry=https://npm.sencha.com --scope=@sencha
- 重新登录到仓库。npm install -g @sencha/ext-gen
或 npm install -g @sencha/ext-react-gen
del %HOMEPATH%\.npmrc
- 删除存储的 npm 仓库凭据。此位置在您的系统上可能有所不同。npm cache clean --force
或 rmdir /s /q %HOMEPATH%\AppData\Roaming\npm
- 清理 npm 包。rmdir /s /q %HOMEPATH%\AppData\Roaming\npm-cache
- 通过删除 npm 缓存来清理它。npm login --registry=https://npm.sencha.com --scope=@sencha
- 重新登录到仓库。npm install -g @sencha/ext-gen
或 npm install -g @sencha/ext-react-gen
当 npm.sencha.com
上出现授权错误时。
首先要做的是验证您是否已通过我们的仓库正确身份验证,方法是验证您是否已在 .npmrc 文件中获得访问令牌。
type .npmrc
。cat .npmrc
。npm login --registry=https://npm.sencha.com --scope=@sencha
并再次登录 npm 仓库。npm --registry https://npm.sencha.com whoami
测试您的授权。npm install -g @sencha/ext-gen
或 npm install -g @sencha/ext-react-gen
以验证您已登录。高级组件要求您已在 商店的产品矩阵中购买了高级组件。如果您尚未购买产品的高级组件,当您尝试为产品的高级组件运行 npm install
时,它将抛出 403 异常。
有时可能需要重置项目中的 node 包/依赖项。
rmdir /s /q node_modules
删除项目中的 node_modules 目录。npm install
再次下载依赖项。rm -rf node_modules
删除项目中的 node_modules 目录。npm install
再次下载依赖项。当您使用 ExtGen 生成应用程序时,会提供两个 npm 构建脚本以帮助您入门。第一个脚本是 dev
。dev
脚本将构建应用程序的开发版本并在浏览器中启动它。第二个脚本是 build
脚本。此脚本旨在创建应用程序的生产就绪版本。
与 Sencha Cmd 一样,您的 app.json 将在 builds
对象中包含构建配置文件。默认情况下,桌面构建配置文件指定为您要在 build
脚本中用于构建生产应用程序的构建配置文件。您可以通过为 --env.profile
设置脚本参数来指定要在 npm 脚本中使用的构建配置文件,如下所示
"dev": "webpack-dev-server --env.profile=phone --env.browser=yes --env.verbose=no",
"build": "npm run clean && cross-env webpack --env.profile=desktop --env.environment=production --env.treeshake=yes"
在 app.json 中添加构建配置文件时,您必须查看它并验证所有路径是否存在。例如,如果您使用 ext-gen 生成应用程序,请确保 {build.id}/some/path 存在于您的项目中。确保您浏览整个 app.json 并验证所有路径都存在于您的代码中。
当 app.json 属性路径不存在时,会出现此错误。
% sencha app build
Sencha Cmd v7.X.X.X
[INF] Processing Build Descriptor : desktop (production environment)
[INF] Loading compiler context
[INF] Loading app json manifest...
[ERR] Failed to resolve dependency MyExtGenApp.Application for file MyExtGenApp.app.$Application
[ERR]
[ERR] BUILD FAILED
[ERR] com.sencha.exceptions.ExNotFound: Unknown definition for dependency : MyExtGenApp.Application
[ERR]
[ERR] Total time: 3 seconds
...
一旦您从项目中的 app.json 添加缺失的路径,它就会构建。