logoCreated with Sketch.

G6

ModelRect

阅读时间约 5 分钟

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


提示：数据中无 description 字段时，则不显示描述信息。

使用方法

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

1 实例化图时全局配置

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

const graph = new G6.Graph({
  container: 'mountNode',
  width: 800,
  height: 600,
  defaultNode: {
    shape: 'modelRect',
    // 其他配置
  },
});

2 在数据中动态配置

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

const data = {
  nodes: [{
	  id: 'node0',
    shape: 'modelRect',
    ... // 其他配置
    },
    ... // 其他节点
  ],
  edges: [
    ... // 边
  ]
}

配置项说明

modelRect 节点支持 节点通用配置，下表对部分属性进行解释。对于 Object 类型的配置项将在后面有详细讲解：

名称 含义 类型 备注
size 卡片的大小 Number Array
style 卡片的默认样式 Object Canvas 支持的属性
label 标签文本内容 String
labelCfg 文本配置项 Object
stateStyles 各状态下的样式 Object 只对 keyShape 起作用
linkPoints 视觉上的四个锚点 Object 默认不显示，应与 anchorPoints 配合使用。二者区别请看 linkPoints
preRect 左侧的小矩形 Object modelRect 节点特有
logoIcon 左侧的 logo 图标 Object modelRect 节点特有
stateIcon 右侧的状态图标 Object modelRect 节点特有
description 节点主要文本下方的描述文本 String modelRect 节点特有
descriptionCfg
将在 V3.3 版本后支持		 描述文本的配置项 Object modelRect 节点特有 
    // 节点中 icon 配置
    logoIcon: {
      // 是否显示 icon，值为 false 则不渲染 icon
      show: true,
      x: 0,
      y: 0,
      // icon 的地址，字符串类型
      img: 'https://gw.alipayobjects.com/zos/basement_prod/4f81893c-1806-4de4-aff3-9a6b266bc8a2.svg',
      width: 16,
      height: 16,
      // 用于调整图标的左右位置
      offset: 0
    },
    // 节点中表示状态的 icon 配置
    stateIcon: {
      // 是否显示 icon，值为 false 则不渲染 icon
      show: true,
      x: 0,
      y: 0,
      // icon 的地址，字符串类型
      img: 'https://gw.alipayobjects.com/zos/basement_prod/300a2523-67e0-4cbf-9d4a-67c077b40395.svg',
      width: 16,
      height: 16,
      // 用于调整图标的左右位置
      offset: -5
    }

样式属性 style

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

const data = {
  nodes: [
    {
      x: 100,
      y: 100,
      shape: 'modelRect',
      label: 'modelRect',
    },
  ],
};
const graph = new G6.Graph({
  container: 'mountNode',
  width: 800,
  height: 600,
  defaultNode: {
    // shape: 'modelRect',  // 在数据中已经指定 shape，这里无需再次指定
    size: [200, 80],
    style: {
      fill: '#f0f5ff',
      stroke: '#adc6ff',
      lineWidth: 2,
    },
  },
});
graph.data(data);
graph.render();

标签文本配置 labelCfg

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

const data = {
  // ... data 内容
};
const graph = new G6.Graph({
  // ... 图的其他属性
  defaultNode: {
    // ... 节点其他属性
    labelCfg: {
      style: {
        fill: '#9254de',
        fontSize: 18,
      },
    },
  },
});
// ...

描述文本配置 descriptionCfg

⚠️注意： 将在 V3.3 版本后支持。

Object 类型。通过 descriptionCfg 配置标签文本。支持 节点通用标签配置。此外，还有一个特殊属性：

名称 含义 类型 备注
paddingTop 距离上方标签文本的垂直距离 Number 默认为 0

基于上面 样式属性 style 中的代码，下面代码在 defaultNode 中增加了 descriptionCfg 配置项进行描述文本的配置。

const data = {
  // ... data 内容
};
const graph = new G6.Graph({
  // ... 图的其他属性
  defaultNode: {
    // ... 节点其他属性
    descriptionCfg: {
      style: {
        fill: '#f00',
      },
    },
  },
});
// ...

linkPoints

Object 类型。通过配置 linkPoints ，可以指定 modelRect 周围「上、下、左、右」四个小圆点。

⚠️注意:区分于 anchorPoints： anchorPoints 是真正用于指定该节点相关边的连入位置的「数组」，见 anchorPoints； 而 linkPoints 仅是指定是否「绘制」出四个圆点，不起实际的连接相关边的作用。二者常常配合使用。

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

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

const data = {
  // ... data 内容
};
const graph = new G6.Graph({
  // ... 图的其他属性
  defaultNode: {
    // ... 节点其他属性
    linkPoints: {
      top: true,
      bottom: true,
      left: true,
      right: true,
      size: 5,
      fill: '#fff',
    },
  },
});
// ...

左侧矩形 preRect

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

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

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

const data = {
  // ... data 内容
};
const graph = new G6.Graph({
  // ... 图的其他属性
  defaultNode: {
    // ... 节点其他属性
    preRect: {
      // 设置为 false，则不显示
      show: true,
      fill: '#f759ab',
      width: 8,
    },
  },
});
// ...

图标 logoIcon / stateIcon

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

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

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

const data = {
  // ... data 内容
};
const graph = new G6.Graph({
  // ... 图的其他属性
  defaultNode: {
    // ... 节点其他属性
    logoIcon: {
      show: false,
    },
    stateIcon: {
      show: true,
      img:
        'https://gw.alipayobjects.com/zos/basement_prod/c781088a-c635-452a-940c-0173663456d4.svg',
    },
  },
});
// ...