logo

G6

  • 文档
  • API
  • 图表示例
  • 社区
  • 所有产品antv logo arrow
  • 5.0.49
  • 简介
  • 开始使用
    • 快速开始
    • 安装
    • 前端框架集成
      • 在 React 中使用
      • 在 Vue 中使用
      • 在 Angular 中使用
    • 详细教程
  • 图 Graph
    • Graph - 图
    • Options 配置项
    • 内置扩展
    • Extension - 扩展
  • 数据 Data
  • 元素 Element
    • 元素总览
    • 元素状态
    • 节点 Node
      • 节点总览
      • 节点通用配置项
      • 圆形节点 Circle
      • 菱形节点 Diamond
      • 甜甜圈节点 Donut
      • 椭圆形节点 Ellipse
      • 六边形节点 Hexagon
      • HTML节点 Html
      • 图片节点 Image
      • 矩形节点 Rect
      • 五角形节点 Star
      • 三角形节点 Triangle
      • 自定义节点
      • 使用 React 定义节点
    • 边 Edge
      • 边总览
      • 边通用配置项
      • 三次贝塞尔曲线边 Cubic
      • 水平三次贝塞尔曲线边 CubicHorizontal
      • 垂直三次贝塞尔曲线边 CubicVertical
      • 直线边 Line
      • 二次贝塞尔曲线边 Quadratic
      • 折线边 Polyline
      • 自定义边
    • 组合 Combo
      • 组合总览
      • 组合通用配置项
      • 圆形组合 Circle
      • 矩形组合 Rect
      • 自定义 Combo
    • 图形 Shape
      • 图形 Shape 与 KeyShape
      • 原子 Shape 以及其属性
      • 复合 Shape 的设计与实现
  • 布局 Layout
    • 布局总览
    • 布局通用配置项
    • AntV Dagre 布局 AntvDagre
    • 环形布局 Circular
    • 复合布局 ComboCombined
    • 紧凑树布局 CompactBox
    • 同心圆布局 Concentric
    • 3D D3力导向布局 D3Force3D
    • D3力导向布局 D3Force
    • Dagre 布局
    • 生态树 Dendrogram
    • 鱼骨布局 Fishbone
    • ForceAtlas2 力导向布局
    • Force 力导向布局
    • Fruchterman 力导向布局
    • 网格布局 Grid
    • 缩进树 Indented
    • 高维数据降维布局 MDS
    • 脑图树 Mindmap
    • 径向布局 Radial
    • 随机布局 Random
    • 蛇形布局 Snake
    • 自定义布局
  • 交互 Behavior
    • 交互总览
    • 缩放画布 ZoomCanvas
    • 标签自适应显示 AutoAdaptLabel
    • 框选 BrushSelect
    • 点击选中 ClickSelect
    • 展开/收起元素 CollapseExpand
    • 创建边 CreateEdge
    • 拖拽画布 DragCanvas
    • 拖拽元素 DragElement
    • 力导向拖拽元素 DragElementForce
    • 缩放画布时固定元素大小 FixElementSize
    • 聚焦元素 FocusElement
    • 悬停激活 HoverActivate
    • 套索选择 LassoSelect
    • 优化视口变换 OptimizeViewportTransform
    • 滚动画布 ScrollCanvas
    • 自定义交互
  • 插件 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
  • 常见问题
  • 参与贡献

Options 配置项

上一篇
Graph - 图
下一篇
内置扩展

资源

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...

autoFit

{ type: 'view'; options?: FitViewOptions; animation?: ViewportAnimationEffectTiming; } | { type: 'center'; animation?: ViewportAnimationEffectTiming; } | 'view' | 'center'

是否自动适应画布。⚠️ 注意:每次执行 render 时,都会根据 autoFit 进行自适应。

两种基本自适应模式:

  • 'view' - 自动缩放,确保所有内容都在视图内可见
  • 'center' - 内容居中显示,但不改变缩放比例

还可通过对象形式实现更精细的自适应控制:

const graph = new Graph({
autoFit: {
type: 'view', // 自适应类型:'view' 或 'center'
options: {
// 仅适用于 'view' 类型
when: 'overflow', // 何时适配:'overflow'(仅当内容溢出时) 或 'always'(总是适配)
direction: 'x', // 适配方向:'x'、'y' 或 'both'
},
animation: {
// 自适应动画效果
duration: 1000, // 动画持续时间(毫秒)
easing: 'ease-in-out', // 动画缓动函数
},
},
});

