Timebar 时间条
上一篇
Snapline 对齐线
下一篇
Toolbar 工具栏
Loading...
时间条插件是一个用于时序数据探索的重要工具，它能够通过时间轴或趋势图的形式展示数据的时间分布，并支持时间区间筛选、动态播放等交互方式，帮助用户更好地理解数据随时间的变化。
以下是一个简单的 Timebar 插件初始化示例：
const graph = new Graph({plugins: [{type: 'timebar',data: timeData, // 时间数据width: 450, // 时间条宽度height: 60, // 时间条高度position: 'bottom', // 位置loop: false, // 是否循环播放},],});
createGraph({data: {nodes: new Array(25).fill(0).map((_, index) => ({id: `node-${index}`,data: {timestamp: new Date('2023-08-01').getTime() + (index % 5) * 3600 * 24 * 1000,value: index % 10,label: new Date(new Date('2023-08-01').getTime() + (index % 5) * 3600 * 24 * 1000).toLocaleString(),},})),edges: new Array(25).fill(0).map((_, i) => ({id: `edge-${i}`,source: `node-${i % 12}`,target: `node-${(i % 10) + 15}`,data: {edgeType: 'e1',},})),},layout: { type: 'grid', cols: 5 },node: {style: { size: 24, fill: '#7e3feb' },palette: { field: 'cluster' },},edge: { style: { stroke: '#8b9baf' } },behaviors: ['drag-canvas'],plugins: ['grid-line',{type: 'timebar',key: 'timebar',data: [10, 2, 3, 4, 15].map((value, index) => ({time: new Date(new Date('2023-08-01').getTime() + index * 3600 * 24 * 1000),value,label: new Date(new Date('2023-08-01').getTime() + index * 3600 * 24 * 1000).toLocaleString(),})),timebarType: 'time',height: 100,},],autoFit: 'view',padding: [10, 0, 100, 0],},{ width: 600, height: 400 },(gui, graph) => {const options = {type: 'timebar',position: 'bottom',enable: true,timebarType: 'time',className: 'g6-timebar',width: 450,height: 100,zIndex: 3,elementTypes: ['node'],mode: 'modify',loop: false,};const optionFolder = gui.addFolder('Timebar Options');optionFolder.add(options, 'type').disable(true);optionFolder.add(options, 'height', 40, 100, 1);optionFolder.add(options, 'width', 200, 800, 1);optionFolder.add(options, 'position', ['bottom', 'top']);optionFolder.add(options, 'timebarType', ['time', 'chart']);optionFolder.add(options, 'loop');optionFolder.onChange(({ property, value }) => {graph.updatePlugin({key: 'timebar',[property]: value,});graph.render();});const apiFolder = gui.addFolder('Timebar API');const instance = graph.getPluginInstance('timebar');apiFolder.add(instance, 'play');apiFolder.add(instance, 'pause');apiFolder.add(instance, 'forward');apiFolder.add(instance, 'backward');apiFolder.add(instance, 'reset');},);
| 属性 | 描述 | 类型 | 默认值 | 必选 |
|---|---|---|---|---|
| type | 插件类型 | string | timebar | ✓ |
| key | 插件的唯一标识，可用于获取插件实例或更新插件选项 | string | - | |
| className | 给工具栏的 DOM 追加的类名 | string | g6-timebar | |
| x | X 位置（设置后 position 会失效） | number | - | |
| y | Y 位置（设置后 position 会失效） | number | - | |
| width | 时间条宽度 | number | 450 | |
| height | 时间条高度 | number | 60 | |
| position | 时间条位置 | bottom | top | bottom | |
| padding | 边距 | number | number[] | 10 | |
| data | 时间数据 | number[] | { time: number; value: number }[] | - | ✓ |
| timebarType | 时间条展示类型 | time | chart | time | |
| elementTypes | 筛选元素类型 | (node | edge | combo)[] | [node] | |
| mode | 控制元素的筛选方式，支持以下两种配置： - modify：通过修改图数据进行筛选 - visibility：通过修改元素可见性进行筛选 | modify | visibility | modify | |
| values | 当前时间值 | number | [number, number] | Date | [Date, Date] | - | |
| loop | 是否循环播放 | boolean | false | |
| getTime | 获取元素时间的方法 | (datum: ElementDatum) => number | - | |
| labelFormatter | 图表模式下自定义时间格式化 | (time: number | Date) => string | - | |
| onChange | 时间区间变化时的回调 | (values: number | [number, number]) => void | - | |
| onReset | 重置时的回调 | () => void | - | |
| onSpeedChange | 播放速度变化时的回调 | (speed: number) => void | - | |
| onPlay | 开始播放时的回调 | () => void | - | |
| onPause | 暂停时的回调 | () => void | - | |
| onBackward | 后退时的回调 | () => void | - | |
| onForward | 前进时的回调 | () => void | - |
timebarType 属性用于控制时间条的展示类型，支持以下两种配置：
最简单的配置方式：
const graph = new Graph({layout: { type: 'grid', cols: 5 },plugins: [{type: 'timebar',data: [{time: new Date('2023-08-01').getTime(),value: 5,},{time: new Date('2023-08-02').getTime(),value: 10,},{time: new Date('2023-08-03').getTime(),value: 15,},],},],data: {nodes: [{id: 'node1',label: '节点1',// 默认情况下 elementTypes=['node']，所以节点需要设置 data.timestamp，才能按照时间轴内的时间依次展示data: {timestamp: new Date('2023-08-01').getTime(),},},{id: 'node2',label: '节点2',data: {timestamp: new Date('2023-08-02').getTime(),},},{id: 'node3',label: '节点3',data: {timestamp: new Date('2023-08-03').getTime(),},},],edges: [{id: 'edge1',source: 'node1',target: 'node2',// 场景一：默认情况 elementTypes = ['node']// - 边不需要设置 data.timestamp，边的显示/隐藏完全取决于其连接的两个节点是否可见// 场景二：如果elementTypes包含了'edge'，比如 elementTypes = ['node', 'edge']// - 此时必须为边设置 data.timestamp，边的显示受其控制// data: {// timestamp: new Date('2023-08-01').getTime()// }},{id: 'edge2',source: 'node2',target: 'node3',},{id: 'edge3',source: 'node3',target: 'node1',},],},});
效果如下：
createGraph({width: 600,height: 400,layout: { type: 'grid', cols: 5 },plugins: [{type: 'timebar',data: [{time: new Date('2023-08-01').getTime(),value: 5,},{time: new Date('2023-08-02').getTime(),value: 10,},{time: new Date('2023-08-03').getTime(),value: 15,},],},],data: {nodes: [{id: 'node1',label: '节点1',data: {timestamp: new Date('2023-08-01').getTime(),},},{id: 'node2',label: '节点2',data: {timestamp: new Date('2023-08-02').getTime(),},},{id: 'node3',label: '节点3',data: {timestamp: new Date('2023-08-03').getTime(),},},],edges: [{id: 'edge1',source: 'node1',target: 'node2',},{id: 'edge2',source: 'node2',target: 'node3',},{id: 'edge3',source: 'node3',target: 'node1',},],},},{ width: 600, height: 400 },);
width、height、padding、className 可自定义时间条的展示效果，但需要注意 className 仅作用于外层 DOM 容器，无法影响时间条内部的 Canvas 渲染内容（时间轴、图表、播放按钮等）。
const graph = new Graph({plugins: [{type: 'timebar',className: 'custom-timebar', // 注意：由于内容是 Canvas 渲染，CSS 样式无法影响到时间条的内部内容width: 400, // 设置时间条宽度height: 80, // 设置时间条高度padding: [20, 20, 10, 20], // 设置内边距 [上, 右, 下, 左]position: 'bottom', // 位置保持在底部data: timeData,// labelFormatter: (time) => {// return new Date(time).toLocaleDateString();// }},],});
通过 CSS 只能设置时间条容器的样式：
.custom-timebar {background-color: #f0f0f0;border: 1px solid #ccc;border-radius: 5px;box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);}
效果如下：
createGraph({data: () => {return {nodes: [{id: 'node1',style: { x: 100, y: 100, label: 'Node 1' },data: {timestamp: new Date('2023-08-01').getTime(),},},{id: 'node2',style: { x: 200, y: 100, label: 'Node 2' },data: {timestamp: new Date('2023-08-01').getTime() + 3600 * 24 * 1000,},},{id: 'node3',style: { x: 150, y: 200, label: 'Node 3' },data: {timestamp: new Date('2023-08-01').getTime() + 3600 * 24 * 1000 * 2,},},],edges: [{ id: 'edge1', source: 'node1', target: 'node2' },{ id: 'edge2', source: 'node2', target: 'node3' },{ id: 'edge3', source: 'node3', target: 'node1' },],};},node: {style: {size: 20,label: true,},},edge: {style: {stroke: '#91d5ff',lineWidth: 1,},},plugins: [{type: 'timebar',className: 'custom-timebar',width: 400,height: 80,padding: [20, 20, 10, 20],position: 'bottom',data: [{time: new Date('2023-08-01').getTime(),value: 5,},{time: new Date('2023-08-01').getTime() + 3600 * 24 * 1000,value: 10,},{time: new Date('2023-08-01').getTime() + 3600 * 24 * 1000 * 2,value: 15,},],labelFormatter: (time) => {return new Date(time).toLocaleDateString();},},],},{ width: 600, height: 400 },(gui, graph) => {gui?.hide();const style = document.createElement('style');style.innerHTML = `.custom-timebar {background-color: #f0f0f0;border: 1px solid #ccc;border-radius: 5px;box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);}`;document.head.appendChild(style);},);