highcharts 10.2.1 → 10.3.1

package/es-modules/Series/ErrorBar/ErrorBarSeriesDefaults.js

@@ -0,0 +1,147 @@
+/* *
+ *
+ *  (c) 2010-2021 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+/* *
+ *
+ *  API Options
+ *
+ * */
+/**
+ * Error bars are a graphical representation of the variability of data and
+ * are used on graphs to indicate the error, or uncertainty in a reported
+ * measurement.
+ *
+ * @sample highcharts/demo/error-bar/
+ *         Error bars on a column series
+ * @sample highcharts/series-errorbar/on-scatter/
+ *         Error bars on a scatter series
+ * @sample highcharts/series-errorbar/datalabels/
+ *         Error bars with data labels
+ *
+ * @extends      plotOptions.boxplot
+ * @excluding    boostBlending, boostThreshold
+ * @product      highcharts
+ * @requires     highcharts-more
+ * @optionparent plotOptions.errorbar
+ */
+var ErrorBarSeriesDefaults = {
+    /**
+     * The main color of the bars. This can be overridden by
+     * [stemColor](#plotOptions.errorbar.stemColor) and
+     * [whiskerColor](#plotOptions.errorbar.whiskerColor) individually.
+     *
+     * @sample {highcharts} highcharts/plotoptions/error-bar-styling/
+     *         Error bar styling
+     *
+     * @type    {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+     * @default #000000
+     * @since   3.0
+     * @product highcharts
+     */
+    color: "#000000" /* Palette.neutralColor100 */,
+    grouping: false,
+    /**
+     * The parent series of the error bar. The default value links it to
+     * the previous series. Otherwise, use the id of the parent series.
+     *
+     * @since   3.0
+     * @product highcharts
+     */
+    linkedTo: ':previous',
+    tooltip: {
+        pointFormat: '<span style="color:{point.color}">\u25CF</span> {series.name}: <b>{point.low}</b> - <b>{point.high}</b><br/>'
+    },
+    /**
+     * The line width of the whiskers, the horizontal lines marking
+     * low and high values. When `null`, the general
+     * [lineWidth](#plotOptions.errorbar.lineWidth) applies.
+     *
+     * @sample {highcharts} highcharts/plotoptions/error-bar-styling/
+     *         Error bar styling
+     *
+     * @type    {number}
+     * @since   3.0
+     * @product highcharts
+     */
+    whiskerWidth: null
+};
+/**
+ * A `errorbar` series. If the [type](#series.errorbar.type) option
+ * is not specified, it is inherited from [chart.type](#chart.type).
+ *
+ * @extends   series,plotOptions.errorbar
+ * @excluding dataParser, dataURL, stack, stacking, boostThreshold,
+ *            boostBlending
+ * @product   highcharts
+ * @requires  highcharts-more
+ * @apioption series.errorbar
+ */
+/**
+ * An array of data points for the series. For the `errorbar` series
+ * type, points can be given in the following ways:
+ *
+ * 1. An array of arrays with 3 or 2 values. In this case, the values correspond
+ *    to `x,low,high`. If the first value is a string, it is applied as the name
+ *    of the point, and the `x` value is inferred. The `x` value can also be
+ *    omitted, in which case the inner arrays should be of length 2\. Then the
+ *    `x` value is automatically calculated, either starting at 0 and
+ *    incremented by 1, or from `pointStart` and `pointInterval` given in the
+ *    series options.
+ *    ```js
+ *    data: [
+ *        [0, 10, 2],
+ *        [1, 1, 8],
+ *        [2, 4, 5]
+ *    ]
+ *    ```
+ *
+ * 2. An array of objects with named values. The following snippet shows only a
+ *    few settings, see the complete options set below. If the total number of
+ *    data points exceeds the series'
+ *    [turboThreshold](#series.errorbar.turboThreshold), this option is not
+ *    available.
+ *    ```js
+ *    data: [{
+ *        x: 1,
+ *        low: 0,
+ *        high: 0,
+ *        name: "Point2",
+ *        color: "#00FF00"
+ *    }, {
+ *        x: 1,
+ *        low: 5,
+ *        high: 5,
+ *        name: "Point1",
+ *        color: "#FF00FF"
+ *    }]
+ *    ```
+ *
+ * @sample {highcharts} highcharts/series/data-array-of-arrays/
+ *         Arrays of numeric x and y
+ * @sample {highcharts} highcharts/series/data-array-of-arrays-datetime/
+ *         Arrays of datetime x and y
+ * @sample {highcharts} highcharts/series/data-array-of-name-value/
+ *         Arrays of point.name and y
+ * @sample {highcharts} highcharts/series/data-array-of-objects/
+ *         Config objects
+ *
+ * @type      {Array<Array<(number|string),number>|Array<(number|string),number,number>|*>}
+ * @extends   series.arearange.data
+ * @excluding dataLabels, drilldown, marker, states
+ * @product   highcharts
+ * @apioption series.errorbar.data
+ */
+''; // adds doclets above to transpiled file
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default ErrorBarSeriesDefaults;

