Skip to content

图表库通用说明

由于图表库采用了通过配置参数实现不同图表样式的功能,api接口里有通用配置项,这项通用接口的结构是一样的,可在不同的图表类型里共享,本文档旨在针对这项通用接口及方法进行说明。

通用接口接口及参数说明

OptionInterface

图表的通用配置接口,可以配置图表的坐标轴数据和样式,图表的总样式和展示数据节点的样式,是图表库的核心配置接口。

参数名参数类型描述是否必填默认值
paddingPadding设置图表的内间距20
colorstring[]设置图表的数据颜色
legendLegendInterface设置图表的描述部分
tooltipTooltipInterface选中数据时的菜单展示样式图表库默认配置
radarRadarInterface设置雷达图的样式,非雷达图不用设置
xAxisAxisInterface设置图表的x坐标轴样式,雷达图、环形图不用设置图表库默认配置
yAxisAxisInterface设置图表的y坐标轴样式,雷达图、环形图不用设置图表库默认配置
seriesSeriesInterface<T>[]设置图表的数据
titleObject设置图表的标题

SeriesInterface

属性名类型说明
namestring?本组数据的名称
colorstring?本组数据的整体颜色
lineStyleLineStyle?线条样式
barStyleBarStyle?柱形的样式,柱状图需要
labelLabelStyle?本组数据的标签样式
areaStyleAreaStyle?填充样式
labelLineInterfaceObj?标签线的样式
emphasisInterfaceObj?高亮样式
stackstring?堆叠名称,用于堆叠图
padAnglenumber?初始角度,环状图和雷达图需要,默认 90
radiusstring[]?半径占比,环状图需要,如 ['70%', '40%']
centerstring[]?图表中心位置,如 ['50%', '50%'] 指位于父组件中心
smoothboolean?是否平滑显示
hideboolean?是否隐藏本组数据
dataT[]?本组数据的具体数据

坐标轴接口: AxisInterface

属性名类型说明
namestring?轴名称
nameTextStyleTextStyle?轴名称文本样式
nameGapnumber?轴名称与轴线的间距
axisLineLineStyle?坐标轴线样式
axisTickAxisTickStyle?坐标轴刻度样式
axisLabelAxisLabelStyle?坐标轴标签样式
dataArray<string | number>?坐标轴数据
splitLineLineStyle?坐标轴标线样式

雷达图接口RadarInterface

属性名类型描述
indicatorInterfaceObj[] (可选)指示器的数组,定义了雷达图的各个指标。
centerArray<string | number> (可选)雷达图中心的位置,可以是 [x, y] 的数组,表示中心点的坐标。
radiusnumber | string (可选)雷达图的半径,可以是数字或字符串。
startAnglenumber (可选)雷达图的起始角度,默认是 90°,单位为度。
nameGapnumber (可选)指标名称与坐标轴之间的间距。
splitNumbernumber (可选)将圆环分成的区块数,控制雷达图的分割数。
axisLineStyleLineStyle (可选)坐标轴线的样式。
axisNameTextStyle (可选)坐标轴名称的样式。
splitLineStyleLineStyle (可选)分割线的样式。
splitAreaAreaStyle[] (可选)分割区域的样式,控制每个区域的样式。

提示层接口TooltipInterface

属性名类型描述
showboolean (可选)是否显示提示层。
typestring (可选)提示层的类型,defaultcustom默认为 default
backgroundColorstring (可选)提示层的背景颜色。
borderColorstring (可选)提示层边框的颜色。
borderWidthnumber (可选)提示层边框的宽度。
paddingnumber (可选)提示层的内边距。
textStyleTextStyle (可选)提示层文本的样式。

更多接口如LineStyleTextStyle等样式类接口,可在sdk内部查看。

通用组件、类及方法

DrawBaseViewModel<T>

该类是实现绘制图表的核心类,包含了绘制时的基础参数、绘制过程,开发者可通过继承该类实现更加复杂的图表绘制

方法名参数描述
create无参数在初次创建时绘制
bindEvent(ClickEvent, Function)点击图表空间时的回调
setOptionOptionInterface<T>创建对象时调用,可扩展加入更多的Option属性
drawDescriptionsSeriesInterface<T>[]绘制图表描述信息的方法,如不需要则不用实现
clear无参数当父组件disAppear时调用,可自定义进行资源回收与重置逻辑