!!!###!!!title=标签——VisActor/VGraph 教程文档!!!###!!!

标签工具

自定义节点是图可视化应用研发最大的痛点之一。vGraph 总结了业务中常用的自定义节点组件抽象成可配置的工具方法,帮助大家解决一些不方便实现的视觉效果。

标签多用于自定义节点中,可配置含有业务含义的图标,也可以配置添加/关闭功能。可以生成单个标签,也可以生成一排标签,并自带溢出处理。可以在带有标签的自定义节点 体验。

import { TagUtils, Layer } from '@visactor/vgraph';

// container 是标签容器,一般情况下是节点自定义传入的参数 Layer
const container = new Layer({...});

// 生成单个标签
const tagLayer = TagUtils.initTag(container, tagOption);

// 移除单个标签
TagUtils.removeTag(tagLayer);

单个标签的配置如下:

字段类型描述
textstring[必填] 标签上显示的文本
leftnumber[必填] 标签左上角横坐标
topnumber[必填] 标签左上角纵坐标
maxWidthnumber标签最大宽度
theme'rect' | 'capsule'标签样式,默认为矩形
label标签文本样式自定义
label.fillStylestring标签文本颜色
label.fontSizenumber标签文本字号
label.lineHeightnumber标签文本行高
label.triggerIdstring用于与 tooltip 绑定
label.fontFamilystring统计牌文本字体
background标签背景配置
background.fillStylestring标签背景填充色
background.strokeStylestring标签背景边框颜色
background.paddingnumber | nunber[]标签四周留白
background.radiusnumber标签边框圆角
iconnumber标签左侧图标配置
icon.iconstring标签左侧图标的 iconfont 引用
icon.fillStylenumber标签左侧图标颜色
icon.sizenumber标签左侧图标尺寸
icon.onClick(e: GraphEvent, layer: Layer) => void标签左侧图标点击事件
closenumber标签右侧关闭图标配置
close.iconstring标签右侧关闭图标的 iconfont 引用
close.fillStylenumber标签右侧关闭图标颜色
close.sizenumber标签右侧关闭图标尺寸
close.onClick(e: GraphEvent, layer: Layer) => void标签右侧关闭图标点击事件

TagUtils 对单行多文本也有较好支持。可参考可删除标签的节点

import { TagUtils, Layer } from '@visactor/vgraph';

// container 是标签容器,一般情况下是节点自定义传入的参数 Layer
const container = new Layer({...});

// 生成多个标签
const tagsLayer = TagUtils.initTag(container, tagsOption);

// 移除单个标签
TagUtils.removeTag(tagLayer);

// 添加单个标签
TagUtils.addTag(tagsLayer, tagOption);
字段类型描述
leftnumber[必填] 标签左上角横坐标
topnumber[必填] 标签左上角纵坐标
maxWidthnumber标签所在行最大宽度
theme'rect' | 'capsule'标签样式,默认为矩形
tagstagOption标签文本样式。配置参考单个标签配置,left,top 将自动计算无须传入。
overflowTagtagOption溢出计数的标签样式。配置参考单个标签配置,left,top 将自动计算无须传入。