FitViewOptions

属性描述类型默认值必选
when在以下情况下进行适配
- 'overflow' 仅当图内容超出视口时进行适配
- 'always' 总是进行适配
'overflow' | 'always''always'
direction仅对指定方向进行适配
- 'x' 仅适配 x 方向
- 'y' 仅适配 y 方向
- 'both' 适配 x 和 y 方向
'x' | 'y' | 'both''both'

ViewportAnimationEffectTiming

type ViewportAnimationEffectTiming =
| boolean // true 启用默认动画,false 禁用动画
| {
easing?: string; // 动画缓动函数:'ease-in-out'、'ease-in'、'ease-out'、'linear'
duration?: number; // 动画持续时间(毫秒)
};

autoResize

boolean 默认值: false

是否自动调整画布大小。

基于 window.onresize 事件实现。当浏览器窗口大小变化时,画布将自动调整大小以适应容器。

background

string

画布背景色。

该颜色作为导出图片时的背景色。可以使用任何有效的 CSS 颜色值,如十六进制、RGB、RGBA 等。

canvas

CanvasConfig

画布配置。GraphOptions 下相关配置项(如 container、width、height、devicePixelRatio、background、cursor)为快捷配置项,会被转换为 canvas 配置项。

CanvasConfig

属性描述类型默认值必填
container画布容器string | HTMLElement-
devicePixelRatio设备像素比number-
width画布宽度number-
height画布高度number-
cursor指针样式,与 GraphOptions.cursor 配置相同string-
background画布背景色string-
renderer渲染器,与 GraphOptions.renderer 配置相同(layer: 'background' | 'main' | 'label' | 'transient') => IRenderer-
enableMultiLayer是否启用多图层。非动态参数,仅在初始化时生效boolean-

container

string | HTMLElement | Canvas

画布容器,可以是以下三种赋值之一:

  • DOM 元素的 ID 字符串,如 'container'
  • HTML 元素对象,如 document.getElementById('container')
  • Canvas 实例,如 new Canvas(options),其中 options 为 CanvasConfig 类型。

cursor

string

指针样式,控制鼠标悬停在画布上时的光标形状。可以使用任何有效的 CSS cursor 值。

支持的值有: 'auto'、'default'、'none'、'context-menu'、'help'、'pointer'、'progress'、'wait'、'cell'、'crosshair'、'text'、'vertical-text'、'alias'、'copy'、'move'、'no-drop'、'not-allowed'、'grab'、'grabbing'、'all-scroll'、'col-resize'、'row-resize'、'n-resize'、'e-resize'、's-resize'、'w-resize'、'ne-resize'、'nw-resize'、'se-resize'、'sw-resize'、'ew-resize'、'ns-resize'、'nesw-resize'、'nwse-resize'、'zoom-in'、'zoom-out'。

这里的 Cursor 值参考 MDN - cursor。

devicePixelRatio

number

设备像素比。

用于高清屏的设备像素比,默认为 window.devicePixelRatio。

width

number

画布宽度。如果未设置,则会自动获取容器宽度。

height

number

画布高度。如果未设置,则会自动获取容器高度。

renderer

(layer: 'background' | 'main' | 'label' | 'transient') => IRenderer

手动指定渲染器

G6 采用了分层渲染的方式,分为 background、main、label、transient 四层,用户可以通过该配置项分别设置每层画布的渲染器。

示例: 使用 SVG 渲染器进行渲染

import { Renderer as SVGRenderer } from '@antv/g-svg';
import { Graph } from '@antv/g6';
const graph = new Graph({
renderer: () => new SVGRenderer(),
});

padding

number | number[]

画布内边距

通常在自适应时,会根据内边距进行适配。可以是单个数值(四边相同)或者数组形式(按顺序指定上、右、下、左的内边距)。

示例:

// 单个数值
const graph1 = new Graph({
padding: 20, // 四边均为 20 像素的内边距
});
// 数组形式
const graph2 = new Graph({
padding: [20, 40, 20, 40], // 上、右、下、左的内边距
});

rotation

number 默认值: 0

旋转角度(以弧度为单位)

x

number

视口 x 坐标,设置视口的初始水平位置。

