logoCreated with Sketch.

G2Plot

GroupedRose - 分组玫瑰图

阅读时间约 7 分钟

快速上手

import { Rose } from '@antv/g2plot';

const data = [
  {
    type: '分类一',
    value: 27,
    user: '用户一',
  },
  {
    type: '分类二',
    value: 25,
    user: '用户一',
  },
  {
    type: '分类三',
    value: 18,
    user: '用户一',
  },
  {
    type: '分类四',
    value: 15,
    user: '用户一',
  },
  {
    type: '分类五',
    value: 10,
    user: '用户一',
  },
  {
    type: '其它',
    value: 5,
    user: '用户一',
  },
  {
    type: '分类一',
    value: 7,
    user: '用户二',
  },
  {
    type: '分类二',
    value: 5,
    user: '用户二',
  },
  {
    type: '分类三',
    value: 38,
    user: '用户二',
  },
  {
    type: '分类四',
    value: 5,
    user: '用户二',
  },
  {
    type: '分类五',
    value: 20,
    user: '用户二',
  },
  {
    type: '其它',
    value: 15,
    user: '用户二',
  },
];

const rosePlot = new GroupedRose(document.getElementById('container'), {
  data,
  radiusField: 'value',
  categoryField: 'type',
  groupField: 'user',
  label: {
    visible: true,
    type: 'inner',
  },
});

rosePlot.render();

配置属性

图表容器

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 上的配置将同时影响所有组件的文本信息。

默认配置： 无

细分配置项名称类型功能描述
aliasstring字段的别名
formatterfunctioncallback方法，对该字段所有值进行格式化处理
valuesstring[]枚举该字段下所有值
rangenumber[]字段的数据映射区间，默认为[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();

radiusField 📌

必选, string

功能描述：扇形切片半径长度所对应的数据字段名。

categoryField 📌

必选, string

功能描述：扇形切片分类所对应的数据字段名（每个扇形的弧度相等）。

groupField 📌

必选, string

功能描述： 数据集中的分组字段名，通过该字段的值，玫瑰图中的扇形切片将会被分为多个组，通过颜色进行区分

图形样式

radius ✨

可选, number

功能描述： 玫瑰图的半径，原点为画布中心。配置值域为 [0,1]，0 代表玫瑰图大小为 0，即不显示，1 代表玫瑰图撑满绘图区域。

默认配置： 0.8, 即 width / 2 * 0.8。

color

可选, string | string[] | Function

功能描述： 指定扇形颜色，即可以指定一系列色值，也可以通过回调函数的方法根据对应数值进行设置。

默认配置：采用 theme 中的色板。

用法示例：

// 配合颜色映射，指定多值
colorField:'type',
color:['blue','yellow','green']
//配合颜色映射，使用回调函数指定色值
colorField:'type',
color:(d)=>{
    if(d==='a') return 'red';
    return 'blue';
}

sectorStyle ✨

可选, object

功能描述： 设置扇形样式。sectorStyle中的fill会覆盖 color 的配置。sectorStyle可以直接指定，也可以通过callback的方式，根据数据为每个扇形切片指定单独的样式。

默认配置： 无

细分配置类型功能描述
fillstring填充颜色
strokestring描边颜色
lineWidthnumber描边宽度
lineDashnumber虚线描边
opacitynumber整体透明度
fillOpacitynumber填充透明度
strokeOpacitynumber描边透明度

图表组件

title

可选, optional

DEMOS

功能描述： 配置图表的标题，默认显示在图表左上角。

默认配置：

visible: false,
alignTo: 'left',
text:'',
style:{
    fontSize: 18,
    fill: 'black',
}
细分配置类型功能描述
visibleboolean是否显示
alignTostring位置，支持三种配置：
'left'
styleobject样式：
- fontSize: number 文字大小
- fill: string 文字颜色
- stroke: string  描边颜色
- lineWidth: number 描边粗细
- lineDash: number 虚线描边
- opacity: number 透明度
- fillOpacity: number 填充透明度
- strokeOpacity: number 描边透明度

description

可选, optional

DEMOS

功能描述： 配置图表的描述，默认显示在图表左上角，标题下方。

默认配置：

visible: false,
alignTo: 'left',
text:'',
style:{
    fontSize: 12,
    fill: 'grey',
}
细分配置类型功能描述
visibleboolean是否显示
alignTostring位置，支持三种配置：
'left'
styleobject样式：
- fontSize: number 文字大小
- fill: string 文字颜色
- stroke: string  描边颜色
- lineWidth: number 描边粗细
- lineDash: number 虚线描边
- opacity: number 透明度
- fillOpacity: number 填充透明度
- strokeOpacity: number 描边透明度

legend

可选, object

DEMOS

功能描述：图例，配置colorField时显示，用于展示颜色分类信息

默认配置：

visible: true,
position: 'right-center',
flipPage: true
细分配置类型功能描述
visibleboolean是否可见
positionstring位置，支持12方位布局
top-left, top-center,top-right
bottom-left,bottom-center,bottom-right
left-top,left-center,left-bottom
right-top,right-center,right-bottom
formatterfunction对图例显示信息进行格式化
offsetXnumber图例在 position 的基础上再往 x 方向偏移量，单位 px
offsetYnumber图例在 position 的基础上再往 y 方向偏移量，单位 px
titleobject图例标题
- visible: boolean 是否显示
- text: string 图例文本，如不配置则自动取对应字段名
- style: object 标题样式
markerobject图例 marker
- symbol: string marker符号，默认为 'circle'。可选类型：circle,square,diamond,triangle,triangleDown,hexagon,bowtie,cross,tick,plus,hyphen,line,hollowCircle,hollowSquare,hollowDiamond
- style: object marker样式，其中 r 配置marker的大小，其余样式参数参考绘图属性文档。
textobject图例文本
- style: object 配置图例文本样式
- formatter:(text,cfg)=>string 格式化图例文本

tooltip

可选, object

功能描述：信息提示框

默认配置：

visible: true,
offset: 20,
细分属性类型功能描述
visibleboolean是否显示
offsetnumber距离鼠标位置偏移值
domStylesobject配置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样式
fieldsstring设置tooltip内容字段，默认为[ radiusField, categoryField, groupField ]
formatterobject对tooltip items进行格式化，入参为tooltip fields对应数值，出参为格式为{name:'a',value:1}

label

功能描述： 标签文本

默认配置：

visible: false
type:'inner'
autoRotate: true
细分配置类型功能描述
visibleboolean是否显示
typestringlabel的类型
- inner label显示于扇形切片内
- outer label显示于外侧
autoRotateboolean是否自动旋转
formatterfunction对文本标签内容进行格式化
offsetXnumber在 label 位置的基础上再往 x 方向的偏移量
offsetYnumber在 label 位置的基础上再往 y 方向的偏移量
styleobject配置文本标签样式。
image.png

事件

图形事件

onRoseClick
图形点击事件		onRoseDblClick
图形双击事件		onRoseDblClick
图形双击事件		onRoseMouseleave
图形鼠标离开事件
onRoseMousemove
图形鼠标移动事件		onRoseMousedown
图形鼠标按下事件		onRoseMouseup
图形鼠标松开事件		onRoseMouseenter
图形鼠标进入事件

图表区域事件

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。