Graph
Graph 是 G6 图表的载体,所有的 G6 节点实例操作以及事件,行为监听都在 Graph 实例上进行。
Graph 的生命周期为:初始化—>加载数据—>渲染—>更新—>销毁。
初始化
G6.Graph
参数
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
container | String | HTMLElement | 图的 DOM 容器,可以传入该 DOM 的 id 或者直接传入容器的 HTML 节点对象。 |
width | Number | undefined | 指定画布宽度,单位为 'px'。 |
height | Number | undefined | 指定画布高度,单位为 'px'。 |
renderer | String | canvas | 渲染引擎,支持 canvas 和 SVG。 |
fitView | Boolean | false | 是否开启画布自适应。开启后图自动适配画布大小。 |
fitViewPadding | Array | Number | fitView 为 true 时生效。图适应画布时,指定四周的留白。- 可以是一个值, 例如: fitViewPadding: 20 - 也可以是一个数组,例如: fitViewPadding: [ 20, 40, 50, 20 ] 当指定一个值时,四边的边距都相等,当指定数组时,数组内数值依次对应 上,右,下,左四边的边距。 |
groupByTypes | Boolean | true | 各种元素是否在一个分组内,决定节点和边的层级问题,默认情况下所有的节点在一个分组中,所有的边在一个分组中,当这个参数为 false 时,节点和边的层级根据生成的顺序确定。 |
autoPaint | Boolean | true | 当图中元素更新,或视口变换时,是否自动重绘。建议在批量操作节点时关闭,以提高性能,完成批量操作后再打开,参见后面的 setAutoPaint() 方法。 |
modes | Object | 设置画布的模式。详情可见 交互模式 Mode 文档。 | |
nodeStateStyles | Object | {} | 各个状态下节点的样式,例如 hover 、selected ,3.1版本新增。 |
edgeStateStyles | Object | {} | 各个状态下边的样式,例如 hover 、selected ,3.1版本新增。 |
defaultNode | Object | {} | 默认状态下节点的配置,比如 shape , size , color 。会被写入的 data 覆盖。 |
defaultEdge | Object | {} | 默认状态下边的配置,比如 shape , size , color 。会被写入的 data 覆盖。 |
plugins | Array | [] | 向 graph 注册插件。插件机制请见:插件 |
animate | Boolean | false | 是否启用全局动画。 |
animateCfg | Object | 动画配置项,仅在 animate 为 true 时有效。 |
|
animateCfg. onFrame |
Function | null | 回调函数,用于自定义节点运动路径,为空时线性运动。 |
animateCfg. duration |
Number | 500 | 动画时长,单位为毫秒。 |
animateCfg. easing |
String | easeLinear | 动画动效,可参见 d3 ease。 |
minZoom | Number | 0.2 | 最小缩放比例 |
maxZoom | Number | 10 | 最大缩放比例 |
pixelRatio | Number | 1.0 | 像素比率 |
groupType | String | circle | 节点分组类型,支持 circle 和 rect |
groupStyle | Object | groupStyle 用于指定分组的样式,详情参看 节点分组 Group 教程 | |
layout | Object | 布局配置项,使用 type 字段指定使用的布局方式,type可取以下值:random, radial, mds, circular, fruchterman, force, dagre,各布局详细的配置请参考 Layout API 文档 |
⚠️注意:6 3.1 版本中实例化 Graph 时,新增了 nodeStateStyles
及 edgeStateStyles
两个配置项,删除了 nodeStyle
和 edgeStyle
,使用 3.1 以下版本的同学,只需要将 nodeStyle
改成 nodeStateStyles
,将 edgeStyle
改成 edgeStateStyles
,配置内容保持不变。
用法
Graph 的初始化通过 new 进行实例化,实例化时需要传入需要的参数。
const graph = new G6.Graph({
container: '',
width: 500,
height: 500,
modes: {
default: ['drag-canvas'],
},
layout: {
type: 'radial',
unitRadius: 50,
center: [500, 300],
},
});
加载
data(data)
设置图初始化数据。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
data | Object | true | 初始化的图数据,是一个包括 nodes 数组和 edges 数组的对象 |
用法
const data = {
nodes: [
{
id: 'node1',
label: 'node1',
},
{
id: 'node2',
label: 'node2',
},
],
edges: [
{
source: 'node1',
target: 'node2',
},
],
};
// graph 是 Graph 的实例
graph.data(data);
渲染
render()
根据提供的数据渲染视图。
用法
graph.render();
renderCustomGroup(data, groupType)
根据提供的数据渲染组群。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
data | Object | true | 渲染图的数据 |
groupType | string | true | group 类型,支持 'circle' 、'rect' |
用法
const data = {
nodes: [
{
id: 'node1',
groupId: 'group1',
label: 'node1',
},
{
id: 'node2',
groupId: 'group1',
label: 'node2',
},
],
edges: [
{
source: 'node1',
target: 'node2',
},
],
groups: [
{
id: 'group1',
title: {
text: '我的群组1',
stroke: '#444',
offsetX: -20,
offsetY: 30,
},
},
],
};
// graph 是 Graph 的实例
graph.renderCustomGroup(data, 'circle');
read(data)
接收数据,并进行渲染,read 方法的功能相当于 data 和 render 方法的结合。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
data | Object | true | 初始化的图数据,是一个包括 nodes 和 edges 的对象 |
用法
const data = {
nodes: [
{
id: 'node1',
label: 'node1',
},
{
id: 'node2',
label: 'node2',
},
],
edges: [
{
source: 'node1',
target: 'node2',
},
],
};
// graph是Graph的实例
graph.read(data);
changeData(data)
更新数据源,根据新的数据重新渲染视图。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
data | Object | true | 图数据,是一个包括 nodes 和 edges 的对象 |
用法
const data = {
nodes: [
{
id: 'node1',
label: 'node1',
},
{
id: 'node2',
label: 'node2',
},
],
edges: [
{
source: 'node1',
target: 'node2',
},
],
};
// graph是Graph的实例
graph.changeData(data);
collapseGroup(groupId)
收起分组,收起分组后,隐藏分组中的所有节点和边,分组外部与分组内节点有连线的则临时连接到分组上面。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
groupId | String | true | 分组 ID |
用法
graph.collapseGroup('groupId');
expandGroup(groupId)
展开分组,显示分组中的所有节点和边,恢复收起前的连接情况。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
groupId | String | true | 分组 ID |
用法
graph.expandGroup('groupId');
更新
addItem(type, model)
新增元素(节点,边,或节点分组)。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
type | String | true | 元素类型,可选值为 'node' 、'edge' 和 'group' |
model | Object | true | 元素的数据模型,type: 'group' 时,参看 手动创建节点分组文档 |
用法
const model = {
id: 'node',
label: 'node',
address: 'cq',
x: 200,
y: 150,
style: {
fill: 'blue',
},
};
graph.addItem('node', model);
// 当 type 为 'group' 时候,model 的数据结构如下:
const model = {
groupId: 'xxx000999',
nodes: ['123', '23'],
type: 'rect',
zIndex: 0,
title: {
text: '名称',
},
};
graph.addItem('group', model);
add(type, model)
同 addItem(type, model)。
updateItem(item, model)
更新元素,包括更新数据、样式等。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
item | String / Object | true | 元素 ID 或元素实例 |
cfg | Object | false | 需要更新的数据模型 |
用法
const model = {
id: 'node',
label: 'node',
address: 'cq',
x: 200,
y: 150,
style: {
fill: 'blue',
},
};
// 通过 ID 查询节点实例
const item = graph.findById('node');
graph.updateItem(item, model);
update(item, model)
同 updateItem(item, model)。
removeItem(item)
删除元素,当 item 为 group ID 时候,则删除分组。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
item | String / Object | true | 元素 ID 或元素实例 |
用法
// 通过 ID 查询节点实例
const item = graph.findById('node');
graph.removeItem(item);
remove(item)
同 removeItem(item)。
refresh()
当源数据发生变更时,根据新数据刷新视图。
该方法无参数。
用法
graph.refresh();
refreshItem(item)
刷新指定元素。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
item | String / Object | true | 元素 ID 或元素实例 |
用法
// 通过 ID 查询节点实例
const item = graph.findById('node');
graph.refreshItem(item);
refreshPositions()
当节点位置发生变化时,刷新所有节点位置,并重计算边的位置。
该方法无参数。
用法
graph.refreshPositions();
paint()
仅重新绘制画布。当设置了元素样式或状态后,通过调用 paint()
方法,让修改生效。
该方法无参数。
用法
const item = e.item;
const graph = this.graph;
const autoPaint = graph.get('autoPaint');
graph.setAutoPaint(false);
graph.setItemState(item, 'selected', true);
graph.paint();
graph.setAutoPaint(autoPaint);
setAutoPaint(auto)
设置是否在更新/删除后自动重绘,一般搭配 paint()
方法使用。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
auto | Boolean | true | 是否自动重绘 |
用法
const item = e.item;
const graph = this.graph;
const autoPaint = graph.get('autoPaint');
graph.setAutoPaint(false);
graph.setItemState(item, 'selected', true);
graph.paint();
graph.setAutoPaint(autoPaint);
布局
G6 3.1 内置了丰富的布局。关于如何使用 G6 中内置的布局,请参考 Layout API。
layout()
重新以当前配置的属性进行一次布局。
用法
const graph = new G6.Graph({
container: 'mountNode',
width: 1000,
height: 600,
layout: {
type: 'force',
},
modes: {
default: ['drag-node'],
},
});
graph.data({
nodes: data.nodes,
edges: data.edges.map((edge, i) => {
edge.id = 'edge' + i;
return Object.assign({}, edge);
}),
});
graph.render();
function refreshDragedNodePosition(e) {
const model = e.item.get('model');
model.fx = e.x;
model.fy = e.y;
}
graph.on('node:dragstart', e => {
// 拖动节点时重新布局
graph.layout();
refreshDragedNodePosition(e);
});
graph.on('node:drag', e => {
refreshDragedNodePosition(e);
});
graph.on('node:dragend', e => {
e.item.get('model').fx = null;
e.item.get('model').fy = null;
});
updateLayout(cfg)
更新布局配置项。
- 如果参数
cfg
中含有type
字段,type
字段类型为 String,且与现有布局方法不同,则更换布局; - 如果参数
cfg
中不包含type
字段,则保持原有布局,仅更新布局配置项。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
cfg | Object | true | 新布局配置项 |
用法
const graph = new G6.Graph({
container: 'mountNode',
width: 1000,
height: 600,
modes: {
default: ['drag-canvas', 'drag-node'],
},
layout: {
type: 'circular',
center: [500, 300],
},
animate: true,
});
graph.data(data);
graph.render();
// 实例化时通过 layout 指定布局,在合适的时候通过 updateLayout 更新布局配置
graph.updateLayout({
radius: 200,
startAngle: Math.PI / 4,
endAngle: Math.PI,
divisions: 5,
ordering: 'degree',
});
销毁
clear()
清除画布元素。该方法一般用于清空数据源,重新设置数据源,重新 render 的场景,此时所有的图形都会被清除。
该方法无参数。
用法
graph.clear();
destroy()
销毁画布。
该方法无参数。
用法
graph.destroy();
状态
showItem(item)
显示指定的元素。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
item | String / Object | true | 元素 ID 或元素实例 |
用法
// 通过 ID 查询节点实例
const item = graph.findById('nodeId');
graph.showItem(item);
// 等价于
graph.showItem('nodeId');
hideItem(item)
隐藏指定元素。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
item | String / Object | true | 元素 ID 或元素实例 |
用法
// 通过 ID 查询节点实例
const item = graph.findById('nodeId');
graph.hideItem(item);
// 等价于
graph.hideItem('nodeId');
setItemState(item, state, enabled)
设置元素状态。
该方法在执行过程中会触发 beforitemstatechange
,afteritemstatechange
事件。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
item | String / Object | true | 元素 ID 或元素实例 |
state | String | true | 状态值,支持自定义,如 selected、hover、actived 等。 |
enabled | Boolean | true | 是否启用状态 |
用法
graph.setItemState('node1', 'selected', true);
clearItemStates(item, states)
清除元素状态,可以一次性清除多个状态。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
item | String / Object | true | 元素 ID 或元素实例 |
states | String / Array | null | false |
用法
// 清除单个状态
graph.clearItemStates(node, 'a');
// 清除多个状态
graph.clearItemStates(node, ['a', 'b']);
// 清除所有状态
graph.clearItemStates(node);
node(nodeFn)
设置各个节点样式,以及在各个状态下节点的 KeyShape 的样式。
提示:该方法必须在 render 之前调用,否则不起作用。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
nodeFn | Function | true | 指定每个节点样式 |
用法
graph.node(node => {
return {
id: node.id,
shape: 'rect',
style: {
fill: 'blue',
},
};
});
graph.data(data);
graph.render();
edge(edgeFn)
设置各条边的样式。
提示:该方法必须在 render 之前调用,否则不起作用。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
edgeFn | Function | true | 指定每条边的样式 |
用法
graph.edge(edge => {
return {
id: edge.id,
shape: 'cubic-horizontal',
style: {
stroke: 'green',
},
};
});
graph.data(data);
graph.render();
交互
addBehaviors(behaviors, modes)
新增行为,将单个或多个行为添加到单个或多个模式中。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
behaviors | String / Array | true | 添加的行为的名称 |
modes | String / Array | true | 模式的名称 |
用法
// 将单个 Behavior 添加到单个模式(默认的 default 模式)中
graph.addBehaviors('click-select', 'default');
// 将多个 Behavior 添加到单个模式(默认的 default 模式)中
graph.addBehaviors(['brush-select', 'click-select'], 'default');
// 将单个 Behavior 添加到多个模式中
graph.addBehaviors('brush-select', ['default', 'select']);
// 将多个 Behavior 添加到多个模式中
graph.addBehaviors(['brush-select', 'click-select'], ['default', 'select']);
removeBehaviors(behaviors, modes)
移除行为,将单个或多个行为从单个或多个模式中去除。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
behaviors | String / Array | true | 删除的行为的名称 |
modes | String / Array | true | 模式的名称 |
用法
// 从单个模式中移除单个 Behavior
graph.removeBehaviors('click-select', 'default');
// 从单个模式中移除多个 Behavior
graph.removeBehaviors(['brush-select', 'click-select'], 'default');
// 从多个模式中移除单个 Behavior
graph.removeBehaviors('brush-select', ['default', 'select']);
// 从多个模式中移除多个 Behavior
graph.removeBehaviors(['brush-select', 'click-select'], ['default', 'select']);
setMode(mode)
切换图行为模式。主要用于不同模式下的行为切换,如从编辑模式下切换到只读模式。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
mode | String | true | 模式的名称 |
用法
const graph = new G6.Graph({
container: div,
width: 500,
height: 500,
pixelRatio: 2,
modes: {
default: [...],
custom: [...]
}
})
graph.setMode('custom')
getCurrentMode()
获取当前的行为模式。
该方法无参数。
返回值
- 返回值类型:String;
- 返回值表示当前的行为模式。
用法
// 返回值 mode 表示当前的行为模式
const mode = graph.getCurrentMode();
getZoom()
获取当前视口的缩放比例。
该方法无参数。
返回值
- 返回值类型:Number;
- 返回值表示当前视口的缩放比例, 默认值为
1
。
用法
// 返回值zoom表示当前视口的缩放比例
const zoom = graph.getZoom();
zoom(ratio, center)
改变视口的缩放比例,在当前画布比例下缩放,是相对比例。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
ratio | Number | true | 缩放比例 |
center | Object | false | 以 center 的 x 、y 坐标为中心缩放,如果省略了 center 参数,则以元素当前位置为中心缩放 |
用法
// 以 (100, 100) 为中心点,放大3倍
graph.zoom(3, { x: 100, y: 100 });
// 以当前元素位置为中心,缩小到 0.5
graph.zoom(0.5);
zoomTo(toRatio, center)
缩放视窗窗口到一个固定比例。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
toRatio | Number | true | 固定比例值 |
center | Object | false | 以 center 的 x 、y 坐标为中心缩放,如果省略了 center 参数,则以元素当前位置为中心缩放 |
用法
// 以 (100, 100) 为中心点,放大3倍
graph.zoomTo(3, { x: 100, y: 100 });
// 以当前元素位置为中心,缩小到 0.5
graph.zoomTo(0.5);
focusItem(item)
将元素移动到视口中心,该方法可用于做搜索后的缓动动画。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
item | String / Object | true | 元素 ID 或元素实例 |
用法
graph.focusItem(item);
changeSize(width, height)
改变画布大小。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
width | Number | true | 画布宽度 |
height | Number | true | 画布高度 |
用法
graph.changeSize(600, 350);
translate(dx, dy)
采用相对位移来平移画布。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
dx | Number | true | 水平方向位移 |
dy | Number | true | 垂直方向位移 |
用法
graph.translate(100, 100);
moveTo(x, y)
采用绝对位移将画布移动到指定坐标。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
x | Number | true | 水平方向坐标 |
y | Number | true | 垂直方向坐标 |
用法
graph.moveTo(200, 300);
fitView(padding)
让画布内容适应视口。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
padding | Number / Array | false | [top, right, bottom, left] 四个方向上的间距值 |
用法
// padding 只设置为一个值,则表示 top = right = bottom = left = 20
graph.fitView(20);
// 等价于 graph.fitView(20)
graph.fitView([20]);
// padding 设置为数组,只传 2 个值,则 top = bottom = 20, right = left = 10
graph.fitView([20, 10]);
// padding 设置为数组,四个方向值都指定
graph.fitView([20, 10, 20, 15]);
查找
find(type, fn)
根据具体规则查找单个元素。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
type | String | true | 元素类型,可选值为 'node' 、'edge' |
fn | Function | true | 查找的规则 |
返回值
- 返回值类型:Object;
- 如果有符合规则的元素实例,则返回第一个匹配的元素实例,否则返回
undefined
。
用法
const findNode = graph.find('node', node => {
return node.get('model').x === 100;
});
findById(id)
根据 ID,查询对应的元素实例。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
id | String | true | 元素 ID |
返回值
- 返回值类型:Object;
- 如果有符合规则的元素实例,则返回该元素实例,否则返回
undefined
。
用法
const node = graph.findById('node');
findAll(type, fn)
查询所有满足规则的元素。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
type | String | true | 元素类型,可选值为 'node' 、'edge' |
fn | Function | true | 查找的规则 |
返回值
- 返回值类型:Array;
- 如果有符合规则的元素实例,则返回所有元素实例,否则返回
undefined
。
用法
const nodes = graph.findAll('node', node => {
return node.get('model').x;
});
findAllByState(type, state)
查找所有处于指定状态的元素。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
type | String | true | 元素类型,可选值为 'node' 、'edge' |
state | String | true | 状态名称 |
返回值
- 返回值类型:Array;
- 返回所有指定状态的元素实例。
用法
// 查询所有选中的元素
const nodes = graph.findAllByState('node', 'selected');
数据
save()
获取图数据。
该方法无参数。
返回值
- 返回值类型:Object;
-
返回值包括所有节点和边,数据结构如下下所示:
{ nodes: [], edges: [], groups: [], }
用法
graph.save();
getNodes()
获取图中所有节点的实例。
⚠️注意:这里返回的是节点的实例,而不是节点的数据项。
返回值
- 返回值类型:Array;
- 返回值表示图中所有节点的实例。
用法
const nodes = graph.getNodes();
getEdges()
获取图中所有边的实例。
⚠️注意:这里返回的是边的实例,而不是边的数据项。
返回值
- 返回值类型:Array;
- 返回值表示图中所有边的实例。
用法
const edges = graph.getEdges();
坐标转换
这部分主要是说明视口坐标、Canvas 坐标和页面坐标之前的相互转换。其中视口坐标和 Canvas 坐标的示意图如下所示。
getPointByClient(clientX, clientY)
将屏幕/页面坐标转换为视口坐标。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
clientX | Number | true | 屏幕 x 坐标 |
clientY | Number | true | 屏幕 y 坐标 |
返回值
- 返回值类型:Object;
- 包含的属性:x 和 y 属性,分别表示视口的 x 、y 坐标。
用法
const point = graph.getPointByClient(e.clientX, e.clientY);
console.log('视口 x/y 坐标分别为:', point.x, point.y);
getClientByPoint(x, y)
将视口坐标转换为屏幕/页面坐标。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
x | Number | true | 视口 x 坐标 |
y | Number | true | 视口 y 坐标 |
返回值
- 返回值类型:Object;
- 包含的属性:
x
和y
属性,分别表示屏幕/页面的 x、y 坐标。
用法
const point = graph.getClientByPoint(100, 200);
console.log('屏幕/页面x/y坐标分别为:', point.x, point.y);
getPointByCanvas(canvasX, canvasY)
将 Canvas 画布坐标转换为视口坐标。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
canvasX | Number | true | 画布 x 坐标 |
canvasY | Number | true | 画布 y 坐标 |
返回值
- 返回值类型:Object;
- 包含的属性:x 和 y 属性,分别表示视口的 x、y 坐标。
用法
const point = graph.getPointByCanvas(100, 200);
console.log('视口x/y坐标分别为:', point.x, point.y);
getCanvasByPoint(x, y)
将视口坐标转换为 Canvas 画布坐标。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
x | Number | true | 视口 x 坐标 |
y | Number | true | 视口 y 坐标 |
返回值
- 返回值类型:Object;
- 包含的属性:x 和 y 属性,分别表示 Canvas 画布的 x、y 坐标。
用法
const point = graph.getCanvasByPoint(100, 200);
console.log('Canvas画布的x/y坐标分别为:', point.x, point.y);
动画
positionsAnimate()
根据当前数据中的节点位置,动画更新节点位置。将会使用 graph 上的 animateCfg
配置项作为动画行为的依据。
stopAnimate()
停止画布上的所有动画。
用法
graph.stopAnimate();
isAnimating()
判断当前是否有正在执行的动画。
其他
addPlugin(plugin)
添加指定的插件。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
plugin | Object | true | 插件实例 |
用法
import miniMap from '@antv/g6/build/minimap';
graph.Plugin(miniMap);
removePlugin(plugin)
移除指定的插件。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
plugin | Object | true | 插件实例 |
用法
import miniMap from '@antv/g6/build/minimap';
graph.removePlugin(miniMap);
get(key)
根据 key 获取属性值。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
key | String | true | 属性的键 |
用法
// 获取 group
const group = graph.get('group');
// 获取 canvas 实例
const canvas = graph.get('canvas');
// 获取 autoPaint 值
const autoPaint = graph.get('autoPaint');
set(key, val)
设置属性值。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
key | String | true | 属性的键 |
val | String / Object / Array | true | 属性的值 |
用法
// 设置 capture 值为 false
graph.set('capture', false);
// 设置 customGroup 值为 group
graph.set('customGroup', group);
// 设置 nodeIdList 值为数组
graph.set('nodeIdList', [1, 3, 5]);
downloadImage(name)
将画布上的元素导出为图片。
参数
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
name | String | true | 图片的名称 |
用法
graph.downloadImage();
toDataURL()
将画布上元素生成为图片的 URL。
返回值
- 返回值类型:String;
- 返回值表示生成的图片的 URL。
用法
const dataURL = graph.toDataURL();