y

number

视口 y 坐标,设置视口的初始垂直位置。

zoom

number 默认值: 1

设置视口的初始缩放级别,1 表示 100%(原始大小)。

zoomRange

[number, number] 默认值: [0.01, 10]

缩放范围,限制用户可以缩放的最小和最大比例。

animation

boolean | AnimationEffectTiming

启用或关闭全局动画

为动画配置项时,会启用动画,并将该动画配置作为全局动画的基础配置。

AnimationEffectTiming

属性描述类型默认值必选
delay动画延迟时间number-
direction动画方向'alternate' | 'alternate-reverse' | 'normal' | 'reverse''forward'
duration动画持续时间number-
easing动画缓动函数string-
fill动画结束后的填充模式'auto' | 'backwards' | 'both' | 'forwards' | 'none''none'
iterations动画迭代次数number-

示例:

// 简单启用
const graph1 = new Graph({
animation: true,
});
// 详细配置
const graph2 = new Graph({
animation: {
duration: 500, // 动画持续时间(毫秒)
easing: 'ease-in-out', // 缓动函数
},
});

data

GraphData

数据。

GraphData

属性描述类型默认值必选
nodes节点数据NodeData[]-✓
edges边数据EdgeData[]-✓
combos组合数据ComboData[]-✓

NodeData

属性描述类型默认值必选
id节点的唯一标识符,用于区分不同的节点string-✓
type节点类型,内置节点类型名称或者自定义节点的名称string-
data节点数据,用于存储节点的自定义数据,例如节点的名称、描述等。可以在样式映射中通过回调函数获取object-
style节点样式,包括位置、大小、颜色等视觉属性object-
states节点初始状态,如选中、激活、悬停等string[]-
combo所属的组合 ID,用于组织节点的层级关系,如果没有则为 nullstring | null-
children子节点 ID 集合,仅在树图场景下使用string[]-

EdgeData

属性描述类型默认值必选
source边起始节点 IDstring-✓
target边目标节点 IDstring-✓
id边的唯一标识符string-
type边类型,内置边类型名称或者自定义边的名称string-
data边数据,用于存储边的自定义数据,可以在样式映射中通过回调函数获取object-
style边样式,包括线条颜色、宽度、箭头等视觉属性object-
states边初始状态string[]-

ComboData

属性描述类型默认值必选
id组合的唯一标识符string-✓
type组合类型,内置组合类型名称或者自定义组合名称string-
data组合数据,用于存储组合的自定义数据,可以在样式映射中通过回调函数获取object-
style组合样式object-
states组合初始状态string[]-
combo组合的父组合 ID。如果没有父组合,则为 nullstring | null-

示例:

const graph = new Graph({
data: {
nodes: [
{ id: 'node1', style: { x: 100, y: 100 } },
{ id: 'node2', style: { x: 200, y: 200 } },
],
edges: [{ id: 'edge1', source: 'node1', target: 'node2' }],
combos: [{ id: 'combo1', style: { x: 150, y: 150 } }],
},
});
  • 阅读 数据 深入了解图数据,包括不限于数据格式、如何操作数据等。

node

NodeOptions

节点配置项。

NodeOptions

属性描述类型默认值必选
type节点类型,内置节点类型名称或自定义节点的名称Typecircle
style节点样式,包括颜色、大小等Style-
state定义节点在不同状态下的样式State-
palette定义节点的色板,用于根据不同数据映射颜色Palette-
animation定义节点的动画效果Animation-

详见 Node

示例:

const graph = new Graph({
node: {
type: 'circle', // 节点类型
style: {
fill: '#e6f7ff', // 填充色
stroke: '#91d5ff', // 边框色
lineWidth: 1, // 边框宽度
r: 20, // 半径
labelText: (d) => d.id, // 标签文本
},
// 节点状态样式
state: {
hover: {
lineWidth: 2,
stroke: '#69c0ff',
},
selected: {
fill: '#bae7ff',
stroke: '#1890ff',
lineWidth: 2,
},
},
},
});

edge

EdgeOptions

边配置项

EdgeOptions

属性描述类型默认值必选
type边类型,内置边类型名称或自定义边的名称Typeline
style边样式,包括颜色、大小等Style-
state定义边在不同状态下的样式State-
palette定义边的色板,用于根据不同数据映射颜色Palette-
animation定义边的动画效果Animation-

