keyboard-navigation.src.js
46.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
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
/**
* Accessibility module - Keyboard navigation
*
* (c) 2010-2017 Highsoft AS
* Author: Oystein Moseng
*
* License: www.highcharts.com/license
*/
'use strict';
import H from '../parts/Globals.js';
import '../parts/Utilities.js';
import '../parts/Chart.js';
import '../parts/Series.js';
import '../parts/Point.js';
import '../parts/Tooltip.js';
import '../parts/SvgRenderer.js';
var win = H.win,
doc = win.document,
each = H.each,
addEvent = H.addEvent,
fireEvent = H.fireEvent,
merge = H.merge,
pick = H.pick,
hasSVGFocusSupport;
// Add focus border functionality to SVGElements.
// Draws a new rect on top of element around its bounding box.
H.extend(H.SVGElement.prototype, {
addFocusBorder: function (margin, style) {
// Allow updating by just adding new border
if (this.focusBorder) {
this.removeFocusBorder();
}
// Add the border rect
var bb = this.getBBox(),
pad = pick(margin, 3);
this.focusBorder = this.renderer.rect(
bb.x - pad,
bb.y - pad,
bb.width + 2 * pad,
bb.height + 2 * pad,
style && style.borderRadius
)
.addClass('highcharts-focus-border')
.attr({
stroke: style && style.stroke,
'stroke-width': style && style.strokeWidth
})
.attr({
zIndex: 99
})
.add(this.parentGroup);
},
removeFocusBorder: function () {
if (this.focusBorder) {
this.focusBorder.destroy();
delete this.focusBorder;
}
}
});
// Set for which series types it makes sense to move to the closest point with
// up/down arrows, and which series types should just move to next series.
H.Series.prototype.keyboardMoveVertical = true;
each(['column', 'pie'], function (type) {
if (H.seriesTypes[type]) {
H.seriesTypes[type].prototype.keyboardMoveVertical = false;
}
});
/**
* Strip HTML tags away from a string. Used for aria-label attributes, painting
* on a canvas will fail if the text contains tags.
* @param {String} s The input string
* @return {String} The filtered string
*/
function stripTags(s) {
return typeof s === 'string' ? s.replace(/<\/?[^>]+(>|$)/g, '') : s;
}
/**
* Get the index of a point in a series. This is needed when using e.g. data
* grouping.
*
* @param {Point} point The point to find index of.
* @return {number} The index in the series.points array of the point.
*/
function getPointIndex(point) {
var index = point.index,
points = point.series.points,
i = points.length;
if (points[index] !== point) {
while (i--) {
if (points[i] === point) {
return i;
}
}
} else {
return index;
}
}
/**
* Set default keyboard navigation options
*/
H.setOptions({
accessibility: {
/**
* Options for keyboard navigation.
*
* @type {Object}
* @since 5.0.0
* @apioption accessibility.keyboardNavigation
*/
keyboardNavigation: {
/**
* Enable keyboard navigation for the chart.
*
* @type {Boolean}
* @default true
* @since 5.0.0
* @apioption accessibility.keyboardNavigation.enabled
*/
enabled: true,
/**
* Options for the focus border drawn around elements while
* navigating through them.
*
* @type {Object}
* @sample highcharts/accessibility/custom-focus
* Custom focus ring
* @since 6.0.3
* @apioption accessibility.keyboardNavigation.focusBorder
*/
focusBorder: {
/**
* Enable/disable focus border for chart.
*
* @type {Boolean}
* @default true
* @since 6.0.3
* @apioption accessibility.keyboardNavigation.focusBorder.enabled
*/
enabled: true,
/**
* Hide the browser's default focus indicator.
*
* @type {Boolean}
* @default true
* @since 6.0.4
* @apioption accessibility.keyboardNavigation.focusBorder.hideBrowserFocusOutline
*/
hideBrowserFocusOutline: true,
/**
* Style options for the focus border drawn around elements
* while navigating through them. Note that some browsers in
* addition draw their own borders for focused elements. These
* automatic borders can not be styled by Highcharts.
*
* In styled mode, the border is given the
* `.highcharts-focus-border` class.
*
* @type {Object}
* @since 6.0.3
* @apioption accessibility.keyboardNavigation.focusBorder.style
*/
style: {
/**
* Color of the focus border.
*
* @type {Color}
* @default #000000
* @since 6.0.3
* @apioption accessibility.keyboardNavigation.focusBorder.style.color
*/
color: '#335cad',
/**
* Line width of the focus border.
*
* @type {Number}
* @default 2
* @since 6.0.3
* @apioption accessibility.keyboardNavigation.focusBorder.style.lineWidth
*/
lineWidth: 2,
/**
* Border radius of the focus border.
*
* @type {Number}
* @default 3
* @since 6.0.3
* @apioption accessibility.keyboardNavigation.focusBorder.style.borderRadius
*/
borderRadius: 3
},
/**
* Focus border margin around the elements.
*
* @type {Number}
* @default 2
* @since 6.0.3
* @apioption accessibility.keyboardNavigation.focusBorder.margin
*/
margin: 2
},
/**
* Set the keyboard navigation mode for the chart. Can be "normal"
* or "serialize". In normal mode, left/right arrow keys move
* between points in a series, while up/down arrow keys move between
* series. Up/down navigation acts intelligently to figure out which
* series makes sense to move to from any given point.
*
* In "serialize" mode, points are instead navigated as a single
* list. Left/right behaves as in "normal" mode. Up/down arrow keys
* will behave like left/right. This is useful for unifying
* navigation behavior with/without screen readers enabled.
*
* @type {String}
* @validvalue ["normal", "serialize"]
* @default normal
* @since 6.0.4
* @apioption accessibility.keyboardNavigation.mode
*/
/**
* Skip null points when navigating through points with the
* keyboard.
*
* @type {Boolean}
* @default true
* @since 5.0.0
* @apioption accessibility.keyboardNavigation.skipNullPoints
*/
skipNullPoints: true
}
}
});
/**
* Keyboard navigation for the legend. Requires the Accessibility module.
* @since 5.0.14
* @apioption legend.keyboardNavigation
*/
/**
* Enable/disable keyboard navigation for the legend. Requires the Accessibility
* module.
*
* @type {Boolean}
* @see [accessibility.keyboardNavigation](
* #accessibility.keyboardNavigation.enabled)
* @default true
* @since 5.0.13
* @apioption legend.keyboardNavigation.enabled
*/
// Abstraction layer for keyboard navigation. Keep a map of keyCodes to
// handler functions, and a next/prev move handler for tab order. The
// module's keyCode handlers determine when to move to another module.
// Validate holds a function to determine if there are prerequisites for
// this module to run that are not met. Init holds a function to run once
// before any keyCodes are interpreted. Terminate holds a function to run
// once before moving to next/prev module.
// The chart object keeps track of a list of KeyboardNavigationModules.
function KeyboardNavigationModule(chart, options) {
this.chart = chart;
this.id = options.id;
this.keyCodeMap = options.keyCodeMap;
this.validate = options.validate;
this.init = options.init;
this.terminate = options.terminate;
}
KeyboardNavigationModule.prototype = {
// Find handler function(s) for key code in the keyCodeMap and run it.
run: function (e) {
var navModule = this,
keyCode = e.which || e.keyCode,
found = false,
handled = false;
each(this.keyCodeMap, function (codeSet) {
if (codeSet[0].indexOf(keyCode) > -1) {
found = true;
handled = codeSet[1].call(navModule, keyCode, e) === false ?
// If explicitly returning false, we haven't handled it
false :
true;
}
});
// Default tab handler, move to next/prev module
if (!found && keyCode === 9) {
handled = this.move(e.shiftKey ? -1 : 1);
}
return handled;
},
// Move to next/prev valid module, or undefined if none, and init
// it. Returns true on success and false if there is no valid module
// to move to.
move: function (direction) {
var chart = this.chart;
if (this.terminate) {
this.terminate(direction);
}
chart.keyboardNavigationModuleIndex += direction;
var newModule = chart.keyboardNavigationModules[
chart.keyboardNavigationModuleIndex
];
// Remove existing focus border if any
if (chart.focusElement) {
chart.focusElement.removeFocusBorder();
}
// Verify new module
if (newModule) {
if (newModule.validate && !newModule.validate()) {
return this.move(direction); // Invalid module, recurse
}
if (newModule.init) {
newModule.init(direction); // Valid module, init it
return true;
}
}
// No module
chart.keyboardNavigationModuleIndex = 0; // Reset counter
// Set focus to chart or exit anchor depending on direction
if (direction > 0) {
this.chart.exiting = true;
this.chart.tabExitAnchor.focus();
} else {
this.chart.renderTo.focus();
}
return false;
}
};
// Utility function to attempt to fake a click event on an element
function fakeClickEvent(element) {
var fakeEvent;
if (element && element.onclick && doc.createEvent) {
fakeEvent = doc.createEvent('Events');
fakeEvent.initEvent('click', true, false);
element.onclick(fakeEvent);
}
}
// Determine if a series should be skipped
function isSkipSeries(series) {
var a11yOptions = series.chart.options.accessibility;
return series.options.skipKeyboardNavigation ||
series.options.enableMouseTracking === false || // #8440
!series.visible ||
// Skip all points in a series where pointDescriptionThreshold is
// reached
(a11yOptions.pointDescriptionThreshold &&
a11yOptions.pointDescriptionThreshold <= series.points.length);
}
// Determine if a point should be skipped
function isSkipPoint(point) {
var a11yOptions = point.series.chart.options.accessibility;
return point.isNull && a11yOptions.keyboardNavigation.skipNullPoints ||
point.visible === false ||
isSkipSeries(point.series);
}
// Get the point in a series that is closest (in distance) to a reference point
// Optionally supply weight factors for x and y directions
function getClosestPoint(point, series, xWeight, yWeight) {
var minDistance = Infinity,
dPoint,
minIx,
distance,
i = series.points.length;
if (point.plotX === undefined || point.plotY === undefined) {
return;
}
while (i--) {
dPoint = series.points[i];
if (dPoint.plotX === undefined || dPoint.plotY === undefined) {
continue;
}
distance = (point.plotX - dPoint.plotX) *
(point.plotX - dPoint.plotX) * (xWeight || 1) +
(point.plotY - dPoint.plotY) *
(point.plotY - dPoint.plotY) * (yWeight || 1);
if (distance < minDistance) {
minDistance = distance;
minIx = i;
}
}
return minIx !== undefined && series.points[minIx];
}
// Pan along axis in a direction (1 or -1), optionally with a defined
// granularity (number of steps it takes to walk across current view)
H.Axis.prototype.panStep = function (direction, granularity) {
var gran = granularity || 3,
extremes = this.getExtremes(),
step = (extremes.max - extremes.min) / gran * direction,
newMax = extremes.max + step,
newMin = extremes.min + step,
size = newMax - newMin;
if (direction < 0 && newMin < extremes.dataMin) {
newMin = extremes.dataMin;
newMax = newMin + size;
} else if (direction > 0 && newMax > extremes.dataMax) {
newMax = extremes.dataMax;
newMin = newMax - size;
}
this.setExtremes(newMin, newMax);
};
// Set chart's focus to an SVGElement. Calls focus() on it, and draws the focus
// border. If the focusElement argument is supplied, it draws the border around
// svgElement and sets the focus to focusElement.
H.Chart.prototype.setFocusToElement = function (svgElement, focusElement) {
var focusBorderOptions = this.options.accessibility
.keyboardNavigation.focusBorder,
browserFocusElement = focusElement || svgElement;
// Set browser focus if possible
if (
browserFocusElement.element &&
browserFocusElement.element.focus
) {
browserFocusElement.element.focus();
// Hide default focus ring
if (focusBorderOptions.hideBrowserFocusOutline) {
browserFocusElement.css({ outline: 'none' });
}
}
if (focusBorderOptions.enabled) {
// Remove old focus border
if (this.focusElement) {
this.focusElement.removeFocusBorder();
}
// Draw focus border (since some browsers don't do it automatically)
svgElement.addFocusBorder(focusBorderOptions.margin, {
stroke: focusBorderOptions.style.color,
strokeWidth: focusBorderOptions.style.lineWidth,
borderRadius: focusBorderOptions.style.borderRadius
});
this.focusElement = svgElement;
}
};
// Highlight a point (show tooltip and display hover state). Returns the
// highlighted point.
H.Point.prototype.highlight = function () {
var chart = this.series.chart;
if (!this.isNull) {
this.onMouseOver(); // Show the hover marker and tooltip
} else {
if (chart.tooltip) {
chart.tooltip.hide(0);
}
// Don't call blur on the element, as it messes up the chart div's focus
}
// We focus only after calling onMouseOver because the state change can
// change z-index and mess up the element.
if (this.graphic) {
chart.setFocusToElement(this.graphic);
}
chart.highlightedPoint = this;
return this;
};
// Function to highlight next/previous point in chart
// Returns highlighted point on success, false on failure (no adjacent point to
// highlight in chosen direction)
H.Chart.prototype.highlightAdjacentPoint = function (next) {
var chart = this,
series = chart.series,
curPoint = chart.highlightedPoint,
curPointIndex = curPoint && getPointIndex(curPoint) || 0,
curPoints = curPoint && curPoint.series.points,
lastSeries = chart.series && chart.series[chart.series.length - 1],
lastPoint = lastSeries && lastSeries.points &&
lastSeries.points[lastSeries.points.length - 1],
newSeries,
newPoint;
// If no points, return false
if (!series[0] || !series[0].points) {
return false;
}
if (!curPoint) {
// No point is highlighted yet. Try first/last point depending on move
// direction
newPoint = next ? series[0].points[0] : lastPoint;
} else {
// We have a highlighted point.
// Grab next/prev point & series
newSeries = series[curPoint.series.index + (next ? 1 : -1)];
newPoint = curPoints[curPointIndex + (next ? 1 : -1)];
if (!newPoint && newSeries) {
// Done with this series, try next one
newPoint = newSeries.points[next ? 0 : newSeries.points.length - 1];
}
// If there is no adjacent point, we return false
if (!newPoint) {
return false;
}
}
// Recursively skip points
if (isSkipPoint(newPoint)) {
// If we skip this whole series, move to the end of the series before we
// recurse, just to optimize
newSeries = newPoint.series;
if (isSkipSeries(newSeries)) {
chart.highlightedPoint = next ?
newSeries.points[newSeries.points.length - 1] :
newSeries.points[0];
} else {
// Otherwise, just move one point
chart.highlightedPoint = newPoint;
}
// Retry
return chart.highlightAdjacentPoint(next);
}
// There is an adjacent point, highlight it
return newPoint.highlight();
};
// Highlight first valid point in a series. Returns the point if successfully
// highlighted, otherwise false. If there is a highlighted point in the series,
// use that as starting point.
H.Series.prototype.highlightFirstValidPoint = function () {
var curPoint = this.chart.highlightedPoint,
start = (curPoint && curPoint.series) === this ?
getPointIndex(curPoint) :
0,
points = this.points;
if (points) {
for (var i = start, len = points.length; i < len; ++i) {
if (!isSkipPoint(points[i])) {
return points[i].highlight();
}
}
for (var j = start; j >= 0; --j) {
if (!isSkipPoint(points[j])) {
return points[j].highlight();
}
}
}
return false;
};
// Highlight next/previous series in chart. Returns false if no adjacent series
// in the direction, otherwise returns new highlighted point.
H.Chart.prototype.highlightAdjacentSeries = function (down) {
var chart = this,
newSeries,
newPoint,
adjacentNewPoint,
curPoint = chart.highlightedPoint,
lastSeries = chart.series && chart.series[chart.series.length - 1],
lastPoint = lastSeries && lastSeries.points &&
lastSeries.points[lastSeries.points.length - 1];
// If no point is highlighted, highlight the first/last point
if (!chart.highlightedPoint) {
newSeries = down ? (chart.series && chart.series[0]) : lastSeries;
newPoint = down ?
(newSeries && newSeries.points && newSeries.points[0]) : lastPoint;
return newPoint ? newPoint.highlight() : false;
}
newSeries = chart.series[curPoint.series.index + (down ? -1 : 1)];
if (!newSeries) {
return false;
}
// We have a new series in this direction, find the right point
// Weigh xDistance as counting much higher than Y distance
newPoint = getClosestPoint(curPoint, newSeries, 4);
if (!newPoint) {
return false;
}
// New series and point exists, but we might want to skip it
if (isSkipSeries(newSeries)) {
// Skip the series
newPoint.highlight();
adjacentNewPoint = chart.highlightAdjacentSeries(down); // Try recurse
if (!adjacentNewPoint) {
// Recurse failed
curPoint.highlight();
return false;
}
// Recurse succeeded
return adjacentNewPoint;
}
// Highlight the new point or any first valid point back or forwards from it
newPoint.highlight();
return newPoint.series.highlightFirstValidPoint();
};
// Highlight the closest point vertically
H.Chart.prototype.highlightAdjacentPointVertical = function (down) {
var curPoint = this.highlightedPoint,
minDistance = Infinity,
bestPoint;
if (curPoint.plotX === undefined || curPoint.plotY === undefined) {
return false;
}
each(this.series, function (series) {
if (isSkipSeries(series)) {
return;
}
each(series.points, function (point) {
if (point.plotY === undefined || point.plotX === undefined ||
point === curPoint) {
return;
}
var yDistance = point.plotY - curPoint.plotY,
width = Math.abs(point.plotX - curPoint.plotX),
distance = Math.abs(yDistance) * Math.abs(yDistance) +
width * width * 4; // Weigh horizontal distance highly
// Reverse distance number if axis is reversed
if (series.yAxis.reversed) {
yDistance *= -1;
}
if (
yDistance < 0 && down || yDistance > 0 && !down || // Wrong dir
distance < 5 || // Points in same spot => infinite loop
isSkipPoint(point)
) {
return;
}
if (distance < minDistance) {
minDistance = distance;
bestPoint = point;
}
});
});
return bestPoint ? bestPoint.highlight() : false;
};
// Show the export menu and focus the first item (if exists)
H.Chart.prototype.showExportMenu = function () {
if (this.exportSVGElements && this.exportSVGElements[0]) {
this.exportSVGElements[0].element.onclick();
this.highlightExportItem(0);
}
};
// Hide export menu
H.Chart.prototype.hideExportMenu = function () {
var chart = this,
exportList = chart.exportDivElements;
if (exportList && chart.exportContextMenu) {
// Reset hover states etc.
each(exportList, function (el) {
if (el.className === 'highcharts-menu-item' && el.onmouseout) {
el.onmouseout();
}
});
chart.highlightedExportItem = 0;
// Hide the menu div
chart.exportContextMenu.hideMenu();
// Make sure the chart has focus and can capture keyboard events
chart.container.focus();
}
};
// Highlight export menu item by index
H.Chart.prototype.highlightExportItem = function (ix) {
var listItem = this.exportDivElements && this.exportDivElements[ix],
curHighlighted =
this.exportDivElements &&
this.exportDivElements[this.highlightedExportItem];
if (
listItem &&
listItem.tagName === 'DIV' &&
!(listItem.children && listItem.children.length)
) {
if (listItem.focus && hasSVGFocusSupport) {
// Only focus if we can set focus back to the elements after
// destroying the menu (#7422)
listItem.focus();
}
if (curHighlighted && curHighlighted.onmouseout) {
curHighlighted.onmouseout();
}
if (listItem.onmouseover) {
listItem.onmouseover();
}
this.highlightedExportItem = ix;
return true;
}
};
// Try to highlight the last valid export menu item
H.Chart.prototype.highlightLastExportItem = function () {
var chart = this,
i;
if (chart.exportDivElements) {
i = chart.exportDivElements.length;
while (i--) {
if (chart.highlightExportItem(i)) {
break;
}
}
}
};
// Highlight range selector button by index
H.Chart.prototype.highlightRangeSelectorButton = function (ix) {
var buttons = this.rangeSelector.buttons;
// Deselect old
if (buttons[this.highlightedRangeSelectorItemIx]) {
buttons[this.highlightedRangeSelectorItemIx].setState(
this.oldRangeSelectorItemState || 0
);
}
// Select new
this.highlightedRangeSelectorItemIx = ix;
if (buttons[ix]) {
this.setFocusToElement(buttons[ix].box, buttons[ix]);
this.oldRangeSelectorItemState = buttons[ix].state;
buttons[ix].setState(2);
return true;
}
return false;
};
// Highlight legend item by index
H.Chart.prototype.highlightLegendItem = function (ix) {
var items = this.legend.allItems,
oldIx = this.highlightedLegendItemIx;
if (items[ix]) {
if (items[oldIx]) {
fireEvent(
items[oldIx].legendGroup.element,
'mouseout'
);
}
// Scroll if we have to
if (items[ix].pageIx !== undefined &&
items[ix].pageIx + 1 !== this.legend.currentPage) {
this.legend.scroll(1 + items[ix].pageIx - this.legend.currentPage);
}
// Focus
this.highlightedLegendItemIx = ix;
this.setFocusToElement(items[ix].legendItem, items[ix].legendGroup);
fireEvent(items[ix].legendGroup.element, 'mouseover');
return true;
}
return false;
};
// Add keyboard navigation handling modules to chart
H.Chart.prototype.addKeyboardNavigationModules = function () {
var chart = this;
function navModuleFactory(id, keyMap, options) {
return new KeyboardNavigationModule(chart, merge({
keyCodeMap: keyMap
}, { id: id }, options));
}
// List of the different keyboard handling modes we use depending on where
// we are in the chart. Each mode has a set of handling functions mapped to
// key codes. Each mode determines when to move to the next/prev mode.
chart.keyboardNavigationModules = [
// Entry point catching the first tab, allowing users to tab into points
// more intuitively.
navModuleFactory('entry', []),
// Points
navModuleFactory('points', [
// Left/Right
[[37, 39], function (keyCode) {
var right = keyCode === 39;
if (!chart.highlightAdjacentPoint(right)) {
// Failed to highlight next, wrap to last/first
return this.init(right ? 1 : -1);
}
return true;
}],
// Up/Down
[[38, 40], function (keyCode) {
var down = keyCode !== 38,
navOptions = chart.options.accessibility.keyboardNavigation;
if (navOptions.mode && navOptions.mode === 'serialize') {
// Act like left/right
if (!chart.highlightAdjacentPoint(down)) {
return this.init(down ? 1 : -1);
}
return true;
}
// Normal mode, move between series
var highlightMethod = chart.highlightedPoint &&
chart.highlightedPoint.series.keyboardMoveVertical ?
'highlightAdjacentPointVertical' :
'highlightAdjacentSeries';
chart[highlightMethod](down);
return true;
}],
// Enter/Spacebar
[[13, 32], function () {
if (chart.highlightedPoint) {
chart.highlightedPoint.firePointEvent('click');
}
}]
], {
// Always start highlighting from scratch when entering this module
init: function (dir) {
var numSeries = chart.series.length,
i = dir > 0 ? 0 : numSeries,
res;
if (dir > 0) {
delete chart.highlightedPoint;
// Find first valid point to highlight
while (i < numSeries) {
res = chart.series[i].highlightFirstValidPoint();
if (res) {
return res;
}
++i;
}
} else {
// Find last valid point to highlight
while (i--) {
chart.highlightedPoint = chart.series[i].points[
chart.series[i].points.length - 1
];
// Highlight first valid point in the series will also
// look backwards. It always starts from currently
// highlighted point.
res = chart.series[i].highlightFirstValidPoint();
if (res) {
return res;
}
}
}
},
// If leaving points, don't show tooltip anymore
terminate: function () {
if (chart.tooltip) {
chart.tooltip.hide(0);
}
delete chart.highlightedPoint;
}
}),
// Exporting
navModuleFactory('exporting', [
// Left/Up
[[37, 38], function () {
var i = chart.highlightedExportItem || 0,
reachedEnd = true;
// Try to highlight prev item in list. Highlighting e.g.
// separators will fail.
while (i--) {
if (chart.highlightExportItem(i)) {
reachedEnd = false;
break;
}
}
if (reachedEnd) {
chart.highlightLastExportItem();
return true;
}
}],
// Right/Down
[[39, 40], function () {
var highlightedExportItem = chart.highlightedExportItem || 0,
reachedEnd = true;
// Try to highlight next item in list. Highlighting e.g.
// separators will fail.
for (
var i = highlightedExportItem + 1;
i < chart.exportDivElements.length;
++i
) {
if (chart.highlightExportItem(i)) {
reachedEnd = false;
break;
}
}
if (reachedEnd) {
chart.highlightExportItem(0);
return true;
}
}],
// Enter/Spacebar
[[13, 32], function () {
fakeClickEvent(
chart.exportDivElements[chart.highlightedExportItem]
);
}]
], {
// Only run exporting navigation if exporting support exists and is
// enabled on chart
validate: function () {
return (
chart.exportChart &&
!(
chart.options.exporting &&
chart.options.exporting.enabled === false
)
);
},
// Show export menu
init: function (direction) {
chart.highlightedPoint = null;
chart.showExportMenu();
// If coming back to export menu from other module, try to
// highlight last item in menu
if (direction < 0) {
chart.highlightLastExportItem();
}
},
// Hide the menu
terminate: function () {
chart.hideExportMenu();
}
}),
// Map zoom
navModuleFactory('mapZoom', [
// Up/down/left/right
[[38, 40, 37, 39], function (keyCode) {
chart[keyCode === 38 || keyCode === 40 ? 'yAxis' : 'xAxis'][0]
.panStep(keyCode < 39 ? -1 : 1);
}],
// Tabs
[[9], function (keyCode, e) {
var button;
// Deselect old
chart.mapNavButtons[chart.focusedMapNavButtonIx].setState(0);
if (
e.shiftKey && !chart.focusedMapNavButtonIx ||
!e.shiftKey && chart.focusedMapNavButtonIx
) { // trying to go somewhere we can't?
chart.mapZoom(); // Reset zoom
// Nowhere to go, go to prev/next module
return this.move(e.shiftKey ? -1 : 1);
}
chart.focusedMapNavButtonIx += e.shiftKey ? -1 : 1;
button = chart.mapNavButtons[chart.focusedMapNavButtonIx];
chart.setFocusToElement(button.box, button);
button.setState(2);
}],
// Enter/Spacebar
[[13, 32], function () {
fakeClickEvent(
chart.mapNavButtons[chart.focusedMapNavButtonIx].element
);
}]
], {
// Only run this module if we have map zoom on the chart
validate: function () {
return (
chart.mapZoom &&
chart.mapNavButtons &&
chart.mapNavButtons.length === 2
);
},
// Make zoom buttons do their magic
init: function (direction) {
var zoomIn = chart.mapNavButtons[0],
zoomOut = chart.mapNavButtons[1],
initialButton = direction > 0 ? zoomIn : zoomOut;
each(chart.mapNavButtons, function (button, i) {
button.element.setAttribute('tabindex', -1);
button.element.setAttribute('role', 'button');
button.element.setAttribute(
'aria-label',
chart.langFormat(
'accessibility.mapZoom' + (i ? 'Out' : 'In'),
{ chart: chart }
)
);
});
chart.setFocusToElement(initialButton.box, initialButton);
initialButton.setState(2);
chart.focusedMapNavButtonIx = direction > 0 ? 0 : 1;
}
}),
// Highstock range selector (minus input boxes)
navModuleFactory('rangeSelector', [
// Left/Right/Up/Down
[[37, 39, 38, 40], function (keyCode) {
var direction = (keyCode === 37 || keyCode === 38) ? -1 : 1;
// Try to highlight next/prev button
if (
!chart.highlightRangeSelectorButton(
chart.highlightedRangeSelectorItemIx + direction
)
) {
return this.move(direction);
}
}],
// Enter/Spacebar
[[13, 32], function () {
// Don't allow click if button used to be disabled
if (chart.oldRangeSelectorItemState !== 3) {
fakeClickEvent(
chart.rangeSelector.buttons[
chart.highlightedRangeSelectorItemIx
].element
);
}
}]
], {
// Only run this module if we have range selector
validate: function () {
return (
chart.rangeSelector &&
chart.rangeSelector.buttons &&
chart.rangeSelector.buttons.length
);
},
// Make elements focusable and accessible
init: function (direction) {
each(chart.rangeSelector.buttons, function (button) {
button.element.setAttribute('tabindex', '-1');
button.element.setAttribute('role', 'button');
button.element.setAttribute(
'aria-label',
chart.langFormat(
'accessibility.rangeSelectorButton',
{
chart: chart,
buttonText: button.text && button.text.textStr
}
)
);
});
// Focus first/last button
chart.highlightRangeSelectorButton(
direction > 0 ? 0 : chart.rangeSelector.buttons.length - 1
);
}
}),
// Highstock range selector, input boxes
navModuleFactory('rangeSelectorInput', [
// Tab/Up/Down
[[9, 38, 40], function (keyCode, e) {
var direction =
(keyCode === 9 && e.shiftKey || keyCode === 38) ? -1 : 1,
newIx = chart.highlightedInputRangeIx =
chart.highlightedInputRangeIx + direction;
// Try to highlight next/prev item in list.
if (newIx > 1 || newIx < 0) { // Out of range
return this.move(direction);
}
chart.rangeSelector[newIx ? 'maxInput' : 'minInput'].focus();
}]
], {
// Only run if we have range selector with input boxes
validate: function () {
var inputVisible = (
chart.rangeSelector &&
chart.rangeSelector.inputGroup &&
chart.rangeSelector.inputGroup.element
.getAttribute('visibility') !== 'hidden'
);
return (
inputVisible &&
chart.options.rangeSelector.inputEnabled !== false &&
chart.rangeSelector.minInput &&
chart.rangeSelector.maxInput
);
},
// Highlight first/last input box
init: function (direction) {
chart.highlightedInputRangeIx = direction > 0 ? 0 : 1;
chart.rangeSelector[
chart.highlightedInputRangeIx ? 'maxInput' : 'minInput'
].focus();
}
}),
// Legend navigation
navModuleFactory('legend', [
// Left/Right/Up/Down
[[37, 39, 38, 40], function (keyCode) {
var direction = (keyCode === 37 || keyCode === 38) ? -1 : 1;
// Try to highlight next/prev legend item
if (!chart.highlightLegendItem(
chart.highlightedLegendItemIx + direction
) && chart.legend.allItems.length > 1) {
// Wrap around if more than 1 item
this.init(direction);
}
}],
// Enter/Spacebar
[[13, 32], function () {
var legendElement = chart.legend.allItems[
chart.highlightedLegendItemIx
].legendItem.element;
fakeClickEvent(
!chart.legend.options.useHTML ? // #8561
legendElement.parentNode : legendElement
);
}]
], {
// Only run this module if we have at least one legend - wait for
// it - item. Don't run if the legend is populated by a colorAxis.
// Don't run if legend navigation is disabled.
validate: function () {
return chart.legend && chart.legend.allItems &&
chart.legend.display &&
!(chart.colorAxis && chart.colorAxis.length) &&
(chart.options.legend &&
chart.options.legend.keyboardNavigation &&
chart.options.legend.keyboardNavigation.enabled) !== false;
},
// Make elements focusable and accessible
init: function (direction) {
each(chart.legend.allItems, function (item) {
item.legendGroup.element.setAttribute('tabindex', '-1');
item.legendGroup.element.setAttribute('role', 'button');
item.legendGroup.element.setAttribute(
'aria-label',
chart.langFormat(
'accessibility.legendItem',
{
chart: chart,
itemName: stripTags(item.name)
}
)
);
});
// Focus first/last item
chart.highlightLegendItem(
direction > 0 ? 0 : chart.legend.allItems.length - 1
);
}
})
];
};
// Add exit anchor to the chart
// We use this to move focus out of chart whenever we want, by setting focus
// to this div and not preventing the default tab action.
// We also use this when users come back into the chart by tabbing back, in
// order to navigate from the end of the chart.
// Function returns the unbind function for the exit anchor's event handler.
H.Chart.prototype.addExitAnchor = function () {
var chart = this;
chart.tabExitAnchor = doc.createElement('div');
chart.tabExitAnchor.setAttribute('tabindex', '0');
// Hide exit anchor
merge(true, chart.tabExitAnchor.style, {
position: 'absolute',
left: '-9999px',
top: 'auto',
width: '1px',
height: '1px',
overflow: 'hidden'
});
chart.renderTo.appendChild(chart.tabExitAnchor);
return addEvent(chart.tabExitAnchor, 'focus',
function (ev) {
var e = ev || win.event,
curModule;
// If focusing and we are exiting, do nothing once.
if (!chart.exiting) {
// Not exiting, means we are coming in backwards
chart.renderTo.focus();
e.preventDefault();
// Move to last valid keyboard nav module
// Note the we don't run it, just set the index
chart.keyboardNavigationModuleIndex =
chart.keyboardNavigationModules.length - 1;
curModule = chart.keyboardNavigationModules[
chart.keyboardNavigationModuleIndex
];
// Validate the module
if (curModule.validate && !curModule.validate()) {
// Invalid.
// Move inits next valid module in direction
curModule.move(-1);
} else {
// We have a valid module, init it
curModule.init(-1);
}
} else {
// Don't skip the next focus, we only skip once.
chart.exiting = false;
}
}
);
};
// Clear the chart and reset the navigation state
H.Chart.prototype.resetKeyboardNavigation = function () {
var chart = this,
curMod = (
chart.keyboardNavigationModules &&
chart.keyboardNavigationModules[
chart.keyboardNavigationModuleIndex || 0
]
);
if (curMod && curMod.terminate) {
curMod.terminate();
}
if (chart.focusElement) {
chart.focusElement.removeFocusBorder();
}
chart.keyboardNavigationModuleIndex = 0;
chart.keyboardReset = true;
};
/**
* On destroy, we need to clean up the focus border and the state
*/
H.addEvent(H.Series, 'destroy', function () {
var chart = this.chart;
if (chart.highlightedPoint && chart.highlightedPoint.series === this) {
delete chart.highlightedPoint;
if (chart.focusElement) {
chart.focusElement.removeFocusBorder();
}
}
});
// Add keyboard navigation events on chart load
H.Chart.prototype.callbacks.push(function (chart) {
var a11yOptions = chart.options.accessibility;
if (a11yOptions.enabled && a11yOptions.keyboardNavigation.enabled) {
// Test if we have focus support for SVG elements
hasSVGFocusSupport = !!chart.renderTo
.getElementsByTagName('g')[0].focus;
// Init nav modules. We start at the first module, and as the user
// navigates through the chart the index will increase to use different
// handler modules.
chart.addKeyboardNavigationModules();
chart.keyboardNavigationModuleIndex = 0;
// Make chart container reachable by tab
if (
chart.container.hasAttribute &&
!chart.container.hasAttribute('tabIndex')
) {
chart.container.setAttribute('tabindex', '0');
}
// Add tab exit anchor
if (!chart.tabExitAnchor) {
chart.unbindExitAnchorFocus = chart.addExitAnchor();
}
// Handle keyboard events by routing them to active keyboard nav module
chart.unbindKeydownHandler = addEvent(chart.renderTo, 'keydown',
function (ev) {
var e = ev || win.event,
curNavModule = chart.keyboardNavigationModules[
chart.keyboardNavigationModuleIndex
];
chart.keyboardReset = false;
// If there is a nav module for the current index, run it.
// Otherwise, we are outside of the chart in some direction.
if (curNavModule) {
if (curNavModule.run(e)) {
// Successfully handled this key event, stop default
e.preventDefault();
}
}
});
// Reset chart navigation state if we click outside the chart and it's
// not already reset
chart.unbindBlurHandler = addEvent(doc, 'mouseup', function () {
if (
!chart.keyboardReset &&
!(chart.pointer && chart.pointer.chartPosition)
) {
chart.resetKeyboardNavigation();
}
});
// Add cleanup handlers
addEvent(chart, 'destroy', function () {
chart.resetKeyboardNavigation();
if (chart.unbindExitAnchorFocus && chart.tabExitAnchor) {
chart.unbindExitAnchorFocus();
}
if (chart.unbindKeydownHandler && chart.renderTo) {
chart.unbindKeydownHandler();
}
if (chart.unbindBlurHandler) {
chart.unbindBlurHandler();
}
});
}
});