relation-chart
v1.1.5
Published
A relation chart library based on D3.js force
Downloads
8
Maintainers
Readme
relation-chart
人物关系图生成器
可进行拖拽,缩放
高亮选中的节点
install
npm:
npm install relation-chart --save
引用
ES6:
import RelationChart from 'relation-chart'
Script tag:
// 引用 dist/dist.js 文件,注意自己项目的路径
<script src="./node_modules/relation-chart/dist/dist.js"></script>
API
new RelationChart(domElement, data[, config])
参数说明:
- domElement:容器dom元素
- data:人物关系图的数据,格式见下文
- config:自定义配置,可省略,默认详细配置见下文
数据格式
{
// 节点列表
nodes:[
{
"name": "路人甲",
"avatar": "./img/140646844806.jpg"
},
{
"name": "路人乙",
"avatar": "./img/141611471224.jpg"
},
{
"name": "路人丙",
"avatar": "./img/140848800133.jpg"
},
],
// 线条列表
links:[
{
"source": 0, // 起始节点在 nodes[] 中的索引
"target": 1, // 目标节点在 nodes[] 中的索引
"relation": "朋友", // 关系名称
"color": "734646" // 自定义细条颜色,#734646
},
{
"source": 1,
"target": 2,
"relation": "女朋友",
"color": "734646"
},
],
}
config
默认配置
const defaultConfig = {
width: 1000, // 总画布svg的宽,单位为px,默认为容器的宽
height: 800, // 高,默认为容器的高
isHighLight: true, // 是否启动 鼠标 hover 到节点上高亮与节点有关的节点,其他无关节点透明的功能
isScale: true, // 是否启用缩放平移zoom功能
scaleExtent: [0.5, 1.5], // 缩放的比例尺
chargeStrength: -300, // 万有引力
collide: 100, // 碰撞力的大小 (节点之间的间距)
nodeWidth: 160, // 每个node节点所占的宽度,正方形
margin: 20, // node节点距离父亲div的margin
alphaDecay: 0.0228, // 控制力学模拟衰减率
r: 45, // 头像的半径 [30 - 45]
relFontSize: 12, // 关系文字字体大小
linkSrc: 30, // 划线时候的弧度
linkColor: '#bad4ed', // 链接线默认的颜色
strokeColor: '#7ecef4', // 头像外围包裹的颜色
strokeWidth: 3, // 头像外围包裹的宽度
}
自定义配置会覆盖默认配置
example
html 有个承载 svg 图的容器
<div id="map" style="width: 1000px;height: 800px">
</div>
import RelationChart from 'relation-chart'
// 容器
let element = document.querySelector('#map');
// 关系图数据
let data = {
nodes: [
{
"name": "路人甲",
"avatar": "./img/140646844806.jpg"
},
{
"name": "路人乙",
"avatar": "./img/141611471224.jpg"
},
{
"name": "路人丙",
"avatar": "./img/140848800133.jpg"
},
],
links: [
{
"source": 0,
"target": 1,
"relation": "朋友",
"color": "734646"
},
{
"source": 1,
"target": 2,
"relation": "女朋友",
"color": "734646"
},
],
}
// 创建人物关系图 svg
new RelationChart(element, data)
vue 中使用案例
<template>
<div class="page">
<div id="map" class="map" ref="map" style="width: 1000px;height: 1000px;">
</div>
</div>
</template>
<script>
import RelationChart from 'relation-chart'
export default {
data () {
return {}
},
mounted() {
new RelationChart(this.$refs.map, data)
},
}
</script>