文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
protected

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

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

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

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

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

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

Sencha Inspector


顶部

检查桌面应用

有三种基本方法可以将您的应用程序与 Sencha Inspector 连接

  • 使用浏览器“bookmarklet”,这不会向您的应用程序添加任何代码
  • 使用 Sencha Cmd 运行 sencha app watch 并添加一个特殊的标志
  • 向应用程序的 app.jsonApplication.js 文件添加几行代码

哪种方法更适合您取决于几个因素

  • 您(或不)想更改应用程序中的任何代码
  • 应用程序是否由 Sencha Cmd 本地托管
  • 您的目标是检查一个 可能远程部署的应用程序
  • 您的目标是检查您 当前正在开发的本地计算机上的应用程序

每种方法都有其优点和缺点,但它们都相对容易使用。

配置开发版本

如果您计划在开发阶段使用 Sencha Inspector,尤其是在使用 Sencha Cmd 的情况下,则应使用此方法。如果您正在使用 Sencha Cmd,这也将允许您检查 应用程序主题 (Ext JS 6+),这提供了一种强大的动态主题方法。

要配置开发应用程序,您有两种选择

  • 使用 Sencha Cmd 运行 sencha app watch 并添加一个特殊的标志
  • 向应用程序的 app.jsonApplication.js 文件添加几行代码

使用 Sencha Cmd 直接连接

无需向应用程序添加任何代码,您可以运行 sencha app watch --inspect 来启动 Sencha Cmd Web 服务器。额外的 --inspect 标志将自动注入一些代码,将您的应用程序连接到 Sencha Inspector。

注意: 在运行该命令之前,请确保 Sencha Inspector 已在您机器的 端口 1839 上运行。

您的应用程序现在可以在浏览器中以 https://127.0.0.1:1841 查看,并且 Sencha Inspector 应该会自动检测到它并允许您检查应用程序。

配置应用程序以进行连接

或者,您可以添加几行代码,将您的应用程序连接到 Sencha Inspector。

首先,打开 app.json 并找到“js”数组。接下来,编辑它以包含以下行

 "js" : [

      ..//existing scripts

      {
           // default settings
           "path" : "http://local.senchainspector.com:1839/inspector.js",

           // Or Use your Machine Name
           //"path" : "http://MyComputerName:1839/inspector.js",

           // Or Use your IP Address
           //"path" : "http://123.456.78.90:1839/inspector.js",

           "remote"    : true,
           "bootstrap" : true
      }

 ]

将此配置添加到 app.json 后,您还需要向您的应用程序添加初始化代码。找到 {appRoot}/app/Application.js,然后修改它以包含 launch() 方法,如下例所示。

 //Do not modify entire Application.js - "DemoClient" is just an example name  

 Ext.define('DemoClient.Application', {  
      extend: 'Ext.app.Application',       
      name: 'DemoClient',  

      stores: [  
           'Users'  
      ],  

      //Add Sencha Inspector init to launch function  
      launch: function () {
          // <debug>
          try {
              /**
               * init() defaults to "http://local.senchainspector.com:1839"
               * so we don't have to pass a URL
               */
              SenchaInspector.init();


              /**
               * NOTE: The URL needs to match what you defined in app.json.
               * If you connected app.json via a machine name or IP address,
               * you'll need to explicitly configure that here too
               */
              // SenchaInspector.init('http://MyComputerName:1839');
          } catch (e) {}
          // </debug>
      }
  });  

请注意,我们将对 init() 的调用包装在调试标志内。Sencha Cmd 将在生产构建期间忽略这些块之间的所有代码。

最后,使用 Sencha Cmd 运行 sencha app watch。这将允许您在浏览器中以 https://127.0.0.1:1841 预览您的应用程序。如果配置正确,Sencha Inspector 应该会自动检测到它并允许您检查应用程序。

连接 Ext JS 4.2.x 应用程序

Sencha Inspector 也适用于 Ext JS 4.2.x 应用程序。但是,您需要采取与上述步骤略有不同的步骤。

对于 Ext JS 4.2.x 应用程序,您需要将以下代码添加到您的 Application.js 文件中

launch: function() { 
    SenchaInspector.init(); 
}

然后,在 index.html 中,将以下包含项添加到 <x-compile> 块中

<script type="text/javascript" src="http://local.senchainspector.com:1839/inspector.js"></script>

检查已部署的应用程序

此方法依赖于使用“bookmarklet”来设置应用程序和 Sencha Inspector 之间的连接。如果您的连接是 Ext JS 或 Touch 应用程序,则应使用此方法,该应用程序是

  • 已部署
  • 不在本地计算机上运行
  • 未使用 Sencha Command 构建

使用此方法一些缺点。例如,如果通过 bookmarklet 连接,则无法使用 Sencha Inspector 检查应用程序的主题。

通过 Bookmarklet 连接应用程序

什么是“bookmarklet”?

“bookmarklet”是一小段 JavaScript 代码,作为浏览器内的书签保存。您通过在浏览器中单击 bookmarklet 来使用它,就像使用常规书签一样。然后,JavaScript 代码将在加载它的页面上执行。

配置 Bookmarklet

Sencha Inspector 提供了一种为要检查的应用程序配置 bookmarklet 的方法。

  1. 单击 Sencha Inspector 主窗口顶部工具栏中的“连接您的应用程序...”按钮。

  2. 单击窗口叠加层中的“创建 Bookmarklet”按钮

  3. 将屏幕上的按钮拖到浏览器中的书签栏;这将创建一个新的书签,其中包含 Sencha Inspector 的相应 bookmarklet 代码。(注意:您可以通过单击“高级设置”来更改 bookmarklet 的设置)

  4. 在浏览器中打开您要检查的应用程序

  5. 单击您创建的 bookmarklet。

如果您按照上述所有步骤操作,Sencha Inspector 应该会检测到您的应用程序并允许您检查它。

学习路径

Sencha Inspector