请访问 Apache ECharts 的官网  

https://echarts.apache.org
访问官网
x

series-tree

树图

树图主要用来可视化树形数据结构,是一种特殊的层次类型,具有唯一的根节点,左子树,和右子树。

注意:目前不支持在单个 series 中直接绘制森林,可以通过在一个 option 中配置多个 series 实现森林

树图示例:

多个 series 组合成森林示例:

所有属性

series-tree. type = 'tree'

string

series-tree. id

string

组件 ID。默认不指定。指定则可用于在 option 或者 API 中引用组件。

series-tree. name

string

系列名称,用于tooltip的显示,legend 的图例筛选,在 setOption 更新数据和配置项时用于指定对应的系列。

series-tree. zlevel

number

所有图形的 zlevel 值。

zlevel用于 Canvas 分层,不同zlevel值的图形会放置在不同的 Canvas 中,Canvas 分层是一种常见的优化手段。我们可以把一些图形变化频繁(例如有动画)的组件设置成一个单独的zlevel。需要注意的是过多的 Canvas 会引起内存开销的增大,在手机端上需要谨慎使用以防崩溃。

zlevel 大的 Canvas 会放在 zlevel 小的 Canvas 的上面。

series-tree. z = 2

number

组件的所有图形的z值。控制图形的前后顺序。z值小的图形会被z值大的图形覆盖。

z相比zlevel优先级更低,而且不会创建新的 Canvas。

series-tree. left = 12% 试一试

stringnumber

tree组件离容器左侧的距离。

left 的值可以是像 20 这样的具体像素值,可以是像 '20%' 这样相对于容器高宽的百分比,也可以是 'left', 'center', 'right'

如果 left 的值为 'left', 'center', 'right',组件会根据相应的位置自动对齐。

series-tree. top = 12% 试一试

stringnumber

tree组件离容器上侧的距离。

top 的值可以是像 20 这样的具体像素值,可以是像 '20%' 这样相对于容器高宽的百分比,也可以是 'top', 'middle', 'bottom'

如果 top 的值为 'top', 'middle', 'bottom',组件会根据相应的位置自动对齐。

series-tree. right = 12% 试一试

stringnumber

tree组件离容器右侧的距离。

right 的值可以是像 20 这样的具体像素值,可以是像 '20%' 这样相对于容器高宽的百分比。

series-tree. bottom = 12% 试一试

stringnumber

tree组件离容器下侧的距离。

bottom 的值可以是像 20 这样的具体像素值,可以是像 '20%' 这样相对于容器高宽的百分比。

series-tree. width 试一试

stringnumber

tree组件的宽度。

series-tree. height 试一试

stringnumber

tree组件的高度。

series-tree. center

Array

当前视角的中心点。可以是包含两个 number 类型(表示像素值)或 string 类型(表示相对容器的百分比)的数组。 从 5.3.3 版本开始支持 string 类型。

例如:

center: [115.97, '30%']

series-tree. zoom = 1

number

当前视角的缩放比例。

series-tree. layout = 'orthogonal' 试一试

string

树图的布局,有 正交径向 两种。这里的 正交布局 就是我们通常所说的 水平垂直 方向,对应的参数取值为 'orthogonal' 。而 径向布局 是指以根节点为圆心,每一层节点为环,一层层向外发散绘制而成的布局,对应的参数取值为 'radial'

正交布局示例:

径向布局示例:

series-tree. orient = 'LR' 试一试

string

树图中 正交布局 的方向,也就是说只有在 layout = 'orthogonal' 的时候,该配置项才生效。对应有 水平 方向的 从左到右从右到左;以及垂直方向的 从上到下从下到上。取值分别为 'LR' , 'RL', 'TB', 'BT'注意,之前的配置项值 'horizontal' 等同于 'LR''vertical' 等同于 'TB'

series-tree. symbol = 'emptyCircle' 试一试

stringFunction

标记的图形。

ECharts 提供的标记类型包括

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'

可以通过 'image://url' 设置为图片,其中 URL 为图片的链接,或者 dataURI

URL 为图片链接例如:

'image://http://example.website/a/b.png'

URL 为 dataURI 例如:

'image://data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/XBs/fNwfjZ0frl3/zy7////wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAkAABAALAAAAAAQABAAAAVVICSOZGlCQAosJ6mu7fiyZeKqNKToQGDsM8hBADgUXoGAiqhSvp5QAnQKGIgUhwFUYLCVDFCrKUE1lBavAViFIDlTImbKC5Gm2hB0SlBCBMQiB0UjIQA7'

可以通过 'path://' 将图标设置为任意的矢量路径。这种方式相比于使用图片的方式,不用担心因为缩放而产生锯齿或模糊,而且可以设置为任意颜色。路径图形会自适应调整为合适的大小。路径的格式参见 SVG PathData。可以从 Adobe Illustrator 等工具编辑导出。

