瀑布图
配置属性
图表容器
width
可选, number
功能描述： 设置图表宽度。
默认配置： 400
height
可选, number
功能描述： 设置图表高度。
默认配置： 400
forceFit
可选, boolean
功能描述： 图表是否自适应容器宽高。当 forceFit 设置为 true 时，width 和 height 的设置将失效。
默认配置： true
pixelRatio
可选, number
功能描述： 设置图表渲染的像素比
默认配置： 2
renderer
可选, string
功能描述: 设置图表渲染方式为 canvas 或 svg
默认配置： canvas
数据映射
data 📌
必选, array object
功能描述： 设置图表数据源
默认配置： 无
数据源为对象集合，例如：[{ type: 'a'，value: 20 }, { type: 'b'，value: 20 }]。
meta
可选, object
功能描述： 全局化配置图表数据元信息，以字段为单位进行配置。在 meta 上的配置将同时影响所有组件的文本信息。
默认配置： 无
| 细分配置项名称 | 类型 | 功能描述 |
|---|---|---|
| alias | string | 字段的别名 |
| formatter | function | callback 方法，对该字段所有值进行格式化处理 |
| values | string[] | 枚举该字段下所有值 |
| range | number[] | 字段的数据映射区间，默认为[0,1] |
const data = [
{ country: 'Asia', year: '1750', value: 502,},
{ country: 'Asia', year: '1800', value: 635,},
{ country: 'Europe', year: '1750', value: 163,},
{ country: 'Europe', year: '1800', value: 203,},
];
const areaPlot = new PercentageStackArea(document.getElementById('container'), {
title: {
visible: true,
text: '百分比堆叠面积图',
},
data,
meta: { year: { alias:'年份' range: [0, 1], }, value: { alias: '数量', formatter:(v)=>{return `${v}个`} } }, xField: 'year',
yField: 'value',
stackField: 'country',
});
areaPlot.render();xField 📌
必选, string
功能描述： 柱形在 x 方向位置映射对应的数据字段名，一般对应一个分类字段。
默认配置： 无
yField 📌
必选, string
功能描述： 柱形在 y 方向高度映射所对应的数据字段名，一般对应一个离散字段。
默认配置： 无
colorField
可选, string
功能描述：柱形颜色映射对应的数据字段名。从基础柱状图的使用场景来说，我们不推荐对柱形进行额外的颜色映射。
默认配置： 无
图形样式
color
可选, string | string[] | Function
功能描述： 指定瀑布图柱形颜色。
- string： 指定值为单值时，配置瀑布图柱子的颜色
-
object： 指定值为一个对象数组时，可配置涨跌和总计值颜色，可选值如下：
rising正值柱形填充颜色falling负值柱形填充颜色total总计值柱形填充颜色，可选
默认配置：
rising: '#f4664a';
falling: '#30bf78';
total: 'rgba(0, 0, 0, 0.25)';用法示例：
// 指定单值
color: '#000000'
// 指定颜色为一个对象数组
color:{
rising:'red',
falling:'blue',
total:'green'
}waterfallStyle ✨
可选, object
功能描述： 设置柱子样式。waterfallStyle 中的fill会覆盖 color 的配置。waterfallStyle 可以直接指定，也可以通过 callback 的方式，根据数据为每一根柱子指定单独的样式。
默认配置： 无
| 细分配置 | 类型 | 功能描述 |
|---|---|---|
| fill | string | 填充颜色 |
| stroke | string | 描边颜色 |
| lineWidth | number | 描边宽度 |
| lineDash | number | 虚线描边 |
| opacity | number | 整体透明度 |
| fillOpacity | number | 填充透明度 |
| strokeOpacity | number | 描边透明度 |
图表组件
title
可选, optional
功能描述： 配置图表的标题，默认显示在图表左上角。
默认配置：
visible: false,
alignTo: 'left',
text:'',
style:{
fontSize: 18,
fill: 'black',
}| 细分配置 | 类型 | 功能描述 |
|---|---|---|
| visible | boolean | 是否显示 |
| alignTo | string | 位置，支持三种配置： 'left' |
| style | object | 样式： - fontSize: number 文字大小 - fill: string 文字颜色 - stroke: string 描边颜色 - lineWidth: number 描边粗细 - lineDash: number 虚线描边 - opacity: number 透明度 - fillOpacity: number 填充透明度 - strokeOpacity: number 描边透明度 |
description
可选, optional
功能描述： 配置图表的描述，默认显示在图表左上角，标题下方。
默认配置：
visible: false,
alignTo: 'left',
text:'',
style:{
fontSize: 12,
fill: 'grey',
}| 细分配置 | 类型 | 功能描述 |
|---|---|---|
| visible | boolean | 是否显示 |
| alignTo | string | 位置，支持三种配置： 'left' |
| style | object | 样式： - fontSize: number 文字大小 - fill: string 文字颜色 - stroke: string 描边颜色 - lineWidth: number 描边粗细 - lineDash: number 虚线描边 - opacity: number 透明度 - fillOpacity: number 填充透明度 - strokeOpacity: number 描边透明度 |
xAxis
可选, object
功能描述： x 方向上的坐标轴，用于展示 xField 对应的映射信息
默认配置：
visible: true,
grid: {
visible: false,
},
line: {
visible: true
},
tickLine: {
visible: true,
},
label: {
visible: true,
autoRotate: true,
autoHide: true
},
title: {
visible: false,
offset: 12,
},| 细分配置 | 类型 | 功能描述 |
|---|---|---|
| visible | boolean | 是否可见 |
| line | object | 坐标轴轴线 - visible: boolean 是否可见 - style：object 轴线样式 |
| grid | object | 网格线 - visible: boolean 是否可见 - line：object 网格线样式 |
| label | object | 坐标轴标签 - visible: boolean 是否可见 - formatter: function 坐标轴标签格式化 - suffix: string 后缀 - offsetX: number 位置在 x 方向上的偏移量 - offsetY：number 位置在 y 方向上的偏移量 - style：object 样 -autoHide: boolean 是否自动隐藏 -autoRotate: boolean 是否自动旋转 |
| tickLine | object | 坐标轴刻度 - visible：boolean 是否可见 - style: object 样式 |
| title | object | 坐标轴标题 - visible： boolean 是否可见 - text: string 标题文字 - offset: number 位置偏移量 - style：object 样式 |
yAxis
可选, object
功能描述： y 方向上的坐标轴，用于展示 yField 对应的映射信息
默认配置：
visible: true,
grid: {
visible: true,
},
line: {
visible: false,
},
tickLine: {
visible: false,
},
label: {
visible: true,
autoRotate: true,
autoHide: true
},
title: {
visible: true,
offset: 12,
},| 细分配置 | 类型 | 功能描述 |
|---|---|---|
| visible | boolean | 是否可见 |
| tickCount | number | 坐标轴刻度数量 |
| tickInterval | number | 坐标轴刻度间隔 |
| min | number | 设置坐标轴最小值 |
| max | number | 设置坐标轴最大值 |
| line | object | 坐标轴轴线 - visible: boolean 是否可见 - style：object 轴线样式 |
| grid | object | 网格线 - visible: boolean 是否可见 - line：object 网格线样式 |
| label | object | 坐标轴标签 - visible: boolean 是否可见 - formatter: function 坐标轴标签格式化 DEMO - suffix: string 后缀 - precision：number 标签精度，如配置为 2，则格式化为 2 位小数 - offsetX: number 位置在 x 方向上的偏移量 - offsetY：number 位置在 y 方向上的偏移量 - style：object 样 -autoHide: boolean 是否自动隐藏 -autoRotate: boolean 是否自动旋转 |
| tickLine | object | 坐标轴刻度 - visible：boolean 是否可见 - style: object 样式 |
| title | object | 坐标轴标题 - visible： boolean 是否可见 - text: string 标题文字 - offset: number 位置偏移量 - style：object 样式 |
tooltip
可选, object
功能描述：信息提示框
默认配置：
visible: true,
offset: 20,| 细分属性 | 类型 | 功能描述 |
|---|---|---|
| visible | boolean | 是否显示 |
| offset | number | 距离鼠标位置偏移值 |
| domStyles | object | 配置 tooltip 样式 - g2-tooltip: object 设置 tooltip 容器的 CSS 样式 - g2-tooltip-title: object 设置 tooltip 标题的 CSS 样式 - g2-tooltip-list: object 设置 tooltip 列表容器的 CSS 样式 - g2-tooltip-marker: object 设置 tooltip 列表容器中每一项 marker 的 CSS 样式 - g2-tooltip-value: object 设置 tooltip 列表容器中每一项 value 的 CSS 样式 |
| fields | string | 设置 tooltip 内容字段，默认为[ xField, '$$value$$' ] |
| formatter | object | 对 tooltip items 进行格式化，入参为 tooltip fields 对应数值，出参为格式为{name:'a',value:1} |
label
功能描述： 标签文本
默认配置：
visible: false
position: 'middle'
style:{
fill: 'rgba(0, 0, 0, 0.65)',
stroke: '#ffffff',
lineWidth: 2,
}| 细分配置 | 类型 | 功能描述 |
|---|---|---|
| visible | boolean | 是否显示 |
| position | string | label 的位置 - top 位于柱子顶部 - middle 位于柱子垂直中心 - bottom 位于柱子底部 |
| formatter | function | 对文本标签内容进行格式化 |
| offsetX | number | 在 label 位置的基础上再往 x 方向的偏移量 |
| offsetY | number | 在 label 位置的基础上再往 y 方向的偏移量 |
| style | object | 配置文本标签样式。 |
leaderLine ✨
可选, object
功能描述： 是否显示柱子间的连接线以及连接线的样式
默认配置：
visible: true,
style: {
stroke: '#d3d3d3',
lineDash: [4, 2],
lineWidth: 1
}| 细分配置 | 类型 | 功能描述 |
|---|---|---|
| visible | boolean | 是否显示 |
| style | object | 配置连接线样式 |
showTotal ✨
可选, object
功能描述：是否显示总计值以及总计值的标签设置
默认配置：
visible: true;| 细分配置 | 类型 | 功能描述 |
|---|---|---|
| visible | boolean | 是否显示 |
| label | string | 总计值文本标签 |
diffLabel ✨
可选, object
功能描述： 差值 label，显示在柱子头部
默认配置：
visible: true;| 细分配置 | 类型 | 功能描述 |
|---|---|---|
| visible | boolean | 是否显示差值标签 |
| formatter | function | 文本标签格式化 |
| style | object | 设置差值 label 样式 |
guideLine
可选, object[]
功能描述： 配置图表辅助线，支持同时配置多条。
默认配置： 无
| 细分配置 | 类型 | 功能描述 |
|---|---|---|
| type | string | 含有统计意义的辅助线类型，可选类型为 max |
| start | array | 指定辅助线起始位置，如不配置type，则该辅助线为自定义辅助线，start是必选项。支持两种配置形式，两者不能混用： - 原始数据值，如 ['2010-01-01', 100] - 绘图区域百分比位置，如 ['50%', '50%'] |
| end | array | 指定辅助线终止位置，如不配置type，则该辅助线为自定义辅助线，end 是必选项。支持两种数据形式，两者不能混用： - 原始数据值，如 ['2010-01-01', 100] - 绘图区域百分比位置，如 ['50%', '50%'] |
| lineStyle | object | 配置辅助线样式。 |
| text | object | 设置辅助线文本。 - position: string 辅助线文本位置，可选项：start、center、end - content: string 辅助线文本内容 - offsetX: number 位置在 x 方向上的偏移量 - offsetY: number 位置在 y 方向上的偏移量 - style: object 文本样式 |
配置统计辅助线示例代码：
{
guideLine: [
{
type: 'mean',
lineStyle: {},
text: {},
},
],
}配置自定义辅助线示例代码：
{
guideLine: [
{
start: ['2010-01-01', 100] || ['0%', '50%'],
end: ['2010-01-10', 50] || ['100%', '80%'],
lineStyle: {},
text: {},
},
],
}事件
柱形图形事件
| onColumnClick 柱形点击事件 |
onColumnDblClick 柱形双击事件 |
onColumnDblClick 柱形双击事件 |
onColumnMouseleave 柱形鼠标离开事件 |
|---|---|---|---|
| onColumnMousemove 柱形鼠标移动事件 |
onColumnMousedown 柱形鼠标按下事件 |
onColumnMouseup 柱形鼠标松开事件 |
onColumnMouseenter 柱形鼠标进入事件 |
图表区域事件
| onPlotClick 图表区域点击事件 |
onPlotDblClick 图表区域双击事件 |
onPlotDblClick 图表区域双击事件 |
onPlotMouseleave 图表区域鼠标离开事件 |
|---|---|---|---|
| onPlotMousemove 图表区域鼠标移动事件 |
onPlotMousedown 图表区域鼠标按下事件 |
onPlotMouseup 图表区域鼠标松开事件 |
onPlotMouseenter 图表区域鼠标进入事件 |
图例事件
| onLegendClick 图例点击事件 |
onLegendDblClick 图例双击事件 |
onLegendMouseenter 图例鼠标进入事件 |
onLegendMouseleave 图例鼠标离开事件 |
|---|---|---|---|
| onLegendMousemove 图例鼠标移动事件 |
onLegendMousedown 图例鼠标按下事件 |
onLegendMouseup 图例鼠标松开事件 |
onLegendMouseenter 图例鼠标进入事件 |
坐标轴事件
| onAxisClick 坐标轴点击事件 |
onAxisDblClick 坐标轴双击事件 |
onAxisDblClick 坐标轴双击事件 |
onAxisMouseleave 坐标轴鼠标离开事件 |
|---|---|---|---|
| onAxisMousemove 坐标轴鼠标移动事件 |
onAxisMousedown 坐标轴鼠标按下事件 |
onAxisMouseup 坐标轴鼠标松开事件 |
onAxiMouseenter 坐标轴鼠标进入事件 |
图形标签事件
| onLabelClick 图形标签点击事件 |
onLabelDblClick 图形标签双击事件 |
onLabelDblClick 图形标签双击事件 |
onLabelMouseleave 图形标签鼠标离开事件 |
|---|---|---|---|
| onLabelMousemove 图形标签鼠标移动事件 |
onLabelMousedown 图形标签鼠标按下事件 |
onLabelMouseup 图形标签鼠标松开事件 |
onLabelMouseenter 图形标签鼠标进入事件 |
标题事件
| onTitleClick 标题点击事件 |
onTitleDblClick 标题双击事件 |
onTitleDblClick 标题双击事件 |
onTitleMouseleave 标题鼠标离开事件 |
|---|---|---|---|
| onTitleMousemove 标题鼠标移动事件 |
onTitleMousedown 标题鼠标按下事件 |
onTitleMouseup 标题鼠标松开事件 |
onTitleMouseenter 标题鼠标进入事件 |
描述事件
| onDescriptionClick 标题点击事件 |
onDescriptionDblClick 标题双击事件 |
onDescriptionDblClick 标题双击事件 |
onDescriptionMouseleave 标题鼠标离开事件 |
|---|---|---|---|
| onDescriptionMousemove 标题鼠标移动事件 |
onDescriptionMousedown 标题鼠标按下事件 |
onDescriptionMouseup 标题鼠标松开事件 |
onDescriptionMouseenter 标题鼠标进入事件 |
图表方法
render() 📌
必选
渲染图表。
updateConfig()
可选
更新图表配置项。
plot.updateConfig({
width: 500,
height: 600,
legend: {
visible: false,
},
});
plot.render();changeData()
可选
更新图表数据。updateConfig()方法会导致图形区域销毁并重建，如果只进行数据更新，而不涉及其他配置项更新，推荐使用本方法。
plot.changeData(newData);repaint()
可选
图表画布重绘。
destroy()
可选
销毁图表。
getData()
获取图表数据。
getPlotTheme()
获取图表 theme。
设计规范