!!!###!!!title=配置项——VisActor/VGraph 教程文档!!!###!!!!!!###!!!description=树图 TreeGraph 接受嵌套结构的数据(详情请见[数据结构](/vgraph/guide/data-structure)小节),通常用于树图,思维导图的展示和分析。一般用法如下:```typescriptimport { TreeGraph } from '@visactor/vgraph';const graph = new TreeGraph(options); // 树图配置项graph.data(someData); // 写入数据,一般情况下会直接渲染结果```!!!###!!!

树图配置

树图 TreeGraph 接受嵌套结构的数据(详情请见数据结构小节),通常用于树图,思维导图的展示和分析。一般用法如下:

import { TreeGraph } from '@visactor/vgraph';

const graph = new TreeGraph(options);  // 树图配置项
graph.data(someData);              // 写入数据,一般情况下会直接渲染结果

配置项

由于树图一般都会带有展开收起的交互和对应的动画需求,想在进行数据操作时默认达到比较好的效果就需要指定图的布局方式和动画。因此 TreeGraph 除了 Graph 的配置外支持传入布局和动画配置,配合 TreeGraph 实例方法就能达到较好的效果。

字段类型描述
layout{ type: string, options: LayoutOptions } | LayoutBase[NEW] 指定图布局类型和自定义配置项,或直接传入布局实例指定图布局。详情请见 TreeLayout 小节
animateBoolean | AnimateConfigs布局变化时的动画效果。详情请见 Animation 小节
fitViewAfterLayoutBoolean是否先将图形缩放到适合视窗大小后再进行动画。默认为 true
containerDOMNode | string[必填]图容器,可以是 dom 节点,也可以是 dom 对应的 id
widthnumber[必填]设置图宽度
heightnumber[必填]设置图高度
renderMode'canvas' | 'dom'[NEW] 指定使用 canvas 还是外置 dom 组件渲染节点。默认为canvas。用于配合 vgraph-react 或 vgraph-vue 使用。
autoLayoutboolean[NEW] 自动布局开关,默认打开。则当调用 graph 上方法增删改节点后会自动刷新布局。建议批量增删改时临时关闭以提高性能。
setDefaultNode(nodeData) => NodeConfigs批量设置图中节点配置,具体配置项请见节点配置项
setNodeStateStyles(nodeData) => keyShapeStyles设置图中节点 keyShape 在特定状态下的样式
setDefaultEdge(edgeData) => StateConfigs批量设置图中连线的配置,具体配置项请见连线配置项
setEdgeStateStyles(edgeData) => keyShapeStyles设置图中连线 keyShape 在特定状态下的样式
setDefaultGroup(groupData) => GroupConfigs批量设置图中分组的配置,具体配置项请见分组配置项
setGroupStateStyles(groupData) => keyShapeStyles设置图中分组 keyShape 在特定状态下的样式
paddingnumber | number[]指定图边缘留白,用于视口自适应等情况
minRationumber指定图的最小缩放比
maxRationumber指定图的最大缩放比
autoDrawboolean是否在更新图设置/调用实例方法后自动重绘。默认为 true。当进行批量操作时先置为 false ,操作后主动绘制能提供更好的性能。
linkCenterboolean连线是否直接连接到节点中心。默认为 false。批量计算连线的连接点有一定消耗。如果对节点与连线的连接点没有要求(不设置锚点 Anchor) 且当节点不透明时,置为 true 能提升性能。
throwErrorboolean是否直接抛出异常,默认为 true。如果在生产环境,或认为一些异常是可以存在的,可以设置为 false。则异常信息将以 console.error 的形式提醒。

TreeLayout

目前 vGraph 支持三种树布局方式。分别有两种指定方式如下:

import { CompactBox, TreeGraph } from '@visactor/vgraph';

// 第一种直接在实例化时配置
const graph = new TreeGraph({
  layout: {
    type: 'compactBox',
    options: layoutOptions
  }
});

// 第二种直接实例化一个布局,传入 TreeGraph
const layout = new CompactBox(layoutOptions);

const graph = new TreeGraph({
  layout,
  ...graphOptions,
});
布局名称布局效果特征适合场景
Dendrogram 平衡树
不管树层级如何,总是叶节点对齐,非叶节点根据层级均匀分布组织架构图,亲缘谱系图
MindMap 脑图树
深度相同的节点将会被放置在同一层,每棵子树占用空间不会有交叉数据归纳整理,头脑风暴
CompactBox 紧凑树
从根节点开始,同一深度的节点在同一层,并且布局时会将节点大小考虑进去尽量节省空间数据量大或展示空间不足的树图
Indented 缩进树
从根节点开始,同一深度的节点在同一层,父子之间排布更紧凑文件夹等信息密集场景

除节点配置项 (width: 节点宽度, height: 节点高度, collapsed: 是否收起) 外,也支持如下参数自定义布局。

字段类型描述
directionLR \ RL \ TB \ BT布局方向;LR 为从左到右布局, RL 为从右到左布局, TB 为从上到下布局,BT为从下到上布局。默认为TB 布局
nodeSep(nodeData: any) => number指定同层级节点之间的间距
rankSep(nodeData: any) => number指定跨层级节点间距
nodeSize(nodeData: any) => number指定节点大小。推荐在节点上直接配置 widthheight
radialboolean是否采用径向树分布。默认为 false。当单层节点特别多时推荐开启以获得更好的浏览体验。径向树分布时会在节点上写入 radial 辅助定义节点文本标签的旋转。具体可见径向树布局示例

Animation

vGraph 提供精细的动画,默认配置为 true,在图初始化,收起节点,展开节点的时候提供默认的动画效果。也可以通过以下配置项来自定义。

字段类型描述
durationnumber动画持续时间 (ms) ,默认 500
delaynumber延迟一定时间 (ms) 开始执行动画
easingstring指定动画效果,默认是线性动画 easelinear。也支持 easeCubic, easePoly, easeQuad,easeSin, easeExp, easeBounce等多个效果满足特殊场景下的数据表现。
repeatboolean是否重复动画。默认为 false
onFinish() => void动画执行结束回调