例如:

'path://M30.9,53.2C16.8,53.2,5.3,41.7,5.3,27.6S16.8,2,30.9,2C45,2,56.4,13.5,56.4,27.6S45,53.2,30.9,53.2z M30.9,3.5C17.6,3.5,6.8,14.4,6.8,27.6c0,13.3,10.8,24.1,24.101,24.1C44.2,51.7,55,40.9,55,27.6C54.9,14.4,44.1,3.5,30.9,3.5z M36.9,35.8c0,0.601-0.4,1-0.9,1h-1.3c-0.5,0-0.9-0.399-0.9-1V19.5c0-0.6,0.4-1,0.9-1H36c0.5,0,0.9,0.4,0.9,1V35.8z M27.8,35.8 c0,0.601-0.4,1-0.9,1h-1.3c-0.5,0-0.9-0.399-0.9-1V19.5c0-0.6,0.4-1,0.9-1H27c0.5,0,0.9,0.4,0.9,1L27.8,35.8L27.8,35.8z'

如果需要每个数据的图形不一样,可以设置为如下格式的回调函数:

(value: Array|number, params: Object) => string

其中第一个参数 valuedata 中的数据值。第二个参数params 是其它的数据项参数。

series-tree. symbolSize = 7 试一试

numberArrayFunction

标记的大小,可以设置成诸如 10 这样单一的数字,也可以用数组分开表示宽和高,例如 [20, 10] 表示标记宽为20,高为10

如果需要每个数据的图形大小不一样,可以设置为如下格式的回调函数:

(value: Array|number, params: Object) => number|Array

其中第一个参数 valuedata 中的数据值。第二个参数params 是其它的数据项参数。

series-tree. symbolRotate 试一试

numberFunction

标记的旋转角度(而非弧度)。正值表示逆时针旋转。注意在 markLine 中当 symbol'arrow' 时会忽略 symbolRotate 强制设置为切线的角度。

如果需要每个数据的旋转角度不一样,可以设置为如下格式的回调函数:

(value: Array|number, params: Object) => number

其中第一个参数 valuedata 中的数据值。第二个参数params 是其它的数据项参数。

从 4.8.0 开始支持回调函数。

series-tree. symbolKeepAspect 试一试

boolean

如果 symbolpath:// 的形式,是否在缩放时保持该图形的长宽比。

series-tree. symbolOffset = [0, 0] 试一试

Array

标记相对于原本位置的偏移。默认情况下,标记会居中置放在数据对应的位置,但是如果 symbol 是自定义的矢量路径或者图片,就有可能不希望 symbol 居中。这时候可以使用该配置项配置 symbol 相对于原本居中的偏移,可以是绝对的像素值,也可以是相对的百分比。

例如 [0, '-50%'] 就是把自己向上移动了一半的位置,在 symbol 图形是气泡的时候可以让图形下端的箭头对准数据点。

series-tree. edgeShape = 'curve' 试一试

string

v4.7.0 开始支持

树图在 正交布局 下,边的形状。分别有曲线和折线两种,对应的取值是 curvepolyline.

注意:该配置项只在 正交布局 下有效,在经向布局下的开发环境中会报错。

series-tree. edgeForkPosition = '50%' 试一试

string

正交布局下当边的形状是折线时,子树中折线段分叉的位置。这里的位置指的是分叉点与子树父节点的距离占整个子树高度的百分比。默认取值是 '50%',可以是 ['0', '100%'] 之间。

注意:该配置项只有在 edgeShape = 'polyline' 时才有效。

series-tree. roam 试一试

booleanstring

是否开启鼠标缩放和平移漫游。默认不开启。如果只想要开启缩放或者平移,可以设置成 'scale' 或者 'move'。设置成 true 为都开启

series-tree. expandAndCollapse = true 试一试

boolean

子树折叠和展开的交互,默认打开 。由于绘图区域是有限的,而通常一个树图的节点可能会比较多,这样就会出现节点之间相互遮盖的问题。为了避免这一问题,可以将暂时无关的子树折叠收起,等到需要时再将其展开。如上面径向布局树图示例,节点中心用蓝色填充的就是折叠收起的子树,可以点击将其展开。

注意:如果配置自定义的图片作为节点的标记,是无法通过填充色来区分当前节点是否有折叠的子树的。而目前暂不支持,上传两张图片分别表示节点折叠和展开两种状态。所以,如果想明确地显示节点的两种状态,建议使用 ECharts 常规的标记类型,如 'emptyCircle' 等。

series-tree. initialTreeDepth = 2 试一试

number

