Carga

Carga

static/lib/Highcharts-10.2.1/es-modules/Accessibility/Components/AnnotationsA11y.js

@@ -0,0 +1,160 @@
+/* *
+ *
+ *  (c) 2009-2021 Øystein Moseng
+ *
+ *  Annotations accessibility code.
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+import HTMLUtilities from '../Utils/HTMLUtilities.js';
+var escapeStringForHTML = HTMLUtilities.escapeStringForHTML, stripHTMLTagsFromString = HTMLUtilities.stripHTMLTagsFromString;
+/* *
+ *
+ *  Functions
+ *
+ * */
+/**
+ * Get list of all annotation labels in the chart.
+ *
+ * @private
+ * @param {Highcharts.Chart} chart The chart to get annotation info on.
+ * @return {Array<object>} The labels, or empty array if none.
+ */
+function getChartAnnotationLabels(chart) {
+    var annotations = chart.annotations || [];
+    return annotations.reduce(function (acc, cur) {
+        if (cur.options &&
+            cur.options.visible !== false) {
+            acc = acc.concat(cur.labels);
+        }
+        return acc;
+    }, []);
+}
+/**
+ * Get the text of an annotation label.
+ *
+ * @private
+ * @param {Object} label The annotation label object
+ * @return {string} The text in the label.
+ */
+function getLabelText(label) {
+    return ((label.options &&
+        label.options.accessibility &&
+        label.options.accessibility.description) ||
+        (label.graphic &&
+            label.graphic.text &&
+            label.graphic.text.textStr) ||
+        '');
+}
+/**
+ * Describe an annotation label.
+ *
+ * @private
+ * @param {Object} label The annotation label object to describe
+ * @return {string} The description for the label.
+ */
+function getAnnotationLabelDescription(label) {
+    var a11yDesc = (label.options &&
+        label.options.accessibility &&
+        label.options.accessibility.description);
+    if (a11yDesc) {
+        return a11yDesc;
+    }
+    var chart = label.chart;
+    var labelText = getLabelText(label);
+    var points = label.points;
+    var getAriaLabel = function (point) { return (point.graphic &&
+        point.graphic.element &&
+        point.graphic.element.getAttribute('aria-label') ||
+        ''); };
+    var getValueDesc = function (point) {
+        var valDesc = (point.accessibility &&
+            point.accessibility.valueDescription ||
+            getAriaLabel(point));
+        var seriesName = (point &&
+            point.series.name ||
+            '');
+        return (seriesName ? seriesName + ', ' : '') + 'data point ' + valDesc;
+    };
+    var pointValueDescriptions = points
+        .filter(function (p) { return !!p.graphic; }) // Filter out mock points
+        .map(getValueDesc)
+        // Filter out points we can't describe
+        .filter(function (desc) { return !!desc; });
+    var numPoints = pointValueDescriptions.length;
+    var pointsSelector = numPoints > 1 ?
+        'MultiplePoints' : numPoints ?
+        'SinglePoint' : 'NoPoints';
+    var langFormatStr = ('accessibility.screenReaderSection.annotations.description' +
+        pointsSelector);
+    var context = {
+        annotationText: labelText,
+        annotation: label,
+        numPoints: numPoints,
+        annotationPoint: pointValueDescriptions[0],
+        additionalAnnotationPoints: pointValueDescriptions.slice(1)
+    };
+    return chart.langFormat(langFormatStr, context);
+}
+/**
+ * Return array of HTML strings for each annotation label in the chart.
+ *
+ * @private
+ * @param {Highcharts.Chart} chart The chart to get annotation info on.
+ * @return {Array<string>} Array of strings with HTML content for each annotation label.
+ */
+function getAnnotationListItems(chart) {
+    var labels = getChartAnnotationLabels(chart);
+    return labels.map(function (label) {
+        var desc = escapeStringForHTML(stripHTMLTagsFromString(getAnnotationLabelDescription(label)));
+        return desc ? "<li>".concat(desc, "</li>") : '';
+    });
+}
+/**
+ * Return the annotation info for a chart as string.
+ *
+ * @private
+ * @param {Highcharts.Chart} chart The chart to get annotation info on.
+ * @return {string} String with HTML content or empty string if no annotations.
+ */
+function getAnnotationsInfoHTML(chart) {
+    var annotations = chart.annotations;
+    if (!(annotations && annotations.length)) {
+        return '';
+    }
+    var annotationItems = getAnnotationListItems(chart);
+    return "<ul style=\"list-style-type: none\">".concat(annotationItems.join(' '), "</ul>");
+}
+/**
+ * Return the texts for the annotation(s) connected to a point, or empty array
+ * if none.
+ *
+ * @private
+ * @param {Highcharts.Point} point The data point to get the annotation info from.
+ * @return {Array<string>} Annotation texts
+ */
+function getPointAnnotationTexts(point) {
+    var labels = getChartAnnotationLabels(point.series.chart);
+    var pointLabels = labels
+        .filter(function (label) { return label.points.indexOf(point) > -1; });
+    if (!pointLabels.length) {
+        return [];
+    }
+    return pointLabels.map(function (label) { return "".concat(getLabelText(label)); });
+}
+/* *
+ *
+ *  Default Export
+ *
+ * */
+var AnnotationsA11y = {
+    getAnnotationsInfoHTML: getAnnotationsInfoHTML,
+    getAnnotationLabelDescription: getAnnotationLabelDescription,
+    getAnnotationListItems: getAnnotationListItems,
+    getPointAnnotationTexts: getPointAnnotationTexts
+};
+export default AnnotationsA11y;