Axis

1 min read

坐标轴指二维空间中统计图表中的轴,它用来定义坐标系中数据在方向和值的映射关系的图表组件

引入

import { Linear, Arc, Helix } from '@antv/gui';

基本配置

属性名类型描述默认值
titlefalse | AxisTitleCfg标题
linefalse | AxisLineCfg轴线
ticksTickDatum[]刻度数据
ticksThresholdfalse | number刻度数量阈值
tickLinefalse | AxisTickCfg刻度线配置
labelfalse | AxisLabelCfg标签文本配置
subTickLinefalse | AxisSubTickCfg子刻度线配置
verticalFactor-1 | 1刻度与标签相对于轴线向量的位置。轴线为纵向时,-1 代表在向量左侧, 1 代表在向量右侧; 当轴线为横向时,-1 代表在轴线的上方,1 代表在轴线的下方; 当轴线为弧形时,-1 代表在轴线的内部,1 代表在轴线的外部

直线坐标轴

属性名类型描述默认值
startPos[number, number]轴线起点坐标
endPos[number, number]轴线终点坐标

圆弧坐标轴

属性名类型描述默认值
startAnglenumber起始角,弧度、角度均可
endAnglenumber结束角
radiusnumber半径
center[number, number]圆心位置

螺旋坐标轴

属性名类型描述默认值
anumber参数 a
bnumber参数 b
startAnglenumber起始角
endAnglenumber结束角
precisionnumber精度,影响螺旋线的绘制0.1

标题 AxisTitleCfg

属性名类型描述默认值
contentstring内容
styleTextProps样式
position'start' | 'center' | 'end'位置'start'
offset[number, number]偏移量[0,0]
rotatenumber旋转角度0

轴线 AxisLineCfg

属性名类型描述默认值
styleLineProps线条样式
arrow{start: MarkerCfg, end: MarkerCfg}轴线两端箭头

刻度线 AxisTickLineCfg

属性名类型描述默认值
lengthnumber长度5
styleMixAttrs带状态的线条样式
offsetnumber在轴线方向的偏移量0
appendTickboolean末尾追加 tick,一般用于 label alignTick 为 false 的情况false

标签 AxisLabelCfg

属性名类型描述默认值
type'text' | 'number' | 'time'标签文本类型,会影响缩略策略text
styleMixAttrs带状态的文本样式
alignTickbooleanlabel 是否与 Tick 对齐
align'normal' | 'tangential' | 'radial'标签文本与轴线的对齐方式,normal-水平,tangential-切向 radial-径向'normal'
formatter(tick: TickDatum) => string标签格式化
offset[number, number]偏移量
overlapOrder'autoRotate' | 'autoEllipsis' | 'autoHide'[]处理 label 重叠的优先级
margin[number, number, number, number] 标签外边距,在进行自动避免重叠时的额外间隔[0, 0, 0, 0]
autoRotateboolean旋转度数,默认垂直或平行于刻度线true
rotateRange[number, number]自动旋转的范围[0, 90]
rotatenumber范围[-90, 90] 手动指定旋转角度,配置后自动旋转失效
autoHidebooleanlabel 过多时隐藏部分true
autoHideTickLineboolean隐藏 label 时,同时隐藏掉其对应的 tickLinetrue
autoEllipsisbooleanlabel 过长时缩略true
ellipsisStepnumber | string缩略步长,传入 string 时将计算其长度(下同)
minLengthnumber | stringlabel 的最小长度
maxLengthnumber | stringlabel 的最大长度,无穷大表示不限制长度Infinity

子刻度线 AxisSubTickLineCfg

属性名类型描述默认值
lengthnumber长度2
countnumber两个刻度之间的子刻度数4
styleMixAttrs带状态的线条样式
offsetnumber在轴线方向的偏移量0

数据 TickDatum

属性名类型描述默认值
valuenumber范围 [0, 1], 表示在轴线上的位置
textstring显示的标签内容value
state'default'|'active'状态'default'
idstringidindex