g6/packages/site/docs/manual/middle/elements/shape/shape-and-properties.zh.md

title	order
图形 Shape 及其属性	1

G6 中的元素（节点/边）是由一个或多个图形 Shape 组成，主要通过自定义节点或自定义边时在 draw 方法中使用 group.addShape 添加，G6 中支持以下的图形 Shape：

• circle：圆；
• rect：矩形；
• ellipse：椭圆；
• polygon：多边形；
• fan：扇形；
• image：图片；
• marker：标记；
• path：路径；
• text：文本；
• dom(svg)：DOM（图渲染方式 renderer 为 'svg' 时可用）。

各图形 Shape 的通用属性

属性名	含义	备注
fill	设置用于填充绘画的颜色、渐变或模式	对应 Canvas 属性 fillStyle
stroke	设置用于笔触的颜色、渐变或模式	对应 Canvas 属性 strokeStyle
lineWidth	描边宽度
lineDash	描边虚线	Number[] 类型代表实、虚长度
shadowColor	设置用于阴影的颜色
shadowBlur	设置用于阴影的模糊级别	数值越大，越模糊
shadowOffsetX	设置阴影距形状的水平距离
shadowOffsetY	设置阴影距形状的垂直距离
opacity	设置绘图的当前 alpha 或透明值	对应 Canvas 属性 globalAlpha
fillOpacity	设置填充的 alpha 或透明值
cursor	鼠标在该节点上时的鼠标样式，CSS 的 cursor 选项都支持

用法

group.addShape('rect', {
  attrs: {
    fill: 'red',
    shadowOffsetX: 10,
    shadowOffsetY: 10,
    shadowColor: 'blue',
    shadowBlur: 10,
    opacity: 0.8,
  },
  // 在 G6 3.3 及之后的版本中，必须指定 name，可以是任意字符串，但需要在同一个自定义元素类型中保持唯一性
  name: 'rect-shape',
});

各图形 Shape 的通用方法

attr()

设置或获取实例的绘图属性。

attr(name)

获取实例的属性值。

const width = shape.attr('width');

attr(name, value)

更新实例的单个绘图属性。

attr({...})

批量更新实例绘图属性。

rect.attr({
    fill: '#999',
    stroke: '#666'
});

圆图形 Circle

属性

属性名	含义
x	圆心的 x 坐标
y	圆心的 y 坐标
r	圆的半径

用法

group.addShape('circle', {
  attrs: {
    x: 100,
    y: 100,
    r: 50,
    fill: 'blue',
  },
  // 在 G6 3.3 及之后的版本中，必须指定 name，可以是任意字符串，但需要在同一个自定义元素类型中保持唯一性
  name: 'circle-shape',
});

矩形图形 Rect

属性

属性名	含义	备注
x	矩形左上角的 x 坐标
y	矩形左上角的 y 坐标
width	矩形的宽度
height	矩形的高度
radius	定义圆角	支持整数或数组形式， 分别对应左上、右上、右下、左下角的半径： - radius 缩写为 1 或 [ 1 ] 相当于 [ 1, 1, 1, 1 ] - radius 缩写为 [ 1, 2 ] 相当于 [ 1, 2, 1, 2 ] - radius 缩写为 [ 1, 2, 3 ] 相当于 [ 1, 2, 3, 2 ]

用法

group.addShape('rect', {
  attrs: {
    x: 150,
    y: 150,
    width: 150,
    height: 150,
    stroke: 'black',
    radius: [2, 4],
  },
  // 在 G6 3.3 及之后的版本中，必须指定 name，可以是任意字符串，但需要在同一个自定义元素类型中保持唯一性
  name: 'rect-shape',
});

椭圆图形 Ellipse

属性

属性名	含义
x	圆心的 x 坐标
y	圆心的 y 坐标
rx	水平半径
ry	垂直半径

用法

group.addShape('ellipse', {
  attrs: {
    x: 100,
    y: 100,
    rx: 50,
    ry: 50,
    fill: 'blue',
  },
  // 在 G6 3.3 及之后的版本中，必须指定 name，可以是任意字符串，但需要在同一个自定义元素类型中保持唯一性
  name: 'ellipse-shape',
});

多边形图形 Polygon

属性

属性名	含义	备注
points	多边形的所有端点坐标	数组形式

用法

group.addShape('polygon', {
  attrs: {
    points: [
      [30, 30],
      [40, 20],
      [30, 50],
      [60, 100],
    ],
    fill: 'red',
  },
  // 在 G6 3.3 及之后的版本中，必须指定 name，可以是任意字符串，但需要在同一个自定义元素类型中保持唯一性
  name: 'polygon-shape',
});

图片图形 Image

属性

属性名	含义	备注
x	图片左上角的 x 坐标
y	图片左上角的 y 坐标
width	图片宽度
height	图片高度
img	图片源	G6 支持多种格式的图片：url、ImageData、Image、canvas

用法

group.addShape('image', {
  attrs: {
    x: 0,
    y: 0,
    img: 'https://g.alicdn.com/cm-design/arms-trace/1.0.155/styles/armsTrace/images/TAIR.png',
  },
  // 在 G6 3.3 及之后的版本中，必须指定 name，可以是任意字符串，但需要在同一个自定义元素类型中保持唯一性
  name: 'image-shape',
});

标记图形 Marker

属性

属性名	含义	备注
x	中心的 x 坐标
y	中心的 y 坐标
r	形状半径
symbol	指定形状	内置了一些常用形状，如圆形 circle ， 矩形  square ， 菱形  diamond ，三角形  triangle ， 倒三角形 triangle-down ，也可以是自定义的 path 路径。

用法

