logoCreated with Sketch.

X6

Other

2 min read

方法

removeTools()

removeTools(): this

删除工具。

hideTools()

hideTools(): this

隐藏工具。

showTools()

showTools(): this

显示工具。

defineFilter(...)

defineFilter(options: FilterOptions): string

定义滤镜，返回滤镜 ID。

参数

名称类型必选默认值描述
options.namestring✓滤镜名称。
options.argsstring-滤镜参数。
options.idstring-滤镜 ID，默认自动生成。
options.attrsKeyValue-添加到 <filter> 元素上的属性。

使用

const filterId = graph.defineFilter({
  name: 'dropShadow',
  args: {
    dx: 2,
    dy: 2,
    blur: 3,
  },
})

rect.attr('body/filter', `#${filterId}`)

defineGradient(...)

defineGradient(options: GradientOptions): string

定义渐变背景，返回背景 ID。

参数

名称类型必选默认值描述
options.typestring✓渐变背景元素名称。
options.stops{offset: number; color: string; opacity?: number}[]-渐变背景的控制点。
options.idstring-背景 ID，默认自动生成。
options.attrsKeyValue-添加到渐变背景元素上的属性。

使用

rect.attr('body/fill', `url#${graph.defineGradient(...)}`)
rect.attr('body/stroke', `url#${graph.defineGradient(...)}`)

defineMarker(...)

defineMarker(options: MarkerOptions): string

定义箭头或路径点的 Maker，返回 ID。

参数

名称类型必选默认值描述
options.idstring-默认自动生成。
options.tagNamestring'path'元素标签名。
options.markerUnitsstring'userSpaceOnUse'
options.childrenMarkerOptions[]-子元素。
options.attrsKeyValue-元素的属性。