文档帮助

术语、图标和标签

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

访问级别

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

Public 类和类成员可供任何其他类或应用程序代码使用，并且在主要产品版本中可以作为稳定和持久的类和成员来依赖。公共类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的 public 成员，旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
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

受保护的

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

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

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

参数

item : Object

正在添加的配置对象。

返回值

Ext.Component

要添加的组件。

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

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

成员标志

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

Required - 实例化类时需要的配置
Bindable - 配置具有 setter，允许通过 ViewModel 绑定设置此配置
Read Only - 属性可以读取，但不能用于在运行时配置/重新配置类实例
Singleton - Singleton 类在定义后立即实例化，不能手动实例化
Static - 静态方法或属性是属于类本身的方法或属性，而不是类的实例
Chainable - 指的是在调用时返回类实例的方法。
这使得可以进行链式方法调用，例如：classInstance.method1().method2().etc();
Deprecated - 计划在未来框架版本中删除的类或成员，并在当前版本中提供以实现向后兼容性。
已弃用的类和成员将包含一条消息，指导您将来使用的首选类/方法。
Removed - 已删除的类或成员，仅在文档中存在，作为用户在框架版本之间升级的参考
Template - 在基类中定义的方法，旨在由子类重写
Abstract - 类或成员可以定义为抽象的。抽象类和成员建立类结构并提供有限的（如果有的话）代码。特定于类的代码将通过子类中的重写来提供。
Preventable - 如果从事件处理程序返回 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 原始页面除外）都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

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

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

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

查看类源代码

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

GXT 4.x

显示私有类

顶部

GXT 3.0 绘图和图表

参考

图表入门 - 图表入门。
图表轴 - 有关图表轴配置的更多信息。
图表系列 - 有关图表系列配置的更多信息。
ListStore - 有关列表存储配置的更多信息。

演示

绘图和图表

在 GWT 中绘制对象一直是一个挑战，因为 SVG 和 VML 不受开箱即用的支持。在现代 Web 应用程序中，拥有图表或其他丰富的交互式视觉效果非常有用，尤其是在数据量大的应用程序中，可视化关系和想法非常重要。

目前，Ext GWT 2.0 提供了此功能，但它依赖于第三方 Flash 库 Open Flash Chart。虽然此库满足了对可视化的需求，但缺乏可扩展性和自定义性。在 Ext GWT 3.0 中，我们通过提供一个可在任何地方运行的绘图框架来解决此问题，从 IE6 到最新的 Chrome，该框架被开发为纯 GWT 库。

绘图引擎

Ext GWT 3.0 通过新的绘图系统使这一切成为可能，该系统为浏览器选择适当的渲染引擎。Draw 包使用一个名为 Surface 的抽象类，该类在编译期间被用户代理的适当绘图引擎替换。SVG 引擎默认用于大多数浏览器，VML 引擎用于 IE 6、7 和 8。这一切都在幕后无缝发生，从而允许所有浏览器之间的视觉奇偶校验。

<replace-with class='com.sencha.gxt.chart.client.draw.engine.SVG'>
  <when-type-is class='com.sencha.gxt.chart.client.draw.Surface' />
</replace-with>

<replace-with class='com.sencha.gxt.chart.client.draw.engine.VML'>
  <when-type-is class='com.sencha.gxt.chart.client.draw.Surface' />
  <any>
    <when-property-is name='user.agent' value='ie6' />
    <when-property-is name='user.agent' value='ie8' />
  </any>
</replace-with>

绘图精灵

draw 包的根是 DrawComponent。DrawComponent 是一个组件，它为视觉元素提供类似画布的区域。DrawComponent 的场景由来自表面引擎渲染的各种几何基元的精灵组成，范围从椭圆到文本。

DrawComponent component = new DrawComponent(600, 400);

支持渐变，并且可以代替任何颜色属性使用。

CircleSprite circle = new CircleSprite();
circle.setCenterX(30);
circle.setCenterY(100);
circle.setRadius(25);
Scaling scale = new Scaling();
scale.setX(2);
scale.setY(2);
circle.setScaling(scale);
circle.setStroke(new Color("#999"));
Gradient gradient = new Gradient("gradient", 21);
gradient.addStop(0, new Color("#79A933"));
gradient.addStop(13, new Color("#70A333"));
gradient.addStop(34, new Color("#559332"));
gradient.addStop(58, new Color("#277B2F"));
gradient.addStop(86, new Color("#005F27"));
gradient.addStop(100, new Color("#005020"));
circle.setFill(gradient);
component.addGradient(gradient);
circle.setStrokeWidth(3);
component.add(circle);

