highcharts 9.2.1 → 9.3.2

package/es-modules/Accessibility/Components/SeriesComponent/SeriesComponent.js

@@ -10,23 +10,33 @@
  *
  * */
 'use strict';
-import H from '../../../Core/Globals.js';
-import U from '../../../Core/Utilities.js';
-var extend = U.extend;
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
 import AccessibilityComponent from '../../AccessibilityComponent.js';
-import SeriesKeyboardNavigation from './SeriesKeyboardNavigation.js';
-import NewDataAnnouncer from './NewDataAnnouncer.js';
-import addForceMarkersEvents from './ForcedMarkers.js';
 import ChartUtilities from '../../Utils/ChartUtilities.js';
 var hideSeriesFromAT = ChartUtilities.hideSeriesFromAT;
+import ForcedMarkers from './ForcedMarkers.js';
+import NewDataAnnouncer from './NewDataAnnouncer.js';
 import SeriesDescriber from './SeriesDescriber.js';
 var describeSeries = SeriesDescriber.describeSeries;
+import SeriesKeyboardNavigation from './SeriesKeyboardNavigation.js';
 import Tooltip from '../../../Core/Tooltip.js';
-// Expose functionality to users
-H.SeriesAccessibilityDescriber = SeriesDescriber;
-// Handle forcing markers
-addForceMarkersEvents();
-/* eslint-disable no-invalid-this, valid-jsdoc */
+/* *
+ *
+ *  Class
+ *
+ * */
 /**
  * The SeriesComponent class
  *
@@ -34,24 +44,46 @@ addForceMarkersEvents();
  * @class
  * @name Highcharts.SeriesComponent
  */
