/
Drilldown.ts
1797 lines (1603 loc) · 55.5 KB
/
Drilldown.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
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
/* *
*
* Highcharts Drilldown module
*
* Author: Torstein Honsi
*
* License: www.highcharts.com/license
*
* !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
*
* */
'use strict';
import type {
AlignObject,
AlignValue,
VerticalAlignValue
} from '../Core/Renderer/AlignObject';
import type AnimationOptions from '../Core/Animation/AnimationOptions';
import type BBoxObject from '../Core/Renderer/BBoxObject';
import type { ButtonRelativeToValue } from '../Maps/MapNavigationOptions';
import type ColorType from '../Core/Color/ColorType';
import type {
CSSObject,
CursorValue
} from '../Core/Renderer/CSSObject';
import type Options from '../Core/Options';
import type {
PointOptions,
PointShortOptions
} from '../Core/Series/PointOptions';
import type SeriesOptions from '../Core/Series/SeriesOptions';
import type { SeriesTypeOptions } from '../Core/Series/SeriesType';
import type SVGAttributes from '../Core/Renderer/SVG/SVGAttributes';
import type SVGElement from '../Core/Renderer/SVG/SVGElement';
import A from '../Core/Animation/AnimationUtilities.js';
const { animObject } = A;
import Axis from '../Core/Axis/Axis.js';
import Chart from '../Core/Chart/Chart.js';
import Color from '../Core/Color/Color.js';
import ColumnSeries from '../Series/Column/ColumnSeries.js';
import F from '../Core/FormatUtilities.js';
const { format } = F;
import H from '../Core/Globals.js';
const { noop } = H;
import D from '../Core/DefaultOptions.js';
const { defaultOptions } = D;
import { Palette } from '../Core/Color/Palettes.js';
import Point from '../Core/Series/Point.js';
import Series from '../Core/Series/Series.js';
import SeriesRegistry from '../Core/Series/SeriesRegistry.js';
const { seriesTypes } = SeriesRegistry;
import SVGRenderer from '../Core/Renderer/SVG/SVGRenderer.js';
import Tick from '../Core/Axis/Tick.js';
import U from '../Core/Utilities.js';
import Breadcrumbs from './Breadcrumbs.js';
const {
addEvent,
removeEvent,
extend,
fireEvent,
merge,
objectEach,
pick,
syncTimeout
} = U;
declare module '../Core/Axis/AxisLike' {
interface AxisLike {
ddPoints?: Record<string, Array<(false|Point)>>;
oldPos?: number;
drilldownCategory(x: number, e: MouseEvent): void;
getDDPoints(x: number): Array<(false|Point)>;
}
}
declare module '../Core/Axis/TickLike' {
interface TickLike {
drillable(): void;
}
}
declare module '../Core/Chart/ChartLike' {
interface ChartLike {
ddDupes?: Array<string>;
drilldown?: Highcharts.ChartDrilldownObject;
drilldownLevels?: Array<Highcharts.DrilldownLevelObject>;
drillUpButton?: SVGElement;
addSeriesAsDrilldown(
point: Point,
options: SeriesTypeOptions
): void;
addSingleSeriesAsDrilldown(
point: Point,
ddOptions: SeriesTypeOptions
): void;
applyDrilldown(): void;
drillUp(): void;
}
}
declare module '../Core/Options'{
interface Options {
drilldown?: Highcharts.DrilldownOptions;
}
}
declare module '../Core/LangOptions' {
interface LangOptions {
drillUpText?: string;
}
}
declare module '../Core/Renderer/SVG/SVGElementLike' {
interface SVGElementLike {
fadeIn(animation?: (boolean|Partial<AnimationOptions>)): void;
}
}
declare module '../Core/Series/PointLike' {
interface PointLike {
drilldown?: string;
doDrilldown(): void;
runDrilldown(
holdRedraw?: boolean,
category?: number,
originalEvent?: Event
): void;
unbindDrilldownClick?: Function;
}
}
declare module '../Core/Series/SeriesLike' {
interface SeriesLike {
drilldownLevel?: Highcharts.DrilldownLevelObject;
isDrilling?: boolean;
purgedOptions?: SeriesTypeOptions;
/** @requires Extensions/Drilldown */
animateDrilldown(init?: boolean): void;
/** @requires Extensions/Drilldown */
animateDrillupFrom(level: Highcharts.DrilldownLevelObject): void;
/** @requires Extensions/Drilldown */
animateDrillupTo(init?: boolean): void;
}
}
declare module '../Core/Series/SeriesOptions' {
interface SeriesOptions {
_colorIndex?: number;
_ddSeriesId?: number;
_levelNumber?: number;
drilldown?: string;
}
}
/**
* Internal types
* @private
*/
declare global {
namespace Highcharts {
interface ChartDrilldownObject {
chart: Chart,
update(options: DrilldownOptions, redraw?: boolean): void;
fadeInGroup(group?: SVGElement): void;
}
interface ChartEventsOptions {
drilldown?: DrilldownCallbackFunction;
drillup?: DrillupCallbackFunction;
drillupall?: DrillupAllCallbackFunction;
}
interface DrilldownActiveDataLabelStyleOptions {
color?: string;
cursor?: string;
fontWeight?: string;
textDecoration?: string;
}
interface DrilldownDrillUpButtonOptions {
position: (AlignObject|DrilldownDrillUpButtonPositionOptions);
relativeTo?: ButtonRelativeToValue;
theme?: object;
}
interface DrilldownDrillUpButtonPositionOptions {
align?: AlignValue;
verticalAlign?: VerticalAlignValue;
x?: number;
y?: number;
}
interface DrilldownCallbackFunction {
(this: Chart, e: DrilldownEventObject): void;
}
interface DrilldownEventObject {
category?: number;
originalEvent?: Event;
point: Point;
points?: Array<(boolean|Point)>;
preventDefault: Function;
seriesOptions?: SeriesTypeOptions;
target: Chart;
type: 'drilldown';
}
interface DrilldownOptions {
activeAxisLabelStyle?: CSSObject;
activeDataLabelStyle?: (
CSSObject|DrilldownActiveDataLabelStyleOptions
);
allowPointDrilldown?: boolean;
animation?: (boolean|Partial<AnimationOptions>);
drillUpButton?: DrilldownDrillUpButtonOptions;
series?: Array<SeriesTypeOptions>;
}
interface DrilldownLevelObject {
bBox: (BBoxObject|Record<string, undefined>);
color?: ColorType;
colorIndex?: number;
levelNumber: number;
levelSeries: Array<Series>;
levelSeriesOptions: Array<SeriesOptions>;
lowerSeries: Series;
lowerSeriesOptions: SeriesOptions;
oldExtremes: Record<string, (number|undefined)>;
pointIndex: number;
pointOptions: (PointOptions|PointShortOptions);
seriesOptions: SeriesOptions;
seriesPurgedOptions: SeriesOptions;
shapeArgs?: SVGAttributes;
resetZoomButton: SVGElement;
}
interface DrillupAllCallbackFunction {
(this: Chart, e: DrillupAllEventObject): void;
}
interface DrillupAllEventObject {
preventDefault: Function;
target: Chart;
type: 'drillupall';
}
interface DrillupCallbackFunction {
(this: Chart, e: DrillupEventObject): void;
}
interface DrillupEventObject {
preventDefault: Function;
seriesOptions?: SeriesTypeOptions;
target: Chart;
type: 'drillup';
}
interface Tick {
drillable(): void;
}
}
}
/**
* Gets fired when a drilldown point is clicked, before the new series is added.
* Note that when clicking a category label to trigger multiple series
* drilldown, one `drilldown` event is triggered per point in the category.
*
* @callback Highcharts.DrilldownCallbackFunction
*
* @param {Highcharts.Chart} this
* The chart where the event occurs.
*
* @param {Highcharts.DrilldownEventObject} e
* The drilldown event.
*/
/**
* The event arguments when a drilldown point is clicked.
*
* @interface Highcharts.DrilldownEventObject
*//**
* If a category label was clicked, which index.
* @name Highcharts.DrilldownEventObject#category
* @type {number|undefined}
*//**
* The original browser event (usually click) that triggered the drilldown.
* @name Highcharts.DrilldownEventObject#originalEvent
* @type {global.Event|undefined}
*//**
* Prevents the default behaviour of the event.
* @name Highcharts.DrilldownEventObject#preventDefault
* @type {Function}
*//**
* The originating point.
* @name Highcharts.DrilldownEventObject#point
* @type {Highcharts.Point}
*//**
* If a category label was clicked, this array holds all points corresponding to
* the category. Otherwise it is set to false.
* @name Highcharts.DrilldownEventObject#points
* @type {boolean|Array<Highcharts.Point>|undefined}
*//**
* Options for the new series. If the event is utilized for async drilldown, the
* seriesOptions are not added, but rather loaded async.
* @name Highcharts.DrilldownEventObject#seriesOptions
* @type {Highcharts.SeriesOptionsType|undefined}
*//**
* The event target.
* @name Highcharts.DrilldownEventObject#target
* @type {Highcharts.Chart}
*//**
* The event type.
* @name Highcharts.DrilldownEventObject#type
* @type {"drilldown"}
*/
/**
* This gets fired after all the series have been drilled up. This is especially
* usefull in a chart with multiple drilldown series.
*
* @callback Highcharts.DrillupAllCallbackFunction
*
* @param {Highcharts.Chart} this
* The chart where the event occurs.
*
* @param {Highcharts.DrillupAllEventObject} e
* The final drillup event.
*/
/**
* The event arguments when all the series have been drilled up.
*
* @interface Highcharts.DrillupAllEventObject
*//**
* Prevents the default behaviour of the event.
* @name Highcharts.DrillupAllEventObject#preventDefault
* @type {Function}
*//**
* The event target.
* @name Highcharts.DrillupAllEventObject#target
* @type {Highcharts.Chart}
*//**
* The event type.
* @name Highcharts.DrillupAllEventObject#type
* @type {"drillupall"}
*/
/**
* Gets fired when drilling up from a drilldown series.
*
* @callback Highcharts.DrillupCallbackFunction
*
* @param {Highcharts.Chart} this
* The chart where the event occurs.
*
* @param {Highcharts.DrillupEventObject} e
* The drillup event.
*/
/**
* The event arguments when drilling up from a drilldown series.
*
* @interface Highcharts.DrillupEventObject
*//**
* Prevents the default behaviour of the event.
* @name Highcharts.DrillupEventObject#preventDefault
* @type {Function}
*//**
* Options for the new series.
* @name Highcharts.DrillupEventObject#seriesOptions
* @type {Highcharts.SeriesOptionsType|undefined}
*//**
* The event target.
* @name Highcharts.DrillupEventObject#target
* @type {Highcharts.Chart}
*//**
* The event type.
* @name Highcharts.DrillupEventObject#type
* @type {"drillup"}
*/
import '../Series/Column/ColumnSeries.js';
let PieSeries = seriesTypes.pie,
ddSeriesId = 1;
// Add language
extend(
defaultOptions.lang,
/**
* @optionparent lang
*/
{
/**
* The text for the button that appears when drilling down, linking back
* to the parent series. The parent series' name is inserted for
* `{series.name}`.
*
* @deprecated
* @since 3.0.8
* @product highcharts highmaps
* @requires modules/drilldown
* @apioption lang.drillUpText
*/
}
);
/**
* Options for drill down, the concept of inspecting increasingly high
* resolution data through clicking on chart items like columns or pie slices.
*
* The drilldown feature requires the drilldown.js file to be loaded,
* found in the modules directory of the download package, or online at
* [code.highcharts.com/modules/drilldown.js
* ](https://code.highcharts.com/modules/drilldown.js).
*
* @sample {highcharts} highcharts/series-organization/drilldown
* Organization chart drilldown
*
* @product highcharts highmaps
* @requires modules/drilldown
* @optionparent drilldown
*/
defaultOptions.drilldown = {
/**
* When this option is false, clicking a single point will drill down
* all points in the same category, equivalent to clicking the X axis
* label.
*
* @sample {highcharts} highcharts/drilldown/allowpointdrilldown-false/
* Don't allow point drilldown
*
* @type {boolean}
* @default true
* @since 4.1.7
* @product highcharts
* @apioption drilldown.allowPointDrilldown
*/
/**
* Options for the breadcrumbs, the navigation at the top leading the way
* up through the drilldown levels.
*
* @since 10.0.0
* @product highcharts
* @extends navigation.breadcrumbs
* @optionparent drilldown.breadcrumbs
*/
/**
* An array of series configurations for the drill down. Each series
* configuration uses the same syntax as the [series](#series) option set.
* These drilldown series are hidden by default. The drilldown series is
* linked to the parent series' point by its `id`.
*
* @type {Array<Highcharts.SeriesOptionsType>}
* @since 3.0.8
* @product highcharts highmaps
* @apioption drilldown.series
*/
/**
* Additional styles to apply to the X axis label for a point that
* has drilldown data. By default it is underlined and blue to invite
* to interaction.
*
* In styled mode, active label styles can be set with the
* `.highcharts-drilldown-axis-label` class.
*
* @sample {highcharts} highcharts/drilldown/labels/
* Label styles
*
* @type {Highcharts.CSSObject}
* @default { "cursor": "pointer", "color": "#003399", "fontWeight": "bold", "textDecoration": "underline" }
* @since 3.0.8
* @product highcharts highmaps
*/
activeAxisLabelStyle: {
/** @ignore-option */
cursor: 'pointer',
/** @ignore-option */
color: Palette.highlightColor100,
/** @ignore-option */
fontWeight: 'bold',
/** @ignore-option */
textDecoration: 'underline'
},
/**
* Additional styles to apply to the data label of a point that has
* drilldown data. By default it is underlined and blue to invite to
* interaction.
*
* In styled mode, active data label styles can be applied with the
* `.highcharts-drilldown-data-label` class.
*
* @sample {highcharts} highcharts/drilldown/labels/
* Label styles
*
* @type {Highcharts.CSSObject}
* @default { "cursor": "pointer", "color": "#003399", "fontWeight": "bold", "textDecoration": "underline" }
* @since 3.0.8
* @product highcharts highmaps
*/
activeDataLabelStyle: {
cursor: 'pointer',
color: Palette.highlightColor100,
fontWeight: 'bold',
textDecoration: 'underline'
},
/**
* Set the animation for all drilldown animations. Animation of a drilldown
* occurs when drilling between a column point and a column series,
* or a pie slice and a full pie series. Drilldown can still be used
* between series and points of different types, but animation will
* not occur.
*
* The animation can either be set as a boolean or a configuration
* object. If `true`, it will use the 'swing' jQuery easing and a duration
* of 500 ms. If used as a configuration object, the following properties
* are supported:
*
* - `duration`: The duration of the animation in milliseconds.
*
* - `easing`: A string reference to an easing function set on the `Math`
* object. See
* [the easing demo](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-animation-easing/).
*
* @type {boolean|Partial<Highcharts.AnimationOptionsObject>}
* @since 3.0.8
* @product highcharts highmaps
*/
animation: {
/** @internal */
duration: 500
},
/**
*
* Options for the drill up button that appears when drilling down on a
* series. The text for the button is defined in
* [lang.drillUpText](#lang.drillUpText).
*
* This option is deprecated since 9.3.2, use `drilldown.breadcrumbs`
* instead.
*
* @sample highcharts/breadcrumbs/single-button
* Breadcrumbs set up like a legacy button
* @sample {highcharts} highcharts/drilldown/drillupbutton/ Drill up button
* @sample {highmaps} highcharts/drilldown/drillupbutton/ Drill up button
*
* @since 3.0.8
* @product highcharts highmaps
*
* @deprecated
*/
drillUpButton: {
/**
* What box to align the button to. Can be either `plotBox` or
* `spacingBox`.
*
* @type {Highcharts.ButtonRelativeToValue}
* @default plotBox
* @since 3.0.8
* @product highcharts highmaps
* @apioption drilldown.drillUpButton.relativeTo
*/
/**
* A collection of attributes for the button. The object takes SVG
* attributes like `fill`, `stroke`, `stroke-width` or `r`, the border
* radius. The theme also supports `style`, a collection of CSS
* properties for the text. Equivalent attributes for the hover state
* are given in `theme.states.hover`.
*
* In styled mode, drill-up button styles can be applied with the
* `.highcharts-drillup-button` class.
*
* @sample {highcharts} highcharts/drilldown/drillupbutton/
* Button theming
* @sample {highmaps} highcharts/drilldown/drillupbutton/
* Button theming
*
* @type {Object}
* @since 3.0.8
* @product highcharts highmaps
* @apioption drilldown.drillUpButton.theme
*/
/**
* Positioning options for the button within the `relativeTo` box.
* Available properties are `x`, `y`, `align` and `verticalAlign`.
*
* @type {Highcharts.AlignObject}
* @since 3.0.8
* @product highcharts highmaps
*/
position: {
/**
* Vertical alignment of the button.
*
* @type {Highcharts.VerticalAlignValue}
* @default top
* @product highcharts highmaps
* @apioption drilldown.drillUpButton.position.verticalAlign
*/
/**
* Horizontal alignment.
*
* @type {Highcharts.AlignValue}
*/
align: 'right',
/**
* The X offset of the button.
*/
x: -10,
/**
* The Y offset of the button.
*/
y: 10
}
}
};
/**
* Fires when a drilldown point is clicked, before the new series is added. This
* event is also utilized for async drilldown, where the seriesOptions are not
* added by option, but rather loaded async. Note that when clicking a category
* label to trigger multiple series drilldown, one `drilldown` event is
* triggered per point in the category.
*
* Event arguments:
*
* - `category`: If a category label was clicked, which index.
*
* - `originalEvent`: The original browser event (usually click) that triggered
* the drilldown.
*
* - `point`: The originating point.
*
* - `points`: If a category label was clicked, this array holds all points
* corresponding to the category.
*
* - `seriesOptions`: Options for the new series.
*
* @sample {highcharts} highcharts/drilldown/async/
* Async drilldown
*
* @type {Highcharts.DrilldownCallbackFunction}
* @since 3.0.8
* @product highcharts highmaps
* @context Highcharts.Chart
* @requires modules/drilldown
* @apioption chart.events.drilldown
*/
/**
* Fires when drilling up from a drilldown series.
*
* @type {Highcharts.DrillupCallbackFunction}
* @since 3.0.8
* @product highcharts highmaps
* @context Highcharts.Chart
* @requires modules/drilldown
* @apioption chart.events.drillup
*/
/**
* In a chart with multiple drilldown series, this event fires after all the
* series have been drilled up.
*
* @type {Highcharts.DrillupAllCallbackFunction}
* @since 4.2.4
* @product highcharts highmaps
* @context Highcharts.Chart
* @requires modules/drilldown
* @apioption chart.events.drillupall
*/
/**
* The `id` of a series in the [drilldown.series](#drilldown.series) array to
* use for a drilldown for this point.
*
* @sample {highcharts} highcharts/drilldown/basic/
* Basic drilldown
*
* @type {string}
* @since 3.0.8
* @product highcharts
* @requires modules/drilldown
* @apioption series.line.data.drilldown
*/
/**
* A general fadeIn method.
*
* @requires module:modules/drilldown
*
* @function Highcharts.SVGElement#fadeIn
*
* @param {boolean|Partial<Highcharts.AnimationOptionsObject>} [animation]
* The animation options for the element fade.
*/
SVGRenderer.prototype.Element.prototype.fadeIn = function (
animation?: (boolean|Partial<AnimationOptions>)
): void {
this
.attr({
opacity: 0.1,
visibility: 'inherit'
})
.animate({
opacity: pick(this.newOpacity, 1) // newOpacity used in maps
}, animation || {
duration: 250
});
};
/**
* Add a series to the chart as drilldown from a specific point in the parent
* series. This method is used for async drilldown, when clicking a point in a
* series should result in loading and displaying a more high-resolution series.
* When not async, the setup is simpler using the
* [drilldown.series](https://api.highcharts.com/highcharts/drilldown.series)
* options structure.
*
* @sample highcharts/drilldown/async/
* Async drilldown
*
* @function Highcharts.Chart#addSeriesAsDrilldown
*
* @param {Highcharts.Point} point
* The point from which the drilldown will start.
*
* @param {Highcharts.SeriesOptionsType} options
* The series options for the new, detailed series.
*/
Chart.prototype.addSeriesAsDrilldown = function (
point: Point,
options: SeriesTypeOptions
): void {
this.addSingleSeriesAsDrilldown(point, options);
this.applyDrilldown();
};
Chart.prototype.addSingleSeriesAsDrilldown = function (
point: Point,
ddOptions: SeriesTypeOptions
): void {
let oldSeries = point.series,
xAxis = oldSeries.xAxis,
yAxis = oldSeries.yAxis,
newSeries: Series,
pointIndex: number,
levelSeries: Array<Series> = [],
levelSeriesOptions: Array<SeriesOptions> = [],
level: (Highcharts.DrilldownLevelObject),
levelNumber: number,
last: (Highcharts.DrilldownLevelObject|undefined),
colorProp: SeriesOptions;
colorProp = this.styledMode ?
{ colorIndex: pick(point.colorIndex, oldSeries.colorIndex) } :
{ color: point.color || oldSeries.color };
if (!this.drilldownLevels) {
this.drilldownLevels = [];
}
levelNumber = oldSeries.options._levelNumber || 0;
// See if we can reuse the registered series from last run
last = this.drilldownLevels[this.drilldownLevels.length - 1];
if (last && last.levelNumber !== levelNumber) {
last = void 0;
}
ddOptions = extend(extend<SeriesOptions>({
_ddSeriesId: ddSeriesId++
}, colorProp), ddOptions);
pointIndex = oldSeries.points.indexOf(point);
// Record options for all current series
oldSeries.chart.series.forEach(function (series: Series): void {
if (series.xAxis === xAxis && !series.isDrilling) {
series.options._ddSeriesId =
series.options._ddSeriesId || ddSeriesId++;
series.options._colorIndex = series.userOptions._colorIndex;
series.options._levelNumber =
series.options._levelNumber || levelNumber; // #3182
if (last) {
levelSeries = last.levelSeries;
levelSeriesOptions = last.levelSeriesOptions;
} else {
levelSeries.push(series);
// (#10597)
series.purgedOptions = merge<SeriesTypeOptions>({
_ddSeriesId: series.options._ddSeriesId,
_levelNumber: series.options._levelNumber,
selected: series.options.selected
}, series.userOptions);
levelSeriesOptions.push(series.purgedOptions);
}
}
});
// Add a record of properties for each drilldown level
level = extend<Highcharts.DrilldownLevelObject>({
levelNumber: levelNumber,
seriesOptions: oldSeries.options,
seriesPurgedOptions: oldSeries.purgedOptions as any,
levelSeriesOptions: levelSeriesOptions,
levelSeries: levelSeries,
shapeArgs: point.shapeArgs,
// no graphic in line series with markers disabled
bBox: point.graphic ? point.graphic.getBBox() : {},
color: point.isNull ?
Color.parse(colorProp.color).setOpacity(0).get() :
colorProp.color,
lowerSeriesOptions: ddOptions,
pointOptions: (oldSeries.options.data as any)[pointIndex],
pointIndex: pointIndex,
oldExtremes: {
xMin: xAxis && xAxis.userMin,
xMax: xAxis && xAxis.userMax,
yMin: yAxis && yAxis.userMin,
yMax: yAxis && yAxis.userMax
},
resetZoomButton: last && last.levelNumber === levelNumber ?
void 0 : this.resetZoomButton as any
} as any, colorProp);
// Push it to the lookup array
this.drilldownLevels.push(level);
// Reset names to prevent extending (#6704)
if (xAxis && xAxis.names) {
xAxis.names.length = 0;
}
newSeries = level.lowerSeries = this.addSeries(ddOptions, false);
newSeries.options._levelNumber = levelNumber + 1;
if (xAxis) {
xAxis.oldPos = xAxis.pos;
xAxis.userMin = xAxis.userMax = null as any;
yAxis.userMin = yAxis.userMax = null as any;
}
// Run fancy cross-animation on supported and equal types
if (oldSeries.type === newSeries.type) {
newSeries.animate = (newSeries.animateDrilldown || noop);
newSeries.options.animation = true;
}
};
Chart.prototype.applyDrilldown = function (): void {
let drilldownLevels = this.drilldownLevels,
levelToRemove: (number|undefined);
if (drilldownLevels && drilldownLevels.length > 0) { // #3352, async loading
levelToRemove = drilldownLevels[drilldownLevels.length - 1].levelNumber;
(this.drilldownLevels as any).forEach(function (
level: Highcharts.DrilldownLevelObject
): void {
if (level.levelNumber === levelToRemove) {
level.levelSeries.forEach(function (series): void {
// Not removed, not added as part of a multi-series
// drilldown
if (
series.options &&
series.options._levelNumber === levelToRemove
) {
series.remove(false);
}
});
}
});
}
// We have a reset zoom button. Hide it and detatch it from the chart. It
// is preserved to the layer config above.
if (this.resetZoomButton) {
this.resetZoomButton.hide();
delete this.resetZoomButton;
}
this.pointer.reset();
fireEvent(this, 'afterDrilldown');
this.redraw();
fireEvent(this, 'afterApplyDrilldown');
};
/**
* This method creates an array of arrays containing a level number
* with the corresponding series/point.
*
* @requires modules/breadcrumbs
*
* @private
* @param {Highcharts.Chart} chart
* Highcharts Chart object.
* @return {Array<Breadcrumbs.BreadcrumbOptions>}
* List for Highcharts Breadcrumbs.
*/
const createBreadcrumbsList = function (chart: Chart): Array<Breadcrumbs.BreadcrumbOptions> {
const list: Array<Breadcrumbs.BreadcrumbOptions> = [],
drilldownLevels = chart.drilldownLevels;
// The list is based on drilldown levels from the chart object
if (drilldownLevels && drilldownLevels.length) {
// Add the initial series as the first element.
if (!list[0]) {
list.push({
level: 0,
levelOptions: drilldownLevels[0].seriesOptions
});
}
drilldownLevels.forEach(function (level, i): void {
const lastBreadcrumb = list[list.length - 1];
// If level is already added to breadcrumbs list,
// don't add it again- drilling categories
// + 1 because of the wrong levels numeration
// in drilldownLevels array.
if (level.levelNumber + 1 > lastBreadcrumb.level) {
list.push({
level: level.levelNumber + 1,
levelOptions: merge({
name: level.lowerSeries.name
}, level.pointOptions)
});
}
});
}
return list;
};
/**
* When the chart is drilled down to a child series, calling `chart.drillUp()`
* will drill up to the parent series.
*
* @requires modules/drilldown
*
* @function Highcharts.Chart#drillUp
*
* @sample {highcharts} highcharts/drilldown/programmatic
* Programmatic drilldown
*/
Chart.prototype.drillUp = function (): void {
if (!this.drilldownLevels || this.drilldownLevels.length === 0) {
return;
}
fireEvent(this, 'beforeDrillUp');
let chart = this,
drilldownLevels = chart.drilldownLevels as any,
levelNumber = drilldownLevels[drilldownLevels.length - 1].levelNumber,
i = drilldownLevels.length,
chartSeries = chart.series,
seriesI: number,
level: Highcharts.DrilldownLevelObject,
oldSeries: Series,
newSeries: (Series|undefined),
oldExtremes: Record<string, (number|undefined)>,
addSeries = function (seriesOptions: SeriesOptions): void {
let addedSeries;
chartSeries.forEach(function (series): void {
if (series.options._ddSeriesId === seriesOptions._ddSeriesId) {
addedSeries = series;
}
});
addedSeries = addedSeries || chart.addSeries(seriesOptions, false);
if (
addedSeries.type === oldSeries.type &&
addedSeries.animateDrillupTo
) {
addedSeries.animate = addedSeries.animateDrillupTo;
}
if (seriesOptions === level.seriesPurgedOptions) {
newSeries = addedSeries;
}
};
const drilldownLevelsNumber = (chart.drilldownLevels as any).length;
while (i--) {
level = drilldownLevels[i];
if (level.levelNumber === levelNumber) {
drilldownLevels.pop();
// Get the lower series by reference or id