highcharts 10.2.1 → 10.3.1

package/es-modules/Series/Column/ColumnSeriesDefaults.js

@@ -0,0 +1,487 @@
+/* *
+ *
+ *  (c) 2010-2021 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+/* *
+ *
+ *  API Options
+ *
+ * */
+/**
+ * Column series display one column per value along an X axis.
+ *
+ * @sample {highcharts} highcharts/demo/column-basic/
+ *         Column chart
+ * @sample {highstock} stock/demo/column/
+ *         Column chart
+ *
+ * @extends      plotOptions.line
+ * @excluding    connectEnds, connectNulls, gapSize, gapUnit, linecap,
+ *               lineWidth, marker, step, useOhlcData
+ * @product      highcharts highstock
+ * @optionparent plotOptions.column
+ */
+var ColumnSeriesDefaults = {
+    /**
+     * The corner radius of the border surrounding each column or bar.
+     *
+     * @sample {highcharts} highcharts/plotoptions/column-borderradius/
+     *         Rounded columns
+     *
+     * @product highcharts highstock gantt
+     */
+    borderRadius: 0,
+    /**
+     * When using automatic point colors pulled from the global
+     * [colors](colors) or series-specific
+     * [plotOptions.column.colors](series.colors) collections, this option
+     * determines whether the chart should receive one color per series or
+     * one color per point.
+     *
+     * In styled mode, the `colors` or `series.colors` arrays are not
+     * supported, and instead this option gives the points individual color
+     * class names on the form `highcharts-color-{n}`.
+     *
+     * @see [series colors](#plotOptions.column.colors)
+     *
+     * @sample {highcharts} highcharts/plotoptions/column-colorbypoint-false/
+     *         False by default
+     * @sample {highcharts} highcharts/plotoptions/column-colorbypoint-true/
+     *         True
+     *
+     * @type      {boolean}
+     * @default   false
+     * @since     2.0
+     * @product   highcharts highstock gantt
+     * @apioption plotOptions.column.colorByPoint
+     */
+    /**
+     * A series specific or series type specific color set to apply instead
+     * of the global [colors](#colors) when [colorByPoint](
+     * #plotOptions.column.colorByPoint) is true.
+     *
+     * @type      {Array<Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject>}
+     * @since     3.0
+     * @product   highcharts highstock gantt
+     * @apioption plotOptions.column.colors
+     */
+    /**
+     * When `true`, the columns will center in the category, ignoring null
+     * or missing points. When `false`, space will be reserved for null or
+     * missing points.
+     *
+     * @sample {highcharts} highcharts/series-column/centerincategory/
+     *         Center in category
+     *
+     * @since   8.0.1
+     * @product highcharts highstock gantt
+     */
+    centerInCategory: false,
+    /**
+     * Padding between each value groups, in x axis units.
+     *
+     * @sample {highcharts} highcharts/plotoptions/column-grouppadding-default/
+     *         0.2 by default
+     * @sample {highcharts} highcharts/plotoptions/column-grouppadding-none/
+     *         No group padding - all columns are evenly spaced
+     *
+     * @product highcharts highstock gantt
+     */
+    groupPadding: 0.2,
+    /**
+     * Whether to group non-stacked columns or to let them render
+     * independent of each other. Non-grouped columns will be laid out
+     * individually and overlap each other.
+     *
+     * @sample {highcharts} highcharts/plotoptions/column-grouping-false/
+     *         Grouping disabled
+     * @sample {highstock} highcharts/plotoptions/column-grouping-false/
+     *         Grouping disabled
+     *
+     * @type      {boolean}
+     * @default   true
+     * @since     2.3.0
+     * @product   highcharts highstock gantt
+     * @apioption plotOptions.column.grouping
+     */
+    /** @ignore-option */
+    marker: null,
+    /**
+     * The maximum allowed pixel width for a column, translated to the
+     * height of a bar in a bar chart. This prevents the columns from
+     * becoming too wide when there is a small number of points in the
+     * chart.
+     *
+     * @see [pointWidth](#plotOptions.column.pointWidth)
+     *
+     * @sample {highcharts} highcharts/plotoptions/column-maxpointwidth-20/
+     *         Limited to 50
+     * @sample {highstock} highcharts/plotoptions/column-maxpointwidth-20/
+     *         Limited to 50
+     *
+     * @type      {number}
+     * @since     4.1.8
+     * @product   highcharts highstock gantt
+     * @apioption plotOptions.column.maxPointWidth
+     */
+    /**
+     * Padding between each column or bar, in x axis units.
+     *
+     * @sample {highcharts} highcharts/plotoptions/column-pointpadding-default/
+     *         0.1 by default
+     * @sample {highcharts} highcharts/plotoptions/column-pointpadding-025/
+     *          0.25
+     * @sample {highcharts} highcharts/plotoptions/column-pointpadding-none/
+     *         0 for tightly packed columns
+     *
+     * @product highcharts highstock gantt
+     */
+    pointPadding: 0.1,
+    /**
+     * A pixel value specifying a fixed width for each column or bar point.
+     * When set to `undefined`, the width is calculated from the
+     * `pointPadding` and `groupPadding`. The width effects the dimension
+     * that is not based on the point value. For column series it is the
+     * hoizontal length and for bar series it is the vertical length.
+     *
+     * @see [maxPointWidth](#plotOptions.column.maxPointWidth)
+     *
+     * @sample {highcharts} highcharts/plotoptions/column-pointwidth-20/
+     *         20px wide columns regardless of chart width or the amount of
+     *         data points
+     *
+     * @type      {number}
+     * @since     1.2.5
+     * @product   highcharts highstock gantt
+     * @apioption plotOptions.column.pointWidth
+     */
+    /**
+     * A pixel value specifying a fixed width for the column or bar.
+     * Overrides pointWidth on the series.
+     *
+     * @see [series.pointWidth](#plotOptions.column.pointWidth)
+     *
+     * @type      {number}
+     * @default   undefined
+     * @since     7.0.0
+     * @product   highcharts highstock gantt
+     * @apioption series.column.data.pointWidth
+     */
+    /**
+     * The minimal height for a column or width for a bar. By default,
+     * 0 values are not shown. To visualize a 0 (or close to zero) point,
+     * set the minimal point length to a pixel value like 3\. In stacked
+     * column charts, minPointLength might not be respected for tightly
+     * packed values.
+     *
+     * @sample {highcharts} highcharts/plotoptions/column-minpointlength/
+     *         Zero base value
+     * @sample {highcharts} highcharts/plotoptions/column-minpointlength-pos-and-neg/
+     *         Positive and negative close to zero values
+     *
+     * @product highcharts highstock gantt
+     */
+    minPointLength: 0,
+    /**
+     * When the series contains less points than the crop threshold, all
+     * points are drawn, event if the points fall outside the visible plot
+     * area at the current zoom. The advantage of drawing all points
+     * (including markers and columns), is that animation is performed on
+     * updates. On the other hand, when the series contains more points than
+     * the crop threshold, the series data is cropped to only contain points
+     * that fall within the plot area. The advantage of cropping away
+     * invisible points is to increase performance on large series.
+     *
+     * @product highcharts highstock gantt
+     */
+    cropThreshold: 50,
+    /**
+     * The X axis range that each point is valid for. This determines the
+     * width of the column. On a categorized axis, the range will be 1
+     * by default (one category unit). On linear and datetime axes, the
+     * range will be computed as the distance between the two closest data
+     * points.
+     *
+     * The default `null` means it is computed automatically, but this
+     * option can be used to override the automatic value.
+     *
+     * This option is set by default to 1 if data sorting is enabled.
+     *
+     * @sample {highcharts} highcharts/plotoptions/column-pointrange/
+     *         Set the point range to one day on a data set with one week
+     *         between the points
+     *
+     * @type    {number|null}
+     * @since   2.3
+     * @product highcharts highstock gantt
+     */
+    pointRange: null,
+    states: {
+        /**
+         * Options for the hovered point. These settings override the normal
+         * state options when a point is moused over or touched.
+         *
+         * @extends   plotOptions.series.states.hover
+         * @excluding halo, lineWidth, lineWidthPlus, marker
+         * @product   highcharts highstock gantt
+         */
+        hover: {
+            /** @ignore-option */
+            halo: false,
+            /**
+             * A specific border color for the hovered point. Defaults to
+             * inherit the normal state border color.
+             *
+             * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+             * @product   highcharts gantt
+             * @apioption plotOptions.column.states.hover.borderColor
+             */
+            /**
+             * A specific color for the hovered point.
+             *
+             * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+             * @product   highcharts gantt
+             * @apioption plotOptions.column.states.hover.color
+             */
+            /**
+             * How much to brighten the point on interaction. Requires the
+             * main color to be defined in hex or rgb(a) format.
+             *
+             * In styled mode, the hover brightening is by default replaced
+             * with a fill-opacity set in the `.highcharts-point:hover`
+             * rule.
+             *
+             * @sample {highcharts} highcharts/plotoptions/column-states-hover-brightness/
+             *         Brighten by 0.5
+             *
+             * @product highcharts highstock gantt
+             */
+            brightness: 0.1
+        },
+        /**
+         * Options for the selected point. These settings override the
+         * normal state options when a point is selected.
+         *
+         * @extends   plotOptions.series.states.select
+         * @excluding halo, lineWidth, lineWidthPlus, marker
+         * @product   highcharts highstock gantt
+         */
+        select: {
+            /**
+             * A specific color for the selected point.
+             *
+             * @type    {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+             * @default #cccccc
+             * @product highcharts highstock gantt
+             */
+            color: "#cccccc" /* Palette.neutralColor20 */,
+            /**
+             * A specific border color for the selected point.
+             *
+             * @type    {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+             * @default #000000
+             * @product highcharts highstock gantt
+             */
+            borderColor: "#000000" /* Palette.neutralColor100 */
+        }
+    },
+    dataLabels: {
+        align: void 0,
+        verticalAlign: void 0,
+        /**
+         * The y position offset of the label relative to the point in
+         * pixels.
+         *
+         * @type {number}
+         */
+        y: void 0
+    },
+    // false doesn't work well: https://jsfiddle.net/highcharts/hz8fopan/14/
+    /** @ignore-option */
+    startFromThreshold: true,
+    stickyTracking: false,
+    tooltip: {
+        distance: 6
+    },
+    /**
+     * The Y axis value to serve as the base for the columns, for
+     * distinguishing between values above and below a threshold. If `null`,
+     * the columns extend from the padding Y axis minimum.
+     *
+     * @type    {number|null}
+     * @since   2.0
+     * @product highcharts
+     */
+    threshold: 0,
+    /**
+     * The width of the border surrounding each column or bar. Defaults to
+     * `1` when there is room for a border, but to `0` when the columns are
+     * so dense that a border would cover the next column.
+     *
+     * In styled mode, the stroke width can be set with the
+     * `.highcharts-point` rule.
+     *
+     * @sample {highcharts} highcharts/plotoptions/column-borderwidth/
+     *         2px black border
+     *
+     * @type      {number}
+     * @default   undefined
+     * @product   highcharts highstock gantt
+     * @apioption plotOptions.column.borderWidth
+     */
+    /**
+     * The color of the border surrounding each column or bar.
+     *
+     * In styled mode, the border stroke can be set with the
+     * `.highcharts-point` rule.
+     *
+     * @sample {highcharts} highcharts/plotoptions/column-bordercolor/
+     *         Dark gray border
+     *
+     * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+     * @default   #ffffff
+     * @product   highcharts highstock gantt
+     */
+    borderColor: "#ffffff" /* Palette.backgroundColor */
+};
+/**
+ * A `column` series. If the [type](#series.column.type) option is
+ * not specified, it is inherited from [chart.type](#chart.type).
+ *
+ * @extends   series,plotOptions.column
+ * @excluding connectNulls, dataParser, dataURL, gapSize, gapUnit, linecap,
+ *            lineWidth, marker, connectEnds, step
+ * @product   highcharts highstock
+ * @apioption series.column
+ */
+/**
+ * An array of data points for the series. For the `column` series type,
+ * points can be given in the following ways:
+ *
+ * 1. An array of numerical values. In this case, the numerical values will be
+ *    interpreted as `y` options. The `x` values will be automatically
+ *    calculated, either starting at 0 and incremented by 1, or from
+ *    `pointStart` and `pointInterval` given in the series options. If the axis
+ *    has categories, these will be used. Example:
+ *    ```js
+ *    data: [0, 5, 3, 5]
+ *    ```
+ *
+ * 2. An array of arrays with 2 values. In this case, the values correspond to
+ *    `x,y`. If the first value is a string, it is applied as the name of the
+ *    point, and the `x` value is inferred.
+ *    ```js
+ *    data: [
+ *        [0, 6],
+ *        [1, 2],
+ *        [2, 6]
+ *    ]
+ *    ```
+ *
+ * 3. 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.column.turboThreshold), this option is not
+ *    available.
+ *    ```js
+ *    data: [{
+ *        x: 1,
+ *        y: 9,
+ *        name: "Point2",
+ *        color: "#00FF00"
+ *    }, {
+ *        x: 1,
+ *        y: 6,
+ *        name: "Point1",
+ *        color: "#FF00FF"
+ *    }]
+ *    ```
+ *
+ * @sample {highcharts} highcharts/chart/reflow-true/
+ *         Numerical values
+ * @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<number|Array<(number|string),(number|null)>|null|*>}
+ * @extends   series.line.data
+ * @excluding marker
+ * @product   highcharts highstock
+ * @apioption series.column.data
+ */
+/**
+ * The color of the border surrounding the column or bar.
+ *
+ * In styled mode, the border stroke can be set with the `.highcharts-point`
+ * rule.
+ *
+ * @sample {highcharts} highcharts/plotoptions/column-bordercolor/
+ *         Dark gray border
+ *
+ * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+ * @product   highcharts highstock
+ * @apioption series.column.data.borderColor
+ */
+/**
+ * The width of the border surrounding the column or bar.
+ *
+ * In styled mode, the stroke width can be set with the `.highcharts-point`
+ * rule.
+ *
+ * @sample {highcharts} highcharts/plotoptions/column-borderwidth/
+ *         2px black border
+ *
+ * @type      {number}
+ * @product   highcharts highstock
+ * @apioption series.column.data.borderWidth
+ */
+/**
+ * A name for the dash style to use for the column or bar. Overrides
+ * dashStyle on the series.
+ *
+ * In styled mode, the stroke dash-array can be set with the same classes as
+ * listed under [data.color](#series.column.data.color).
+ *
+ * @see [series.pointWidth](#plotOptions.column.dashStyle)
+ *
+ * @type      {Highcharts.DashStyleValue}
+ * @apioption series.column.data.dashStyle
+ */
+/**
+ * A pixel value specifying a fixed width for the column or bar. Overrides
+ * pointWidth on the series. The width effects the dimension that is not based
+ * on the point value.
+ *
+ * @see [series.pointWidth](#plotOptions.column.pointWidth)
+ *
+ * @type      {number}
+ * @apioption series.column.data.pointWidth
+ */
+/**
+ * @excluding halo, lineWidth, lineWidthPlus, marker
+ * @product   highcharts highstock
+ * @apioption series.column.states.hover
+ */
+/**
+ * @excluding halo, lineWidth, lineWidthPlus, marker
+ * @product   highcharts highstock
+ * @apioption series.column.states.select
+ */
+''; // keeps doclets above in JS file
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default ColumnSeriesDefaults;