group.addShape('marker', {
  attrs: {
    x: 10,
    y: 10,
    r: 10,
    symbol: function (x, y, r) {
      return [['M', x, y], ['L', x + r, y + r], ['L', x + r * 2, y], ['Z']];
    },
  },
  // 在 G6 3.3 及之后的版本中，必须指定 name，可以是任意字符串，但需要在同一个自定义元素类型中保持唯一性
  name: 'marker-shape',
});

路径 Path

  ⚠️ 注意: 当边太细交互不易命中时，请设置 lineAppendWidth 属性值。

属性

属性名	含义	备注
path	线条路径	可以是 String 形式，也可以是线段的数组。
startArrow	起始端的箭头	为 true 时在边的结束端绘制默认箭头，为 false 时不绘制结束端箭头。也可以是一个通过 path 自定义的箭头
endArrow	末尾端的箭头	为 true 时在边的开始端绘制默认箭头，为 false 时不绘制开始端箭头。也可以是一个通过 path 自定义的箭头
lineAppendWidth	边的击中范围	提升边的击中范围，扩展响应范围，数值越大，响应范围越广
lineCap	设置线条的结束端点样式
lineJoin	设置两条线相交时，所创建的拐角形状
lineWidth	设置当前的线条宽度
miterLimit	设置最大斜接长度
lineDash	设置线的虚线样式，可以指定一个数组	一组描述交替绘制线段和间距（坐标空间单位）长度的数字。 如果数组元素的数量是奇数， 数组的元素会被复制并重复。例如， [5, 15, 25] 会变成 [5, 15, 25, 5, 15, 25]。

用法

group.addShape('path', {
  attrs: {
    startArrow: {
      // 自定义箭头指向(0, 0)，尾部朝向 x 轴正方向的 path
      path: 'M 0,0 L 20,10 L 20,-10 Z',
      // 箭头的偏移量，负值代表向 x 轴正方向移动
      // d: -10,
    },
    endArrow: {
      // 自定义箭头指向(0, 0)，尾部朝向 x 轴正方向的 path
      path: 'M 0,0 L 20,10 L 20,-10 Z',
      // 箭头的偏移量，负值代表向 x 轴正方向移动
      // d: -10,
    },
    path: [
      ['M', 100, 100],
      ['L', 200, 200],
    ],
    stroke: '#000',
    lineWidth: 8,
    lineAppendWidth: 5,
  },
  // 在 G6 3.3 及之后的版本中，必须指定 name，可以是任意字符串，但需要在同一个自定义元素类型中保持唯一性
  name: 'path-shape',
});

文本 Text

属性

属性名	含义	备注
fill	设置用于填充绘画的颜色、渐变或模式	对应 Canvas 属性 fillStyle
stroke	设置用于笔触的颜色、渐变或模式	对应 Canvas 属性 strokeStyle
shadowColor	设置用于阴影的颜色
shadowBlur	设置用于阴影的模糊级别	数值越大，越模糊
shadowOffsetX	设置阴影距形状的水平距离
shadowOffsetY	设置阴影距形状的垂直距离
opacity	设置绘图的当前 alpha 或透明值	对应 Canvas 属性 globalAlpha
textAlign	设置文本内容的当前对齐方式	支持的属性：center / end / left / right / start，默认值为 start
textBaseline	设置在绘制文本时使用的当前文本基线	支持的属性: top / middle / bottom / alphabetic / hanging。默认值为 bottom
fontStyle	字体样式	对应 font-style
fontVariant	设置为小型大写字母字体	对应 font-variant
fontWeight	字体粗细	对应 font-weight
fontSize	字体大小	对应 font-size
fontFamily	字体系列	对应 font-family
lineHeight	行高	对应 line-height

用法

group.addShape('text', {
  attrs: {
    text: 'test text',
    x: 0,
    y: 10,
    fontSize: 14,
    textAlign: 'left',
    textBaseline: 'middle',
    fill: '#0000D9',
  },
  // 在 G6 3.3 及之后的版本中，必须指定 name，可以是任意字符串，但需要在同一个自定义元素类型中保持唯一性
  name: 'text-shape',
});

DOM (svg)

仅在 Graph 的 renderer 为 'svg' 时可以使用。

⚠️ 注意:

• 只支持原生 HTML DOM，不支持各类 react、vue 组件；
• 使用 'dom' 进行自定义的节点或边，不支持 G6 的交互事件，请使用原生 DOM 的交互事件；
• 在 Safari 中，若 dom 节点被设置了 position:relative，将会导致渲染异常。该问题与 Safari 的 foreignObject bug 有关。Issus。

特殊属性

属性名	含义	备注
html	DOM 的 html 值

用法

group.addShape('dom', {
  attrs: {
    width: cfg.size[0],
    height: cfg.size[1],
    // DOM's html
    html: `
    <div style="background-color: #fff; border: 2px solid #5B8FF9; border-radius: 5px; width: ${
      cfg.size[0] - 5
    }px; height: ${cfg.size[1] - 5}px; display: flex;">
      <div style="height: 100%; width: 33%; background-color: #CDDDFD">
        <img alt="img" style="line-height: 100%; padding-top: 6px; padding-left: 8px;" src="https://gw.alipayobjects.com/mdn/rms_f8c6a0/afts/img/A*Q_FQT6nwEC8AAAAAAAAAAABkARQnAQ" width="20" height="20" />  
      </div>
      <span style="margin:auto; padding:auto; color: #5B8FF9">${cfg.label}</span>
    </div>
      `,
  },
  // 在 G6 3.3 及之后的版本中，必须指定 name，可以是任意字符串，但需要在同一个自定义元素类型中保持唯一性
  name: 'dom-shape',
  draggable: true,
});