logo

G6

  • 文档
  • API
  • 图表示例
  • 社区
  • 所有产品antv logo arrow
  • 5.0.47
  • 简介
  • 开始使用
    • 快速开始
    • 安装
    • 前端框架集成
      • 在 React 中使用
      • 在 Vue 中使用
      • 在 Angular 中使用
    • 详细教程
  • 图 Graph
    • Graph - 图
    • Options 配置项
    • 内置扩展
    • Extension - 扩展
  • 数据 Data
  • 元素 Element
    • 元素总览
    • 元素状态
    • 节点 Node
      • 节点总览
      • 内置节点
        • 节点通用配置项
        • Diamond 菱形
        • Donut 甜甜圈
        • Ellipse 椭圆形
        • Hexagon 六边形
        • Html HTML
        • Image 图片
        • Rect 矩形
        • Star 五角形
        • Triangle 三角形
        • Circle 圆形
      • 自定义节点
      • 使用 React 定义节点
    • 边 Edge
      • 边总览
      • 内置边
        • 边通用配置项
        • Cubic 三次贝塞尔曲线
        • CubicHorizontal 水平三次贝塞尔曲线
        • CubicVertical 垂直三次贝塞尔曲线
        • Line 直线
        • Polyline 折线
        • Quadratic 二次贝塞尔曲线
      • 自定义边
    • 组合 Combo
      • 组合总览
      • 内置组合
        • 组合配置项
        • Circle 圆形
        • Rect 矩形
      • 自定义 Combo
    • 图形 Shape
      • 图形 Shape 与 KeyShape
      • 原子 Shape 以及其属性
      • 复合 Shape 的设计与实现
  • 布局 Layout
    • 布局总览
    • 内置布局
      • 布局通用配置项
      • AntvDagre 布局
      • Circular 环形布局
      • ComboCombined 复合布局
      • CompactBox 紧凑树
      • Concentric 同心圆布局
      • D3Force 力导向布局
      • D3Force3D 3D 力导向布局
      • Dagre 布局
      • Dendrogram 生态树
      • Fishbone 鱼骨布局
      • Force 力导向布局
      • ForceAtlas2 力导向布局
      • Fruchterman 力导向布局
      • Grid 网格布局
      • Indented 缩进树
      • MDS 高维数据降维布局
      • Mindmap 脑图树
      • Radial 径向布局
      • Random 随机布局
      • Snake 蛇形布局
    • 自定义布局
  • 交互 Behavior
    • 交互总览
    • 内置交互
      • AutoAdaptLabel 标签自适应显示
      • BrushSelect 框选
      • ClickSelect 点击选中
      • CollapseExpand 展开/收起元素
      • CreateEdge 创建边
      • DragCanvas 拖拽画布
      • DragElement 拖拽元素
      • DragElementForce 力导向拖拽元素
      • FixElementSize 缩放画布时固定元素大小
      • FocusElement 聚焦元素
      • HoverActivate 悬停激活
      • LassoSelect 套索选择
      • OptimizeViewportTransform 优化视口变换
      • ScrollCanvas 滚动画布
      • ZoomCanvas 缩放画布
    • 自定义交互
  • 插件 Plugin
    • 插件总览
    • 内置插件
      • Background 背景
      • BubbleSets 气泡集
      • Contextmenu 上下文菜单
      • EdgeBundling 边绑定
      • EdgeFilterLens 边过滤镜
      • Fisheye 鱼眼放大镜
      • Fullscreen 全屏展示
      • GridLine 网格线
      • History 历史记录
      • Hull 轮廓包围
      • Legend 图例
      • Minimap 小地图
      • Snapline 对齐线
      • Timebar 时间条
      • Toolbar 工具栏
      • Tooltip 提示框
      • Watermark 水印
    • 自定义插件
  • 数据处理 Transform
    • 数据处理总览
    • 内置数据处理
      • MapNodeSize 动态调整节点大小
      • PlaceRadialLabels 径向标签
      • ProcessParallelEdges 平行边
    • 自定义数据处理
  • 主题 Theme
    • 主题总览
    • 自定义主题
    • 色板
    • 自定义色板
  • 动画 Animation
    • 动画总览
    • 自定义动画
  • 扩展阅读
    • 事件
    • 渲染器
    • 坐标系
    • 下载图片
    • 使用 iconfont
    • 使用 3D
    • 项目打包
  • 版本特性
    • 新版本特性
    • 升级到 5.0
  • 常见问题
  • 参与贡献

