分析组件

阅读时间约 4 分钟

<ContextMenu /> 组件

Props:

  属性类型是否必选说明
bindType'node' | 'edge' | 'canvas'否事件的监听对象类型,默认值为 node
graphGraph否G6 实例
optionsMenuItemType[]否菜单项配置
render(props: RenderProps) => React.ReactElement否自定义的菜单渲染函数
onContextmenu(e: G6Event, graph: Graph) => boolean;否右键菜单事件的 hook 函数。返回 false 可以阻止右键菜单出现

注意:options 和 render 必须提供一个。

RenderProps

ContextMenu render 函数的参数。

RenderProps extend 了 ContextMenu 的 Props:

  属性类型是否必选说明
onClose( ) => void;否隐藏右键菜单事件回调

MenuItem 的配置项

  属性类型是否必选说明
keystring是React 组件 key
visibleboolean否G6 实例
iconTypeReactElement/HTMLElement否icon 实例:@ant-design/icons
titlestring否菜单项文本
widthnumber否菜单宽度
heightnumber否菜单高度
onClick(props: ContainerProps) => void;否点击回调
render(props: ContainerProps) => ReactElement;否自定义渲染函数

ContainerProps

MenuItem 点击和渲染函数的参数

  属性类型是否必选说明
graphGraph否G6 实例
menuMenuItemType[ ]否菜单项配置
onClose( ) => void;否隐藏右键菜单事件回调

<Toolbar /> 组件

Props:

  属性类型是否必选说明
graphDOMHTMLElement是G6 挂载的 DOM 节点,Graphin 组件的子组件会被自动注入
graphGraph否G6 实例
apisApis否Graphin API
classNamestring否类名
graphVars{ width?: number; height: number; }否G6 图表信息
directionhorizontal | vertical否Toolbar 布局方向
render(props: RenderProps) => MenuItem[ ]否自定义工具栏菜单渲染函数
  属性类型是否必选说明
idstring是唯一标识
namestring是菜单项文本
iconReactElement/HTMLElement否icon 实例:@ant-design/icons
actionhorizontal | vertical是点击事件回调
disabledboolean否是否禁用菜单项
styleCSSProperties否自定义样式
renderTooltip() => ReactElement;否自定义工具栏渲染函数

RenderProps

  属性类型是否必选说明
toolbarCfgMenuItem[]是默认的工具栏配置数组
graphGraph否G6 实例
apisApis否Graphin API
graphVars{ width?: number; height: number; }否G6 图表信息
directionhorizontal | vertical否Toolbar 布局方向

<Legend /> 组件

Props:

  属性类型是否必选说明
optionsOption[]是Legend 的配置
onchange(checked: Option, newOptions: Option[], props: LegendProps) => any;否点击后的回调函数
graphGraph否G6 实例
apisApis否Graphin API

Option

  属性类型是否必选说明
labelstring是标签名
colorstring是小圆点的颜色
valuestring | number是每个 Item 的 Key 值
checkedboolean否默认全部选中