ExtReact 文档帮助

介绍

ExtReact 产品的文档与其他 Sencha 产品的文档有所不同。以下部分描述了除另有说明为 ExtReact 独有的产品之外的所有产品的文档。

术语、图标和标签

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

ExtReact 组件类在 API 类文档的顶部突出显示可配置的名称,后跟完全限定的类名。

访问级别

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

成员类型

成员语法

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

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

  • 展开/折叠 - 在成员行的左侧是一个控件,用于展开和折叠每个成员行以显示/隐藏成员详细信息。
  • 成员名称 - 类成员的名称(本例中为 lookupComponent
  • 方法参数 (Method Param) - 方法使用的任何必需或可选参数(或传递给事件处理程序方法的参数)将列在方法名称旁边的括号内(本例中为 ( item )
  • 返回类型 (Return type) - 方法或属性返回的类实例或 javascript 对象(在本例中为 Ext.Component)。对于除了 undefined 之外不返回任何内容的方法,或者可能显示为由正斜杠 / 分隔的多个可能值,则可以省略此项,这表示返回的内容可能取决于方法调用的结果(即,如果 get 方法调用成功,则方法可能返回 Component,如果失败,则返回 false,这将显示为 Ext.Component/Boolean)。
  • 标志 (Flags) - 适用于成员的任何标志将显示在旁边(本例中为 PROTECTED - 请参阅下面的标志部分)
  • 成员来源 (Member Origin) - 在成员行的右侧是最初描述成员的类(本例中为 Ext.container.Container)。如果成员源自当前类,则源类将显示为蓝色链接,如果是从祖先类或混入类继承而来,则显示为灰色链接。
  • 成员源代码 (Member Source) - 在成员来源类右侧下方是一个链接,用于查看成员的源代码(示例中的 view source
  • 参数列表 (Params List) - 类方法的每个参数都将使用上面括号中找到的相同名称、预期的类或对象类型以及参数的描述列出(示例中为 item : Object)。
  • 返回值 (Returns) - 如果类返回 undefined 以外的值,则“返回值 (Returns)”部分将注释返回的类或对象的类型以及描述(示例中为 Ext.Component
  • Since示例中未显示)- 某些成员将显示成员首次引入的产品版本(即 Available since 3.4.0 - 示例中未显示),紧接在成员描述之后
  • Default示例中未显示)- Configs 通常显示要应用于类实例的默认配置值(如果未被覆盖)(即 Defaults to: false

成员标志

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

  • Required(必需)- 实例化类时必需的配置
  • Bindable(可绑定)- 配置具有 setter,允许通过 ViewModel 绑定设置此配置

    所有 ExtReact props 都是 bindable,除非装饰为 immutable

  • Immutable(不可变)

    不可变的 ExtReact props 在实例化组件时不能用作可配置的 prop

  • Read Only(只读)- 属性可以读取,但不能用于在运行时配置/重新配置类实例
  • Singleton(单例)- 单例类在定义后立即实例化,不能手动实例化
  • Static(静态)- 静态方法或属性是属于类本身的方法或属性,而不是类的实例
  • Chainable(可链式调用)- 指的是在调用时返回类实例的方法。
    这使得可以进行链式方法调用,如:classInstance.method1().method2().etc();
  • Deprecated(已弃用)- 计划在未来的框架版本中删除的类或成员,并在当前版本中提供以实现向后兼容性。
    已弃用的类和成员将包含一条消息,指导您未来使用的首选类/方法。
  • Removed(已移除)- 仅在文档中存在的已移除的类或成员,作为在框架版本之间升级的用户的参考
  • Template(模板)- 在基类中定义的方法,旨在被子类覆盖
  • Abstract(抽象)- 类或成员可以定义为抽象的。抽象类和成员建立类结构并提供有限的(如果有的话)代码。特定于类的代码将通过子类中的覆盖提供。
  • Preventable(可阻止)- 如果事件处理程序返回 false,则标记为 preventable 的事件将不会触发

类图标

- 表示框架类

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

- 组件类型的框架类(Ext JS 框架中扩展 Ext.Component 的任何类)

- 表示类、成员或指南在当前查看的版本中是新的

成员图标

- 表示类型为 config 的类成员

或者在 ExtReact 组件类的情况下,这表示类型为 prop 的成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

- 表示类型为 theme variable 的类成员

- 表示类型为 theme mixin 的类成员

- 表示类、成员或指南在当前查看的版本中是新的

类成员快速导航菜单

在 API 文档页面的类名正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮都显示按类型划分的成员计数(此计数会随着过滤器的应用而更新)。单击按钮会将您导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。

Getter 和 Setter 方法

与类 config 选项相关的 Getter 和 setter 方法将显示在方法部分以及 API 文档和成员类型菜单的 configs 部分中,就在它们所使用的 config 下方。Getter 和 setter 方法文档将在 config 行中找到,以便于参考。

ExtReact 组件类不会将 getter/setter 方法提升到 prop 中。所有方法都将在 Methods 部分中描述

历史记录栏

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

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

如果在历史记录配置菜单中选择“全部 (All)”,则将启用“在历史记录栏中显示产品详细信息 (Show product details in the history bar)”复选框选项。选中后,每个历史页面的产品/版本将在历史记录栏中的页面名称旁边显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。

搜索和过滤器

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

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

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

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

API 文档类元数据

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

  • Alternate Name(备用名称)- 一个或多个额外的类名称同义词(在 Ext JS 6.0.0 中,Ext.button.Button 类具有 Ext.Button 的备用类名称)。备用类名称通常为了向后兼容性而维护。
  • Hierarchy(层次结构)- 层次结构视图列出了当前类的继承链,从其祖先类一直到根基类。
  • Mixins(混入)- 混入当前类的类列表
  • Inherited Mixins(继承的混入)- 混入当前类的祖先的类列表
  • Requires(需要)- 实例化类所需定义的所有类
  • Uses(使用)- 类在其生命周期的某个时刻可能使用,但不一定最初实例化类所需的类列表
  • Subclasses(子类)- 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面与移动视图

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

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

查看类源代码

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

ExtAngular 7.5.0


顶部

ExtAngular 数据包

ExtAngular 中许多处理大量数据的组件(如网格和图表)都使用 ExtAngular 数据包中的类来加载、排序、过滤和准备数据以进行显示。本指南解释了使用 ExtAngular 数据包的基础知识。

Ext.data.Store

Ext.data.Store 类用于将数据加载到网格、树、列表、图表、D3 可视化等中。此示例显示了 Ext.data.StoreGrid 的典型用法

import { Component } from '@angular/core';
declare var Ext: any;

@Component({
    selector: 'app-root-1',
    styles: [``],
    template: `
    <grid title="Users" [store]="this.store" fitToParent="true">
        <column text="Name" dataIndex="name"></column>
        <column text="Email" dataIndex="email"></column>
    </grid>
    `
})
export class ExampleComponent {
    store = Ext.create('Ext.data.Store', {
        fields: ['name', 'email'],
        data: [
          { name: 'Tim Smith', email: '[email protected]' },
          { name: 'Jill Lindsey', email: '[email protected]' }
        ]
      });
}

存储可以配置 fields 数组或 model。上面的示例通过 data 配置使用内联数据。在大多数实际应用程序中,您将使用 proxy 配置您的存储以从服务器获取数据。

Ext.data.Proxy

存储可以通过设置 proxy 配置从服务器获取数据,该配置采用 Ext.data.proxy.Proxy 子类的配置选项。我们可以修改之前的示例中的存储,以使用 Ext.data.proxy.Ajaxusers.json 获取数据

store = Ext.create('Ext.data.Store', {
  fields: ['name', 'email'],
  autoLoad: true,
  proxy: {
    type: 'ajax', // refers to the alias "proxy.ajax" on Ext.data.proxy.Ajax
    url: 'users.json'
  }
})

在这里,我们将 autoLoad 配置设置为 true,以便在创建存储后立即获取数据。我们也可以设置 autoLoad: false,稍后通过调用来获取数据

this.store.load();

排序

您可以通过指定 sorters 配置来对存储中的数据进行排序

store = Ext.create('Ext.data.Store', {
  fields: ['name', 'email'],
  autoLoad: true,
  proxy: {
    type: 'ajax', // refers to the alias "proxy.ajax" on Ext.data.proxy.Ajax
    url: 'users.json'
  },
  sorters: [{
    property: 'email',
    direction: 'ASC'
  }]
})

或通过调用 sort 方法

this.store.sort([{
  property: 'email',
  direction: 'ASC'
}])

默认情况下,排序在客户端完成。您可以通过在存储上设置 remoteSort: true 来配置服务器端排序。当 remoteSort 设置为 true 时,代理将随每个请求一起发送 sorters 配置作为参数。例如

users.json?sort=[{"property":"email","direction":"ASC"}]

过滤

您可以通过指定 filters 配置来过滤存储中的数据

store = Ext.create('Ext.data.Store', {
  fields: ['name', 'email'],
  autoLoad: true,
  proxy: {
    type: 'ajax', // refers to the alias "proxy.ajax" on Ext.data.proxy.Ajax
    url: 'users.json'
  },
  filters: [{
    property: 'email',
    value: /@sencha.com$/
  }]
})

或使用自定义过滤器函数

filters: [{
  filterFn: record => record.get('email').match(/@sencha.com$/i)
}]

我们还可以通过调用 filterBy 方法来过滤存储中的数据

this.store.filterBy(record => record.get('email').match(/@sencha.com$/i));

我们可以通过调用来删除任何现有过滤器

this.store.clearFilters();

与排序一样,默认情况下,过滤在客户端完成。我们可以设置 remoteFilter: true 以在服务器上过滤。当 remoteFilter 设置为 true 时,filters 配置将作为参数随每个请求一起发送。例如

users.json?filter=[{"property":"email","value":"@sencha.com"}]

链式存储

当存储被过滤或排序时,所有使用它的组件都会自动刷新。有时我们希望在一个组件中显示所有数据,而在另一个组件中显示数据的子集。我们可以通过使用 Ext.data.ChainedStore 来做到这一点。

例如,我们可以在一个网格中显示所有用户,而在另一个网格中仅显示特定域中的用户

import { Component } from '@angular/core'
declare var Ext: any;

@Component({
    selector: 'app-root-1',
    styles: [``],
    template: `
    <container layout="vbox">
      <grid [title]="'All Users'" [store]="allUsers">
        ...
      </grid>
      <grid [title]="'Sencha Users'" [store]="senchaUsers">
        ...
      </grid>
    </container>
    `
})
export class ExampleComponent {
    allUsers = Ext.create('Ext.data.Store', {
      autoLoad: true,
      proxy: {
        type: 'ajax',
        url: 'users.json'
      }
    });

    senchaUsers = Ext.create('Ext.data.ChainedStore', { 
      source: allUsers, 
      filters: [{ 
        property: 'email', 
        value: '@sencha.com' 
      }] 
    });
}

Ext.data.Model

存储可以配置 fields 数组或 model。实际上,指定 fields 数组会创建一个隐式模型。模型允许您在多个存储中重用一组字段。模型还为我们提供了一种定义用于解释数据的可重用逻辑的方法。这是一个定义模型的示例

Ext.define('MyApp.model.User', {
  extend: 'Ext.data.Model',
  fields: [
    { name: 'name', type: 'string' },
    { name: 'email', type: 'string' },
    { name: 'age', type: 'integer' },
    { name: 'active', type: 'boolean', defaultValue: true, convert: value => value == 'Yes' }
  ]
});

在上面的示例中,我们使用 convert 配置来处理自定义数据格式,在本例中,将“Yes”转换为 true,并将所有其他值转换为 false

请注意,Ext.define 的第一个参数(在本例中为“MyApp.model.User”)是我们想要创建的类的名称。它将作为全局变量导出。如果我们不想导出全局变量,我们可以简单地指定 null 作为第一个参数。例如

export default Ext.define(null, {
  extend: 'Ext.data.Model',
  ...
})

计算字段

模型可以定义其值从其他字段计算得出的字段。例如

Ext.define('MyApp.model.Substance', {
  fields: [{
    name: 'volume',
    type: 'float'
  }, {
    name: 'mass',
    type: 'float'
  }, { 
    name: 'density',
    calculate: ({ volume, mass }) => volume / mass
  }]
})

访问字段数据

我们可以使用 get 方法访问模型字段的值

record.get('email');

所有具体的(非计算的)字段都可通过 data 属性获得

const { name, email } = record.data;

ExtAngular 7.5.0