树图初始展开的层级(深度)。根节点是第 0 层,然后是第 1 层、第 2 层,... ,直到叶子节点。该配置项主要和 折叠展开 交互一起使用,目的还是为了防止一次展示过多节点,节点之间发生遮盖。如果设置为 -1 或者 null 或者 undefined,所有节点都将展开。

series-tree. itemStyle

Object

树图中每个节点的样式,其中 itemStyle.color 表示节点的填充色,用来区别当前节点所对应的子树折叠或展开的状态。

series-tree.itemStyle. color = 自适应 试一试

Color

图形的颜色。 默认从全局调色盘 option.color 获取颜色。

支持使用rgb(255,255,255)rgba(255,255,255,1)#fff等方式设置为纯色,也支持设置为渐变色和纹理填充,具体见option.color

series-tree.itemStyle. borderColor = '#c23531' 试一试

Color

图形的描边颜色。支持的颜色格式同 color,不支持回调函数。

series-tree.itemStyle. borderWidth = 1.5 试一试

number

描边线宽。为 0 时无描边。

series-tree.itemStyle. borderType = 'solid' 试一试

stringnumberArray

描边类型。

可选:

  • 'solid'
  • 'dashed'
  • 'dotted'

v5.0.0 开始,也可以是 number 或者 number 数组,用以指定线条的 dash array,配合 borderDashOffset 可实现更灵活的虚线效果。

例如:

{

borderType: [5, 10],

borderDashOffset: 5
}

series-tree.itemStyle. borderDashOffset 试一试

number

v5.0.0 开始支持

用于设置虚线的偏移量,可搭配 borderType 指定 dash array 实现灵活的虚线效果。

更多详情可以参考 MDN lineDashOffset

series-tree.itemStyle. borderCap = 'butt' 试一试

string

v5.0.0 开始支持

用于指定线段末端的绘制方式,可以是:

  • 'butt': 线段末端以方形结束。
  • 'round': 线段末端以圆形结束。
  • 'square': 线段末端以方形结束,但是增加了一个宽度和线段相同,高度是线段厚度一半的矩形区域。

默认值为 'butt'。 更多详情可以参考 MDN lineCap

series-tree.itemStyle. borderJoin = 'bevel' 试一试

string

v5.0.0 开始支持

用于设置2个长度不为0的相连部分(线段,圆弧,曲线)如何连接在一起的属性(长度为0的变形部分,其指定的末端和控制点在同一位置,会被忽略)。

可以是:

  • 'bevel': 在相连部分的末端填充一个额外的以三角形为底的区域, 每个部分都有各自独立的矩形拐角。
  • 'round': 通过填充一个额外的,圆心在相连部分末端的扇形,绘制拐角的形状。 圆角的半径是线段的宽度。
  • 'miter': 通过延伸相连部分的外边缘,使其相交于一点,形成一个额外的菱形区域。这个设置可以通过 borderMiterLimit 属性看到效果。

默认值为 'bevel'。 更多详情可以参考 MDN lineJoin

series-tree.itemStyle. borderMiterLimit = 10 试一试

number

v5.0.0 开始支持

用于设置斜接面限制比例。只有当 borderJoinmiter 时, borderMiterLimit 才有效。

默认值为 10。负数、0InfinityNaN 均会被忽略。

更多详情可以参考 MDN miterLimit

series-tree.itemStyle. shadowBlur 试一试

number

图形阴影的模糊大小。该属性配合 shadowColor,shadowOffsetX, shadowOffsetY 一起设置图形的阴影效果。

示例:

{
    shadowColor: 'rgba(0, 0, 0, 0.5)',
    shadowBlur: 10
}

series-tree.itemStyle. shadowColor 试一试

Color

阴影颜色。支持的格式同color

series-tree.itemStyle. shadowOffsetX 试一试

number

阴影水平方向上的偏移距离。

series-tree.itemStyle. shadowOffsetY 试一试

number

阴影垂直方向上的偏移距离。

series-tree.itemStyle. opacity = 1 试一试

number

图形透明度。支持从 0 到 1 的数字,为 0 时不绘制该图形。

series-tree. label

Object

label 描述了每个节点所对应的文本标签的样式。

series-tree.label. show = true 试一试

boolean

是否显示标签。

series-tree.label. position 试一试

stringArray

标签的位置。

  • 可以通过内置的语义声明位置:

    示例:

      position: 'top'
    

    支持:top / left / right / bottom / inside / insideLeft / insideRight / insideTop / insideBottom / insideTopLeft / insideBottomLeft / insideTopRight / insideBottomRight

  • 也可以用一个数组表示相对的百分比或者绝对像素值表示标签相对于图形包围盒左上角的位置。

    示例:

      // 绝对的像素值
      position: [10, 10],
      // 相对的百分比
      position: ['50%', '50%']
    

