-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
settings.ts
172 lines (151 loc) · 4.9 KB
/
settings.ts
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
163
164
165
166
167
168
169
170
171
172
/**
* Sigma.js Settings
* =================================
*
* The list of settings and some handy functions.
* @module
*/
import { Attributes } from "graphology-types";
import {
EdgeArrowProgram,
EdgeLabelDrawingFunction,
EdgeProgramType,
EdgeRectangleProgram,
NodeCircleProgram,
NodeHoverDrawingFunction,
NodeLabelDrawingFunction,
NodeProgramType,
drawDiscNodeHover,
drawDiscNodeLabel,
drawStraightEdgeLabel,
} from "./rendering";
import { EdgeDisplayData, NodeDisplayData } from "./types";
import { assign } from "./utils";
/**
* Sigma.js settings
* =================================
*/
export interface Settings<
N extends Attributes = Attributes,
E extends Attributes = Attributes,
G extends Attributes = Attributes,
> {
// Performance
hideEdgesOnMove: boolean;
hideLabelsOnMove: boolean;
renderLabels: boolean;
renderEdgeLabels: boolean;
enableEdgeEvents: boolean;
// Component rendering
defaultNodeColor: string;
defaultNodeType: string;
defaultEdgeColor: string;
defaultEdgeType: string;
labelFont: string;
labelSize: number;
labelWeight: string;
labelColor: { attribute: string; color?: string } | { color: string; attribute?: undefined };
edgeLabelFont: string;
edgeLabelSize: number;
edgeLabelWeight: string;
edgeLabelColor: { attribute: string; color?: string } | { color: string; attribute?: undefined };
stagePadding: number;
zoomToSizeRatioFunction: (ratio: number) => number;
itemSizesReference: "screen" | "positions";
defaultDrawEdgeLabel: EdgeLabelDrawingFunction<N, E, G>;
defaultDrawNodeLabel: NodeLabelDrawingFunction<N, E, G>;
defaultDrawNodeHover: NodeHoverDrawingFunction<N, E, G>;
// Labels
labelDensity: number;
labelGridCellSize: number;
labelRenderedSizeThreshold: number;
// Reducers
nodeReducer: null | ((node: string, data: N) => Partial<NodeDisplayData>);
edgeReducer: null | ((edge: string, data: E) => Partial<EdgeDisplayData>);
// Features
zIndex: boolean;
minCameraRatio: null | number;
maxCameraRatio: null | number;
// Lifecycle
allowInvalidContainer: boolean;
// Program classes
nodeProgramClasses: { [type: string]: NodeProgramType<N, E, G> };
nodeHoverProgramClasses: { [type: string]: NodeProgramType<N, E, G> };
edgeProgramClasses: { [type: string]: EdgeProgramType<N, E, G> };
}
export const DEFAULT_SETTINGS: Settings<Attributes, Attributes, Attributes> = {
// Performance
hideEdgesOnMove: false,
hideLabelsOnMove: false,
renderLabels: true,
renderEdgeLabels: false,
enableEdgeEvents: false,
// Component rendering
defaultNodeColor: "#999",
defaultNodeType: "circle",
defaultEdgeColor: "#ccc",
defaultEdgeType: "line",
labelFont: "Arial",
labelSize: 14,
labelWeight: "normal",
labelColor: { color: "#000" },
edgeLabelFont: "Arial",
edgeLabelSize: 14,
edgeLabelWeight: "normal",
edgeLabelColor: { attribute: "color" },
stagePadding: 30,
zoomToSizeRatioFunction: Math.sqrt,
itemSizesReference: "screen",
defaultDrawEdgeLabel: drawStraightEdgeLabel,
defaultDrawNodeLabel: drawDiscNodeLabel,
defaultDrawNodeHover: drawDiscNodeHover,
// Labels
labelDensity: 1,
labelGridCellSize: 100,
labelRenderedSizeThreshold: 6,
// Reducers
nodeReducer: null,
edgeReducer: null,
// Features
zIndex: false,
minCameraRatio: null,
maxCameraRatio: null,
// Lifecycle
allowInvalidContainer: false,
// Program classes
nodeProgramClasses: {},
nodeHoverProgramClasses: {},
edgeProgramClasses: {},
};
export const DEFAULT_NODE_PROGRAM_CLASSES: Record<string, NodeProgramType> = {
circle: NodeCircleProgram,
};
export const DEFAULT_EDGE_PROGRAM_CLASSES: Record<string, EdgeProgramType> = {
arrow: EdgeArrowProgram,
line: EdgeRectangleProgram,
};
export function validateSettings<
N extends Attributes = Attributes,
E extends Attributes = Attributes,
G extends Attributes = Attributes,
>(settings: Settings<N, E, G>): void {
if (typeof settings.labelDensity !== "number" || settings.labelDensity < 0) {
throw new Error("Settings: invalid `labelDensity`. Expecting a positive number.");
}
const { minCameraRatio, maxCameraRatio } = settings;
if (typeof minCameraRatio === "number" && typeof maxCameraRatio === "number" && maxCameraRatio < minCameraRatio) {
throw new Error(
"Settings: invalid camera ratio boundaries. Expecting `maxCameraRatio` to be greater than `minCameraRatio`.",
);
}
}
export function resolveSettings<
N extends Attributes = Attributes,
E extends Attributes = Attributes,
G extends Attributes = Attributes,
>(settings: Partial<Settings<N, E, G>>): Settings<N, E, G> {
const resolvedSettings = assign({}, DEFAULT_SETTINGS, settings);
resolvedSettings.nodeProgramClasses = assign({}, DEFAULT_NODE_PROGRAM_CLASSES, resolvedSettings.nodeProgramClasses);
resolvedSettings.edgeProgramClasses = assign({}, DEFAULT_EDGE_PROGRAM_CLASSES, resolvedSettings.edgeProgramClasses);
return resolvedSettings;
}