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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512 | interface SearchResult {
vertices?: VertexSearchResult;
edges?: EdgesSearchResult;
defaultProps?: DefaultProps;
}
type Theme = 'light' | 'dark';
type EdgeMarker = 'arrow' | 'none';
type VertexLabelOrientation = 'top' | 'bottom' | 'center' | 'left' | 'right';
type SizeMode = 'compact' | 'normal';
interface Settings {
// Size of pagination page (default 100)
pageSize: number;
// Whether to group edges with the same source and target (default false)
groupEdges: boolean;
// Layout type or LayoutSettings (default force)
layout: LayoutType | Partial<LayoutSettings>;
// Network Evolution configuration
evolution: NestedPartial<Shortcuts<Evolution>>;;
// Filters correspond to Legend entries that also controls visiblity/styling highlights
// @Deprecated since version 25.1, use ruleBasedStyles instead
filters: Filter[];
// Smart groups settings
smartGroup: SmartGroup;
// Smart expand settings
smartExpand: SmartExpand;
// Enables live search feature
searchEnabled: boolean;
// Escapes HTML content used on vertex/edge tooltip
escapeHtml: boolean;
// Width used for legend area
legendWidth: number;
// Number of hops used for expand action
numberOfHops: number;
// Smart expand used based on Id
selectedSmartExpand: Nullable<number>;
// Smart group used based on Id
selectedSmartGroup: Nullable<number>;
// Size mode determines the size of UI elements (like toolbar buttons, search region etc). Possible values are 'compact' and 'normal'. When not specified in settings, it will be computed based on the available page width.
sizeMode: SizeMode;
// Property used for live search feature
searchValue: string | undefined;
// Edger marker, can be 'arrow' or 'none', defaults to 'arrow'
edgeMarker: EdgeMarker;
// Flag to show/hide legend of vertices/edges, defaults to true
showLegend: boolean;
// Limit of characters that are shown for vertex/edge label
charLimit: number;
// Show title of edge/vertex components
showTitle: boolean;
// Vertex property showed on the visualization
vertexLabelProperty: Nullable<string>;
// Edge property showed on the visualization
edgeLabelProperty: Nullable<string>;
// Orientation for vertex caption
vertexLabelOrientation: VertexLabelOrientation;
// theme settings (default light theme)
theme: Theme;
// customized theme settings;
customTheme: CustomTheme;
// Limit of characters shown on the vertex/edge tooltip. If not set, defaults to 100
tooltipCharLimit: Nullable<number>;
// Styles applied to all vertices and edges
baseStyles: Styles;
// Rules correspond to Legend entries that also controls visiblity/styling highlights
ruleBasedStyles: RuleBasedStyleSetting[];
}
type FilterComponent = 'vertex' | 'edge';
type ApplyTarget = 'vertex' | 'source' | 'target' | 'edge' | 'ingoing' | 'outgoing';
type FilterOperator = '<' | '<=' | '>' | '>=' | '=' | '!=' | '~' | '*';
interface ElementProperty<T> {
property: string;
value: T;
}
// @Deprecated since version 25.1 - use the equivalent BasicCondition instead
export interface FilterCondition extends ElementProperty<string> {
operator: FilterOperator;
}
export interface BasicCondition extends ElementProperty<string> {
operator: FilterOperator;
}
export interface RuleCondition {
rule: string;
}
interface ExpandCondition extends BasicCondition {
component: FilterComponent;
}
export type ConditionsOperator = 'and' | 'or';
export interface Conditions<T extends FilterCondition | RuleCondition | BasicCondition> {
conditions: T[];
operator: ConditionsOperator;
}
// Graph animations are applied within the filter properties
interface GraphAnimation {
id?: string;
duration: number;
timingFunction: string;
direction?: string;
keyFrames: KeyFrame[];
iterationCount?: number;
}
type FilterProperties = {
colors?: string[];
classes?: string[];
// @Deprecated since version 25.1 - use the equivalent RuleBasedStyle instead
sizes?: number[];
// @Deprecated since version 25.1 - use the equivalent RuleBasedStyle instead
icons?: string[];
// @Deprecated since version 25.1 - use the equivalent RuleBasedStyle instead
iconColors?: string[];
// @Deprecated since version 25.1 - use the equivalent RuleBasedStyle instead
image?: string[];
// @Deprecated since version 25.1 - use the equivalent RuleBasedStyle instead
label?: string[];
// @Deprecated since version 25.1 - use the equivalent RuleBasedStyle instead
style?: string[];
// @Deprecated since version 25.1 - use the equivalent RuleBasedStyle instead
animations?: GraphAnimation[][];
// @Deprecated since version 25.1 - use the equivalent RuleBasedStyle instead
legendTitle?: string[];
// @Deprecated since version 25.1 - use the equivalent RuleBasedStyle instead
legendDescription?: string[];
};
interface FilterInterpolation {
// The property on which interpolation is applied
property: string;
// The minimum range for interpolation
min?: number;
// The maximum range for interpolation
max?: number;
}
// Different types of aggregation functions supported
type AggregationType = 'average' | 'min' | 'max' | 'sum' | 'count' | 'distinctCount';
interface PropertyAggregation {
// The property of vertex or edge on which aggregation is computed
source: string;
// The type of aggregation function used for computation
type: AggregationType;
}
// @Deprecated since version 25.1, use ruleBasedStyles instead
interface Filter extends FromTemplate {
// Marks if Styling is enabled for a filter item and the vertices/edges that it controls
stylingEnabled?: boolean;
// Conditions deciding which vertices/edges will be affected by the filter item
conditions?: Conditions<FilterCondition>;
// The component (eg vertex/edge) for which the filter is defined
component: FilterComponent;
// The target on which this filter applies (vertex, source, target, edge, ingoing, outgoing)
target: ApplyTarget;
// The various properties (like colors, icons, image, animations) of a vertex/edge that this filter's state can affect
properties: FilterProperties;
// Marks if aggregation is enabled for a filter item, based on which computation is performed
aggregationEnabled?: boolean;
// The various aggregation properties configured on this filter
aggregation?: PropertyAggregation[];
// The properties and range on which interpolation will apply
interpolation?: FilterInterpolation;
// References of filter ids
filterReferenceIds?: number[];
}
interface RuleBasedStyleSetting extends FromTemplate {
// Marks if Styling is enabled for a filter item and the vertices/edges that it controls
stylingEnabled?: boolean;
// Conditions deciding which vertices/edges will be affected by the filter item
conditions?: Conditions<BasicCondition | RuleCondition>;
// The component (eg vertex/edge) for which the filter is defined
component: FilterComponent;
// The target on which this filter applies (vertex, source, target, edge, ingoing, outgoing)
target: ApplyTarget;
// The various properties (like colors, icons, image, animations) of a vertex/edge that this filter's state can affect
properties: FilterProperties;
// Marks if aggregation is enabled for a filter item, based on which computation is performed
aggregationEnabled?: boolean;
// The various aggregation properties configured on this filter
aggregation?: PropertyAggregation[];
// The properties and range on which interpolation will apply
interpolation?: FilterInterpolation;
// References of filter ids
filterReferenceIds?: number[];
// Legend title for the rule
legendTitle?: string;
// Style for modifiers. Keys can be selected, unselected, group, hover.
modifierStyles?: TypedMap<VertexStyle | EdgeStyle>;
// Properties for animations
animations?: GraphAnimation[][];
// Marks if the rule is a default rule.
isDefaultRule?: boolean;
}
interface LegendEntry extends Filter, RuleBasedStyleSetting{
// The title of the legend entry when the filter is shown in the legend area
legendTitle?: string[];
// Marks if the legend entry is visible in the legend area
legendEntryVisible: boolean;
// The style of legend entry in the legend area
style: Partial<VertexStyle> | Partial<EdgeStyle>;
// The veritces / edges on which this legend entry has influence
filteredNodes: Vertex[] | Edge[];
// The style is from RuleBasedSetting and will be applied to elements that match the rule.
toApplyStyle?: Partial<VertexStyle> | Partial<EdgeStyle>;
}
type LayoutSettings =
| CircleLayoutSettings
| ConcentricLayoutSettings
| ForceLayoutSettings
| GridLayoutSettings
| HierarchicalLayoutSettings
| PresetLayoutSettings
| RadialLayoutSettings
| RandomLayoutSettings;
type LayoutType = 'circle' | 'concentric' | 'force' | 'grid' | 'hierarchical' | 'preset' | 'radial' | 'random';
interface BaseLayoutSettings {
type: LayoutType;
}
interface SpacingLayoutSettings {
// Spacing among vertices in multiples of vertex radius
spacing: number;
}
interface CircleLayoutSettings extends BaseLayoutSettings, SpacingLayoutSettings {
type: 'circle';
}
interface ClusterOptions {
clusterBy?: string; //vertex property
hideUnclusteredVertices?: boolean;
}
interface ConcentricLayoutSettings extends BaseLayoutSettings, SpacingLayoutSettings {
type: 'concentric';
}
interface ForceLayoutSettings extends BaseLayoutSettings, SpacingLayoutSettings {
type: 'force';
alphaDecay: number; // (default 0.01)
velocityDecay: number; // (default 0.1)
edgeDistance: number; // (default 100)
vertexCharge: number; // (default -60)
clusterEnabled: boolean; // (default false)
clusterOptions?: ClusterOptions;
}
// When selecting grid layout, if neither rows or columns are defined, the graph will be displayed in a square grid
// If rows are selected, it will be displayed in a grid with that many rows
// If columns are selected it will be displayed in a grid witht that many columns
// If both rows and columns are selected, only the rows will be taken into consideration
interface GridLayoutSettings extends BaseLayoutSettings, SpacingLayoutSettings {
type: 'grid';
rows?: number;
columns?: number;
}
type HierarchicalRankDirection =
| 'UL' // Up to left
| 'UR' // Up to right
| 'DL' // Down to left
| 'DR' // Down to right
| 'TB' // Top to bottom
| 'BT' // Bottom to top
| 'LR' // Left to right
| 'RL'; // Right to left
type HierarchicalRanker = 'network-simplex' | 'tight-tree' | 'longest-path';
interface HierarchicalLayoutSettings extends BaseLayoutSettings {
type: 'hierarchical';
// (default 'TB')
rankDirection: HierarchicalRankDirection;
// (default 'network-simplex')
ranker: HierarchicalRanker;
vertexSeparation?: number;
edgeSeparation?: number;
rankSeparation?: number;
}
interface PresetLayoutSettings extends BaseLayoutSettings {
type: 'preset';
// Property of the vertex used as x coordinate
x: string;
// Property of the vertex used as y coordinate
y: string;
}
interface RadialLayoutSettings extends BaseLayoutSettings, SpacingLayoutSettings {
type: 'radial';
}
interface RandomLayoutSettings extends BaseLayoutSettings {
type: 'random';
}
interface MapMarker {
longitude: number;
latitude: number;
content?: string;
}
// Types of maps
type MapType = 'osm_positron' | 'osm_bright' | 'osm_darkmatter' | 'world_map_mb' | 'custom_type';
interface GeographicalLayoutSettings extends BaseLayoutSettings {
type: 'geographical';
longitude: string;
latitude: string;
appId?: string;
mapType?: MapType;
showInfo?: boolean;
showNavigation?: boolean;
layers?: string;
sources?: string;
markers?: MapMarker[];
}
interface EvolutionEntity {
// Start property
start: string;
// End property
end?: string;
}
interface Evolution {
// Height of the UI component (default 100)
height: number;
// Type of the chart (default 'bar')
chart: 'bar' | 'line';
// Aggregation granularity in given unit (default 1)
granularity: number;
// Time unit or undefined for numbers (default undefined)
unit?: 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year';
// Vertex Evolution properties (or just string specifying Start property)
vertex?: string | EvolutionEntity;
// Edge Evolution properties (or just string specifying Start property)
edge?: string | EvolutionEntity;
// Defines exclusion of values
exclude: {
// Array of excluded values
values: (string | number)[];
// Whether to always show or hide excluded values (default false)
show: boolean;
};
// Playback options
playback: {
// Number of vertex / edge changes per step
step: number;
// Number of milliseconds between steps
timeout: number;
};
// When turned on, network evolution will keep the original vertex positions of the graph
// when vertices and edges unfold during playback
preservePositions: boolean;
// Requires a string that represents the format in which the date must be displayed,
// the format must include either YYYY, MM, or DD to work, otherwise, it will be ignored.
// If not provided, the following defaults apply:
// when displaying units of days, only the day will be displayed (1, 15, 30, etc)
// when displaying months only the tag of the month will be displayed (Jan, Feb, etc)
// when displaying years, only the year wil be displayed (2001, 1999, etc).
// If the time window between the first date in the graph and the last date
// in the graph is too big, such that the displayed time label wouldn't fit, it will
// change to the next bigger unit. For example, if days are being used, but the labels don't fit,
// it would try using a month label, if a month label would be too big, a year label would be used
labelFormat?: string;
axis?: 'vertices' | 'edges' | 'both';
}
type SmartExplorerType = 'expand' | 'group';
interface FromTemplate {
_fromTemplate?: boolean;
_id?: number | string;
}
interface SmartExplorer extends FromTemplate {
readonly type: SmartExplorerType;
name: string;
}
interface SmartExpand extends SmartExplorer {
readonly type: 'expand';
numberOfHops: Optional<number>;
navigation: Conditions<ExpandCondition>;
destination: Conditions<ExpandCondition>;
}
interface SmartGroup extends SmartExplorer {
readonly type: 'group';
automatic: boolean;
enabled: boolean;
groupBy?: string;
conditions: Conditions<ExpandCondition>;
}
type Theme = 'light' | 'dark';
interface CustomTheme {
backgroundColor?: string;
textColor?: string;
}
type Styles = TypedMap<VertexStyle | EdgeStyle>;
interface Style extends ElementPosition {
// (default vertex: lightgray, edge: #C0C0C0)
color: string;
// (default 1)
opacity: number;
// Css filter (default none)
filter: string;
// Label settings or just label text or null for no label
label: Nullable<LabelStyle>;
// Legend style or just legend text or null for no legend
legend: Nullable<this & { text: string }>;
// Definitions of child elements (e.g. vertex / edge badges)
children: Nullable<TypedMap<_VertexStyle & Classable>>;
}
interface ImageStyle {
// Image url (default undefined)
url: string;
// Image scale (default 1)
scale?: number;
}
interface BorderStyle {
// Border width (default 1)
width?: number;
// Border color (default #404040)
color?: string;
}
interface IconStyle {
// Icon class e.g. fa-bell (default undefined)
class: string;
// Icon text color (default white)
color?: string;
}
interface VertexStyle extends Style {
// Vertex radius (default 8)
size: number;
// Background image settings or just url or null for no background
image: ImageStyle
// Vertex border settings or just color or null for no border
border: BorderStyle
// Vertex icon settings or just class or null for no icon
icon: IconStyle
}
interface EdgeStyle extends Style {
// Edge width (default 2)
width: number;
// Fill pattern (default undefined)
// Dasharray values '1 5', '5', '5 10', '10 5', '5 1', '15 10 5', '15 10 5 10', '15 10 5 10 15', '5 5 1 5'
dasharray: string;
}
// Position of the label or child vertex
interface ElementPosition {
// Angle position in degrees on the vertex range or null to position into
// center
angle?: Nullable<number>;
// Position on the edge, value between -1 (edge start) and 1 (edge end)
position?: number;
// Offset from: vertex radius (> 0: outside, < 0: inside) or edge path
// (> 0: above, < 0: under)
d: number;
}
interface FontStyle {
// Font size (default 10)
size?: number;
// Font family (default inherited)
family?: string;
// Font style (default inherited)
style?: string;
// Font weight (default inherited)
weight?: string;
}
interface LabelStyle extends ElementPosition {
// Label text
text: string;
// Color (default rgba(0, 0, 0, 0.8))
color?: string;
// Label max length (default 15), the whole label is displayed in tooltip
maxLength: number;
font: FontStyle
}
|