venn.src.js
38.7 KB
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
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
/* *
* Experimental Highcharts module which enables visualization of a Venn Diagram.
*
* (c) 2016-2019 Highsoft AS
*
* Authors: Jon Arild Nygard
*
* Layout algorithm by Ben Frederickson:
* https://www.benfrederickson.com/better-venn-diagrams/
*
* License: www.highcharts.com/license
*/
'use strict';
import draw from '../mixins/draw-point.js';
import geometry from '../mixins/geometry.js';
import geometryCircles from '../mixins/geometry-circles.js';
import NelderMeadModule from '../mixins/nelder-mead.js';
// TODO: replace with individual imports
var nelderMead = NelderMeadModule.nelderMead;
import H from '../parts/Globals.js';
import U from '../parts/Utilities.js';
var isArray = U.isArray,
isNumber = U.isNumber,
isObject = U.isObject,
isString = U.isString;
import '../parts/Series.js';
var addEvent = H.addEvent,
color = H.Color,
extend = H.extend,
getAreaOfCircle = geometryCircles.getAreaOfCircle,
getAreaOfIntersectionBetweenCircles =
geometryCircles.getAreaOfIntersectionBetweenCircles,
getCircleCircleIntersection = geometryCircles.getCircleCircleIntersection,
getCenterOfPoints = geometry.getCenterOfPoints,
getDistanceBetweenPoints = geometry.getDistanceBetweenPoints,
getOverlapBetweenCirclesByDistance =
geometryCircles.getOverlapBetweenCircles,
isPointInsideAllCircles = geometryCircles.isPointInsideAllCircles,
isPointInsideCircle = geometryCircles.isPointInsideCircle,
isPointOutsideAllCircles = geometryCircles.isPointOutsideAllCircles,
merge = H.merge,
seriesType = H.seriesType,
seriesTypes = H.seriesTypes;
var objectValues = function objectValues(obj) {
return Object.keys(obj).map(function (x) {
return obj[x];
});
};
/**
* Calculates the area of overlap between a list of circles.
* @private
* @todo add support for calculating overlap between more than 2 circles.
* @param {Array<object>} circles List of circles with their given positions.
* @return {number} Returns the area of overlap between all the circles.
*/
var getOverlapBetweenCircles = function getOverlapBetweenCircles(circles) {
var overlap = 0;
// When there is only two circles we can find the overlap by using their
// radiuses and the distance between them.
if (circles.length === 2) {
var circle1 = circles[0];
var circle2 = circles[1];
overlap = getOverlapBetweenCirclesByDistance(
circle1.r,
circle2.r,
getDistanceBetweenPoints(circle1, circle2)
);
}
return overlap;
};
/**
* Calculates the difference between the desired overlap and the actual overlap
* between two circles.
* @private
* @param {object} mapOfIdToCircle Map from id to circle.
* @param {Array<object>} relations List of relations to calculate the loss of.
* @return {number} Returns the loss between positions of the circles for the
* given relations.
*/
var loss = function loss(mapOfIdToCircle, relations) {
var precision = 10e10;
// Iterate all the relations and calculate their individual loss.
return relations.reduce(function (totalLoss, relation) {
var loss = 0;
if (relation.sets.length > 1) {
var wantedOverlap = relation.value;
// Calculate the actual overlap between the sets.
var actualOverlap = getOverlapBetweenCircles(
// Get the circles for the given sets.
relation.sets.map(function (set) {
return mapOfIdToCircle[set];
})
);
var diff = wantedOverlap - actualOverlap;
loss = Math.round((diff * diff) * precision) / precision;
}
// Add calculated loss to the sum.
return totalLoss + loss;
}, 0);
};
/**
* Finds the root of a given function. The root is the input value needed for
* a function to return 0.
*
* See https://en.wikipedia.org/wiki/Bisection_method#Algorithm
*
* TODO: Add unit tests.
*
* @param {function} f The function to find the root of.
* @param {number} a The lowest number in the search range.
* @param {number} b The highest number in the search range.
* @param {number} [tolerance=1e-10] The allowed difference between the returned
* value and root.
* @param {number} [maxIterations=100] The maximum iterations allowed.
*/
var bisect = function bisect(f, a, b, tolerance, maxIterations) {
var fA = f(a),
fB = f(b),
nMax = maxIterations || 100,
tol = tolerance || 1e-10,
delta = b - a,
n = 1,
x, fX;
if (a >= b) {
throw new Error('a must be smaller than b.');
} else if (fA * fB > 0) {
throw new Error('f(a) and f(b) must have opposite signs.');
}
if (fA === 0) {
x = a;
} else if (fB === 0) {
x = b;
} else {
while (n++ <= nMax && fX !== 0 && delta > tol) {
delta = (b - a) / 2;
x = a + delta;
fX = f(x);
// Update low and high for next search interval.
if (fA * fX > 0) {
a = x;
} else {
b = x;
}
}
}
return x;
};
/**
* Uses the bisection method to make a best guess of the ideal distance between
* two circles too get the desired overlap.
* Currently there is no known formula to calculate the distance from the area
* of overlap, which makes the bisection method preferred.
* @private
* @param {number} r1 Radius of the first circle.
* @param {number} r2 Radiues of the second circle.
* @param {number} overlap The wanted overlap between the two circles.
* @return {number} Returns the distance needed to get the wanted overlap
* between the two circles.
*/
var getDistanceBetweenCirclesByOverlap =
function getDistanceBetweenCirclesByOverlap(r1, r2, overlap) {
var maxDistance = r1 + r2,
distance;
if (overlap <= 0) {
// If overlap is below or equal to zero, then there is no overlap.
distance = maxDistance;
} else if (getAreaOfCircle(r1 < r2 ? r1 : r2) <= overlap) {
// When area of overlap is larger than the area of the smallest circle,
// then it is completely overlapping.
distance = 0;
} else {
distance = bisect(function (x) {
var actualOverlap = getOverlapBetweenCirclesByDistance(r1, r2, x);
// Return the differance between wanted and actual overlap.
return overlap - actualOverlap;
}, 0, maxDistance);
}
return distance;
};
var isSet = function (x) {
return isArray(x.sets) && x.sets.length === 1;
};
/**
* Calculates a margin for a point based on the iternal and external circles.
* The margin describes if the point is well placed within the internal circles,
* and away from the external
* @private
* @todo add unit tests.
* @param {object} point The point to evaluate.
* @param {Array<object>} internal The internal circles.
* @param {Array<object>} external The external circles.
* @return {number} Returns the margin.
*/
var getMarginFromCircles =
function getMarginFromCircles(point, internal, external) {
var margin = internal.reduce(function (margin, circle) {
var m = circle.r - getDistanceBetweenPoints(point, circle);
return (m <= margin) ? m : margin;
}, Number.MAX_VALUE);
margin = external.reduce(function (margin, circle) {
var m = getDistanceBetweenPoints(point, circle) - circle.r;
return (m <= margin) ? m : margin;
}, margin);
return margin;
};
/**
* Finds the optimal label position by looking for a position that has a low
* distance from the internal circles, and as large possible distane to the
* external circles.
* @private
* @todo Optimize the intial position.
* @todo Add unit tests.
* @param {Array<object>} internal Internal circles.
* @param {Array<object>} external External circles.
* @return {object} Returns the found position.
*/
var getLabelPosition = function getLabelPosition(internal, external) {
// Get the best label position within the internal circles.
var best = internal.reduce(function (best, circle) {
var d = circle.r / 2;
// Give a set of points with the circle to evaluate as the best label
// position.
return [
{ x: circle.x, y: circle.y },
{ x: circle.x + d, y: circle.y },
{ x: circle.x - d, y: circle.y },
{ x: circle.x, y: circle.y + d },
{ x: circle.x, y: circle.y - d }
]
// Iterate the given points and return the one with the largest margin.
.reduce(function (best, point) {
var margin = getMarginFromCircles(point, internal, external);
// If the margin better than the current best, then update best.
if (best.margin < margin) {
best.point = point;
best.margin = margin;
}
return best;
}, best);
}, {
point: undefined,
margin: -Number.MAX_VALUE
}).point;
// Use nelder mead to optimize the initial label position.
var optimal = nelderMead(
function (p) {
return -(
getMarginFromCircles({ x: p[0], y: p[1] }, internal, external)
);
},
[best.x, best.y]
);
// Update best to be the point which was found to have the best margin.
best = {
x: optimal[0],
y: optimal[1]
};
if (!(
isPointInsideAllCircles(best, internal) &&
isPointOutsideAllCircles(best, external)
)) {
// If point was either outside one of the internal, or inside one of the
// external, then it was invalid and should use a fallback.
best = getCenterOfPoints(internal);
}
// Return the best point.
return best;
};
/**
* Finds the available width for a label, by taking the label position and
* finding the largest distance, which is inside all internal circles, and
* outside all external circles.
*
* @private
* @param {object} pos The x and y coordinate of the label.
* @param {Array<object>} internal Internal circles.
* @param {Array<object>} external External circles.
* @return {number} Returns available width for the label.
*/
var getLabelWidth = function getLabelWidth(pos, internal, external) {
var radius = internal.reduce(function (min, circle) {
return Math.min(circle.r, min);
}, Infinity),
// Filter out external circles that are completely overlapping.
filteredExternals = external.filter(function (circle) {
return !isPointInsideCircle(pos, circle);
});
var findDistance = function (maxDistance, direction) {
return bisect(function (x) {
var testPos = {
x: pos.x + (direction * x),
y: pos.y
},
isValid = (
isPointInsideAllCircles(testPos, internal) &&
isPointOutsideAllCircles(testPos, filteredExternals)
);
// If the position is valid, then we want to move towards the max
// distance. If not, then we want to away from the max distance.
return -(maxDistance - x) + (isValid ? 0 : Number.MAX_VALUE);
}, 0, maxDistance);
};
// Find the smallest distance of left and right.
return Math.min(findDistance(radius, -1), findDistance(radius, 1)) * 2;
};
/**
* Calulates data label values for a list of relations.
* @private
* @todo add unit tests
* @todo NOTE: may be better suited as a part of the layout function.
* @param {Array<object>} relations The list of relations.
* @return {object} Returns a map from id to the data label values.
*/
var getLabelValues = function getLabelValues(relations) {
var singleSets = relations.filter(isSet);
return relations.reduce(function (map, relation) {
if (relation.value) {
var sets = relation.sets,
id = sets.join(),
// Create a list of internal and external circles.
data = singleSets.reduce(function (data, set) {
// If the set exists in this relation, then it is internal,
// otherwise it will be external.
var isInternal = sets.indexOf(set.sets[0]) > -1,
property = isInternal ? 'internal' : 'external';
// Add the circle to the list.
data[property].push(set.circle);
return data;
}, {
internal: [],
external: []
}),
// Calulate the label position.
position = getLabelPosition(
data.internal,
data.external
),
// Calculate the label width
width = getLabelWidth(position, data.internal, data.external);
map[id] = {
position: position,
width: width
};
}
return map;
}, {});
};
/**
* Takes an array of relations and adds the properties `totalOverlap` and
* `overlapping` to each set. The property `totalOverlap` is the sum of value
* for each relation where this set is included. The property `overlapping` is
* a map of how much this set is overlapping another set.
* NOTE: This algorithm ignores relations consisting of more than 2 sets.
* @private
* @param {Array<object>} relations The list of relations that should be sorted.
* @return {Array<object>} Returns the modified input relations with added
* properties `totalOverlap` and `overlapping`.
*/
var addOverlapToSets = function addOverlapToSets(relations) {
// Calculate the amount of overlap per set.
var mapOfIdToProps = relations
// Filter out relations consisting of 2 sets.
.filter(function (relation) {
return relation.sets.length === 2;
})
// Sum up the amount of overlap for each set.
.reduce(function (map, relation) {
var sets = relation.sets;
sets.forEach(function (set, i, arr) {
if (!isObject(map[set])) {
map[set] = {
overlapping: {},
totalOverlap: 0
};
}
map[set].totalOverlap += relation.value;
map[set].overlapping[arr[1 - i]] = relation.value;
});
return map;
}, {});
relations
// Filter out single sets
.filter(isSet)
// Extend the set with the calculated properties.
.forEach(function (set) {
var properties = mapOfIdToProps[set.sets[0]];
extend(set, properties);
});
// Returns the modified relations.
return relations;
};
/**
* Takes two sets and finds the one with the largest total overlap.
* @private
* @param {object} a The first set to compare.
* @param {object} b The second set to compare.
* @return {number} Returns 0 if a and b are equal, <0 if a is greater, >0 if b
* is greater.
*/
var sortByTotalOverlap = function sortByTotalOverlap(a, b) {
return b.totalOverlap - a.totalOverlap;
};
/**
* Uses a greedy approach to position all the sets. Works well with a small
* number of sets, and are in these cases a good choice aesthetically.
* @private
* @param {Array<object>} relations List of the overlap between two or more
* sets, or the size of a single set.
* @return {Array<object>} List of circles and their calculated positions.
*/
var layoutGreedyVenn = function layoutGreedyVenn(relations) {
var positionedSets = [],
mapOfIdToCircles = {};
// Define a circle for each set.
relations
.filter(function (relation) {
return relation.sets.length === 1;
}).forEach(function (relation) {
mapOfIdToCircles[relation.sets[0]] = relation.circle = {
x: Number.MAX_VALUE,
y: Number.MAX_VALUE,
r: Math.sqrt(relation.value / Math.PI)
};
});
/**
* Takes a set and updates the position, and add the set to the list of
* positioned sets.
* @private
* @param {object} set The set to add to its final position.
* @param {object} coordinates The coordinates to position the set at.
*/
var positionSet = function positionSet(set, coordinates) {
var circle = set.circle;
circle.x = coordinates.x;
circle.y = coordinates.y;
positionedSets.push(set);
};
// Find overlap between sets. Ignore relations with more then 2 sets.
addOverlapToSets(relations);
// Sort sets by the sum of their size from large to small.
var sortedByOverlap = relations
.filter(isSet)
.sort(sortByTotalOverlap);
// Position the most overlapped set at 0,0.
positionSet(sortedByOverlap.shift(), { x: 0, y: 0 });
var relationsWithTwoSets = relations.filter(function (x) {
return x.sets.length === 2;
});
// Iterate and position the remaining sets.
sortedByOverlap.forEach(function (set) {
var circle = set.circle,
radius = circle.r,
overlapping = set.overlapping;
var bestPosition = positionedSets
.reduce(function (best, positionedSet, i) {
var positionedCircle = positionedSet.circle,
overlap = overlapping[positionedSet.sets[0]];
// Calculate the distance between the sets to get the correct
// overlap
var distance = getDistanceBetweenCirclesByOverlap(
radius,
positionedCircle.r,
overlap
);
// Create a list of possible coordinates calculated from
// distance.
var possibleCoordinates = [
{ x: positionedCircle.x + distance, y: positionedCircle.y },
{ x: positionedCircle.x - distance, y: positionedCircle.y },
{ x: positionedCircle.x, y: positionedCircle.y + distance },
{ x: positionedCircle.x, y: positionedCircle.y - distance }
];
// If there are more circles overlapping, then add the
// intersection points as possible positions.
positionedSets.slice(i + 1).forEach(function (positionedSet2) {
var positionedCircle2 = positionedSet2.circle,
overlap2 = overlapping[positionedSet2.sets[0]],
distance2 = getDistanceBetweenCirclesByOverlap(
radius,
positionedCircle2.r,
overlap2
);
// Add intersections to list of coordinates.
possibleCoordinates = possibleCoordinates.concat(
getCircleCircleIntersection({
x: positionedCircle.x,
y: positionedCircle.y,
r: distance
}, {
x: positionedCircle2.x,
y: positionedCircle2.y,
r: distance2
})
);
});
// Iterate all suggested coordinates and find the best one.
possibleCoordinates.forEach(function (coordinates) {
circle.x = coordinates.x;
circle.y = coordinates.y;
// Calculate loss for the suggested coordinates.
var currentLoss = loss(
mapOfIdToCircles, relationsWithTwoSets
);
// If the loss is better, then use these new coordinates.
if (currentLoss < best.loss) {
best.loss = currentLoss;
best.coordinates = coordinates;
}
});
// Return resulting coordinates.
return best;
}, {
loss: Number.MAX_VALUE,
coordinates: undefined
});
// Add the set to its final position.
positionSet(set, bestPosition.coordinates);
});
// Return the positions of each set.
return mapOfIdToCircles;
};
/**
* Calculates the positions of all the sets in the venn diagram.
* @private
* @todo Add support for constrained MDS.
* @param {Array<object>} relations List of the overlap between two or more sets, or the
* size of a single set.
* @return {Arrat<object>} List of circles and their calculated positions.
*/
var layout = function (relations) {
var mapOfIdToShape = {};
// Calculate best initial positions by using greedy layout.
if (relations.length > 0) {
mapOfIdToShape = layoutGreedyVenn(relations);
relations
.filter(function (x) {
return !isSet(x);
})
.forEach(function (relation) {
var sets = relation.sets,
id = sets.join(),
circles = sets.map(function (set) {
return mapOfIdToShape[set];
});
// Add intersection shape to map
mapOfIdToShape[id] =
getAreaOfIntersectionBetweenCircles(circles);
});
}
return mapOfIdToShape;
};
var isValidRelation = function (x) {
var map = {};
return (
isObject(x) &&
(isNumber(x.value) && x.value > -1) &&
(isArray(x.sets) && x.sets.length > 0) &&
!x.sets.some(function (set) {
var invalid = false;
if (!map[set] && isString(set)) {
map[set] = true;
} else {
invalid = true;
}
return invalid;
})
);
};
var isValidSet = function (x) {
return (isValidRelation(x) && isSet(x) && x.value > 0);
};
/**
* Prepares the venn data so that it is usable for the layout function. Filter
* out sets, or intersections that includes sets, that are missing in the data
* or has (value < 1). Adds missing relations between sets in the data as
* value = 0.
* @private
* @param {Array<object>} data The raw input data.
* @return {Array<object>} Returns an array of valid venn data.
*/
var processVennData = function processVennData(data) {
var d = isArray(data) ? data : [];
var validSets = d
.reduce(function (arr, x) {
// Check if x is a valid set, and that it is not an duplicate.
if (isValidSet(x) && arr.indexOf(x.sets[0]) === -1) {
arr.push(x.sets[0]);
}
return arr;
}, [])
.sort();
var mapOfIdToRelation = d.reduce(function (mapOfIdToRelation, relation) {
if (isValidRelation(relation) && !relation.sets.some(function (set) {
return validSets.indexOf(set) === -1;
})) {
mapOfIdToRelation[relation.sets.sort().join()] = relation;
}
return mapOfIdToRelation;
}, {});
validSets.reduce(function (combinations, set, i, arr) {
var remaining = arr.slice(i + 1);
remaining.forEach(function (set2) {
combinations.push(set + ',' + set2);
});
return combinations;
}, []).forEach(function (combination) {
if (!mapOfIdToRelation[combination]) {
var obj = {
sets: combination.split(','),
value: 0
};
mapOfIdToRelation[combination] = obj;
}
});
// Transform map into array.
return objectValues(mapOfIdToRelation);
};
/**
* Calculates the proper scale to fit the cloud inside the plotting area.
* @private
* @todo add unit test
* @param {number} targetWidth Width of target area.
* @param {number} targetHeight Height of target area.
* @param {object} field The playing field.
* @param {Highcharts.Series} series Series object.
* @return {object} Returns the value to scale the playing field up to the size
* of the target area, and center of x and y.
*/
var getScale = function getScale(targetWidth, targetHeight, field) {
var height = field.bottom - field.top, // top is smaller than bottom
width = field.right - field.left,
scaleX = width > 0 ? 1 / width * targetWidth : 1,
scaleY = height > 0 ? 1 / height * targetHeight : 1,
adjustX = (field.right + field.left) / 2,
adjustY = (field.top + field.bottom) / 2,
scale = Math.min(scaleX, scaleY);
return {
scale: scale,
centerX: targetWidth / 2 - adjustX * scale,
centerY: targetHeight / 2 - adjustY * scale
};
};
/**
* If a circle is outside a give field, then the boundaries of the field is
* adjusted accordingly. Modifies the field object which is passed as the first
* parameter.
* @private
* @todo NOTE: Copied from wordcloud, can probably be unified.
* @param {object} field The bounding box of a playing field.
* @param {object} placement The bounding box for a placed point.
* @return {object} Returns a modified field object.
*/
var updateFieldBoundaries = function updateFieldBoundaries(field, circle) {
var left = circle.x - circle.r,
right = circle.x + circle.r,
bottom = circle.y + circle.r,
top = circle.y - circle.r;
// TODO improve type checking.
if (!isNumber(field.left) || field.left > left) {
field.left = left;
}
if (!isNumber(field.right) || field.right < right) {
field.right = right;
}
if (!isNumber(field.top) || field.top > top) {
field.top = top;
}
if (!isNumber(field.bottom) || field.bottom < bottom) {
field.bottom = bottom;
}
return field;
};
/**
* A Venn diagram displays all possible logical relations between a collection
* of different sets. The sets are represented by circles, and the relation
* between the sets are displayed by the overlap or lack of overlap between
* them. The venn diagram is a special case of Euler diagrams, which can also
* be displayed by this series type.
*
* @sample {highcharts} highcharts/demo/venn-diagram/
* Venn diagram
* @sample {highcharts} highcharts/demo/euler-diagram/
* Euler diagram
*
* @extends plotOptions.scatter
* @excluding connectEnds, connectNulls, cropThreshold, dragDrop,
* findNearestPointBy, getExtremesFromAll, jitter, label, linecap,
* lineWidth, linkedTo, marker, negativeColor, pointInterval,
* pointIntervalUnit, pointPlacement, pointStart, softThreshold,
* stacking, steps, threshold, xAxis, yAxis, zoneAxis, zones
* @product highcharts
* @optionparent plotOptions.venn
*/
var vennOptions = {
borderColor: '#cccccc',
borderDashStyle: 'solid',
borderWidth: 1,
brighten: 0,
clip: false,
colorByPoint: true,
dataLabels: {
/** @ignore-option */
enabled: true,
/** @ignore-option */
verticalAlign: 'middle',
/** @ignore-option */
formatter: function () {
return this.point.name;
}
},
/**
* @ignore-option
* @private
*/
inactiveOtherPoints: true,
marker: false,
opacity: 0.75,
showInLegend: false,
states: {
/**
* @excluding halo
*/
hover: {
opacity: 1,
borderColor: '#333333'
},
/**
* @excluding halo
*/
select: {
color: '#cccccc',
borderColor: '#000000',
animation: false
}
},
tooltip: {
pointFormat: '{point.name}: {point.value}'
}
};
var vennSeries = {
isCartesian: false,
axisTypes: [],
directTouch: true,
pointArrayMap: ['value'],
translate: function () {
var chart = this.chart;
this.processedXData = this.xData;
this.generatePoints();
// Process the data before passing it into the layout function.
var relations = processVennData(this.options.data);
// Calculate the positions of each circle.
var mapOfIdToShape = layout(relations);
// Calculate positions of each data label
var mapOfIdToLabelValues = getLabelValues(relations);
// Calculate the scale, and center of the plot area.
var field = Object.keys(mapOfIdToShape)
.filter(function (key) {
var shape = mapOfIdToShape[key];
return shape && isNumber(shape.r);
})
.reduce(function (field, key) {
return updateFieldBoundaries(field, mapOfIdToShape[key]);
}, { top: 0, bottom: 0, left: 0, right: 0 }),
scaling = getScale(chart.plotWidth, chart.plotHeight, field),
scale = scaling.scale,
centerX = scaling.centerX,
centerY = scaling.centerY;
// Iterate all points and calculate and draw their graphics.
this.points.forEach(function (point) {
var sets = isArray(point.sets) ? point.sets : [],
id = sets.join(),
shape = mapOfIdToShape[id],
shapeArgs,
dataLabelValues = mapOfIdToLabelValues[id] || {},
dataLabelWidth = dataLabelValues.width,
dataLabelPosition = dataLabelValues.position,
dlOptions = point.options && point.options.dataLabels;
if (shape) {
if (shape.r) {
shapeArgs = {
x: centerX + shape.x * scale,
y: centerY + shape.y * scale,
r: shape.r * scale
};
} else if (shape.d) {
// TODO: find a better way to handle scaling of a path.
var d = shape.d.reduce(function (path, arr) {
if (arr[0] === 'M') {
arr[1] = centerX + arr[1] * scale;
arr[2] = centerY + arr[2] * scale;
} else if (arr[0] === 'A') {
arr[1] = arr[1] * scale;
arr[2] = arr[2] * scale;
arr[6] = centerX + arr[6] * scale;
arr[7] = centerY + arr[7] * scale;
}
return path.concat(arr);
}, [])
.join(' ');
shapeArgs = {
d: d
};
}
// Scale the position for the data label.
if (dataLabelPosition) {
dataLabelPosition.x = centerX + dataLabelPosition.x * scale;
dataLabelPosition.y = centerY + dataLabelPosition.y * scale;
} else {
dataLabelPosition = {};
}
if (isNumber(dataLabelWidth)) {
dataLabelWidth = Math.round(dataLabelWidth * scale);
}
}
point.shapeArgs = shapeArgs;
// Placement for the data labels
if (dataLabelPosition && shapeArgs) {
point.plotX = dataLabelPosition.x;
point.plotY = dataLabelPosition.y;
}
// Add width for the data label
if (dataLabelWidth && shapeArgs) {
point.dlOptions = merge(
true,
{
style: {
width: dataLabelWidth
}
},
isObject(dlOptions) && dlOptions
);
}
// Set name for usage in tooltip and in data label.
point.name = point.options.name || sets.join('∩');
});
},
/**
* Draw the graphics for each point.
* @private
*/
drawPoints: function () {
var series = this,
// Series properties
chart = series.chart,
group = series.group,
points = series.points || [],
// Chart properties
renderer = chart.renderer;
// Iterate all points and calculate and draw their graphics.
points.forEach(function (point) {
var attribs = {
zIndex: isArray(point.sets) ? point.sets.length : 0
},
shapeArgs = point.shapeArgs;
// Add point attribs
if (!chart.styledMode) {
extend(attribs, series.pointAttribs(point, point.state));
}
// Draw the point graphic.
point.draw({
isNew: !point.graphic,
animatableAttribs: shapeArgs,
attribs: attribs,
group: group,
renderer: renderer,
shapeType: shapeArgs && shapeArgs.d ? 'path' : 'circle'
});
});
},
/**
* Calculates the style attributes for a point. The attributes can vary
* depending on the state of the point.
* @private
* @param {object} point The point which will get the resulting attributes.
* @param {string} state The state of the point.
* @return {object} Returns the calculated attributes.
*/
pointAttribs: function (point, state) {
var series = this,
seriesOptions = series.options || {},
pointOptions = point && point.options || {},
stateOptions = (state && seriesOptions.states[state]) || {},
options = merge(
seriesOptions,
{ color: point && point.color },
pointOptions,
stateOptions
);
// Return resulting values for the attributes.
return {
'fill': color(options.color)
.setOpacity(options.opacity)
.brighten(options.brightness)
.get(),
'stroke': options.borderColor,
'stroke-width': options.borderWidth,
'dashstyle': options.borderDashStyle
};
},
animate: function (init) {
if (!init) {
var series = this,
animOptions = H.animObject(series.options.animation);
series.points.forEach(function (point) {
var args = point.shapeArgs;
if (point.graphic && args) {
var attr = {},
animate = {};
if (args.d) {
// If shape is a path, then animate opacity.
attr.opacity = 0.001;
} else {
// If shape is a circle, then animate radius.
attr.r = 0;
animate.r = args.r;
}
point.graphic
.attr(attr)
.animate(animate, animOptions);
// If shape is path, then fade it in after the circles
// animation
if (args.d) {
setTimeout(function () {
if (point && point.graphic) {
point.graphic.animate({
opacity: 1
});
}
}, animOptions.duration);
}
}
}, series);
series.animate = null;
}
},
utils: {
addOverlapToSets: addOverlapToSets,
geometry: geometry,
geometryCircles: geometryCircles,
getLabelWidth: getLabelWidth,
getMarginFromCircles: getMarginFromCircles,
getDistanceBetweenCirclesByOverlap: getDistanceBetweenCirclesByOverlap,
layoutGreedyVenn: layoutGreedyVenn,
loss: loss,
nelderMead: NelderMeadModule,
processVennData: processVennData,
sortByTotalOverlap: sortByTotalOverlap
}
};
var vennPoint = {
draw: draw,
shouldDraw: function () {
var point = this;
// Only draw points with single sets.
return !!point.shapeArgs;
},
isValid: function () {
return isNumber(this.value);
}
};
/**
* A `venn` series. If the [type](#series.venn.type) option is
* not specified, it is inherited from [chart.type](#chart.type).
*
* @extends series,plotOptions.venn
* @excluding connectEnds, connectNulls, cropThreshold, dataParser, dataURL,
* findNearestPointBy, getExtremesFromAll, label, linecap, lineWidth,
* linkedTo, marker, negativeColor, pointInterval, pointIntervalUnit,
* pointPlacement, pointStart, softThreshold, stack, stacking, steps,
* threshold, xAxis, yAxis, zoneAxis, zones
* @product highcharts
* @apioption series.venn
*/
/**
* @type {Array<*>}
* @extends series.scatter.data
* @excluding marker, x, y
* @product highcharts
* @apioption series.venn.data
*/
/**
* The name of the point. Used in data labels and tooltip. If name is not
* defined then it will default to the joined values in
* [sets](#series.venn.sets).
*
* @sample {highcharts} highcharts/demo/venn-diagram/
* Venn diagram
* @sample {highcharts} highcharts/demo/euler-diagram/
* Euler diagram
*
* @type {number}
* @since 7.0.0
* @product highcharts
* @apioption series.venn.data.name
*/
/**
* The value of the point, resulting in a relative area of the circle, or area
* of overlap between two sets in the venn or euler diagram.
*
* @sample {highcharts} highcharts/demo/venn-diagram/
* Venn diagram
* @sample {highcharts} highcharts/demo/euler-diagram/
* Euler diagram
*
* @type {number}
* @since 7.0.0
* @product highcharts
* @apioption series.venn.data.value
*/
/**
* The set or sets the options will be applied to. If a single entry is defined,
* then it will create a new set. If more than one entry is defined, then it
* will define the overlap between the sets in the array.
*
* @sample {highcharts} highcharts/demo/venn-diagram/
* Venn diagram
* @sample {highcharts} highcharts/demo/euler-diagram/
* Euler diagram
*
* @type {Array<string>}
* @since 7.0.0
* @product highcharts
* @apioption series.venn.data.sets
*/
/**
* @excluding halo
* @apioption series.venn.states.hover
*/
/**
* @excluding halo
* @apioption series.venn.states.select
*/
/**
* @private
* @class
* @name Highcharts.seriesTypes.venn
*
* @augments Highcharts.Series
*/
seriesType('venn', 'scatter', vennOptions, vennSeries, vennPoint);
// Modify final series options.
addEvent(seriesTypes.venn, 'afterSetOptions', function (e) {
var options = e.options,
states = options.states;
if (this instanceof seriesTypes.venn) {
// Explicitly disable all halo options.
Object.keys(states).forEach(function (state) {
states[state].halo = false;
});
}
});