-var SeriesComponent = function () { };
-SeriesComponent.prototype = new AccessibilityComponent();
-extend(SeriesComponent.prototype, /** @lends Highcharts.SeriesComponent */ {
+var SeriesComponent = /** @class */ (function (_super) {
+    __extends(SeriesComponent, _super);
+    function SeriesComponent() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /* *
+     *
+     *  Static Functions
+     *
+     * */
+    /* eslint-disable valid-jsdoc */
+    /**
+     * @private
+     */
+    SeriesComponent.compose = function (ChartClass, PointClass, SeriesClass) {
+        // Handle forcing markers
+        NewDataAnnouncer.compose(SeriesClass);
+        ForcedMarkers.compose(SeriesClass);
+        SeriesKeyboardNavigation.compose(ChartClass, PointClass, SeriesClass);
+    };
+    /* *
+     *
+     *  Functions
+     *
+     * */
     /**
      * Init the component.
      */
-    init: function () {
+    SeriesComponent.prototype.init = function () {
         this.newDataAnnouncer = new NewDataAnnouncer(this.chart);
         this.newDataAnnouncer.init();
         this.keyboardNavigation = new SeriesKeyboardNavigation(this.chart, this.keyCodes);
         this.keyboardNavigation.init();
         this.hideTooltipFromATWhenShown();
         this.hideSeriesLabelsFromATWhenShown();
-    },
+    };
     /**
      * @private
      */
-    hideTooltipFromATWhenShown: function () {
+    SeriesComponent.prototype.hideTooltipFromATWhenShown = function () {
         var component = this;
         this.addEvent(Tooltip, 'refresh', function () {
             if (this.chart === component.chart &&
@@ -60,11 +92,11 @@ extend(SeriesComponent.prototype, /** @lends Highcharts.SeriesComponent */ {
                 this.label.element.setAttribute('aria-hidden', true);
             }
         });
-    },
+    };
     /**
      * @private
      */
-    hideSeriesLabelsFromATWhenShown: function () {
+    SeriesComponent.prototype.hideSeriesLabelsFromATWhenShown = function () {
         this.addEvent(this.chart, 'afterDrawSeriesLabels', function () {
             this.series.forEach(function (series) {
                 if (series.labelBySeries) {
@@ -72,12 +104,12 @@ extend(SeriesComponent.prototype, /** @lends Highcharts.SeriesComponent */ {
                 }
             });
         });
-    },
+    };
     /**
      * Called on chart render. It is necessary to do this for render in case
      * markers change on zoom/pixel density.
      */
-    onChartRender: function () {
+    SeriesComponent.prototype.onChartRender = function () {
         var chart = this.chart;
         chart.series.forEach(function (series) {
             var shouldDescribeSeries = (series.options.accessibility &&
@@ -90,20 +122,27 @@ extend(SeriesComponent.prototype, /** @lends Highcharts.SeriesComponent */ {
                 hideSeriesFromAT(series);
             }
         });
-    },
+    };
     /**
      * Get keyboard navigation handler for this component.
-     * @return {Highcharts.KeyboardNavigationHandler}
+     * @private
      */
-    getKeyboardNavigation: function () {
+    SeriesComponent.prototype.getKeyboardNavigation = function () {
         return this.keyboardNavigation.getKeyboardNavigationHandler();
-    },
+    };
     /**
      * Remove traces
+     * @private
      */
-    destroy: function () {
+    SeriesComponent.prototype.destroy = function () {
         this.newDataAnnouncer.destroy();
         this.keyboardNavigation.destroy();
-    }
-});
+    };
+    return SeriesComponent;
+}(AccessibilityComponent));
+/* *
+ *
+ *  Default Export
+ *
+ * */
 export default SeriesComponent;

package/es-modules/Accessibility/Components/SeriesComponent/SeriesDescriber.js

@@ -20,6 +20,11 @@ import HTMLUtilities from '../../Utils/HTMLUtilities.js';
 var reverseChildNodes = HTMLUtilities.reverseChildNodes, stripHTMLTags = HTMLUtilities.stripHTMLTagsFromString;
 import U from '../../../Core/Utilities.js';
 var find = U.find, isNumber = U.isNumber, pick = U.pick, defined = U.defined;
+/* *
+ *
+ *  Functions
+ *
+ * */
 /* eslint-disable valid-jsdoc */
 /**
  * @private
@@ -62,8 +67,6 @@ function makeDummyElement(point, pos) {
 }
 /**
  * @private
- * @param {Highcharts.Point} point
- * @return {Highcharts.HTMLDOMElement|Highcharts.SVGDOMElement|undefined}
  */
 function addDummyPointElement(point) {
     var series = point.series, firstPointWithGraphic = findFirstPointWithGraphic(point), firstGraphic = firstPointWithGraphic && firstPointWithGraphic.graphic, parentGroup = firstGraphic ?
@@ -86,8 +89,6 @@ function addDummyPointElement(point) {
 }
 /**
  * @private
- * @param {Highcharts.Series} series
- * @return {boolean}
  */
 function hasMorePointsThanDescriptionThreshold(series) {
     var chartA11yOptions = series.chart.options.accessibility, threshold = (chartA11yOptions.series.pointDescriptionEnabledThreshold);
@@ -97,8 +98,6 @@ function hasMorePointsThanDescriptionThreshold(series) {
 }
 /**
  * @private
- * @param {Highcharts.Series} series
- * @return {boolean}
  */
 function shouldSetScreenReaderPropsOnPoints(series) {
     var seriesA11yOptions = series.options.accessibility || {};
@@ -107,8 +106,6 @@ function shouldSetScreenReaderPropsOnPoints(series) {
 }
 /**
  * @private
- * @param {Highcharts.Series} series
- * @return {boolean}
  */
 function shouldSetKeyboardNavPropsOnPoints(series) {
     var chartA11yOptions = series.chart.options.accessibility, seriesNavOptions = chartA11yOptions.keyboardNavigation.seriesNavigation;
@@ -118,8 +115,6 @@ function shouldSetKeyboardNavPropsOnPoints(series) {
 }
 /**
  * @private
- * @param {Highcharts.Series} series
- * @return {boolean}
  */
 function shouldDescribeSeriesElement(series) {
     var chart = series.chart, chartOptions = chart.options.chart, chartHas3d = chartOptions.options3d && chartOptions.options3d.enabled, hasMultipleSeries = chart.series.length > 1, describeSingleSeriesOption = chart.options.accessibility.series.describeSingleSeries, exposeAsGroupOnlyOption = (series.options.accessibility || {}).exposeAsGroupOnly, noDescribe3D = chartHas3d && hasMultipleSeries;
@@ -128,14 +123,13 @@ function shouldDescribeSeriesElement(series) {
 }
 /**
  * @private
- * @param {Highcharts.Point} point
- * @param {number} value
- * @return {string}
  */
 function pointNumberToString(point, value) {
-    var chart = point.series.chart, a11yPointOptions = chart.options.accessibility.point || {}, tooltipOptions = point.series.tooltipOptions || {}, lang = chart.options.lang;
+    var series = point.series, chart = series.chart, a11yPointOptions = chart.options.accessibility.point || {}, seriesA11yPointOptions = series.options.accessibility &&
+        series.options.accessibility.point || {}, tooltipOptions = series.tooltipOptions || {}, lang = chart.options.lang;
     if (isNumber(value)) {
-        return numberFormat(value, a11yPointOptions.valueDecimals ||
+        return numberFormat(value, seriesA11yPointOptions.valueDecimals ||
+            a11yPointOptions.valueDecimals ||
             tooltipOptions.valueDecimals ||
             -1, lang.decimalPoint, lang.accessibility.thousandsSep || lang.thousandsSep);
     }
@@ -143,8 +137,6 @@ function pointNumberToString(point, value) {
 }
 /**
  * @private
- * @param {Highcharts.Series} series
- * @return {string}
  */
 function getSeriesDescriptionText(series) {
     var seriesA11yOptions = series.options.accessibility || {}, descOpt = seriesA11yOptions.description;
@@ -155,9 +147,6 @@ function getSeriesDescriptionText(series) {
 }
 /**
  * @private
- * @param {Highcharts.series} series
- * @param {string} axisCollection
- * @return {string}
  */
 function getSeriesAxisDescriptionText(series, axisCollection) {
     var axis = series[axisCollection];
@@ -170,16 +159,15 @@ function getSeriesAxisDescriptionText(series, axisCollection) {
  * Get accessible time description for a point on a datetime axis.
  *
  * @private
- * @function Highcharts.Point#getTimeDescription
- * @param {Highcharts.Point} point
- * @return {string|undefined}
- * The description as string.
  */
 function getPointA11yTimeDescription(point) {
-    var series = point.series, chart = series.chart, a11yOptions = chart.options.accessibility.point || {}, dateXAxis = series.xAxis && series.xAxis.dateTime;
+    var series = point.series, chart = series.chart, seriesA11yOptions = series.options.accessibility &&
+        series.options.accessibility.point || {}, a11yOptions = chart.options.accessibility.point || {}, dateXAxis = series.xAxis && series.xAxis.dateTime;
     if (dateXAxis) {
-        var tooltipDateFormat = dateXAxis.getXDateFormat(point.x || 0, chart.options.tooltip.dateTimeLabelFormats), dateFormat = a11yOptions.dateFormatter &&
-            a11yOptions.dateFormatter(point) ||
+        var tooltipDateFormat = dateXAxis.getXDateFormat(point.x || 0, chart.options.tooltip.dateTimeLabelFormats), dateFormat = seriesA11yOptions.dateFormatter &&
+            seriesA11yOptions.dateFormatter(point) ||
+            a11yOptions.dateFormatter && a11yOptions.dateFormatter(point) ||
+            seriesA11yOptions.dateFormat ||
             a11yOptions.dateFormat ||
             tooltipDateFormat;
         return chart.time.dateFormat(dateFormat, point.x || 0, void 0);
@@ -187,8 +175,6 @@ function getPointA11yTimeDescription(point) {
 }
 /**
  * @private
- * @param {Highcharts.Point} point
- * @return {string}
  */
 function getPointXDescription(point) {
     var timeDesc = getPointA11yTimeDescription(point), xAxis = point.series.xAxis || {}, pointCategory = xAxis.categories && defined(point.category) &&
@@ -198,10 +184,6 @@ function getPointXDescription(point) {
 }
 /**
  * @private
- * @param {Highcharts.Point} point
- * @param {string} prefix
- * @param {string} suffix
- * @return {string}
  */
 function getPointArrayMapValueDescription(point, prefix, suffix) {
     var pre = prefix || '', suf = suffix || '', keyToValStr = function (key) {
@@ -214,13 +196,16 @@ function getPointArrayMapValueDescription(point, prefix, suffix) {
 }
 /**
  * @private
- * @param {Highcharts.Point} point
- * @return {string}
  */
 function getPointValue(point) {
-    var series = point.series, a11yPointOpts = series.chart.options.accessibility.point || {}, tooltipOptions = series.tooltipOptions || {}, valuePrefix = a11yPointOpts.valuePrefix ||
-        tooltipOptions.valuePrefix || '', valueSuffix = a11yPointOpts.valueSuffix ||
-        tooltipOptions.valueSuffix || '', fallbackKey = (typeof point.value !==
+    var series = point.series, a11yPointOpts = series.chart.options.accessibility.point || {}, seriesA11yPointOpts = series.chart.options.accessibility &&
+        series.chart.options.accessibility.point || {}, tooltipOptions = series.tooltipOptions || {}, valuePrefix = seriesA11yPointOpts.valuePrefix ||
+        a11yPointOpts.valuePrefix ||
+        tooltipOptions.valuePrefix ||
+        '', valueSuffix = seriesA11yPointOpts.valueSuffix ||
+        a11yPointOpts.valueSuffix ||
+        tooltipOptions.valueSuffix ||
+        '', fallbackKey = (typeof point.value !==
         'undefined' ?
         'value' : 'y'), fallbackDesc = pointNumberToString(point, point[fallbackKey]);
     if (point.isNull) {
@@ -234,12 +219,14 @@ function getPointValue(point) {
     return valuePrefix + fallbackDesc + valueSuffix;
 }
 /**
- * Return the description for the annotation(s) connected to a point, or empty
- * string if none.
+ * Return the description for the annotation(s) connected to a point, or
+ * empty string if none.
  *
  * @private
- * @param {Highcharts.Point} point The data point to get the annotation info from.
- * @return {string} Annotation description
+ * @param {Highcharts.Point} point
+ * The data point to get the annotation info from.
+ * @return {string}
+ * Annotation description
  */
 function getPointAnnotationDescription(point) {
     var chart = point.series.chart;
@@ -251,11 +238,11 @@ function getPointAnnotationDescription(point) {
 /**
  * Return string with information about point.
  * @private
- * @return {string}
  */
 function getPointValueDescription(point) {
-    var series = point.series, chart = series.chart, pointValueDescriptionFormat = chart.options.accessibility
-        .point.valueDescriptionFormat, showXDescription = pick(series.xAxis &&
+    var series = point.series, chart = series.chart, seriesA11yOptions = series.options.accessibility, seriesValueDescFormat = seriesA11yOptions && seriesA11yOptions.point &&
+        seriesA11yOptions.point.valueDescriptionFormat, pointValueDescriptionFormat = seriesValueDescFormat ||
+        chart.options.accessibility.point.valueDescriptionFormat, showXDescription = pick(series.xAxis &&
         series.xAxis.options.accessibility &&
         series.xAxis.options.accessibility.enabled, !chart.angular), xDesc = showXDescription ? getPointXDescription(point) : '', context = {
         point: point,
@@ -269,7 +256,6 @@ function getPointValueDescription(point) {
 /**
  * Return string with information about point.
  * @private
- * @return {string}
  */
 function defaultPointDescriptionFormatter(point) {
     var series = point.series, chart = series.chart, valText = getPointValueDescription(point), description = point.options && point.options.accessibility &&
@@ -286,8 +272,9 @@ function defaultPointDescriptionFormatter(point) {
  * @param {Highcharts.HTMLDOMElement|Highcharts.SVGDOMElement} pointElement
  */
 function setPointScreenReaderAttribs(point, pointElement) {
-    var series = point.series, a11yPointOptions = series.chart.options.accessibility.point || {}, seriesA11yOptions = series.options.accessibility || {}, label = stripHTMLTags(seriesA11yOptions.pointDescriptionFormatter &&
-        seriesA11yOptions.pointDescriptionFormatter(point) ||
+    var series = point.series, a11yPointOptions = series.chart.options.accessibility.point || {}, seriesPointA11yOptions = series.options.accessibility &&
+        series.options.accessibility.point || {}, label = stripHTMLTags(seriesPointA11yOptions.descriptionFormatter &&
+        seriesPointA11yOptions.descriptionFormatter(point) ||
         a11yPointOptions.descriptionFormatter &&
             a11yPointOptions.descriptionFormatter(point) ||
         defaultPointDescriptionFormatter(point));
@@ -313,7 +300,9 @@ function describePointsInSeries(series) {
                 // When setting tabindex, also remove default outline to
                 // avoid ugly border on click.
                 pointEl.setAttribute('tabindex', '-1');
-                pointEl.style.outline = '0';
+                if (!series.chart.styledMode) {
+                    pointEl.style.outline = 'none';
+                }
                 if (setScreenReaderProps && !pointA11yDisabled) {
                     setPointScreenReaderAttribs(point, pointEl);
                 }
@@ -327,7 +316,6 @@ function describePointsInSeries(series) {
 /**
  * Return string with information about series.
  * @private
- * @return {string}
  */
 function defaultSeriesDescriptionFormatter(series) {
     var chart = series.chart, chartTypes = chart.types || [], description = getSeriesDescriptionText(series), shouldDescribeAxis = function (coll) {
@@ -357,7 +345,10 @@ function describeSeriesElement(series, seriesElement) {
         seriesElement.setAttribute('role', 'region');
     } /* else do not add role */
     seriesElement.setAttribute('tabindex', '-1');
-    seriesElement.style.outline = '0'; // Don't show browser outline on click, despite tabindex
+    if (!series.chart.styledMode) {
+        // Don't show browser outline on click, despite tabindex
+        seriesElement.style.outline = 'none';
+    }
     seriesElement.setAttribute('aria-label', stripHTMLTags(a11yOptions.series.descriptionFormatter &&
         a11yOptions.series.descriptionFormatter(series) ||
         defaultSeriesDescriptionFormatter(series)));
@@ -386,13 +377,14 @@ function describeSeries(series) {
         }
     }
 }
+/* *
+ *
+ *  Default Export
+ *
+ * */
 var SeriesDescriber = {
-    describeSeries: describeSeries,
     defaultPointDescriptionFormatter: defaultPointDescriptionFormatter,
     defaultSeriesDescriptionFormatter: defaultSeriesDescriptionFormatter,
-    getPointA11yTimeDescription: getPointA11yTimeDescription,
-    getPointXDescription: getPointXDescription,
-    getPointValue: getPointValue,
-    getPointValueDescription: getPointValueDescription
+    describeSeries: describeSeries
 };
 export default SeriesDescriber;