参见:label position

series-tree.label. distance = 5 试一试

number

距离图形元素的距离。

当 position 为字符描述值(如 'top''insideRight')时候有效。

参见:label position

series-tree.label. rotate 试一试

number

标签旋转。从 -90 度到 90 度。正值是逆时针。

参见:label rotation

series-tree.label. offset 试一试

Array

是否对文字进行偏移。默认不偏移。例如:[30, 40] 表示文字在横向上偏移 30,纵向上偏移 40

series-tree.label. minMargin

number

v5.0.0 开始支持

用于控制标签之间的最小距离,当启用 labelLayout 时可能会用到。

series-tree.label. formatter

stringFunction

标签内容格式器,支持字符串模板和回调函数两种形式,字符串模板与回调函数返回的字符串均支持用 \n 换行。

字符串模板

字符串模板 模板变量有:

  • {a}:系列名。
  • {b}:数据名。
  • {c}:数据值。
  • {d}:百分比。
  • {@xxx}:数据中名为 'xxx' 的维度的值,如 {@product} 表示名为 'product' 的维度的值。
  • {@[n]}:数据中维度 n 的值,如 {@[3]} 表示维度 3 的值,从 0 开始计数。

示例:

formatter: '{b}: {d}'

回调函数

回调函数格式:

(params: Object|Array) => string

参数 params 是 formatter 需要的单个数据集。格式如下:

{
    componentType: 'series',
    // 系列类型
    seriesType: string,
    // 系列在传入的 option.series 中的 index
    seriesIndex: number,
    // 系列名称
    seriesName: string,
    // 数据名,类目名
    name: string,
    // 数据在传入的 data 数组中的 index
    dataIndex: number,
    // 传入的原始数据项
    data: Object,
    // 传入的数据值。在多数系列下它和 data 相同。在一些系列下是 data 中的分量(如 map、radar 中)
    value: number|Array|Object,
    // 坐标轴 encode 映射信息,
    // key 为坐标轴(如 'x' 'y' 'radius' 'angle' 等)
    // value 必然为数组,不会为 null/undefined,表示 dimension index 。
    // 其内容如:
    // {
    //     x: [2] // dimension index 为 2 的数据映射到 x 轴
    //     y: [0] // dimension index 为 0 的数据映射到 y 轴
    // }
    encode: Object,
    // 维度名列表
    dimensionNames: Array<String>,
    // 数据的维度 index,如 0 或 1 或 2 ...
    // 仅在雷达图中使用。
    dimensionIndex: number,
    // 数据图形的颜色
    color: string,
    // 当前节点的祖先节点(包括自身)
    treeAncestors: Array
}

注:encode 和 dimensionNames 的使用方式,例如:

如果数据为:

dataset: {
    source: [
        ['Matcha Latte', 43.3, 85.8, 93.7],
        ['Milk Tea', 83.1, 73.4, 55.1],
        ['Cheese Cocoa', 86.4, 65.2, 82.5],
        ['Walnut Brownie', 72.4, 53.9, 39.1]
    ]
}

则可这样得到 y 轴对应的 value:

params.value[params.encode.y[0]]

如果数据为:

dataset: {
    dimensions: ['product', '2015', '2016', '2017'],
    source: [
        {product: 'Matcha Latte', '2015': 43.3, '2016': 85.8, '2017': 93.7},
        {product: 'Milk Tea', '2015': 83.1, '2016': 73.4, '2017': 55.1},
        {product: 'Cheese Cocoa', '2015': 86.4, '2016': 65.2, '2017': 82.5},
        {product: 'Walnut Brownie', '2015': 72.4, '2016': 53.9, '2017': 39.1}
    ]
}

则可这样得到 y 轴对应的 value:

params.value[params.dimensionNames[params.encode.y[0]]]

series-tree.label. color = '#fff' 试一试

Color

文字的颜色。

如果设置为 'inherit',则为视觉映射得到的颜色,如系列色。

series-tree.label. fontStyle = 'normal' 试一试

string

文字字体的风格。

可选:

  • 'normal'
  • 'italic'
  • 'oblique'

series-tree.label. fontWeight = 'normal' 试一试

stringnumber

文字字体的粗细。

可选:

  • 'normal'
  • 'bold'
  • 'bolder'
  • 'lighter'
  • 100 | 200 | 300 | 400...

series-tree.label. fontFamily = 'sans-serif' 试一试

string

文字的字体系列。

还可以是 'serif' , 'monospace', 'Arial', 'Courier New', 'Microsoft YaHei', ...

series-tree.label. fontSize = 12 试一试

number

文字的字体大小。

series-tree.label. align 试一试

string

文字水平对齐方式,默认自动。

可选:

  • 'left'
  • 'center'
  • 'right'