PathSprite 是最低级别的精灵元素，它允许开发人员手动设置精灵的矢量元素。我们通过使用强类型 PathCommands 使路径系统更易于使用。PathSprite 还提供了有用的辅助函数，例如线条平滑。

PathSprite path = new PathSprite();
path.addCommand(new MoveTo(75, 75));
path.addCommand(new CurveTo(0, -25, 50, 25, 50, 0, true));
path.addCommand(new CurveTo(0, -25, -50, 25, -50, 0, true));
path.setStroke(new Color("#000"));
path.setStrokeWidth(2);
path.setFill(new Color("#fc0"));
path.setFillOpacity(0.25);
component.add(path);

图表示例

为了更好地理解新的图表系统，让我们来看一个示例。

Store

图表中使用的数据从 store 访问。在此示例中，ValueProviders 用于将数据链接到图表的相应区域。ValueProvider 实例接受模型对象并返回一个值。每个 Series 都设计为接受某种类型的值，并且只接受提供该类型的 ValueProviders。虽然您可以实现自己的 ValueProvider 实例，但如果您的数据模型具有 getter 和 setter，则可以定义 PropertyAccess 类型以根据需要提供 ValueProvider 实例。在此示例中，我们使用 Movies 类，该类具有多个 double 类型的属性，每个属性都有自己的 getter 和 setter。每种类型代表给定年份的发行数量。有关 ListStore 配置的更多信息。

public interface MoviesPropertyAccess extends PropertyAccess<Movies> {
  ValueProvider<Movies, Double> action();
  ValueProvider<Movies, Double> comedy();
  ValueProvider<Movies, Double> drama();
  ValueProvider<Movies, Double> thriller();
  ValueProvider<Movies, Integer> year();
  ModelKeyProvider<Movies> yearKey();
}

private static final MoviesPropertyAccess moviesAccess = GWT.create(MoviesPropertyAccess.class);

@Override
public Widget asWidget() {
  final ListStore<Movies> store = new ListStore<Movies>(moviesAccess.yearKey());
  store.addAll(TestData.getMovieData(2005, 4, 0, 10000));

  final Chart<Movies> chart = new Chart<Movies>(600, 400);
  chart.setStore(store);
  chart.setChartShadow(true);
  chart.setAnimated(true);
  //...
}

轴

轴有多种类型，并添加到它们将出现的图表中。每个位置的图表只能使用一个轴。然后，您从 store 链接 ValueProviders 以提供轴使用的数据集。此示例还显示了标题、网格和子刻度步骤的配置。NumericAxis 将在 store 中的值之间进行插值，而 CategoryAxis 将仅使用 store 中的值。某些图表需要一个特殊的 Axis，该 Axis 对于该图表是唯一的 - 例如 Gauge 和 Radar。有关图表轴配置的更多信息。

NumericAxis<Movies> axis = new NumericAxis<Movies>();
axis.setPosition(Position.BOTTOM);
axis.addField(moviesAccess.comedy());
axis.addField(moviesAccess.action());
axis.addField(moviesAccess.drama());
axis.addField(moviesAccess.thriller());
axis.setDisplayGrid(true);
chart.addAxis(axis);

CategoryAxis<Movies> catAxis = new CategoryAxis<Movies>();
catAxis.setPosition(Position.LEFT);
catAxis.addField(moviesAccess.year());
chart.addAxis(catAxis);

图例

图例提供图表中表示的数据的键。图例适应添加到图表的系列，并使用与该系列中表示的数据集类型相关的项目。图例是最终用户突出显示或隐藏图表中数据的简便方法。

Legend<Movies> legend = new Legend<Movies>();
legend.setPosition(Position.RIGHT);
chart.setLegend(legend);

系列

Series 的功能与 Axis 类似。每个系列代表不同的图表类型，例如饼图或雷达图。首先，您添加 ValueProviders 以访问 Series 中表示的数据。接下来，您添加与 Series 关联的颜色。有关图表系列配置的更多信息。

BarSeries<Movies> bar = new BarSeries<Movies>();
bar.setyAxisPosition(Position.BOTTOM);
bar.addyField(moviesAccess.comedy());
bar.addyField(moviesAccess.action());
bar.addyField(moviesAccess.drama());
bar.addyField(moviesAccess.thriller());
bar.addColor(new RGB(148, 174, 10));
bar.addColor(new RGB(17, 95, 166));
bar.addColor(new RGB(166, 17, 32));
bar.addColor(new RGB(255, 136, 9));
bar.setStacked(true);
chart.addSeries(bar);

将图表类型分离到系列中而不是将它们作为图表本身的一部分的优点是，各种图表类型可以混合在一起。在下面的示例中，散点图、折线图和条形图系列都用于同一图表。