详见 Edge

示例:

const graph = new Graph({
edge: {
type: 'polyline', // 边类型
style: {
stroke: '#91d5ff', // 边的颜色
lineWidth: 2, // 边的宽度
endArrow: true, // 是否有箭头
},
// 边的状态样式
state: {
selected: {
stroke: '#1890ff',
lineWidth: 3,
},
},
},
});

combo

ComboOptions

组合配置项

属性描述类型默认值必选
type组合类型,内置组合类型名称或自定义组合的名称Typecircle
style组合样式,包括颜色、大小等Style-
state定义组合在不同状态下的样式State-
palette定义组合的色板,用于根据不同数据映射颜色Palette-
animation定义组合的动画效果Animation-

详见 Combo

示例:

const graph = new Graph({
combo: {
type: 'circle', // 组合类型
style: {
fill: '#f0f0f0', // 背景色
stroke: '#d9d9d9', // 边框色
lineWidth: 1, // 边框宽度
},
// 组合状态样式
state: {
selected: {
stroke: '#1890ff',
lineWidth: 2,
},
},
},
});

layout

CustomLayoutOptions | CustomLayoutOptions[]

布局配置项,可以是对象(普通布局)或数组(流水线布局)。

示例:

const graph = new Graph({
container: 'container',
layout: {
type: 'force', // 力导向布局
preventOverlap: true, // 防止节点重叠
nodeStrength: -50, // 节点之间的斥力
edgeStrength: 0.5, // 边的弹性系数
iterations: 200, // 迭代次数
animation: true, // 启用布局动画
},
});

theme

false | 'light' | 'dark' | string

设置图表的主题,可以是内置的 'light'、'dark' 主题,也可以是自定义主题的名称。设为 false 则不使用任何主题。

behaviors

(string | CustomExtensionOptions | ((this:Graph) =>CustomExtensionOptions))[]

配置图表的交互行为,可以是字符串(使用默认配置)、对象(自定义配置)或函数(动态配置、函数内可访问图实例)。

示例:

const graph = new Graph({
behaviors: [
'drag-canvas', // 使用默认配置启用画布拖拽
'zoom-canvas', // 使用默认配置启用画布缩放
{
type: 'drag-element', // 自定义配置拖拽元素
key: 'drag-node-only',
enable: (event) => event.targetType === 'node', // 只允许拖拽节点
},
function () {
console.log(this); // 输出 graph 实例
return {
type: 'hover-activate',
};
},
],
});
  • 查看 交互总览 深入了解交互原理
  • 浏览 内置交互 获取所有内置交互列表及其配置选项

plugins

(string | CustomExtensionOptions | ((this:Graph) =>CustomExtensionOptions))[]

设置图表的插件,可以是字符串(使用默认配置)、对象(自定义配置)或函数(动态配置、函数内可访问图实例)。

示例:

const graph = new Graph({
container: 'container',
plugins: [
'minimap', // 启用小地图,使用默认配置
{
type: 'grid', // 启用网格背景
key: 'grid-plugin',
line: {
stroke: '#d9d9d9',
lineWidth: 1,
},
},
{
type: 'toolbar', // 启用工具栏
key: 'graph-toolbar',
position: 'top-right', // 位置
},
],
});
  • 查看 插件总览 深入了解插件原理
  • 浏览 内置插件 获取所有内置插件列表及其配置项

transforms

(string | CustomExtensionOptions | ((this:Graph) =>CustomExtensionOptions))[]

配置数据处理,用于在渲染前对数据进行处理,不会影响原始数据。可以是字符串(使用默认配置)、对象(自定义配置)或函数(动态配置、函数内可访问图实例)。

示例:

const graph = new Graph({
transforms: [
'process-parallel-edges', // 处理平行边,使用默认配置
{
type: 'map-node-size', // 根据节点数据映射节点大小
field: 'value', // 使用 value 字段的值
max: 50, // 最大半径
min: 20, // 最小半径
},
],
});
  • 查看 数据处理总览 深入了解数据处理原理
  • 浏览 内置数据处理 获取所有内置数据处理列表及其配置项

CustomExtensionOptions

interface CustomExtensionOption extends Record<string, any> {
/** 拓展类型 */
type: string;
/** 拓展 key,即唯一标识 */
key?: string;
}