rich 中如果没有设置 align,则会取父层级的 align。例如:

{
    align: right,
    rich: {
        a: {
            // 没有设置 `align`,则 `align` 为 right
        }
    }
}

series-tree.label. verticalAlign 试一试

string

文字垂直对齐方式,默认自动。

可选:

  • 'top'
  • 'middle'
  • 'bottom'

rich 中如果没有设置 verticalAlign,则会取父层级的 verticalAlign。例如:

{
    verticalAlign: bottom,
    rich: {
        a: {
            // 没有设置 `verticalAlign`,则 `verticalAlign` 为 bottom
        }
    }
}

series-tree.label. lineHeight 试一试

number

行高。

rich 中如果没有设置 lineHeight,则会取父层级的 lineHeight。例如:

{
    lineHeight: 56,
    rich: {
        a: {
            // 没有设置 `lineHeight`,则 `lineHeight` 为 56
        }
    }
}

series-tree.label. backgroundColor = 'transparent' 试一试

stringObject

文字块背景色。

可以使用颜色值,例如:'#123234', 'red', 'rgba(0,23,11,0.3)'

也可以直接使用图片,例如:

backgroundColor: {
    image: 'xxx/xxx.png'
    // 这里可以是图片的 URL,
    // 或者图片的 dataURI,
    // 或者 HTMLImageElement 对象,
    // 或者 HTMLCanvasElement 对象。
}

当使用图片的时候,可以使用 widthheight 指定高宽,也可以不指定自适应。

如果设置为 'inherit',则为视觉映射得到的颜色,如系列色。

series-tree.label. borderColor 试一试

Color

文字块边框颜色。

如果设置为 'inherit',则为视觉映射得到的颜色,如系列色。

series-tree.label. borderWidth 试一试

number

文字块边框宽度。

series-tree.label. borderType = 'solid' 试一试

stringnumberArray

文字块边框描边类型。

可选:

  • 'solid'
  • 'dashed'
  • 'dotted'

v5.0.0 开始,也可以是 number 或者 number 数组,用以指定线条的 dash array,配合 borderDashOffset 可实现更灵活的虚线效果。

例如:

{

borderType: [5, 10],

borderDashOffset: 5
}

series-tree.label. borderDashOffset 试一试

number

v5.0.0 开始支持

用于设置虚线的偏移量,可搭配 borderType 指定 dash array 实现灵活的虚线效果。

更多详情可以参考 MDN lineDashOffset

series-tree.label. borderRadius 试一试

numberArray

文字块的圆角。

series-tree.label. padding 试一试

numberArray

文字块的内边距。例如:

  • padding: [3, 4, 5, 6]:表示 [上, 右, 下, 左] 的边距。
  • padding: 4:表示 padding: [4, 4, 4, 4]
  • padding: [3, 4]:表示 padding: [3, 4, 3, 4]

注意,文字块的 widthheight 指定的是内容高宽,不包含 padding

series-tree.label. shadowColor = 'transparent' 试一试

Color

文字块的背景阴影颜色。

series-tree.label. shadowBlur 试一试

number

文字块的背景阴影长度。

series-tree.label. shadowOffsetX 试一试

number

文字块的背景阴影 X 偏移。

series-tree.label. shadowOffsetY 试一试

number

文字块的背景阴影 Y 偏移。

series-tree.label. width 试一试

number

文本显示宽度。

series-tree.label. height 试一试

number

文本显示高度。

series-tree.label. textBorderColor 试一试

Color

文字本身的描边颜色。

如果设置为 'inherit',则为视觉映射得到的颜色,如系列色。

series-tree.label. textBorderWidth 试一试

number

文字本身的描边宽度。

series-tree.label. textBorderType = 'solid' 试一试

stringnumberArray

文字本身的描边类型。

可选:

  • 'solid'
  • 'dashed'
  • 'dotted'

v5.0.0 开始,也可以是 number 或者 number 数组,用以指定线条的 dash array,配合 textBorderDashOffset 可实现更灵活的虚线效果。

例如:

{

textBorderType: [5, 10],

textBorderDashOffset: 5
}

series-tree.label. textBorderDashOffset 试一试

number

v5.0.0 开始支持

用于设置虚线的偏移量,可搭配 textBorderType 指定 dash array 实现灵活的虚线效果。

更多详情可以参考 MDN lineDashOffset

series-tree.label. textShadowColor = 'transparent' 试一试

Color

文字本身的阴影颜色。

series-tree.label. textShadowBlur 试一试

number

文字本身的阴影长度。

series-tree.label. textShadowOffsetX 试一试

number

文字本身的阴影 X 偏移。

series-tree.label. textShadowOffsetY 试一试

number

文字本身的阴影 Y 偏移。

