PackedBubbleSeries.js
49.9 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
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
/* *
*
* (c) 2010-2018 Grzegorz Blachlinski, Sebastian Bochan
*
* License: www.highcharts.com/license
*
* !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
*
* */
'use strict';
import H from '../parts/Globals.js';
/**
* Formatter callback function.
*
* @callback Highcharts.SeriesPackedBubbleDataLabelsFormatterCallbackFunction
*
* @param {Highcharts.SeriesPackedBubbleDataLabelsFormatterContextObject|Highcharts.DataLabelsFormatterContextObject} this
* Data label context to format
*
* @return {string}
* Formatted data label text
*/
/**
* Context for the formatter function.
*
* @interface Highcharts.SeriesPackedBubbleDataLabelsFormatterContextObject
* @extends Highcharts.DataLabelsFormatterContextObject
* @since 7.0.0
*/ /**
* The color of the node.
* @name Highcharts.SeriesPackedBubbleDataLabelsFormatterContextObject#color
* @type {Highcharts.ColorString}
* @since 7.0.0
*/ /**
* The point (node) object. The node name, if defined, is available through
* `this.point.name`. Arrays: `this.point.linksFrom` and `this.point.linksTo`
* contains all nodes connected to this point.
* @name Highcharts.SeriesPackedBubbleDataLabelsFormatterContextObject#point
* @type {Highcharts.Point}
* @since 7.0.0
*/ /**
* The ID of the node.
* @name Highcharts.SeriesPackedBubbleDataLabelsFormatterContextObject#key
* @type {string}
* @since 7.0.0
*/
/**
* Data labels options
*
* @interface Highcharts.SeriesPackedBubbleDataLabelsOptionsObject
* @extends Highcharts.DataLabelsOptionsObject
* @since 7.0.0
*/ /**
* The
* [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)
* specifying what to show for _node_ in the networkgraph. In v7.0 defaults to
* `{key}`, since v7.1 defaults to `undefined` and `formatter` is used instead.
* @name Highcharts.SeriesPackedBubbleDataLabelsOptionsObject#format
* @type {string|undefined}
* @since 7.0.0
*/ /**
* Callback JavaScript function to format the data label for a node. Note that
* if a `format` is defined, the format takes precedence and the formatter is
* ignored.
* @name Highcharts.SeriesPackedBubbleDataLabelsOptionsObject#formatter
* @type {Highcharts.SeriesPackedBubbleDataLabelsFormatterCallbackFunction|undefined}
* @since 7.0.0
*/ /**
* @name Highcharts.SeriesPackedBubbleDataLabelsOptionsObject#parentNodeFormat
* @type {string|undefined}
* @since 7.1.0
*/ /**
* Callback to format data labels for _parentNodes_. The `parentNodeFormat`
* option takes precedence over the `parentNodeFormatter`.
* @name Highcharts.SeriesPackedBubbleDataLabelsOptionsObject#parentNodeFormatter
* @type {Highcharts.FormatterCallbackFunction<Highcharts.DataLabelsFormatterContextObject>|undefined}
* @since 7.1.0
*/ /**
* Options for a _parentNode_ label text.
* @sample highcharts/series-packedbubble/packed-dashboard
* Dashboard with dataLabels on parentNodes
* @name Highcharts.SeriesPackedBubbleDataLabelsOptionsObject#parentNodeTextPath
* @type {Highcharts.SeriesPackedBubbleDataLabelsTextPathOptionsObject|undefined}
* @since 7.1.0
*/ /**
* Options for a _node_ label text which should follow marker's shape.
* **Note:** Only SVG-based renderer supports this option.
* @see {@link Highcharts.SeriesPackedBubbleDataLabelsTextPath#linkTextPath}
* @name Highcharts.SeriesPackedBubbleDataLabelsOptionsObject#textPath
* @type {Highcharts.SeriesPackedBubbleDataLabelsTextPathOptionsObject|undefined}
* @since 7.1.0
*/
/**
* **Note:** Only SVG-based renderer supports this option.
*
* @see {@link Highcharts.SeriesNetworkDataLabelsTextPath#linkTextPath}
* @see {@link Highcharts.SeriesNetworkDataLabelsTextPath#textPath}
*
* @interface Highcharts.SeriesPackedBubbleDataLabelsTextPathOptionsObject
* @since 7.1.0
*/ /**
* Presentation attributes for the text path.
* @name Highcharts.SeriesPackedBubbleDataLabelsTextPathOptionsObject#attributes
* @type {Highcharts.SVGAttributes|undefined}
* @since 7.1.0
*/ /**
* Enable or disable `textPath` option for link's or marker's data labels.
* @name Highcharts.SeriesPackedBubbleDataLabelsTextPathOptionsObject#enabled
* @type {boolean|undefined}
* @since 7.1.0
*/
import U from '../parts/Utilities.js';
var defined = U.defined, isArray = U.isArray, isNumber = U.isNumber;
import '../parts/Axis.js';
import '../parts/Color.js';
import '../parts/Point.js';
import '../parts/Series.js';
import '../modules/networkgraph/layouts.js';
import '../modules/networkgraph/draggable-nodes.js';
var seriesType = H.seriesType, Series = H.Series, Point = H.Point, pick = H.pick, addEvent = H.addEvent, fireEvent = H.fireEvent, Chart = H.Chart, color = H.Color, Reingold = H.layouts['reingold-fruchterman'], NetworkPoint = H.seriesTypes.bubble.prototype.pointClass, dragNodesMixin = H.dragNodesMixin;
H.networkgraphIntegrations.packedbubble = {
repulsiveForceFunction: function (d, k, node, repNode) {
return Math.min(d, (node.marker.radius + repNode.marker.radius) / 2);
},
barycenter: function () {
var layout = this, gravitationalConstant = layout.options.gravitationalConstant, box = layout.box, nodes = layout.nodes, centerX, centerY;
nodes.forEach(function (node) {
if (layout.options.splitSeries && !node.isParentNode) {
centerX = node.series.parentNode.plotX;
centerY = node.series.parentNode.plotY;
}
else {
centerX = box.width / 2;
centerY = box.height / 2;
}
if (!node.fixedPosition) {
node.plotX -=
(node.plotX - centerX) *
gravitationalConstant /
(node.mass * Math.sqrt(nodes.length));
node.plotY -=
(node.plotY - centerY) *
gravitationalConstant /
(node.mass * Math.sqrt(nodes.length));
}
});
},
repulsive: function (node, force, distanceXY, repNode) {
var factor = (force * this.diffTemperature / node.mass /
node.degree), x = distanceXY.x * factor, y = distanceXY.y * factor;
if (!node.fixedPosition) {
node.plotX += x;
node.plotY += y;
}
if (!repNode.fixedPosition) {
repNode.plotX -= x;
repNode.plotY -= y;
}
},
integrate: H.networkgraphIntegrations.verlet.integrate,
getK: H.noop
};
H.layouts.packedbubble = H.extendClass(Reingold, {
beforeStep: function () {
if (this.options.marker) {
this.series.forEach(function (series) {
if (series) {
series.calculateParentRadius();
}
});
}
},
setCircularPositions: function () {
var layout = this, box = layout.box, nodes = layout.nodes, nodesLength = nodes.length + 1, angle = 2 * Math.PI / nodesLength, centerX, centerY, radius = layout.options.initialPositionRadius;
nodes.forEach(function (node, index) {
if (layout.options.splitSeries &&
!node.isParentNode) {
centerX = node.series.parentNode.plotX;
centerY = node.series.parentNode.plotY;
}
else {
centerX = box.width / 2;
centerY = box.height / 2;
}
node.plotX = node.prevX = pick(node.plotX, centerX +
radius * Math.cos(node.index || index * angle));
node.plotY = node.prevY = pick(node.plotY, centerY +
radius * Math.sin(node.index || index * angle));
node.dispX = 0;
node.dispY = 0;
});
},
repulsiveForces: function () {
var layout = this, force, distanceR, distanceXY, bubblePadding = layout.options.bubblePadding;
layout.nodes.forEach(function (node) {
node.degree = node.mass;
node.neighbours = 0;
layout.nodes.forEach(function (repNode) {
force = 0;
if (
// Node can not repulse itself:
node !== repNode &&
// Only close nodes affect each other:
// Not dragged:
!node.fixedPosition &&
(layout.options.seriesInteraction ||
node.series === repNode.series)) {
distanceXY = layout.getDistXY(node, repNode);
distanceR = (layout.vectorLength(distanceXY) -
(node.marker.radius +
repNode.marker.radius +
bubblePadding));
// TODO padding configurable
if (distanceR < 0) {
node.degree += 0.01;
node.neighbours++;
force = layout.repulsiveForce(-distanceR / Math.sqrt(node.neighbours), layout.k, node, repNode);
}
layout.force('repulsive', node, force * repNode.mass, distanceXY, repNode, distanceR);
}
});
});
},
applyLimitBox: function (node) {
var layout = this, distanceXY, distanceR, factor = 0.01;
// parentNodeLimit should be used together
// with seriesInteraction: false
if (layout.options.splitSeries &&
!node.isParentNode &&
layout.options.parentNodeLimit) {
distanceXY = layout.getDistXY(node, node.series.parentNode);
distanceR = (node.series.parentNodeRadius -
node.marker.radius -
layout.vectorLength(distanceXY));
if (distanceR < 0 &&
distanceR > -2 * node.marker.radius) {
node.plotX -= distanceXY.x * factor;
node.plotY -= distanceXY.y * factor;
}
}
Reingold.prototype.applyLimitBox.apply(this, arguments);
},
isStable: function () {
return Math.abs(this.systemTemperature -
this.prevSystemTemperature) < 0.00001 ||
this.temperature <= 0 ||
(
// In first iteration system does not move:
this.systemTemperature > 0 &&
(this.systemTemperature /
this.nodes.length < 0.02 &&
this.enableSimulation) // Use only when simulation is enabled
);
}
});
/**
* @private
* @class
* @name Highcharts.seriesTypes.packedbubble
*
* @extends Highcharts.Series
*/
seriesType('packedbubble', 'bubble',
/**
* A packed bubble series is a two dimensional series type, where each point
* renders a value in X, Y position. Each point is drawn as a bubble
* where the bubbles don't overlap with each other and the radius
* of the bubble relates to the value.
* Requires `highcharts-more.js`.
*
* @sample highcharts/demo/packed-bubble/
* Packed bubble chart
* @sample highcharts/demo/packed-bubble-split/
* Split packed bubble chart
* @extends plotOptions.bubble
* @excluding connectEnds, connectNulls, dragDrop, jitter, keys,
* pointPlacement, sizeByAbsoluteValue, step, xAxis, yAxis,
* zMax, zMin
* @product highcharts
* @since 7.0.0
* @optionparent plotOptions.packedbubble
*/
{
/**
* Minimum bubble size. Bubbles will automatically size between the
* `minSize` and `maxSize` to reflect the value of each bubble.
* Can be either pixels (when no unit is given), or a percentage of
* the smallest one of the plot width and height, divided by the square
* root of total number of points.
*
* @sample highcharts/plotoptions/bubble-size/
* Bubble size
*
* @type {number|string}
*
* @private
*/
minSize: '10%',
/**
* Maximum bubble size. Bubbles will automatically size between the
* `minSize` and `maxSize` to reflect the value of each bubble.
* Can be either pixels (when no unit is given), or a percentage of
* the smallest one of the plot width and height, divided by the square
* root of total number of points.
*
* @sample highcharts/plotoptions/bubble-size/
* Bubble size
*
* @type {number|string}
*
* @private
*/
maxSize: '50%',
sizeBy: 'area',
zoneAxis: 'y',
tooltip: {
pointFormat: 'Value: {point.value}'
},
/**
* Flag to determine if nodes are draggable or not. Available for
* graph with useSimulation set to true only.
*
* @since 7.1.0
*
* @private
*/
draggable: true,
/**
* An option is giving a possibility to choose between using simulation
* for calculating bubble positions. These reflects in both animation
* and final position of bubbles. Simulation is also adding options to
* the series graph based on used layout. In case of big data sets, with
* any performance issues, it is possible to disable animation and pack
* bubble in a simple circular way.
*
* @sample highcharts/series-packedbubble/spiral/
* useSimulation set to false
*
* @since 7.1.0
*
* @private
*/
useSimulation: true,
/**
* @type {Highcharts.SeriesPackedBubbleDataLabelsOptionsObject|Array<Highcharts.SeriesPackedBubbleDataLabelsOptionsObject>}
* @default {"formatter": function () { return this.point.value; }, "parentNodeFormatter": function () { return this.name; }, "parentNodeTextPath": {"enabled: true}, "padding": 0}
*
* @private
*/
dataLabels: {
// eslint-disable-next-line valid-jsdoc
/** @ignore-option */
formatter: function () {
return this.point.value;
},
// eslint-disable-next-line valid-jsdoc
/** @ignore-option */
parentNodeFormatter: function () {
return this.name;
},
/** @ignore-option */
parentNodeTextPath: {
enabled: true
},
/** @ignore-option */
padding: 0
},
/**
* Options for layout algorithm when simulation is enabled. Inside there
* are options to change the speed, padding, initial bubbles positions
* and more.
*
* @extends plotOptions.networkgraph.layoutAlgorithm
* @excluding approximation, attractiveForce, repulsiveForce, theta
* @since 7.1.0
*
* @private
*/
layoutAlgorithm: {
/**
* Initial layout algorithm for positioning nodes. Can be one of
* the built-in options ("circle", "random") or a function where
* positions should be set on each node (`this.nodes`) as
* `node.plotX` and `node.plotY`.
*
* @sample highcharts/series-networkgraph/initial-positions/
* Initial positions with callback
*
* @type {"circle"|"random"|Function}
*/
initialPositions: 'circle',
/**
* @sample highcharts/series-packedbubble/initial-radius/
* Initial radius set to 200
*
* @extends plotOptions.networkgraph.layoutAlgorithm.initialPositionRadius
* @excluding states
*/
initialPositionRadius: 20,
/**
* The distance between two bubbles, when the algorithm starts to
* treat two bubbles as overlapping. The `bubblePadding` is also the
* expected distance between all the bubbles on simulation end.
*/
bubblePadding: 5,
/**
* Whether bubbles should interact with their parentNode to keep
* them inside.
*/
parentNodeLimit: false,
/**
* Whether series should interact with each other or not. When
* `parentNodeLimit` is set to true, thi option should be set to
* false to avoid sticking points in wrong series parentNode.
*/
seriesInteraction: true,
/**
* In case of split series, this option allows user to drag and
* drop points between series, for changing point related series.
*
* @sample highcharts/series-packedbubble/packed-dashboard/
* Example of drag'n drop bubbles for bubble kanban
*/
dragBetweenSeries: false,
/**
* Layout algorithm options for parent nodes.
*
* @extends plotOptions.networkgraph.layoutAlgorithm
* @excluding approximation, attractiveForce, enableSimulation,
* repulsiveForce, theta
*/
parentNodeOptions: {
maxIterations: 400,
gravitationalConstant: 0.03,
maxSpeed: 50,
initialPositionRadius: 100,
seriesInteraction: true,
/**
* Styling options for parentNodes markers. Similar to
* line.marker options.
*
* @sample highcharts/series-packedbubble/parentnode-style/
* Bubble size
*
* @extends plotOptions.series.marker
* @excluding states
*/
marker: {
fillColor: null,
fillOpacity: 1,
lineWidth: 1,
lineColor: null,
symbol: 'circle'
}
},
enableSimulation: true,
/**
* Type of the algorithm used when positioning bubbles.
* @ignore-option
*/
type: 'packedbubble',
/**
* Integration type. Integration determines how forces are applied
* on particles. The `packedbubble` integration is based on
* the networkgraph `verlet` integration, where the new position
* is based on a previous position without velocity:
* `newPosition += previousPosition - newPosition`.
*
* @sample highcharts/series-networkgraph/forces/
*
* @ignore-option
*/
integration: 'packedbubble',
maxIterations: 1000,
/**
* Whether to split series into individual groups or to mix all
* series together.
*
* @since 7.1.0
* @default false
*/
splitSeries: false,
/**
* Max speed that node can get in one iteration. In terms of
* simulation, it's a maximum translation (in pixels) that a node
* can move (in both, x and y, dimensions). While `friction` is
* applied on all nodes, max speed is applied only for nodes that
* move very fast, for example small or disconnected ones.
*
* @see [layoutAlgorithm.integration](#series.networkgraph.layoutAlgorithm.integration)
*
* @see [layoutAlgorithm.friction](#series.networkgraph.layoutAlgorithm.friction)
*/
maxSpeed: 5,
gravitationalConstant: 0.01,
friction: -0.981
}
}, {
/**
* An internal option used for allowing nodes dragging.
* @private
*/
hasDraggableNodes: true,
/**
* Array of internal forces. Each force should be later defined in
* integrations.js.
* @private
*/
forces: ['barycenter', 'repulsive'],
pointArrayMap: ['value'],
pointValKey: 'value',
isCartesian: false,
axisTypes: [],
noSharedTooltip: true,
/* eslint-disable no-invalid-this, valid-jsdoc */
/**
* Create a single array of all points from all series
* @private
* @param {Highcharts.Series} series Array of all series objects
* @return {Array<Highcharts.PackedBubbleData>} Returns the array of all points.
*/
accumulateAllPoints: function (series) {
var chart = series.chart, allDataPoints = [], i, j;
for (i = 0; i < chart.series.length; i++) {
series = chart.series[i];
if (series.visible ||
!chart.options.chart.ignoreHiddenSeries) {
// add data to array only if series is visible
for (j = 0; j < series.yData.length; j++) {
allDataPoints.push([
null, null,
series.yData[j],
series.index,
j,
{
id: j,
marker: {
radius: 0
}
}
]);
}
}
}
return allDataPoints;
},
init: function () {
Series.prototype.init.apply(this, arguments);
// When one series is modified, the others need to be recomputed
addEvent(this, 'updatedData', function () {
this.chart.series.forEach(function (s) {
if (s.type === this.type) {
s.isDirty = true;
}
}, this);
});
return this;
},
render: function () {
var series = this, dataLabels = [];
Series.prototype.render.apply(this, arguments);
// #10823 - dataLabels should stay visible
// when enabled allowOverlap.
if (!series.options.dataLabels.allowOverlap) {
series.data.forEach(function (point) {
if (isArray(point.dataLabels)) {
point.dataLabels.forEach(function (dataLabel) {
dataLabels.push(dataLabel);
});
}
});
series.chart.hideOverlappingLabels(dataLabels);
}
},
// Needed because of z-indexing issue if point is added in series.group
setVisible: function () {
var series = this;
Series.prototype.setVisible.apply(series, arguments);
if (series.parentNodeLayout && series.graph) {
if (series.visible) {
series.graph.show();
if (series.parentNode.dataLabel) {
series.parentNode.dataLabel.show();
}
}
else {
series.graph.hide();
series.parentNodeLayout
.removeElementFromCollection(series.parentNode, series.parentNodeLayout.nodes);
if (series.parentNode.dataLabel) {
series.parentNode.dataLabel.hide();
}
}
}
else if (series.layout) {
if (series.visible) {
series.layout.addElementsToCollection(series.points, series.layout.nodes);
}
else {
series.points.forEach(function (node) {
series.layout.removeElementFromCollection(node, series.layout.nodes);
});
}
}
},
// Packedbubble has two separate collecions of nodes if split, render
// dataLabels for both sets:
drawDataLabels: function () {
var textPath = this.options.dataLabels.textPath, points = this.points;
// Render node labels:
Series.prototype.drawDataLabels.apply(this, arguments);
// Render parentNode labels:
if (this.parentNode) {
this.parentNode.formatPrefix = 'parentNode';
this.points = [this.parentNode];
this.options.dataLabels.textPath =
this.options.dataLabels.parentNodeTextPath;
Series.prototype.drawDataLabels.apply(this, arguments);
// Restore nodes
this.points = points;
this.options.dataLabels.textPath = textPath;
}
},
/**
* The function responsible for calculating series bubble' s bBox.
* Needed because of exporting failure when useSimulation
* is set to false
* @private
*/
seriesBox: function () {
var series = this, chart = series.chart, data = series.data, max = Math.max, min = Math.min, radius,
// bBox = [xMin, xMax, yMin, yMax]
bBox = [
chart.plotLeft,
chart.plotLeft + chart.plotWidth,
chart.plotTop,
chart.plotTop + chart.plotHeight
];
data.forEach(function (p) {
if (defined(p.plotX) &&
defined(p.plotY) &&
p.marker.radius) {
radius = p.marker.radius;
bBox[0] = min(bBox[0], p.plotX - radius);
bBox[1] = max(bBox[1], p.plotX + radius);
bBox[2] = min(bBox[2], p.plotY - radius);
bBox[3] = max(bBox[3], p.plotY + radius);
}
});
return isNumber(bBox.width / bBox.height) ?
bBox :
null;
},
/**
* The function responsible for calculating the parent node radius
* based on the total surface of iniside-bubbles and the group BBox
* @private
*/
calculateParentRadius: function () {
var series = this, bBox, parentPadding = 20, minParentRadius = 20;
bBox = series.seriesBox();
series.parentNodeRadius =
Math.min(Math.max(Math.sqrt(2 * series.parentNodeMass / Math.PI) + parentPadding, minParentRadius), bBox ?
Math.max(Math.sqrt(Math.pow(bBox.width, 2) +
Math.pow(bBox.height, 2)) / 2 + parentPadding, minParentRadius) :
Math.sqrt(2 * series.parentNodeMass / Math.PI) + parentPadding);
if (series.parentNode) {
series.parentNode.marker.radius =
series.parentNode.radius = series.parentNodeRadius;
}
},
// Create Background/Parent Nodes for split series.
drawGraph: function () {
// if the series is not using layout, don't add parent nodes
if (!this.layout || !this.layout.options.splitSeries) {
return;
}
var series = this, chart = series.chart, parentAttribs = {}, nodeMarker = this.layout.options.parentNodeOptions.marker, parentOptions = {
fill: nodeMarker.fillColor ||
color(series.color).brighten(0.4).get(),
opacity: nodeMarker.fillOpacity,
stroke: nodeMarker.lineColor || series.color,
'stroke-width': nodeMarker.lineWidth
}, visibility = series.visible ? 'inherit' : 'hidden';
// create the group for parent Nodes if doesn't exist
if (!this.parentNodesGroup) {
series.parentNodesGroup = series.plotGroup('parentNodesGroup', 'parentNode', visibility, 0.1, chart.seriesGroup);
series.group.attr({
zIndex: 2
});
}
this.calculateParentRadius();
parentAttribs = H.merge({
x: series.parentNode.plotX -
series.parentNodeRadius,
y: series.parentNode.plotY -
series.parentNodeRadius,
width: series.parentNodeRadius * 2,
height: series.parentNodeRadius * 2
}, parentOptions);
if (!series.parentNode.graphic) {
series.graph = series.parentNode.graphic =
chart.renderer.symbol(parentOptions.symbol)
.add(series.parentNodesGroup);
}
series.parentNode.graphic.attr(parentAttribs);
},
/**
* Creating parent nodes for split series, in which all the bubbles
* are rendered.
* @private
*/
createParentNodes: function () {
var series = this, chart = series.chart, parentNodeLayout = series.parentNodeLayout, nodeAdded, parentNode = series.parentNode;
series.parentNodeMass = 0;
series.points.forEach(function (p) {
series.parentNodeMass +=
Math.PI * Math.pow(p.marker.radius, 2);
});
series.calculateParentRadius();
parentNodeLayout.nodes.forEach(function (node) {
if (node.seriesIndex === series.index) {
nodeAdded = true;
}
});
parentNodeLayout.setArea(0, 0, chart.plotWidth, chart.plotHeight);
if (!nodeAdded) {
if (!parentNode) {
parentNode = (new NetworkPoint()).init(this, {
mass: series.parentNodeRadius / 2,
marker: {
radius: series.parentNodeRadius
},
dataLabels: {
inside: false
},
dataLabelOnNull: true,
degree: series.parentNodeRadius,
isParentNode: true,
seriesIndex: series.index
});
}
if (series.parentNode) {
parentNode.plotX = series.parentNode.plotX;
parentNode.plotY = series.parentNode.plotY;
}
series.parentNode = parentNode;
parentNodeLayout.addElementsToCollection([series], parentNodeLayout.series);
parentNodeLayout.addElementsToCollection([parentNode], parentNodeLayout.nodes);
}
},
/**
* Function responsible for adding series layout, used for parent nodes.
* @private
*/
addSeriesLayout: function () {
var series = this, layoutOptions = series.options.layoutAlgorithm, graphLayoutsStorage = series.chart.graphLayoutsStorage, graphLayoutsLookup = series.chart.graphLayoutsLookup, parentNodeOptions = H.merge(layoutOptions, layoutOptions.parentNodeOptions, {
enableSimulation: series.layout.options.enableSimulation
}), parentNodeLayout;
parentNodeLayout = graphLayoutsStorage[layoutOptions.type + '-series'];
if (!parentNodeLayout) {
graphLayoutsStorage[layoutOptions.type + '-series'] =
parentNodeLayout =
new H.layouts[layoutOptions.type]();
parentNodeLayout.init(parentNodeOptions);
graphLayoutsLookup.splice(parentNodeLayout.index, 0, parentNodeLayout);
}
series.parentNodeLayout = parentNodeLayout;
this.createParentNodes();
},
/**
* Adding the basic layout to series points.
* @private
*/
addLayout: function () {
var series = this, layoutOptions = series.options.layoutAlgorithm, graphLayoutsStorage = series.chart.graphLayoutsStorage, graphLayoutsLookup = series.chart.graphLayoutsLookup, chartOptions = series.chart.options.chart, layout;
if (!graphLayoutsStorage) {
series.chart.graphLayoutsStorage = graphLayoutsStorage = {};
series.chart.graphLayoutsLookup = graphLayoutsLookup = [];
}
layout = graphLayoutsStorage[layoutOptions.type];
if (!layout) {
layoutOptions.enableSimulation =
!defined(chartOptions.forExport) ?
layoutOptions.enableSimulation :
!chartOptions.forExport;
graphLayoutsStorage[layoutOptions.type] = layout =
new H.layouts[layoutOptions.type]();
layout.init(layoutOptions);
graphLayoutsLookup.splice(layout.index, 0, layout);
}
series.layout = layout;
series.points.forEach(function (node) {
node.mass = 2;
node.degree = 1;
node.collisionNmb = 1;
});
layout.setArea(0, 0, series.chart.plotWidth, series.chart.plotHeight);
layout.addElementsToCollection([series], layout.series);
layout.addElementsToCollection(series.points, layout.nodes);
},
/**
* Function responsible for adding all the layouts to the chart.
* @private
*/
deferLayout: function () {
// TODO split layouts to independent methods
var series = this, layoutOptions = series.options.layoutAlgorithm;
if (!series.visible) {
return;
}
// layout is using nodes for position calculation
series.addLayout();
if (layoutOptions.splitSeries) {
series.addSeriesLayout();
}
},
/**
* Extend the base translate method to handle bubble size,
* and correct positioning them.
* @private
*/
translate: function () {
var series = this, chart = series.chart, data = series.data, index = series.index, point, radius, positions, i, useSimulation = series.options.useSimulation;
series.processedXData = series.xData;
series.generatePoints();
// merged data is an array with all of the data from all series
if (!defined(chart.allDataPoints)) {
chart.allDataPoints = series.accumulateAllPoints(series);
// calculate radius for all added data
series.getPointRadius();
}
// after getting initial radius, calculate bubble positions
if (useSimulation) {
positions = chart.allDataPoints;
}
else {
positions = series.placeBubbles(chart.allDataPoints);
series.options.draggable = false;
}
// Set the shape and arguments to be picked up in drawPoints
for (i = 0; i < positions.length; i++) {
if (positions[i][3] === index) {
// update the series points with the val from positions
// array
point = data[positions[i][4]];
radius = positions[i][2];
if (!useSimulation) {
point.plotX = (positions[i][0] - chart.plotLeft +
chart.diffX);
point.plotY = (positions[i][1] - chart.plotTop +
chart.diffY);
}
point.marker = H.extend(point.marker, {
radius: radius,
width: 2 * radius,
height: 2 * radius
});
point.radius = radius;
}
}
if (useSimulation) {
series.deferLayout();
}
fireEvent(series, 'afterTranslate');
},
/**
* Check if two bubbles overlaps.
* @private
* @param {Array} first bubble
* @param {Array} second bubble
* @return {Boolean} overlap or not
*/
checkOverlap: function (bubble1, bubble2) {
var diffX = bubble1[0] - bubble2[0], // diff of X center values
diffY = bubble1[1] - bubble2[1], // diff of Y center values
sumRad = bubble1[2] + bubble2[2]; // sum of bubble radius
return (Math.sqrt(diffX * diffX + diffY * diffY) -
Math.abs(sumRad)) < -0.001;
},
/**
* Function that is adding one bubble based on positions and sizes of
* two other bubbles, lastBubble is the last added bubble, newOrigin is
* the bubble for positioning new bubbles. nextBubble is the curently
* added bubble for which we are calculating positions
* @private
* @param {Array<number>} lastBubble The closest last bubble
* @param {Array<number>} newOrigin New bubble
* @param {Array<number>} nextBubble The closest next bubble
* @return {Array<number>} Bubble with correct positions
*/
positionBubble: function (lastBubble, newOrigin, nextBubble) {
var sqrt = Math.sqrt, asin = Math.asin, acos = Math.acos, pow = Math.pow, abs = Math.abs, distance = sqrt(// dist between lastBubble and newOrigin
pow((lastBubble[0] - newOrigin[0]), 2) +
pow((lastBubble[1] - newOrigin[1]), 2)), alfa = acos(
// from cosinus theorem: alfa is an angle used for
// calculating correct position
(pow(distance, 2) +
pow(nextBubble[2] + newOrigin[2], 2) -
pow(nextBubble[2] + lastBubble[2], 2)) / (2 * (nextBubble[2] + newOrigin[2]) * distance)), beta = asin(// from sinus theorem.
abs(lastBubble[0] - newOrigin[0]) /
distance),
// providing helping variables, related to angle between
// lastBubble and newOrigin
gamma = (lastBubble[1] - newOrigin[1]) < 0 ? 0 : Math.PI,
// if new origin y is smaller than last bubble y value
// (2 and 3 quarter),
// add Math.PI to final angle
delta = (lastBubble[0] - newOrigin[0]) *
(lastBubble[1] - newOrigin[1]) < 0 ?
1 : -1, // (1st and 3rd quarter)
finalAngle = gamma + alfa + beta * delta, cosA = Math.cos(finalAngle), sinA = Math.sin(finalAngle), posX = newOrigin[0] + (newOrigin[2] + nextBubble[2]) * sinA,
// center of new origin + (radius1 + radius2) * sinus A
posY = newOrigin[1] - (newOrigin[2] + nextBubble[2]) * cosA;
return [
posX,
posY,
nextBubble[2],
nextBubble[3],
nextBubble[4]
]; // the same as described before
},
/**
* This is the main function responsible
* for positioning all of the bubbles
* allDataPoints - bubble array, in format [pixel x value,
* pixel y value, radius,
* related series index, related point index]
* @private
* @param {Array<Highcharts.PackedBubbleData>} allDataPoints All points from all series
* @return {Array<Highcharts.PackedBubbleData>} Positions of all bubbles
*/
placeBubbles: function (allDataPoints) {
var series = this, checkOverlap = series.checkOverlap, positionBubble = series.positionBubble, bubblePos = [], stage = 1, j = 0, k = 0, calculatedBubble, sortedArr, arr = [], i;
// sort all points
sortedArr = allDataPoints.sort(function (a, b) {
return b[2] - a[2];
});
if (sortedArr.length) {
// create first bubble in the middle of the chart
bubblePos.push([
[
0,
0,
sortedArr[0][2],
sortedArr[0][3],
sortedArr[0][4]
] // point index
]); // 0 level bubble
if (sortedArr.length > 1) {
bubblePos.push([
[
0,
(0 - sortedArr[1][2] -
sortedArr[0][2]),
// move bubble above first one
sortedArr[1][2],
sortedArr[1][3],
sortedArr[1][4]
]
]); // 1 level 1st bubble
// first two already positioned so starting from 2
for (i = 2; i < sortedArr.length; i++) {
sortedArr[i][2] = sortedArr[i][2] || 1;
// in case if radius is calculated as 0.
calculatedBubble = positionBubble(bubblePos[stage][j], bubblePos[stage - 1][k], sortedArr[i]); // calculate initial bubble position
if (checkOverlap(calculatedBubble, bubblePos[stage][0])) {
/* if new bubble is overlapping with first bubble
* in current level (stage)
*/
bubblePos.push([]);
k = 0;
/* reset index of bubble, used for
* positioning the bubbles around it,
* we are starting from first bubble in next
* stage because we are changing level to higher
*/
bubblePos[stage + 1].push(positionBubble(bubblePos[stage][j], bubblePos[stage][0], sortedArr[i]));
// (last bubble, 1. from curr stage, new bubble)
stage++; // the new level is created, above current
j = 0; // set the index of bubble in curr level to 0
}
else if (stage > 1 &&
bubblePos[stage - 1][k + 1] &&
checkOverlap(calculatedBubble, bubblePos[stage - 1][k + 1])) {
/* if new bubble is overlapping with one of the prev
* stage bubbles, it means that - bubble, used for
* positioning the bubbles around it has changed
* so we need to recalculate it
*/
k++;
bubblePos[stage].push(positionBubble(bubblePos[stage][j], bubblePos[stage - 1][k], sortedArr[i]));
// (last bubble, prev stage bubble, new bubble)
j++;
}
else { // simply add calculated bubble
j++;
bubblePos[stage].push(calculatedBubble);
}
}
}
series.chart.stages = bubblePos;
// it may not be necessary but adding it just in case -
// it is containing all of the bubble levels
series.chart.rawPositions =
[]
.concat.apply([], bubblePos);
// bubble positions merged into one array
series.resizeRadius();
arr = series.chart.rawPositions;
}
return arr;
},
/**
* The function responsible for resizing the bubble radius.
* In shortcut: it is taking the initially
* calculated positions of bubbles. Then it is calculating the min max
* of both dimensions, creating something in shape of bBox.
* The comparison of bBox and the size of plotArea
* (later it may be also the size set by customer) is giving the
* value how to recalculate the radius so it will match the size
* @private
*/
resizeRadius: function () {
var chart = this.chart, positions = chart.rawPositions, min = Math.min, max = Math.max, plotLeft = chart.plotLeft, plotTop = chart.plotTop, chartHeight = chart.plotHeight, chartWidth = chart.plotWidth, minX, maxX, minY, maxY, radius, bBox, spaceRatio, smallerDimension, i;
minX = minY = Number.POSITIVE_INFINITY; // set initial values
maxX = maxY = Number.NEGATIVE_INFINITY;
for (i = 0; i < positions.length; i++) {
radius = positions[i][2];
minX = min(minX, positions[i][0] - radius);
// (x center-radius) is the min x value used by specific bubble
maxX = max(maxX, positions[i][0] + radius);
minY = min(minY, positions[i][1] - radius);
maxY = max(maxY, positions[i][1] + radius);
}
bBox = [maxX - minX, maxY - minY];
spaceRatio = [
(chartWidth - plotLeft) / bBox[0],
(chartHeight - plotTop) / bBox[1]
];
smallerDimension = min.apply([], spaceRatio);
if (Math.abs(smallerDimension - 1) > 1e-10) {
// if bBox is considered not the same width as possible size
for (i = 0; i < positions.length; i++) {
positions[i][2] *= smallerDimension;
}
this.placeBubbles(positions);
}
else {
/** if no radius recalculation is needed, we need to position
* the whole bubbles in center of chart plotarea
* for this, we are adding two parameters,
* diffY and diffX, that are related to differences
* between the initial center and the bounding box
*/
chart.diffY = chartHeight / 2 +
plotTop - minY - (maxY - minY) / 2;
chart.diffX = chartWidth / 2 +
plotLeft - minX - (maxX - minX) / 2;
}
},
/**
* Calculate min and max bubble value for radius calculation.
* @private
*/
calculateZExtremes: function () {
var chart = this.chart, zMin = this.options.zMin, zMax = this.options.zMax, valMin = Infinity, valMax = -Infinity;
if (zMin && zMax) {
return [zMin, zMax];
}
// it is needed to deal with null
// and undefined values
chart.series.forEach(function (s) {
s.yData.forEach(function (p) {
if (defined(p)) {
if (p > valMax) {
valMax = p;
}
if (p < valMin) {
valMin = p;
}
}
});
});
zMin = pick(zMin, valMin);
zMax = pick(zMax, valMax);
return [zMin, zMax];
},
/**
* Calculate radius of bubbles in series.
* @private
*/
getPointRadius: function () {
var series = this, chart = series.chart, plotWidth = chart.plotWidth, plotHeight = chart.plotHeight, seriesOptions = series.options, useSimulation = seriesOptions.useSimulation, smallestSize = Math.min(plotWidth, plotHeight), extremes = {}, radii = [], allDataPoints = chart.allDataPoints, minSize, maxSize, value, radius, zExtremes;
['minSize', 'maxSize'].forEach(function (prop) {
var length = parseInt(seriesOptions[prop], 10), isPercent = /%$/.test(seriesOptions[prop]);
extremes[prop] = isPercent ?
smallestSize * length / 100 :
length * Math.sqrt(allDataPoints.length);
});
chart.minRadius = minSize = extremes.minSize /
Math.sqrt(allDataPoints.length);
chart.maxRadius = maxSize = extremes.maxSize /
Math.sqrt(allDataPoints.length);
zExtremes = useSimulation ?
series.calculateZExtremes() :
[minSize, maxSize];
(allDataPoints || []).forEach(function (point, i) {
value = useSimulation ?
Math.max(Math.min(point[2], zExtremes[1]), zExtremes[0]) :
point[2];
radius = series.getRadius(zExtremes[0], zExtremes[1], minSize, maxSize, value);
if (radius === 0) {
radius = null;
}
allDataPoints[i][2] = radius;
radii.push(radius);
});
series.radii = radii;
},
// Draggable mode:
/**
* Redraw halo on mousemove during the drag&drop action.
* @private
* @param {Highcharts.Point} point The point that should show halo.
*/
redrawHalo: dragNodesMixin.redrawHalo,
/**
* Mouse down action, initializing drag&drop mode.
* @private
* @param {global.Event} event Browser event, before normalization.
* @param {Highcharts.Point} point The point that event occured.
*/
onMouseDown: dragNodesMixin.onMouseDown,
/**
* Mouse move action during drag&drop.
* @private
* @param {global.Event} event Browser event, before normalization.
* @param {Highcharts.Point} point The point that event occured.
*/
onMouseMove: dragNodesMixin.onMouseMove,
/**
* Mouse up action, finalizing drag&drop.
* @private
* @param {Highcharts.Point} point The point that event occured.
*/
onMouseUp: function (point) {
if (point.fixedPosition && !point.removed) {
var distanceXY, distanceR, layout = this.layout, parentNodeLayout = this.parentNodeLayout;
if (parentNodeLayout && layout.options.dragBetweenSeries) {
parentNodeLayout.nodes.forEach(function (node) {
if (point && point.marker &&
node !== point.series.parentNode) {
distanceXY = layout.getDistXY(point, node);
distanceR = (layout.vectorLength(distanceXY) -
node.marker.radius -
point.marker.radius);
if (distanceR < 0) {
node.series.addPoint(H.merge(point.options, {
plotX: point.plotX,
plotY: point.plotY
}), false);
layout.removeElementFromCollection(point, layout.nodes);
point.remove();
}
}
});
}
dragNodesMixin.onMouseUp.apply(this, arguments);
}
},
destroy: function () {
// Remove the series from all layouts series collections #11469
if (this.chart.graphLayoutsLookup) {
this.chart.graphLayoutsLookup.forEach(function (layout) {
layout.removeElementFromCollection(this, layout.series);
}, this);
}
if (this.parentNode) {
this.parentNodeLayout.removeElementFromCollection(this.parentNode, this.parentNodeLayout.nodes);
if (this.parentNode.dataLabel) {
this.parentNode.dataLabel =
this.parentNode.dataLabel.destroy();
}
}
H.Series.prototype.destroy.apply(this, arguments);
},
alignDataLabel: H.Series.prototype.alignDataLabel
}, {
/**
* Destroy point.
* Then remove point from the layout.
* @private
* @return {undefined}
*/
destroy: function () {
if (this.series.layout) {
this.series.layout.removeElementFromCollection(this, this.series.layout.nodes);
}
return Point.prototype.destroy.apply(this, arguments);
}
});
// Remove accumulated data points to redistribute all of them again
// (i.e after hiding series by legend)
addEvent(Chart, 'beforeRedraw', function () {
if (this.allDataPoints) {
delete this.allDataPoints;
}
});
/* eslint-enable no-invalid-this, valid-jsdoc */
/**
* A `packedbubble` series. If the [type](#series.packedbubble.type) option is
* not specified, it is inherited from [chart.type](#chart.type).
*
* @type {Object}
* @extends series,plotOptions.packedbubble
* @excluding dataParser,dataURL,stack
* @product highcharts highstock
* @apioption series.packedbubble
*/
/**
* An array of data points for the series. For the `packedbubble` series type,
* points can be given in the following ways:
*
* 1. An array of `values`.
*
* ```js
* data: [5, 1, 20]
* ```
*
* 2. An array of objects with named values. The objects are point
* configuration objects as seen below. If the total number of data points
* exceeds the series' [turboThreshold](#series.packedbubble.turboThreshold),
* this option is not available.
*
* ```js
* data: [{
* value: 1,
* name: "Point2",
* color: "#00FF00"
* }, {
* value: 5,
* name: "Point1",
* color: "#FF00FF"
* }]
* ```
*
* @type {Array<Object|Array>}
* @extends series.line.data
* @excluding marker, x, y
* @sample {highcharts} highcharts/series/data-array-of-objects/
* Config objects
* @product highcharts
* @apioption series.packedbubble.data
*/
/**
* @type {Highcharts.SeriesPackedBubbleDataLabelsOptionsObject|Array<Highcharts.SeriesPackedBubbleDataLabelsOptionsObject>}
* @product highcharts
* @apioption series.packedbubble.data.dataLabels
*/
/**
* @excluding enabled,enabledThreshold,height,radius,width
* @product highcharts
* @apioption series.packedbubble.marker
*/
''; // adds doclets above to transpiled file