文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护

在初始化items配置期间或添加新项时将原始配置对象添加到此容器时调用,或添加或{@link #insert 插入}。

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

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

参数

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 基本类型页面)都有一个与该类相关的元数据的菜单视图。此元数据视图将包含以下一项或多项

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源

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

Sencha Inspector


顶部

检查桌面应用程序

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

  • 使用浏览器“书签”,它不会向你的应用程序添加任何代码
  • 使用 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上运行。

您的应用程序现在可以在http://localhost: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。这将允许您在http://localhost: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中,将以下 include 添加到<x-compile>

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

检查已部署的应用程序

此方法依赖于使用“书签小工具”在应用程序和 Sencha Inspector 之间建立连接。如果您要连接到以下 Ext JS 或 Touch 应用程序,则应使用此方法

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

使用此方法有一些缺点。例如,如果您通过书签小工具连接,您不能使用 Sencha Inspector 检查应用程序的主题。

通过书签小工具连接应用程序

什么是“书签小工具”?

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

配置书签小工具

Sencha Inspector 提供了一种为要检查的应用程序配置书签小工具的方法。

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

  2. 单击窗口叠加中的“创建书签小工具”按钮

  3. 将屏幕上的按钮拖动到浏览器中的书签栏;这将创建一个带有适用于 Sencha Inspector 的适当书签小工具代码的新书签。(注意:您可以通过单击“高级设置”来更改书签小工具的设置)

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

  5. 单击您创建的书签小工具。

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

学习路径

Sencha Inspector