series-tree.label. overflow = 'none' 试一试

string

文字超出宽度是否截断或者换行。配置width时有效

  • 'truncate' 截断,并在末尾显示ellipsis配置的文本,默认为...
  • 'break' 换行
  • 'breakAll' 换行,跟'break'不同的是,在英语等拉丁文中,'breakAll'还会强制单词内换行

series-tree.label. ellipsis = '...'

string

overflow配置为'truncate'的时候,可以通过该属性配置末尾显示的文本。

series-tree.label. rich

Object

rich 里面,可以自定义富文本样式。利用富文本样式,可以在标签中做出非常丰富的效果。

例如:

label: {
    // 在文本中,可以对部分文本采用 rich 中定义样式。
    // 这里需要在文本中使用标记符号:
    // `{styleName|text content text content}` 标记样式名。
    // 注意,换行仍是使用 '\n'。
    formatter: [
        '{a|这段文本采用样式a}',
        '{b|这段文本采用样式b}这段用默认样式{x|这段用样式x}'
    ].join('\n'),

    rich: {
        a: {
            color: 'red',
            lineHeight: 10
        },
        b: {
            backgroundColor: {
                image: 'xxx/xxx.jpg'
            },
            height: 40
        },
        x: {
            fontSize: 18,
            fontFamily: 'Microsoft YaHei',
            borderColor: '#449933',
            borderRadius: 4
        },
        ...
    }
}

详情参见教程:富文本标签

所有属性
{ <style_name> }

series-tree. labelLayout

ObjectFunction

v5.0.0 开始支持

标签的统一布局配置。

该配置项是在每个系列默认的标签布局基础上,统一调整标签的(x, y)位置,标签对齐等属性以实现想要的标签布局效果。

该配置项也可以是一个有如下参数的回调函数

// 标签对应数据的 dataIndex
dataIndex: number
// 标签对应的数据类型,只在关系图中会有 node 和 edge 数据类型的区分
dataType?: string
// 标签对应的系列的 index
seriesIndex: number
// 标签显示的文本
text: string
// 默认的标签的包围盒,由系列默认的标签布局决定
labelRect: {x: number, y: number, width: number, height: number}
// 默认的标签水平对齐
align: 'left' | 'center' | 'right'
// 默认的标签垂直对齐
verticalAlign: 'top' | 'middle' | 'bottom'
// 标签所对应的数据图形的包围盒,可用于定位标签位置
rect: {x: number, y: number, width: number, height: number}
// 默认引导线的位置,目前只有饼图(pie)和漏斗图(funnel)有默认标签位置
// 如果没有该值则为 null
labelLinePoints?: number[][]

示例:

将标签显示在图形右侧 10px 的位置,并且垂直居中:

labelLayout(params) {
    return {
        x: params.rect.x + 10,
        y: params.rect.y + params.rect.height / 2,
        verticalAlign: 'middle',
        align: 'left'
    }
}

根据图形的包围盒尺寸决定文本尺寸


labelLayout(params) {
    return {
        fontSize: Math.max(params.rect.width / 10, 5)
    };
}

series-tree.labelLayout. hideOverlap

boolean

是否隐藏重叠的标签。

下面示例演示了在关系图中开启该配置后,在缩放时可以实现自动的标签隐藏。

series-tree.labelLayout. moveOverlap

string

在标签重叠的时候是否挪动标签位置以防止重叠。

目前支持配置为:

  • 'shiftX' 水平方向依次位移,在水平方向对齐时使用
  • 'shiftY' 垂直方向依次位移,在垂直方向对齐时使用

下面是标签右对齐并配置垂直方向依次位移以防止重叠的示例。

series-tree.labelLayout. x

numberstring

标签的 x 位置。支持绝对的像素值或者'20%'这样的相对值。

series-tree.labelLayout. y

numberstring

标签的 y 位置。支持绝对的像素值或者'20%'这样的相对值。

series-tree.labelLayout. dx

number

标签在 x 方向上的像素偏移。可以和x一起使用。

series-tree.labelLayout. dy

number

标签在 y 方向上的像素偏移。可以和y一起使用

series-tree.labelLayout. rotate

number

标签旋转角度。

series-tree.labelLayout. width

number

标签显示的宽度。可以配合overflow使用控制标签显示在固定宽度内

series-tree.labelLayout. height

number

标签显示的高度。

series-tree.labelLayout. align

string

标签水平对齐方式。可以设置'left', 'center', 'right'

series-tree.labelLayout. verticalAlign

string

标签垂直对齐方式。可以设置'top', 'middle', 'bottom'

series-tree.labelLayout. fontSize

number

The text size of the label.

series-tree.labelLayout. draggable

boolean

标签是否可以允许用户通过拖拽二次调整位置。