package/es-modules/Series/ColumnRange/ColumnRangeSeries.js

@@ -29,7 +29,7 @@ var noop = H.noop;
 import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
 var _a = SeriesRegistry.seriesTypes, AreaRangeSeries = _a.arearange, ColumnSeries = _a.column, columnProto = _a.column.prototype;
 import U from '../../Core/Utilities.js';
-var clamp = U.clamp, extend = U.extend, merge = U.merge, pick = U.pick;
+var clamp = U.clamp, extend = U.extend, isNumber = U.isNumber, merge = U.merge, pick = U.pick;
 /* *
  *
  *  Constants
@@ -122,42 +122,46 @@ var ColumnRangeSeries = /** @class */ (function (_super) {
         columnProto.translate.apply(this);
         // Set plotLow and plotHigh
         this.points.forEach(function (point) {
-            var shapeArgs = point.shapeArgs || {}, minPointLength = _this.options.minPointLength;
-            point.plotHigh = plotHigh = safeBounds(yAxis.translate(point.high, 0, 1, 0, 1));
-            point.plotLow = safeBounds(point.plotY);
-            // adjust shape
-            y = plotHigh;
-            height = pick(point.rectPlotY, point.plotY) - plotHigh;
-            // Adjust for minPointLength
-            if (Math.abs(height) < minPointLength) {
-                heightDifference = (minPointLength - height);
-                height += heightDifference;
-                y -= heightDifference / 2;
-                // Adjust for negative ranges or reversed Y axis (#1457)
-            }
-            else if (height < 0) {
-                height *= -1;
-                y -= height;
-            }
-            if (isRadial && _this.polar) {
-                start = point.barX + startAngleRad;
-                point.shapeType = 'arc';
-                point.shapeArgs = _this.polar.arc(y + height, y, start, start + point.pointWidth);
-            }
-            else {
-                shapeArgs.height = height;
-                shapeArgs.y = y;
-                var _a = shapeArgs.x, x = _a === void 0 ? 0 : _a, _b = shapeArgs.width, width = _b === void 0 ? 0 : _b;
-                point.tooltipPos = chart.inverted ?
-                    [
-                        yAxis.len + yAxis.pos - chart.plotLeft - y - height / 2,
-                        xAxis.len + xAxis.pos - chart.plotTop - x - width / 2,
+            var shapeArgs = point.shapeArgs || {}, minPointLength = _this.options.minPointLength, plotY = point.plotY, plotHigh = yAxis.translate(point.high, 0, 1, 0, 1);
+            if (isNumber(plotHigh) && isNumber(plotY)) {
+                point.plotHigh = safeBounds(plotHigh);
+                point.plotLow = safeBounds(plotY);
+                // adjust shape
+                y = point.plotHigh;
+                height = pick(point.rectPlotY, point.plotY) - point.plotHigh;
+                // Adjust for minPointLength
+                if (Math.abs(height) < minPointLength) {
+                    heightDifference = (minPointLength - height);
+                    height += heightDifference;
+                    y -= heightDifference / 2;
+                    // Adjust for negative ranges or reversed Y axis (#1457)
+                }
+                else if (height < 0) {
+                    height *= -1;
+                    y -= height;
+                }
+                if (isRadial && _this.polar) {
+                    start = point.barX + startAngleRad;
+                    point.shapeType = 'arc';
+                    point.shapeArgs = _this.polar.arc(y + height, y, start, start + point.pointWidth);
+                }
+                else {
+                    shapeArgs.height = height;
+                    shapeArgs.y = y;
+                    var _a = shapeArgs.x, x = _a === void 0 ? 0 : _a, _b = shapeArgs.width, width = _b === void 0 ? 0 : _b;
+                    point.tooltipPos = chart.inverted ?
+                        [
+                            yAxis.len + yAxis.pos - chart.plotLeft - y -
+                                height / 2,
+                            xAxis.len + xAxis.pos - chart.plotTop - x -
+                                width / 2,
+                            height
+                        ] : [
+                        xAxis.left - chart.plotLeft + x + width / 2,
+                        yAxis.pos - chart.plotTop + y + height / 2,
                         height
-                    ] : [
-                    xAxis.left - chart.plotLeft + x + width / 2,
-                    yAxis.pos - chart.plotTop + y + height / 2,
-                    height
-                ]; // don't inherit from column tooltip position - #3372
+                    ]; // don't inherit from column tooltip position - #3372
+                }
             }
         });
     };