1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/*
* SPDX-FileCopyrightText: 2023-2024 The Refinery Authors <https://refinery.tools/>
*
* SPDX-License-Identifier: EPL-2.0
*/
import * as d3 from 'd3';
import { type Graphviz, graphviz } from 'd3-graphviz';
import type { BaseType, Selection } from 'd3-selection';
import { reaction, type IReactionDisposer } from 'mobx';
import { observer } from 'mobx-react-lite';
import { useCallback, useRef, useState } from 'react';
import getLogger from '../utils/getLogger';
import type GraphStore from './GraphStore';
import GraphTheme from './GraphTheme';
import { FitZoomCallback } from './ZoomCanvas';
import dotSource from './dotSource';
import postProcessSvg from './postProcessSVG';
const LOG = getLogger('graph.DotGraphVisualizer');
function ptToPx(pt: number): number {
return (pt * 4) / 3;
}
function DotGraphVisualizer({
graph,
fitZoom,
transitionTime,
animateThreshold,
}: {
graph: GraphStore;
fitZoom?: FitZoomCallback;
transitionTime?: number;
animateThreshold?: number;
}): JSX.Element {
const transitionTimeOrDefault =
transitionTime ?? DotGraphVisualizer.defaultProps.transitionTime;
const animateThresholdOrDefault =
animateThreshold ?? DotGraphVisualizer.defaultProps.animateThreshold;
const disposerRef = useRef<IReactionDisposer | undefined>();
const graphvizRef = useRef<
Graphviz<BaseType, unknown, null, undefined> | undefined
>();
const [animate, setAnimate] = useState(true);
const setElement = useCallback(
(element: HTMLDivElement | null) => {
if (disposerRef.current !== undefined) {
disposerRef.current();
disposerRef.current = undefined;
}
if (graphvizRef.current !== undefined) {
// `@types/d3-graphviz` does not contain the signature for the `destroy` method.
(graphvizRef.current as unknown as { destroy(): void }).destroy();
graphvizRef.current = undefined;
}
if (element !== null) {
element.replaceChildren();
const renderer = graphviz(element) as Graphviz<
BaseType,
unknown,
null,
undefined
>;
renderer.keyMode('id');
['TRUE', 'UNKNOWN', 'ERROR'].forEach((icon) =>
renderer.addImage(`#${icon}`, 16, 16),
);
renderer.zoom(false);
renderer.tweenPrecision('5%');
renderer.tweenShapes(false);
renderer.convertEqualSidedPolygons(false);
if (animate) {
const transition = () =>
d3
.transition()
.duration(transitionTimeOrDefault)
.ease(d3.easeCubic);
/* eslint-disable-next-line @typescript-eslint/no-unsafe-argument,
@typescript-eslint/no-explicit-any --
Workaround for error in `@types/d3-graphviz`.
*/
renderer.transition(transition as any);
} else {
renderer.tweenPaths(false);
}
let newViewBox = { width: 0, height: 0 };
renderer.onerror(LOG.error.bind(LOG));
renderer.on(
'postProcessSVG',
// @ts-expect-error Custom `d3-graphviz` hook not covered by typings.
(
svgSelection: Selection<SVGSVGElement, unknown, BaseType, unknown>,
) => {
const svg = svgSelection.node();
if (svg !== null) {
postProcessSvg(svg);
newViewBox = {
width: ptToPx(svg.viewBox.baseVal.width),
height: ptToPx(svg.viewBox.baseVal.height),
};
} else {
// Do not trigger fit zoom.
newViewBox = { width: 0, height: 0 };
}
},
);
renderer.on('renderEnd', () => {
// `d3-graphviz` uses `<title>` elements for traceability,
// so we only remove them after the rendering is finished.
d3.select(element).selectAll('title').remove();
});
if (fitZoom !== undefined) {
if (animate) {
renderer.on('transitionStart', () => fitZoom(newViewBox));
} else {
renderer.on('end', () => fitZoom(false));
}
}
disposerRef.current = reaction(
() => dotSource(graph),
(result) => {
if (result === undefined) {
return;
}
const [source, size] = result;
// Disable tweening for large graphs to improve performance.
// See https://github.com/magjac/d3-graphviz/issues/232#issuecomment-1157555213
const newAnimate = size < animateThresholdOrDefault;
if (animate === newAnimate) {
renderer.renderDot(source);
} else {
setAnimate(newAnimate);
}
},
{ fireImmediately: true },
);
graphvizRef.current = renderer;
}
},
[
graph,
fitZoom,
transitionTimeOrDefault,
animateThresholdOrDefault,
animate,
],
);
return <GraphTheme ref={setElement} colorNodes={graph.colorNodes} />;
}
DotGraphVisualizer.defaultProps = {
fitZoom: undefined,
transitionTime: 250,
animateThreshold: 100,
};
export default observer(DotGraphVisualizer);
|