series-tree.labelLayout. labelLinePoints

Array

标签引导线三个点的位置。格式为:

[[x, y], [x, y], [x, y]]

在饼图中常用来微调已经计算好的引导线,其它情况一般不建议设置。

series-tree. lineStyle

Object

定义树图边的样式。

series-tree.lineStyle. color = '#ccc' 试一试

Color

树图边的颜色。

series-tree.lineStyle. width = 1.5 试一试

number

树图边的宽度。

series-tree.lineStyle. curveness = 0.5 试一试

number

树图边的曲度。

series-tree.lineStyle. shadowBlur 试一试

number

图形阴影的模糊大小。该属性配合 shadowColor,shadowOffsetX, shadowOffsetY 一起设置图形的阴影效果。

示例:

{
    shadowColor: 'rgba(0, 0, 0, 0.5)',
    shadowBlur: 10
}

series-tree.lineStyle. shadowColor 试一试

Color

阴影颜色。支持的格式同color

series-tree.lineStyle. shadowOffsetX 试一试

number

阴影水平方向上的偏移距离。

series-tree.lineStyle. shadowOffsetY 试一试

number

阴影垂直方向上的偏移距离。

series-tree. emphasis

Object

树图中个图形和标签高亮的样式。

series-tree.emphasis. disabled 试一试

boolean

v5.3.0 开始支持

是否关闭高亮状态。

关闭高亮状态可以在鼠标移到图形上,tooltip 触发,或者图例联动的时候不再触发高亮效果。在图形非常多的时候可以关闭以提升交互流畅性。

series-tree.emphasis. focus = 'none'

string

v5.0.0 开始支持

在高亮图形时,是否淡出其它数据的图形已达到聚焦的效果。支持如下配置:

  • 'none' 不淡出其它图形,默认使用该配置。
  • 'self' 只聚焦(不淡出)当前高亮的数据的图形。
  • 'series' 聚焦当前高亮的数据所在的系列的所有图形。
  • 'ancestor' 聚焦所有祖先节点。
  • 'descendant' 聚焦所有子孙节点。
  • 'relative' 聚焦所有子孙和祖先节点。(从 v5.3.3 开始支持)

示例:

下面代码配置了柱状图在高亮一个图形的时候,淡出当前直角坐标系所有其它的系列。

emphasis: {
    focus: 'series',
    blurScope: 'coordinateSystem'
}

series-tree.emphasis. blurScope = 'coordinateSystem'

string

v5.0.0 开始支持

在开启focus的时候,可以通过blurScope配置淡出的范围。支持如下配置

  • 'coordinateSystem' 淡出范围为坐标系,默认使用该配置。
  • 'series' 淡出范围为系列。
  • 'global' 淡出范围为全局。

series-tree.emphasis. itemStyle

Object

该节点的样式。

所有属性
{ color , borderColor , borderWidth , borderType , borderDashOffset , borderCap , borderJoin , borderMiterLimit , shadowBlur , shadowColor , shadowOffsetX , shadowOffsetY , opacity }

series-tree.emphasis. lineStyle

Object

定义树图边的样式。

所有属性
{ color , width , curveness , shadowBlur , shadowColor , shadowOffsetX , shadowOffsetY }

series-tree.emphasis. label

Object
所有属性
{ show , position , distance , rotate , offset , formatter , color , fontStyle , fontWeight , fontFamily , fontSize , align , verticalAlign , lineHeight , backgroundColor , borderColor , borderWidth , borderType , borderDashOffset , borderRadius , padding , shadowColor , shadowBlur , shadowOffsetX , shadowOffsetY , width , height , textBorderColor , textBorderWidth , textBorderType , textBorderDashOffset , textShadowColor , textShadowBlur , textShadowOffsetX , textShadowOffsetY , overflow , ellipsis , rich }

series-tree. blur

Object

v5.0.0 开始支持

淡出状态的相关配置。开启 emphasis.focus 后有效。

series-tree.blur. itemStyle

Object

该节点的样式。

所有属性
{ color , borderColor , borderWidth , borderType , borderDashOffset , borderCap , borderJoin , borderMiterLimit , shadowBlur , shadowColor , shadowOffsetX , shadowOffsetY , opacity }

series-tree.blur. lineStyle

Object

定义树图边的样式。

所有属性
{ color , width , curveness , shadowBlur , shadowColor , shadowOffsetX , shadowOffsetY }

series-tree.blur. label

Object
所有属性
{ show , position , distance , rotate , offset , formatter , color , fontStyle , fontWeight , fontFamily , fontSize , align , verticalAlign , lineHeight , backgroundColor , borderColor , borderWidth , borderType , borderDashOffset , borderRadius , padding , shadowColor , shadowBlur , shadowOffsetX , shadowOffsetY , width , height , textBorderColor , textBorderWidth , textBorderType , textBorderDashOffset , textShadowColor , textShadowBlur , textShadowOffsetX , textShadowOffsetY , overflow , ellipsis , rich }

