文档帮助

内容

术语、图标和标签访问级别成员类型成员语法成员标记类图标成员图标导航和功能类成员快速导航菜单 Getter 和 Setter 方法历史记录栏搜索和筛选 API 文档类元数据展开和折叠示例和类成员桌面 -vs- 移动视图查看类源

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private 或 protected。否则，类/成员为 public。Public、protected 和 private 是访问描述符，用于传达类或类成员应该如何以及何时使用。

Public 类和类成员可供任何其他类或应用程序代码使用，并且可以依赖它们在主要产品版本中稳定且持久。Public 类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的 public 成员，旨在供拥有类或其子类使用。Protected 成员可以通过子类安全地扩展。
Private 类和类成员由框架内部使用，不打算供应用程序开发人员使用。Private 类和成员可能会随时在不通知的情况下更改或从框架中省略，并且不应在应用程序逻辑中依赖它们。

成员类型

Config - 类的配置选项。
Property - 在实例化类后设置一次。*请参见下面的只读。
Method - 可以由类执行的操作。方法应读取为实例方法，只能从给定类的实例调用。可以直接从类本身调用的静态方法将在方法名称旁边有一个 static 标签。*请参见下面的静态。
Event - 事件特定于框架事件系统，允许类以编程方式引发事件，由一个或多个事件处理程序方法处理。DOM 事件虽然由框架事件系统处理，但不会在 API 文档中具体描述。*有关 DOM 事件，请参阅 MDN 的事件参考页面。
Theme Variable - 框架采用的视觉主题引擎使用的变量。
Theme Mixin - 框架采用的视觉主题引擎使用的函数，并且可能使用在各种主题变量中设置的值。

成员语法

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

Ext.container.Container

查看源

lookupComponent ( item ) : Ext.Component

protected

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

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

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

参数

item : Object

要添加的配置对象。

Ext.Component

要添加的组件。

我们来看看成员行中的每一部分

展开/折叠 - 在成员行的左侧是一个用于展开和折叠每个成员行以显示/隐藏成员详细信息的控件。
成员名称 - 类成员的名称（在本例中为 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 文档页面的类名称正下方是与当前类拥有的成员类型相对应的按钮行。每个按钮显示按类型划分的成员数（此计数在应用筛选器时更新）。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示一个弹出菜单，其中包含所有该类型的成员，以便快速导航。

Getter 和 Setter 方法

与类配置选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单中与它们一起工作的配置正下方的配置部分。Getter 和 Setter 方法文档将位于配置行中，以便于参考。

历史记录栏

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

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

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

搜索和筛选器

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

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

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

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

API 文档类元数据

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

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

展开和折叠示例和类成员

默认情况下，可运行示例（小提琴）在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换全部状态将在页面加载之间记住。

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

桌面 -vs- 移动视图

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

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

查看类源

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

Ext JS 7.8.0 - Classic Toolkit

显示私有类

顶部

指南适用于： classic

内容

小部件列了解“widget”配置行主体组件。什么是小部件？使用小部件自定义小部件

在网格中使用组件

自 ExtJS 5.0 以来，开发人员可以使用小部件列类在网格单元格中嵌入组件。

从 ExtJS 6.2.0 开始，开发人员可以使用行小部件插件配置组件，使其显示在数据行下方（或可配置地显示在上方）的扩展行中。

在本指南中，我们将介绍如何在网格单元格或扩展行中嵌入组件。

小部件列

小部件列允许你轻松地将任何组件嵌入到网格单元格中。添加小部件列非常简单。只需将列的 xtype 指定为 “widgetcolumn”，并指定其 widget 配置。widget 配置是一个包含要为每个单元格创建的 xtype 的对象。此 xtype 可以引用任何 Ext.Widget 或 Ext.Component 类。

使用小部件列向网格添加 Sparkline 小部件，你可以完成大量的数据可视化，如下所示。

有关上图的实时示例，请访问小部件网格。

说够了，让我们看看实际操作。在以下示例中，我们使用一组小记录创建了一个 store，该记录填充了一个带有小部件列的网格。

小部件列包含一个进度条小部件，该小部件被添加到每一行。

展开代码

JS 运行

var store = Ext.create('Ext.data.Store', {
    fields: ['name','progress'],
    data: [
        { name: 'Test 1', progress: 0.10 },
        { name: 'Test 2', progress: 0.23 },
        { name: 'Test 3', progress: 0.86 },
        { name: 'Test 4', progress: 0.31 }
    ]
});

Ext.create({
    xtype: 'grid',
    title: 'Widget Column Demo',
    store: store,

    columns: [{
        text: 'Test Number',
        dataIndex: 'name',
        width: 100
    }, {
        xtype: 'widgetcolumn',
        text: 'Progress',
        width: 120,
        dataIndex: 'progress',
        widget: {
            xtype: 'progressbarwidget',
            textTpl: '{value:percent}'
        }
    }],

    width: 220,
    height: 250,
    renderTo: document.body
});