package/es-modules/Series/Flags/FlagsPoint.js

@@ -24,7 +24,7 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
-var ColumnSeries = SeriesRegistry.seriesTypes.column;
+var ColumnPoint = SeriesRegistry.seriesTypes.column.prototype.pointClass;
 import U from '../../Core/Utilities.js';
 var isNumber = U.isNumber;
 /* *
@@ -51,7 +51,6 @@ var FlagsPoint = /** @class */ (function (_super) {
      *  Functions
      *
      * */
-    /* eslint-disable valid-jsdoc */
     /**
      * @private
      */
@@ -68,7 +67,7 @@ var FlagsPoint = /** @class */ (function (_super) {
         return this.graphic && shape && shape !== this.graphic.symbolKey;
     };
     return FlagsPoint;
-}(ColumnSeries.prototype.pointClass));
+}(ColumnPoint));
 /* *
  *
  *  Default Export

package/es-modules/Series/Flags/FlagsSeries.js

@@ -24,6 +24,8 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 import FlagsPoint from './FlagsPoint.js';
+import FlagsSeriesDefaults from './FlagsSeriesDefaults.js';
+import FlagsSymbols from './FlagsSymbols.js';
 import H from '../../Core/Globals.js';
 var noop = H.noop;
 import OnSeriesComposition from '../OnSeriesComposition.js';
@@ -34,7 +36,6 @@ var Series = SeriesRegistry.series, ColumnSeries = SeriesRegistry.seriesTypes.co
 import SVGElement from '../../Core/Renderer/SVG/SVGElement.js';
 import U from '../../Core/Utilities.js';
 var addEvent = U.addEvent, defined = U.defined, extend = U.extend, merge = U.merge, objectEach = U.objectEach, wrap = U.wrap;
-import './FlagsSymbols.js';
 /* *
  *
  *  Classes
@@ -67,14 +68,12 @@ var FlagsSeries = /** @class */ (function (_super) {
         _this.options = void 0;
         _this.points = void 0;
         return _this;
-        /* eslint-enable valid-jsdoc */
     }
     /* *
      *
      *  Functions
      *
      * */
-    /* eslint-disable valid-jsdoc */
     /**
      * Disable animation, but keep clipping (#8546).
      * @private
@@ -89,7 +88,8 @@ var FlagsSeries = /** @class */ (function (_super) {
      * @private
      */
     FlagsSeries.prototype.drawPoints = function () {
-        var series = this, points = series.points, chart = series.chart, renderer = chart.renderer, plotX, plotY, inverted = chart.inverted, options = series.options, optionsY = options.y, shape, i, point, graphic, stackIndex, anchorY, attribs, outsideRight, yAxis = series.yAxis, boxesMap = {}, boxes = [], centered;
+        var series = this, points = series.points, chart = series.chart, renderer = chart.renderer, inverted = chart.inverted, options = series.options, optionsY = options.y, yAxis = series.yAxis, boxesMap = {}, boxes = [];
+        var plotX, plotY, shape, i, point, graphic, stackIndex, anchorY, attribs, outsideRight, centered;
         i = points.length;
         while (i--) {
             point = points[i];
@@ -192,25 +192,26 @@ var FlagsSeries = /** @class */ (function (_super) {
             // If necessary (for overlapping or long labels)  distribute it
             // depending on the label width or a hardcoded value, #16041.
             distribute(boxes, inverted ? yAxis.len : this.xAxis.len, maxDistance_1);
-            points.forEach(function (point) {
-                var plotX = point.plotX, graphic = point.graphic, box = graphic && boxesMap[plotX];
-                if (box && graphic) {
+            for (var _i = 0, points_1 = points; _i < points_1.length; _i++) {
+                var point_1 = points_1[_i];
+                var plotX_1 = point_1.plotX, graphic_1 = point_1.graphic, box = graphic_1 && boxesMap[plotX_1];
+                if (box && graphic_1) {
                     // Hide flag when its box position is not specified
                     // (#8573, #9299)
                     if (!defined(box.pos)) {
-                        graphic.hide().isNew = true;
+                        graphic_1.hide().isNew = true;
                     }
                     else {
-                        graphic[graphic.isNew ? 'attr' : 'animate']({
+                        graphic_1[graphic_1.isNew ? 'attr' : 'animate']({
                             x: box.pos + (box.align || 0) * box.size,
-                            anchorX: point.anchorX
+                            anchorX: point_1.anchorX
                         }).show().isNew = false;
                     }
                 }
-            });
+            }
         }
         // Can be a mix of SVG and HTML and we need events for both (#6303)
-        if (options.useHTML) {
+        if (options.useHTML && series.markerGroup) {
             wrap(series.markerGroup, 'on', function (proceed) {
                 return SVGElement.prototype.on.apply(
                 // for HTML
@@ -229,12 +230,7 @@ var FlagsSeries = /** @class */ (function (_super) {
     FlagsSeries.prototype.drawTracker = function () {
         var series = this, points = series.points;
         _super.prototype.drawTracker.call(this);
-        /* *
-        * Bring each stacked flag up on mouse over, this allows readability
-        * of vertically stacked elements as well as tight points on the x
-        * axis. #1924.
-        */
-        points.forEach(function (point) {
+        var _loop_1 = function (point) {
             var graphic = point.graphic;
             if (graphic) {
                 if (point.unbindMouseOver) {
@@ -251,7 +247,8 @@ var FlagsSeries = /** @class */ (function (_super) {
                         point.raised = true;
                     }
                     // Revert other raised points
-                    points.forEach(function (otherPoint) {
+                    for (var _i = 0, points_3 = points; _i < points_3.length; _i++) {
+                        var otherPoint = points_3[_i];
                         if (otherPoint !== point &&
                             otherPoint.raised &&
                             otherPoint.graphic) {
@@ -260,17 +257,27 @@ var FlagsSeries = /** @class */ (function (_super) {
                             });
                             otherPoint.raised = false;
                         }
-                    });
+                    }
                 });
             }
-        });
+        };
+        /* *
+        * Bring each stacked flag up on mouse over, this allows readability
+        * of vertically stacked elements as well as tight points on the x
+        * axis. #1924.
+        */
+        for (var _i = 0, points_2 = points; _i < points_2.length; _i++) {
+            var point = points_2[_i];
+            _loop_1(point);
+        }
     };
     /**
      * Get presentational attributes
      * @private
      */
     FlagsSeries.prototype.pointAttribs = function (point, state) {
-        var options = this.options, color = (point && point.color) || this.color, lineColor = options.lineColor, lineWidth = (point && point.lineWidth), fill = (point && point.fillColor) || options.fillColor;
+        var options = this.options, color = (point && point.color) || this.color;
+        var lineColor = options.lineColor, lineWidth = (point && point.lineWidth), fill = (point && point.fillColor) || options.fillColor;
         if (state) {
             fill = options.states[state].fillColor;
             lineColor = options.states[state].lineColor;
@@ -293,215 +300,8 @@ var FlagsSeries = /** @class */ (function (_super) {
             this.markerGroup.clip(this.chart.sharedClips[this.sharedClipKey]);
         }
     };
-    /**
-     * Flags are used to mark events in stock charts. They can be added on the
-     * timeline, or attached to a specific series.
-     *
-     * @sample stock/demo/flags-general/
-     *         Flags on a line series
-     *
-     * @extends      plotOptions.column
-     * @excluding    animation, borderColor, borderRadius, borderWidth,
-     *               colorByPoint, dataGrouping, pointPadding, pointWidth,
-     *               turboThreshold
-     * @product      highstock
-     * @optionparent plotOptions.flags
-     */
-    FlagsSeries.defaultOptions = merge(ColumnSeries.defaultOptions, {
-        /**
-         * In case the flag is placed on a series, on what point key to place
-         * it. Line and columns have one key, `y`. In range or OHLC-type series,
-         * however, the flag can optionally be placed on the `open`, `high`,
-         * `low` or `close` key.
-         *
-         * @sample {highstock} stock/plotoptions/flags-onkey/
-         *         Range series, flag on high
-         *
-         * @type       {string}
-         * @default    y
-         * @since      4.2.2
-         * @product    highstock
-         * @validvalue ["y", "open", "high", "low", "close"]
-         * @apioption  plotOptions.flags.onKey
-         */
-        /**
-         * The id of the series that the flags should be drawn on. If no id
-         * is given, the flags are drawn on the x axis.
-         *
-         * @sample {highstock} stock/plotoptions/flags/
-         *         Flags on series and on x axis
-         *
-         * @type      {string}
-         * @product   highstock
-         * @apioption plotOptions.flags.onSeries
-         */
-        pointRange: 0,
-        /**
-         * Whether the flags are allowed to overlap sideways. If `false`, the
-         * flags are moved sideways using an algorithm that seeks to place every
-         * flag as close as possible to its original position.
-         *
-         * @sample {highstock} stock/plotoptions/flags-allowoverlapx
-         *         Allow sideways overlap
-         *
-         * @since 6.0.4
-         */
-        allowOverlapX: false,
-        /**
-         * The shape of the marker. Can be one of "flag", "circlepin",
-         * "squarepin", or an image of the format `url(/path-to-image.jpg)`.
-         * Individual shapes can also be set for each point.
-         *
-         * @sample {highstock} stock/plotoptions/flags/
-         *         Different shapes
-         *
-         * @type    {Highcharts.FlagsShapeValue}
-         * @product highstock
-         */
-        shape: 'flag',
-        /**
-         * When multiple flags in the same series fall on the same value, this
-         * number determines the vertical offset between them.
-         *
-         * @sample {highstock} stock/plotoptions/flags-stackdistance/
-         *         A greater stack distance
-         *
-         * @product highstock
-         */
-        stackDistance: 12,
-        /**
-         * Text alignment for the text inside the flag.
-         *
-         * @since      5.0.0
-         * @product    highstock
-         * @validvalue ["left", "center", "right"]
-         */
-        textAlign: 'center',
-        /**
-         * Specific tooltip options for flag series. Flag series tooltips are
-         * different from most other types in that a flag doesn't have a data
-         * value, so the tooltip rather displays the `text` option for each
-         * point.
-         *
-         * @extends   plotOptions.series.tooltip
-         * @excluding changeDecimals, valueDecimals, valuePrefix, valueSuffix
-         * @product   highstock
-         */
-        tooltip: {
-            pointFormat: '{point.text}'
-        },
-        threshold: null,
-        /**
-         * The text to display on each flag. This can be defined on series
-         * level, or individually for each point. Defaults to `"A"`.
-         *
-         * @type      {string}
-         * @default   A
-         * @product   highstock
-         * @apioption plotOptions.flags.title
-         */
-        /**
-         * The y position of the top left corner of the flag relative to either
-         * the series (if onSeries is defined), or the x axis. Defaults to
-         * `-30`.
-         *
-         * @product highstock
-         */
-        y: -30,
-        /**
-         * Whether to use HTML to render the flag texts. Using HTML allows for
-         * advanced formatting, images and reliable bi-directional text
-         * rendering. Note that exported images won't respect the HTML, and that
-         * HTML won't respect Z-index settings.
-         *
-         * @type      {boolean}
-         * @default   false
-         * @since     1.3
-         * @product   highstock
-         * @apioption plotOptions.flags.useHTML
-         */
-        /**
-         * Fixed width of the flag's shape. By default, width is autocalculated
-         * according to the flag's title.
-         *
-         * @sample {highstock} stock/demo/flags-shapes/
-         *         Flags with fixed width
-         *
-         * @type      {number}
-         * @product   highstock
-         * @apioption plotOptions.flags.width
-         */
-        /**
-         * Fixed height of the flag's shape. By default, height is
-         * autocalculated according to the flag's title.
-         *
-         * @type      {number}
-         * @product   highstock
-         * @apioption plotOptions.flags.height
-         */
-        /**
-         * The fill color for the flags.
-         *
-         * @type    {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
-         * @product highstock
-         */
-        fillColor: "#ffffff" /* Palette.backgroundColor */,
-        /**
-         * The color of the line/border of the flag.
-         *
-         * In styled mode, the stroke is set in the
-         * `.highcharts-flag-series.highcharts-point` rule.
-         *
-         * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
-         * @default   #000000
-         * @product   highstock
-         * @apioption plotOptions.flags.lineColor
-         */
-        /**
-         * The pixel width of the flag's line/border.
-         *
-         * @product highstock
-         */
-        lineWidth: 1,
-        states: {
-            /**
-             * @extends plotOptions.column.states.hover
-             * @product highstock
-             */
-            hover: {
-                /**
-                 * The color of the line/border of the flag.
-                 *
-                 * @type    {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
-                 * @product highstock
-                 */
-                lineColor: "#000000" /* Palette.neutralColor100 */,
-                /**
-                 * The fill or background color of the flag.
-                 *
-                 * @type    {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
-                 * @product highstock
-                 */
-                fillColor: "#ccd6eb" /* Palette.highlightColor20 */
-            }
-        },
-        /**
-         * The text styles of the flag.
-         *
-         * In styled mode, the styles are set in the
-         * `.highcharts-flag-series .highcharts-point` rule.
-         *
-         * @type    {Highcharts.CSSObject}
-         * @default {"fontSize": "11px", "fontWeight": "bold"}
-         * @product highstock
-         */
-        style: {
-            /** @ignore-option */
-            fontSize: '11px',
-            /** @ignore-option */
-            fontWeight: 'bold'
-        }
-    });
+    FlagsSeries.compose = FlagsSymbols.compose;
+    FlagsSeries.defaultOptions = merge(ColumnSeries.defaultOptions, FlagsSeriesDefaults);
     return FlagsSeries;
 }(ColumnSeries));
 OnSeriesComposition.compose(FlagsSeries);
@@ -542,70 +342,3 @@ export default FlagsSeries;
  * @typedef {"circlepin"|"flag"|"squarepin"} Highcharts.FlagsShapeValue
  */
 ''; // detach doclets above
-/* *
- *
- *  API Option
- *
- * */
-/**
- * A `flags` series. If the [type](#series.flags.type) option is not
- * specified, it is inherited from [chart.type](#chart.type).
- *
- * @extends   series,plotOptions.flags
- * @excluding animation, borderColor, borderRadius, borderWidth, colorByPoint,
- *            connectNulls, dashStyle, dataGrouping, dataParser, dataURL,
- *            gapSize, gapUnit, linecap, lineWidth, marker, pointPadding,
- *            pointWidth, step, turboThreshold, useOhlcData
- * @product   highstock
- * @apioption series.flags
- */
-/**
- * An array of data points for the series. For the `flags` series type,
- * points can be given in the following ways:
- *
- * 1. An array of objects with named values. The following snippet shows only a
- *    few settings, see the complete options set below. If the total number of
- *    data points exceeds the series'
- *    [turboThreshold](#series.flags.turboThreshold), this option is not
- *    available.
- *    ```js
- *    data: [{
- *        x: 1,
- *        title: "A",
- *        text: "First event"
- *    }, {
- *        x: 1,
- *        title: "B",
- *        text: "Second event"
- *    }]
- *    ```
- *
- * @type      {Array<*>}
- * @extends   series.line.data
- * @excluding dataLabels, marker, name, y
- * @product   highstock
- * @apioption series.flags.data
- */
-/**
- * The fill color of an individual flag. By default it inherits from
- * the series color.
- *
- * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
- * @product   highstock
- * @apioption series.flags.data.fillColor
- */
-/**
- * The longer text to be shown in the flag's tooltip.
- *
- * @type      {string}
- * @product   highstock
- * @apioption series.flags.data.text
- */
-/**
- * The short text to be shown on the flag.
- *
- * @type      {string}
- * @product   highstock
- * @apioption series.flags.data.title
- */
-''; // adds doclets above to transpiled file