series-tree. select

Object

v5.0.0 开始支持

选中状态的相关配置。开启 selectedMode 后有效。

series-tree.select. disabled 试一试

boolean

v5.3.0 开始支持

是否可以被选中。在开启 selectedMode 的时候有效,可以用于关闭部分数据。

series-tree.select. itemStyle

Object

该节点的样式。

所有属性
{ color , borderColor , borderWidth , borderType , borderDashOffset , borderCap , borderJoin , borderMiterLimit , shadowBlur , shadowColor , shadowOffsetX , shadowOffsetY , opacity }

series-tree.select. lineStyle

Object

定义树图边的样式。

所有属性
{ color , width , curveness , shadowBlur , shadowColor , shadowOffsetX , shadowOffsetY }

series-tree.select. label

Object
所有属性
{ show , position , distance , rotate , offset , formatter , color , fontStyle , fontWeight , fontFamily , fontSize , align , verticalAlign , lineHeight , backgroundColor , borderColor , borderWidth , borderType , borderDashOffset , borderRadius , padding , shadowColor , shadowBlur , shadowOffsetX , shadowOffsetY , width , height , textBorderColor , textBorderWidth , textBorderType , textBorderDashOffset , textShadowColor , textShadowBlur , textShadowOffsetX , textShadowOffsetY , overflow , ellipsis , rich }

series-tree. selectedMode 试一试

booleanstring

v5.0.0 开始支持

选中模式的配置,表示是否支持多个选中,默认关闭,支持布尔值和字符串,字符串取值可选'single''multiple''series' 分别表示单选,多选以及选择整个系列。

从 v5.3.0 开始支持 'series'

series-tree. leaves

Object

叶子节点的特殊配置,如上面的树图实例中,叶子节点和非叶子节点的标签位置不同。

series-tree.leaves. label

Object

描述了叶子节点所对应的文本标签的样式。

所有属性
{ show , position , distance , rotate , offset , formatter , color , fontStyle , fontWeight , fontFamily , fontSize , align , verticalAlign , lineHeight , backgroundColor , borderColor , borderWidth , borderType , borderDashOffset , borderRadius , padding , shadowColor , shadowBlur , shadowOffsetX , shadowOffsetY , width , height , textBorderColor , textBorderWidth , textBorderType , textBorderDashOffset , textShadowColor , textShadowBlur , textShadowOffsetX , textShadowOffsetY , overflow , ellipsis , rich }

series-tree.leaves. itemStyle

Object

树图中叶子节点的样式。

所有属性
{ color , borderColor , borderWidth , borderType , borderDashOffset , borderCap , borderJoin , borderMiterLimit , shadowBlur , shadowColor , shadowOffsetX , shadowOffsetY , opacity }

series-tree.leaves. emphasis

Object

叶子节点高亮状态的配置。

所有属性
{ disabled , itemStyle , lineStyle , label }

series-tree.leaves. blur

Object

v5.0.0 开始支持

叶子节点淡出状态的配置。

所有属性
{ itemStyle , lineStyle , label }

series-tree.leaves. select

Object

v5.0.0 开始支持

叶子节点选中状态的配置。

所有属性
{ disabled , itemStyle , lineStyle , label }

series-tree. data

Object

series-tree.data 的数据格式是树状结构的,例如:

{ // 注意,最外层是一个对象,代表树的根节点
    name: "flare",    // 节点的名称,当前节点 label 对应的文本
    label: {          // 此节点特殊的 label 配置(如果需要的话)。
        ...           // label的格式参见 series-tree.label。
    },
    itemStyle: {      // 此节点特殊的 itemStyle 配置(如果需要的话)。
        ...           // label的格式参见 series-tree.itemStyle。
    },
    children: [
        {
            name: "flex",
            value: 4116,    // value 值,只在 tooltip 中显示
            label: {
                ...
            },
            itemStyle: {
                ...
            },
            collapsed: null, // 如果为 true,表示此节点默认折叠。
            children: [...] // 叶子节点没有 children, 可以不写
        },
        ...
    ]
};
所有属性
{ name , value , collapsed , itemStyle , lineStyle , label , emphasis , blur , select , tooltip , animation , animationThreshold , animationDuration , animationEasing , animationDelay , animationDurationUpdate , animationEasingUpdate , animationDelayUpdate }

series-tree. tooltip

Object

本系列特定的 tooltip 设定。

所有属性
{ position , formatter , valueFormatter , backgroundColor , borderColor , borderWidth , padding , textStyle , extraCssText }
预览