了解“widget”配置

小部件列的 widget 配置用于定义要嵌入到单元格中的组件类型。根据 widget 配置中包含的 xtype，小部件列将创建并管理所需组件实例的生命周期。此配置不能已经是实例，因为小部件列需要每个呈现的单元格一个实例。

每个实例都自动与网格中的特定记录和行连接。在网格的生命周期中，为一行创建的小部件将被“回收”并连接到不同的记录和行。

列的 dataIndex 引用的字段绑定到嵌入式组件的 defaultBindProperty。

从 6.2.0 开始，网格中嵌入的组件可以访问 ViewModel 及其所有数据。ViewModel 包含两个特定于行的属性

record
recordIndex

行主体组件。

行小部件插件允许开发人员指定一个组件，以非常类似于使用小部件列的方式嵌入到扩展行中

要启用此功能，请使用 widget 属性配置 RowWidget 插件

plugins: [{
    ptype: 'rowwidget',

    // The widget definition describes a widget to be rendered into the expansion row.
    // It has access to the application's ViewModel hierarchy. Its immediate ViewModel
    // contains a record and recordIndex property. These, or any property of the record
    // (including association stores) may be bound to the widget.
    widget: {
        xtype: 'form'
        ...

嵌入式组件可以访问网格的 ViewModel，包括 record 和 recordIndex 属性。

网格可以使用 rowViewModel 设置进行配置，该设置可以指定要创建的 ViewModel 的 type，其中可能包括自定义数据和公式，以帮助为小部件提供数据。

请参阅行小部件网格

什么是小部件？

Ext.Widget 类，或简称“小部件”，是一个轻量级类，类似于组件，但仅由 Ext.dom.Element 和关联的侦听器组成。这使得小部件与普通组件有很大不同，因为 Ext.Widget 类不是从 Ext.Component 派生的。组件提供强大的生命周期管理，增加了大量功能。但是，此功能需要付出一些代价。

我们使用 ExtJS 提供了一些库存小部件。其中包括

进度条 (Ext.Progress 或“progressbarwidget”)
滑块 (Ext.slider.Widget 或“sliderwidget”)
火花线 (Ext.sparkline.*)
- 线 (“sparklineline”)
- 条 (“sparklinebar”)
- 离散 (“sparklinediscrete”)
- 项目符号 (“sparklinebullet”)
- 饼图 (“sparklinepie”)
- 框 (“sparklinebox”)
- 三态 (“sparklinetristate”)

使用小部件

与普通组件一样，小部件可以添加到容器的 items 中。例如，我们可以将火花线添加到工具栏

展开代码

JS 运行

var panel = Ext.create({
    xtype: 'panel',
    title: 'Title',
    frame: true,
    renderTo: document.body,
    width: 250, 
    height: 150,
    html: 'Some text',
    tbar: [{
        text: 'Button'
    }, '->', {
        xtype: 'sparklineline',
        fillColor: '#ddf',
        width: 100,
        height: 20,
        values: [2, 3, 0, 4, -1]
    }]
});

对于火花线，您必须提供大小（width 和 height）或使用 ExtJS 布局管理器来执行此操作。这是因为内部绘图没有自然大小。

自定义小部件

虽然 ExtJS 附带了滑块和进度条的“小部件化”版本以及新的火花线，但很可能会有您希望创建自己的小部件的情况。是派生自 Ext.Component 还是 Ext.Widget 的决定实际上取决于所创建类的复杂性。
简单的组件通常可以避免组件生命周期和布局等内容，只需将配置属性映射到关联的元素，同时响应元素事件（如“click”、“dblclick”、“mouseover”等）。

要创建小部件，请扩展 Ext.Widget 并定义您的元素模板及其侦听器。

Ext.define('MyWidget', {
    extend: 'Ext.Widget',

    // The element template - passed to Ext.Element.create()
    element: {
        reference: 'element',
        listeners: {
            click: 'onClick'
        },
        children: [{
            reference: 'innerElement',
            listeners: {
                click: 'onInnerClick'
            }
        }]
    },

    constructor: function(config) {
        // Initializes our element from the template, and calls initConfig().
        this.callParent([config]);

        // After calling the superclass constructor, the Element is available and
        // can safely be manipulated.  Reference Elements are instances of
        // Ext.Element, and are cached on each Widget instance by reference name.
    },

    onClick: function() {
       // Listeners use this Widget instance as their scope
        console.log('element clicked', this);
    },

    onInnerClick: function() {
        // Access the innerElement reference by name
        console.log('inner element clicked', this.innerElement);
    }
});

对于编写过 ExtJS Modern 组件的人来说，这会感觉非常熟悉。这是因为 Ext.Widget 是 ExtJS Modern 中 Ext.AbstractComponent 的增强版本。向 element 模板添加 listeners 的功能是其中一项增强功能，但还有其他一些功能。有关更多详细信息，请参阅 Ext.Widget 的文档。