highcharts 10.2.1 → 10.3.1

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

@@ -0,0 +1,295 @@
+/* *
+ *
+ *  (c) 2010-2021 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+/* *
+ *
+ *  API Options
+ *
+ * */
+/**
+ * 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, cropThreshold, dataGrouping, pointPadding,
+ *               pointWidth, turboThreshold
+ * @product      highstock
+ * @optionparent plotOptions.flags
+ */
+var FlagsSeriesDefaults = {
+    /**
+     * 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}'
+    },
+    /**
+     * @type {number|null}
+     */
+    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'
+    }
+};
+/**
+ * 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, cropThreshold, 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
+ */
+''; // keeps doclets above in transpiled file
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default FlagsSeriesDefaults;

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

@@ -4,87 +4,112 @@
  *
  * */
 import RendererRegistry from '../../Core/Renderer/RendererRegistry.js';
-import SVGRenderer from '../../Core/Renderer/SVG/SVGRenderer.js';
-var symbols = SVGRenderer.prototype.symbols;
 /* *
  *
- *  Symbols
+ *  Composition
  *
  * */
-// create the flag icon with anchor
-symbols.flag = function (x, y, w, h, options) {
-    var anchorX = (options && options.anchorX) || x, anchorY = (options && options.anchorY) || y;
-    // To do: unwanted any cast because symbols.circle has wrong type, it
-    // actually returns an SVGPathArray
-    var path = symbols.circle(anchorX - 1, anchorY - 1, 2, 2);
-    path.push(['M', anchorX, anchorY], ['L', x, y + h], ['L', x, y], ['L', x + w, y], ['L', x + w, y + h], ['L', x, y + h], ['Z']);
-    return path;
-};
-/**
- * Create the circlepin and squarepin icons with anchor.
- * @private
- * @param {string} shape
- * circle or square
- */
-function createPinSymbol(shape) {
-    symbols[(shape + 'pin')] = function (x, y, w, h, options) {
-        var anchorX = options && options.anchorX, anchorY = options && options.anchorY;
-        var path;
-        // For single-letter flags, make sure circular flags are not taller
-        // than their width
-        if (shape === 'circle' && h > w) {
-            x -= Math.round((h - w) / 2);
-            w = h;
+var FlagsSymbols;
+(function (FlagsSymbols) {
+    /* *
+     *
+     *  Constants
+     *
+     * */
+    var modifiedMembers = [];
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    /* eslint-disable valid-jsdoc */
+    /**
+     * @private
+     */
+    function compose(SVGRendererClass) {
+        if (modifiedMembers.indexOf(SVGRendererClass) === -1) {
+            modifiedMembers.push(SVGRendererClass);
+            var symbols = SVGRendererClass.prototype.symbols;
+            symbols.flag = flag;
+            createPinSymbol(symbols, 'circle');
+            createPinSymbol(symbols, 'square');
         }
-        path = (symbols[shape])(x, y, w, h);
-        if (anchorX && anchorY) {
-            /**
-             * If the label is below the anchor, draw the connecting line from
-             * the top edge of the label, otherwise start drawing from the
-             * bottom edge
-             */
-            var labelX = anchorX;
-            if (shape === 'circle') {
-                labelX = x + w / 2;
+        var RendererClass = RendererRegistry.getRendererType();
+        // The symbol callbacks are generated on the SVGRenderer object in all
+        // browsers. Even VML browsers need this in order to generate shapes in
+        // export. Now share them with the VMLRenderer.
+        if (modifiedMembers.indexOf(RendererClass)) {
+            modifiedMembers.push(RendererClass);
+            var symbols = SVGRendererClass.prototype.symbols, vmlSymbols = RendererClass.prototype.symbols;
+            vmlSymbols.circlepin = symbols.circlepin;
+            vmlSymbols.flag = symbols.flag.bind(symbols);
+            vmlSymbols.squarepin = symbols.squarepin;
+        }
+    }
+    FlagsSymbols.compose = compose;
+    /**
+     * Create the flag icon with anchor.
+     * @private
+     */
+    function flag(x, y, w, h, options) {
+        var anchorX = (options && options.anchorX) || x, anchorY = (options && options.anchorY) || y;
+        // To do: unwanted any cast because symbols.circle has wrong type, it
+        // actually returns an SVGPathArray
+        var path = this.circle(anchorX - 1, anchorY - 1, 2, 2);
+        path.push(['M', anchorX, anchorY], ['L', x, y + h], ['L', x, y], ['L', x + w, y], ['L', x + w, y + h], ['L', x, y + h], ['Z']);
+        return path;
+    }
+    /**
+     * Create the circlepin and squarepin icons with anchor.
+     * @private
+     */
+    function createPinSymbol(symbols, shape) {
+        symbols[(shape + 'pin')] = function (x, y, w, h, options) {
+            var anchorX = options && options.anchorX, anchorY = options && options.anchorY;
+            var path;
+            // For single-letter flags, make sure circular flags are not taller
+            // than their width
+            if (shape === 'circle' && h > w) {
+                x -= Math.round((h - w) / 2);
+                w = h;
             }
-            else {
-                var startSeg = path[0];
-                var endSeg = path[1];
-                if (startSeg[0] === 'M' && endSeg[0] === 'L') {
-                    labelX = (startSeg[1] + endSeg[1]) / 2;
+            path = (symbols[shape])(x, y, w, h);
+            if (anchorX && anchorY) {
+                /**
+                 * If the label is below the anchor, draw the connecting line
+                 * from the top edge of the label, otherwise start drawing from
+                 * the bottom edge
+                 */
+                var labelX = anchorX;
+                if (shape === 'circle') {
+                    labelX = x + w / 2;
+                }
+                else {
+                    var startSeg = path[0];
+                    var endSeg = path[1];
+                    if (startSeg[0] === 'M' && endSeg[0] === 'L') {
+                        labelX = (startSeg[1] + endSeg[1]) / 2;
+                    }
                 }
+                var labelY = (y > anchorY) ? y : y + h;
+                path.push([
+                    'M',
+                    labelX,
+                    labelY
+                ], [
+                    'L',
+                    anchorX,
+                    anchorY
+                ]);
+                path = path.concat(symbols.circle(anchorX - 1, anchorY - 1, 2, 2));
             }
-            var labelY = (y > anchorY) ? y : y + h;
-            path.push([
-                'M',
-                labelX,
-                labelY
-            ], [
-                'L',
-                anchorX,
-                anchorY
-            ]);
-            path = path.concat(symbols.circle(anchorX - 1, anchorY - 1, 2, 2));
-        }
-        return path;
-    };
-}
-createPinSymbol('circle');
-createPinSymbol('square');
-/**
- * The symbol callbacks are generated on the SVGRenderer object in all browsers.
- * Even VML browsers need this in order to generate shapes in export. Now share
- * them with the VMLRenderer.
- */
-var Renderer = RendererRegistry.getRendererType();
-if (Renderer !== SVGRenderer) {
-    Renderer.prototype.symbols.circlepin = symbols.circlepin;
-    Renderer.prototype.symbols.flag = symbols.flag;
-    Renderer.prototype.symbols.squarepin = symbols.squarepin;
-}
+            return path;
+        };
+    }
+})(FlagsSymbols || (FlagsSymbols = {}));
 /* *
  *
  *  Default Export
  *
  * */
-export default symbols;
+export default FlagsSymbols;

package/es-modules/Series/HLC/HLCPoint.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;
 /* *
  *
  *  Class
@@ -48,7 +48,7 @@ var HLCPoint = /** @class */ (function (_super) {
         return _this;
     }
     return HLCPoint;
-}(ColumnSeries.prototype.pointClass));
+}(ColumnPoint));
 /* *
  *
  *  Default Export