modelRect

G6 内置了方形卡片 modelRect 节点,其默认样式如下。标签文本位于卡片下方。

modelRect - 图1

modelRect - 图2

说明 数据中无 description 字段时,则不显示描述信息。

使用方法

内置节点 一节所示,配置节点的方式有两种:实例化图时全局配置,在数据中动态配置。

1 实例化图时全局配置

用户在实例化 Graph 时候可以通过 defaultNode 指定 shape'modelRect',即可使用 modelRect 节点。

  1. const graph = new G6.Graph({
  2. container: 'mountNode',
  3. width: 800,
  4. height: 600,
  5. defaultNode: {
  6. shape: 'modelRect',
  7. // 其他配置
  8. },
  9. });

2 在数据中动态配置

如果需要使不同节点有不同的配置,可以将配置写入到节点数据中。这种配置方式可以通过下面代码的形式直接写入数据,也可以通过遍历数据的方式写入。

  1. const data = {
  2. nodes: [{
  3. id: 'node0',
  4. shape: 'modelRect',
  5. ... // 其他配置
  6. },
  7. ... // 其他节点
  8. ],
  9. edges: [
  10. ... // 边
  11. ]
  12. }

配置项说明

modelRect 节点支持以下的配置项,对于 Object 类型的配置项将在后面有详细讲解:

名称含义类型备注
size圆的直径NumberArray
stylecircle 默认样式ObjectCanvas 支持的属性
labelCfg文件配置项Object
stateStyles各状态下的样式Object只对 keyShape 起作用
linkPoints相关边的连入点Object默认不显示
icon圆上 icon 配置Object默认不显示 icon
  1. // 节点中icon配置
  2. logoIcon: {
  3. // 是否显示icon,值为 false 则不渲染icon
  4. show: true,
  5. x: 0,
  6. y: 0,
  7. // icon的地址,字符串类型
  8. img: 'https://gw.alipayobjects.com/zos/basement_prod/4f81893c-1806-4de4-aff3-9a6b266bc8a2.svg',
  9. width: 16,
  10. height: 16,
  11. // 用于调整图标的左右位置
  12. offset: 0
  13. },
  14. // 节点中表示状态的icon配置
  15. stateIcon: {
  16. // 是否显示icon,值为 false 则不渲染icon
  17. show: true,
  18. x: 0,
  19. y: 0,
  20. // icon的地址,字符串类型
  21. img: 'https://gw.alipayobjects.com/zos/basement_prod/300a2523-67e0-4cbf-9d4a-67c077b40395.svg',
  22. width: 16,
  23. height: 16,
  24. // 用于调整图标的左右位置
  25. offset: -5
  26. }
名称含义类型备注
sizemodelRect的宽高NumberArray
stylemodelRect默认样式ObjectCanvas 支持的属性
labelCfg文件配置项Object
stateStyles各状态下的样式Object只对 keyShape 起作用
linkPointsmodelRect上的链接点Object默认不显示
preRect左侧的小矩形ObjectmodelRect 节点特有
logoIcon左侧的logo图标ObjectmodelRect 节点特有
stateIcon右侧的状态图标ObjectmodelRect 节点特有

样式属性 style

Object 类型。通过 style 配置来修改节点的填充色、描边等属性。下面代码演示在实例化图时全局配置方法中配置 style,使之达到如下图效果。modelRect - 图3

  1. const data = {
  2. nodes: [
  3. {
  4. x: 100,
  5. y: 100,
  6. shape: 'modelRect',
  7. label: 'modelRect',
  8. },
  9. ],
  10. };
  11. const graph = new G6.Graph({
  12. container: 'mountNode',
  13. width: 800,
  14. height: 600,
  15. defaultNode: {
  16. // shape: 'modelRect', // 在数据中已经指定 shape,这里无需再次指定
  17. size: [200, 80],
  18. style: {
  19. fill: '#f0f5ff',
  20. stroke: '#adc6ff',
  21. lineWidth: 2,
  22. },
  23. },
  24. });
  25. graph.data(data);
  26. graph.render();

标签文本配置 labelCfg