CompactBox 紧凑树

上一篇
ComboCombined 复合布局
下一篇
Concentric 同心圆布局

Resources

Ant Design
Galacea Effects
Umi-React 应用开发框架
Dumi-组件/文档研发工具
ahooks-React Hooks 库

社区

体验科技专栏
seeconfSEE Conf-蚂蚁体验科技大会

帮助

GitHub
StackOverflow

more products更多产品

Ant DesignAnt Design-企业级 UI 设计语言
yuque语雀-知识创作与分享工具
EggEgg-企业级 Node 开发框架
kitchenKitchen-Sketch 工具集
GalaceanGalacean-互动图形解决方案
xtech蚂蚁体验科技
© Copyright 2025 Ant Group Co., Ltd..备案号:京ICP备15032932号-38

Loading...

概述

紧凑树布局适用于结构化树形数据的展示,基于经典的 Reingold–Tilford tidy 布局算法 演进而来,通过布局时综合考虑每个树节点的包围盒,有效保持树结构的紧凑性与层次清晰。参考更多 CompactBox 布局样例和源码

CompactBox 紧凑树布局示例

使用场景

  • 决策树: 通过紧凑树布局可简单直观的图形化展示每个决策路径
  • 知识图谱: 展示概念之间的层级关系和连接,紧凑布局可以在有限空间内呈现复杂的知识网络

配置方式

const graph = new Graph({
layout: {
type: 'compact-box',
direction: 'LR',
getHeight: () => 16,
getWidth: () => 16,
getVGap: () => 16,
getHGap: () => 40,
},
});

配置项

属性描述类型默认值必选
type布局类型compact-box-✓
direction布局方向,可选值LR | RL | TB | BT | H | VLR
getSide设置节点排布在根节点的左侧/右侧,如未设置,则算法自动分配左侧/右侧。注意:该参数仅在 H 布局方向上生效(d?: NodeData) => string
getId节点 id 的回调函数(d?: NodeData) => string
getWidth计算每个节点的宽度(d?: NodeData) => number
getHeight计算每个节点的高度(d?: NodeData) => number
getHGap计算每个节点的水平间隙(d?: NodeData) => number
getVGap计算每个节点的垂直间隙(d?: NodeData) => number
radial是否启用辐射状布局,说明booleanfalse

direction

LR | RL | TB | BT | H | V Default: LR

树布局方向

  • TB:根节点在上,往下布局

    垂直布局
  • BT:根节点在下,往上布局

    垂直布局
  • LR:根节点在左,往右布局

    水平布局
  • RL:根节点在右,往左布局

    水平布局
  • H:根节点在中间,水平对称布局。可传入 getSide 方法指定每个节点的左右分布逻辑

    水平布局
  • V:根节点在中间,垂直对称布局

    垂直布局

getSide

(d?: NodeData) => string

设置节点排布在根节点的左侧/右侧。注意:该参数仅在 direction 为 H 时生效。如未设置,会默认将子节点前半部分放置在右侧,后半部分放置在左侧,参考 getSide自动计算逻辑。

示例:

(d) => {
// d 是一个节点
if (d.id === 'test-child-id') return 'right';
return 'left';
};

getId

(d?: NodeData) => string

节点 id 的回调函数

示例:

(d) => {
// d 是一个节点
return d.id + '_node';
};

getWidth

(d?: NodeData) => number

每个节点的宽度

示例:

(d) => {
// d 是一个节点
if (d.id === 'testId') return 50;
return 100;
};

getHeight

(d?: NodeData) => number

每个节点的高度

示例:

(d) => {
// d 是一个节点
if (d.id === 'testId') return 50;
return 100;
};

getHGap

(d?: NodeData) => number

每个节点的水平间隙

示例:

(d) => {
// d 是一个节点
if (d.id === 'testId') return 50;
return 100;
};

getVGap

(d?: NodeData) => number

每个节点的垂直间隙

示例:

(d) => {
// d 是一个节点
if (d.id === 'testId') return 50;
return 100;
};

radial

boolean

是否按照辐射状布局。若 radial 为 true,建议 direction 设置为 'LR' 或 'RL'

img

代码示例