ExtReact 产品的文档与其他 Sencha 产品的文档有所不同。以下部分描述了除另有说明为 ExtReact
特有的所有产品的文档。
许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 alias
(如果类扩展了 Ext.Component,则为 xtype
)。别名/xtype 列在适用类的类名旁边,以供快速参考。
ExtReact 组件类在 API 类文档的顶部显着位置列出可配置的名称,后跟完全限定的类名。
框架类或其成员可以指定为 private
或 protected
。否则,类/成员为 public
。Public
、protected
和 private
是访问描述符,用于传达类或类成员应如何以及何时使用。
Public 类和类成员可供任何其他类或应用程序代码使用,并且可以在主要产品版本中作为稳定和持久的内容依赖。公共类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的 public
成员,旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
Private 类和类成员在框架内部使用,不供应用程序开发人员使用。私有类和成员可能会在任何时候更改或从框架中省略,恕不另行通知,不应在应用程序逻辑中依赖。
ExtReact 组件类将配置选项显示为 props
ExtReact 组件类不将属性列为专用成员类型,而是列为 read only
props
static
标签。*请参阅下面的静态。下面是一个示例类成员,我们可以剖析它以显示类成员的语法(在本例中是从 Ext.button.Button 类查看的 lookupComponent 方法)。
让我们看一下成员行的每个部分
lookupComponent
)( item )
)Ext.Component
)。对于不返回除 undefined
之外的任何内容的方法,可以省略此项,或者可以显示为由斜杠 /
分隔的多个可能值,表示返回的内容可能取决于方法调用的结果(即,如果 get 方法调用成功,方法可能返回 Component,如果失败,则返回 false
,这将显示为 Ext.Component/Boolean
)。PROTECTED
- 请参阅下面的标志部分)Ext.container.Container
)。如果成员源自当前类,则源类将显示为蓝色链接;如果成员从祖先类或混入类继承,则显示为灰色。view source
)item : Object
)。undefined
之外的值,“返回值”部分将注明返回的类或对象类型以及描述(示例中为 Ext.Component
)Available since 3.4.0
- 示例中未显示),紧接在成员描述之后Defaults to: false
)API 文档使用许多标志来进一步沟通类成员的功能和意图。标签可以用文本标签、缩写或图标表示。
除非装饰为 immutable
,否则所有 ExtReact props 都是 bindable
Immutable ExtReact props 在实例化组件时不能用作可配置的 prop
classInstance.method1().method2().etc();
false
,则标记为可阻止的事件将不会触发- 表示框架类
- Singleton 框架类。*有关更多信息,请参阅 singleton 标志
- 组件类型的框架类(Ext JS 框架中扩展 Ext.Component 的任何类)
- 表示类、成员或指南在当前查看的版本中是新的
- 表示 config
类型的类成员
或者在 ExtReact 组件类的情况下,这表示 prop
类型的成员
- 表示 property
类型的类成员
- 表示 method
类型的类成员
- 表示 event
类型的类成员
- 表示 theme variable
类型的类成员
- 表示 theme mixin
类型的类成员
- 表示类、成员或指南在当前查看的版本中是新的
在 API 文档页面的类名称正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮都显示按类型划分的成员计数(此计数会随着应用过滤器而更新)。单击按钮会将您导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。
与类配置选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中,紧挨着它们所使用的配置下方。Getter 和 Setter 方法文档将在配置行中找到,以便于参考。
ExtReact 组件类不会将 Getter/Setter 方法提升到 prop 中。所有方法都将在 Methods
部分中描述
您的页面历史记录保存在本地存储中,并显示在顶部标题栏下方(使用可用的实际空间)。默认情况下,显示的唯一搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选选项来扩展显示的内容。这将显示历史记录栏中所有产品/版本的所有最近页面。
在历史记录配置菜单中,您还将看到最近页面访问的列表。结果按“当前产品/版本”和“全部”单选选项过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。
如果在历史记录配置菜单中选择“全部”,则将启用“在历史记录栏中显示产品详细信息”复选框选项。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也将显示产品/版本作为工具提示。
可以使用页面顶部的搜索字段搜索 API 文档和指南。
在 API 文档页面上,还有一个过滤器输入字段,它使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读过滤类成员。这是通过使用页面顶部的复选框完成的。
API 类导航树底部的复选框过滤类列表以包含或排除私有类。
单击空的搜索字段将显示您最近 10 次搜索,以便快速导航。
每个 API 文档页面(Javascript 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项
Ext.button.Button
类具有 Ext.Button
的备用类名称)。维护备用类名称通常是为了向后兼容性。可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。
类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或全局使用右上角的展开/折叠所有切换按钮来展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面视图和“移动”视图之间的主要区别在于
可以通过单击 API 文档页面顶部的类名称来查看类源代码。可以通过单击成员行右侧的“view source”链接来查看类成员的源代码。
图表包由一系列类组成,这些类提供数据可视化功能。这些包括系列、坐标轴、交互以及用于实现标记和图例的机制。本指南概述了这些类如何联系在一起以及每个类中包含哪些功能。以下部分涵盖了特定的坐标轴、系列和交互。
所有类型的图表组件都从 AbstractChart 类扩展而来,AbstractChart 类又扩展了 Ext.draw.Container。图表组件是用于管理系列和坐标轴的容器。它负责在每次尺寸更改时布局系列和坐标轴。抽象类的实现必须覆盖 performLayout
方法。例如,图表需要响应坐标轴厚度的变化并重新计算系列区域。
有三种类型的图表
笛卡尔图表是最常用的图表,并映射到 'chart' 的 xtype。设置 'chart' 的 xtype
假设您想要一个 柱状图、折线图、散点图 或 区域图。其他类型的图表可以指定为 'polar' 或 'spacefilling'。
图表组件管理以下项目
我们提供 Ext.chart.axis.Axis 来表示各种坐标轴。坐标轴对象根据其停靠位置以不同的方式工作。
坐标轴帮助系列将数据值映射到坐标。它们绑定到需要表示的数据类型。
可以通过为坐标轴设置不同类型的坐标轴 layout 和坐标轴 segmenter 来轻松更改坐标轴的行为。
Series 是一个抽象类,由具体的可视化扩展而来,例如折线系列、柱状系列或散点系列。
Series 类本身包含所有这些系列共有的代码,例如事件处理、高亮、标记、标签等等。
以下部分描述了可用的系列类型。它还显示了一个完整的系列配置示例,包括图表、坐标轴和系列选项。有关更具体的信息,请参阅 Series 文档。
Area 系列创建一个堆叠区域图,通常用于显示多个聚合的信息层。与其他系列类似,区域系列必须添加到图表的 series 配置中。
您可以在堆叠系列(例如区域系列和柱状系列)上指定多个 y 字段。
import { Component } from '@angular/core'
declare var Ext: any;
@Component({
selector: 'app-root-1',
styles: [``],
template: `
<cartesian
[store]="this.store"
[series]="cartesianSeries"
[axes]="cartesianAxes"
fitToParent="true"></cartesian>
`
})
export class ExampleComponent {
store = Ext.create('Ext.data.Store', {
fields: ['name', 'data1', 'data2', 'data3'],
data: [
{ 'name': 'metric one', 'data1': 10, 'data2': 12, 'data3': 14 },
{ 'name': 'metric two', 'data1': 7, 'data2': 8, 'data3': 16 },
{ 'name': 'metric three', 'data1': 5, 'data2': 2, 'data3': 14 },
{ 'name': 'metric four', 'data1': 2, 'data2': 14, 'data3': 6 },
{ 'name': 'metric five', 'data1': 27, 'data2': 38, 'data3': 36 }
]
})
cartesianAxes = [{
type: 'category',
position: 'bottom',
fields: ['name'],
title: {
text: 'Sample Values',
fontSize: 15
}
}];
cartesianSeries = [{
type: 'area',
xField: 'name',
yField: ['data1', 'data2', 'data3']
}];
}
Bar 系列创建一个可堆叠或分组的柱状图,通常用于显示显示进展或回归的分类数字数据。请注意,与旧的图表包相反,柱状系列指的是垂直柱状系列或列系列。您可以通过将图表的 flipXY 设置为 true 来获得水平配置。
柱状系列可以是堆叠的或分组的。您可以将系列的 stacked 配置设置为 false,以便将系列切换到分组模式。
import { Component } from '@angular/core'
declare var Ext: any;
@Component({
selector: 'app-root-1',
styles: [``],
template: `
<cartesian
[store]="this.store"
[series]="cartesianSeries"
[axes]="cartesianAxes"
fitToParent="true"></cartesian>
`
})
export class ExampleComponent {
store = Ext.create('Ext.data.Store', {
fields: ['name', 'data1', 'data2', 'data3'],
data: [
{ 'name': 'metric one', 'data1': 10 },
{ 'name': 'metric two', 'data1': 7 },
{ 'name': 'metric three', 'data1': 5 },
{ 'name': 'metric four', 'data1': 2 },
{ 'name': 'metric five', 'data1': 2 }
]
})
cartesianAxes = [{
type: 'category',
position: 'bottom',
fields: ['name'],
title: {
text: 'Sample Values',
fontSize: 15
}
}, {
type: 'numeric',
position: 'left',
fields: 'data1'
}];
cartesianSeries = [{
type: 'bar',
xField: 'name',
yField: 'data1'
}];
}
Line 系列创建一个折线图,它是柱状图的替代方案,用于显示显示进展或回归的分类数字数据。
import { Component } from '@angular/core'
declare var Ext: any;
@Component({
selector: 'app-root-1',
styles: [``],
template: `
<cartesian
[store]="this.store"
[series]="cartesianSeries"
[axes]="cartesianAxes"
[interactions]="['rotate']"
fitToParent="true"></cartesian>
`
})
export class ExampleComponent {
store = Ext.create('Ext.data.Store', {
fields: ['name', 'data1', 'data2', 'data3'],
data: [
{ name: 'metric one', data1: 14, data2: 19 },
{ name: 'metric two', data1: 16, data2: 7 },
{ name: 'metric three', data1: 11, data2: 25 },
{ name: 'metric four', data1: 6, data2: 4 },
{ name: 'metric five', data1: 36, data2: 12 }
]
})
cartesianAxes = [{
type: 'numeric',
position: 'left',
fields: ['data1'],
title: {
text: 'Sample Values',
fontSize: 15
},
grid: true,
minimum: 0
}, {
type: 'category',
position: 'bottom',
fields: ['name'],
title: {
text: 'Sample Values',
fontSize: 15
}
}];
cartesianSeries = [{
type: 'line',
style: {
stroke: '#30BDA7',
lineWidth: 2
},
xField: 'name',
yField: 'data1',
marker: {
type: 'path',
path: ['M', - 4, 0, 0, 4, 4, 0, 0, - 4, 'Z'],
stroke: '#30BDA7',
lineWidth: 2,
fill: 'white'
}
}, {
type: 'line',
fill: true,
style: {
fill: '#96D4C6',
fillOpacity: .6,
stroke: '#0A3F50',
strokeOpacity: .6,
},
xField: 'name',
yField: 'data2',
marker: {
type: 'circle',
radius: 4,
lineWidth: 2,
fill: 'white'
}
}];
}
Pie 系列创建一个饼图,这是显示多个类别的定量信息的好方法,这些类别作为一个整体也具有意义,例如,给定年份的所有 12 个月。
import { Component } from '@angular/core'
declare var Ext: any;
@Component({
selector: 'app-root-1',
styles: [``],
template: `
<polar
[store]="this.store"
[series]="polarSeries"
theme="green"
[interactions]="['rotate']"
fitToParent="true"></polar>
`
})
export class ExampleComponent {
store = Ext.create('Ext.data.Store', {
fields: ['name', 'data1'],
data: [
{ name: 'metric one', data1: 14 },
{ name: 'metric two', data1: 16 },
{ name: 'metric three', data1: 14 },
{ name: 'metric four', data1: 6 },
{ name: 'metric five', data1: 36 }
]
})
polarSeries = [{
type: 'pie',
angleField: 'data1',
donut: 30,
label: {
field: 'name',
display: 'rotate'
},
}];
}
Radar 系列创建一个雷达图,这是显示受约束的类别数量的不同定量值的比较的好方法。
import { Component } from '@angular/core'
declare var Ext: any;
@Component({
selector: 'app-root-1',
styles: [``],
template: `
<polar
[store]="this.store"
theme="green"
[series]="polarSeries"
[axes]="polarAxes"
[interactions]="['rotate']"
fitToParent="true"></polar>
`
})
export class ExampleComponent {
store = Ext.create('Ext.data.Store', {
fields: ['name', 'data1'],
data: [
{ name: 'metric one', data1: 14 },
{ name: 'metric two', data1: 16 },
{ name: 'metric three', data1: 14 },
{ name: 'metric four', data1: 6 },
{ name: 'metric five', data1: 36 }
]
})
polarAxes = [{
type: 'numeric',
position: 'radial',
fields: 'data1',
style: {
estStepSize: 10
},
grid: true
}, {
type: 'category',
position: 'angular',
fields: 'name',
style: {
estStepSize: 1
},
grid: true
}];
polarSeries = [{
type: 'radar',
angleField: 'name',
radiusField: 'data1',
style: {
fillStyle: '#388FAD',
fillOpacity: .1,
strokeStyle: '#388FAD',
strokeOpacity: .8,
lineWidth: 1
}
}];
}
Scatter 系列创建一个散点图,使应用程序能够在同一可视化中显示两个以上的变量。这些变量可以映射到 x、y 坐标,也可以映射到元素的属性,例如半径、大小、颜色等等。
import { Component } from '@angular/core'
declare var Ext: any;
@Component({
selector: 'app-root-1',
styles: [``],
template: `
<cartesian
[store]="this.store"
[series]="cartesianSeries"
[axes]="cartesianAxes"
[interactions]="['rotate']"
fitToParent="true"></cartesian>
`
})
export class ExampleComponent {
store = Ext.create('Ext.data.Store', {
fields: ['name', 'data1', 'data2', 'data3'],
data: [
{ name: 'metric one', data1: 14, data2: 19 },
{ name: 'metric two', data1: 16, data2: 7 },
{ name: 'metric three', data1: 11, data2: 25 },
{ name: 'metric four', data1: 6, data2: 4 },
{ name: 'metric five', data1: 36, data2: 12 }
]
});
cartesianAxes = [{
type: 'numeric',
position: 'left',
fields: ['data1'],
title: {
text: 'Sample Values',
fontSize: 15
},
grid: true,
minimum: 0
}, {
type: 'category',
position: 'bottom',
fields: ['name'],
title: {
text: 'Sample Values',
fontSize: 15
}
}];
cartesianSeries = [{
type: 'scatter',
highlight: {
size: 12,
radius: 12,
fill: '#96D4C6',
stroke: '#30BDA7'
},
fill: true,
xField: 'name',
yField: 'data2',
marker: {
type: 'circle',
fill: '#30BDA7',
radius: 10,
lineWidth: 0
}
}];
}
Gauge 系列创建一个仪表盘图,通常用于显示某个变量的进度。除了使用 stores 之外,您还可以设置仪表盘系列的 value 以显示该值。
import { Component } from '@angular/core'
declare var Ext: any;
@Component({
selector: 'app-root-1',
styles: [``],
template: `
<polar
[store]="this.store"
[series]="polarSeries"
fitToParent="true"></polar>
`
})
export class ExampleComponent {
store = Ext.create('Ext.data.Store', {
fields: ['name', 'data1', 'data2', 'data3'],
data: [{
mph: 65,
fuel: 50,
temp: 150,
rpm: 6000
}]
})
polarSeries = [{
type: 'gauge',
angleField: 'mph',
needle: true,
donut: 30
}];
}
本节介绍 Sencha Charts 包中的交互功能。通过利用这些功能,您可以创建高度交互式的图表,使用户能够可视化和导航复杂的数据集。
要向图表添加交互,请将图表的 interactions 配置设置为交互配置对象的数组。每个对象必须是字符串,或者必须包含与后续章节中描述的交互类型之一匹配的类型属性。每个对象还可以包含适用于特定交互的其他配置选项。
您可以通过扩展 Ext.chart.interactions.Abstract 类并使用带有 "interaction" 前缀的别名注册名称来定义自己的交互。例如,如果您想创建一个名为 "remove" 的交互,请创建名为 "interaction.remove" 的类的别名,然后在交互配置中设置 type: 'remove'
。
以下是几个基本交互的示例。
"itemhighlight" 交互使您能够在图表上高亮显示单个数据点项目。
此交互由 Ext.chart.interactions.ItemHighlight 类实现。有关详细的配置选项,请参阅类文档。
默认情况下,"rotate" 交互使用户可以通过拖动手势来旋转饼图或雷达图。以下代码片段是如何向饼图或雷达图添加 rotate 交互的示例,非常简单
interactions: ['rotate']
此交互由 Ext.chart.interactions.Rotate 类实现。有关详细的配置选项,请参阅类文档。
图表公开了一个数据存储,用于表示从系列中收集的图例信息。 从技术上讲,您可以对此数据存储执行任何操作。 同样,此架构可以帮助您将图例信息与图例组件解耦,因此您可以使用任何技术和自定义来在任何想要的位置显示图例。
为了您的方便,我们还提供了一个默认的 Legend 组件,该组件已经实现了一些用于显示图例的常用和基本功能。 图表配置对象接受一个 legend
部分来启用默认的 Legend 组件并将其停靠在图表中。 默认的 Legend 组件包含一个 dock 配置,并停靠在该侧。