Object 类型。通过 labelCfg 配置标签文本。基于上面 样式属性 style 中的代码,下面代码在 defaultNode 中增加了 labelCfg 配置项进行文本的配置,使之达到如下图效果。modelRect - 图4

  1. const data = {
  2. // ... data 内容
  3. };
  4. const graph = new G6.Graph({
  5. // ... 图的其他属性
  6. defaultNode: {
  7. // ... 节点其他属性
  8. labelCfg: {
  9. style: {
  10. fill: '#9254de',
  11. fontSize: 18,
  12. },
  13. },
  14. },
  15. });
  16. // ...

边的连入点 linkPoints

Object 类型。通过配置 linkPoints ,可以指定 modelRect 周围「上、下、左、右」四个方向上边的连入点。

名称含义类型备注
top是否显示上部的连接点Boolean默认为 false
bottom是否显示底部的连接点Boolean默认为 false
left是否显示左侧的连接点Boolean默认为 false
right是否显示右侧的连接点Boolean默认为 false
size连接点的大小Number默认为 3
fill连接点的填充色String默认为 '#72CC4A&#39;</code></td></tr><tr><td>stroke</td><td>连接点的边框颜色</td><td>String</td><td>默认为 <code>&#39;#72CC4A'
lineWidth连接点边框的宽度Number默认为 1

基于上面 样式属性 style 中的代码,下面代码在 defaultNode 中增加了 linkPoints 配置项进行连入点的配置,使之达到如下图效果。modelRect - 图5

  1. const data = {
  2. // ... data 内容
  3. };
  4. const graph = new G6.Graph({
  5. // ... 图的其他属性
  6. defaultNode: {
  7. // ... 节点其他属性
  8. linkPoints: {
  9. top: true,
  10. bottom: true,
  11. left: true,
  12. right: true,
  13. size: 5,
  14. fill: '#fff',
  15. },
  16. },
  17. });
  18. // ...

左侧矩形 preRect

通过 preRect 可以配置左侧的小矩形形状。

名称含义类型备注
show是否显示左侧小矩形Boolean默认为 true
width左侧小矩形的宽度Number默认为 4
fill左侧小矩形的填充色String默认为 '#40a9ff'
radius左侧小矩形的圆角弧度Number默认为 2

基于上面 样式属性 style 中的代码,下面代码在 defaultNode 中增加了 preRect 配置项进行左侧小矩形的配置,使之达到如下图效果。modelRect - 图6

  1. const data = {
  2. // ... data 内容
  3. };
  4. const graph = new G6.Graph({
  5. // ... 图的其他属性
  6. defaultNode: {
  7. // ... 节点其他属性
  8. preRect: {
  9. // 设置为false,则不显示
  10. show: true,
  11. fill: '#f759ab',
  12. width: 8,
  13. },
  14. },
  15. });
  16. // ...

图标 logoIcon / stateIcon

通过 logoIconstateIcon 可以配置左侧的 logo 小图标和右边的状态小图标,这两个的配置项完全相同。

名称含义类型备注
show是否显示图标Boolean默认为 true
img图标图片String- 左侧图标 logoIcon 的图片默认为 modelRect - 图7- 右侧图标 stateIcon 的图片默认为modelRect - 图8
width图标的宽度Number默认为 16
height图标的高度Number默认为 16
offset图标的左右偏移量Number- 左侧图标 logoIconoffset 默认为 0- 右侧图标 stateIconoffset 默认为 -5

基于上面 样式属性 style 中的代码,下面代码在 defaultNode 中增加了 logoIconstateIcon 配置项进行左右图标的配置,使之达到如下图效果,左侧图标不显示,右侧图标更换图片。modelRect - 图9

  1. const data = {
  2. // ... data 内容
  3. };
  4. const graph = new G6.Graph({
  5. // ... 图的其他属性
  6. defaultNode: {
  7. // ... 节点其他属性
  8. logoIcon: {
  9. show: false,
  10. },
  11. stateIcon: {
  12. show: true,
  13. img:
  14. 'https://gw.alipayobjects.com/zos/basement_prod/c781088a-c635-452a-940c-0173663456d4.svg',
  15. },
  16. },
  17. });
  18. // ...