highcharts 10.2.1 → 10.3.1

package/es-modules/Extensions/DataGrouping/DataGroupingAxisComposition.js

@@ -0,0 +1,174 @@
+/* *
+ *
+ *  (c) 2010-2021 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+import DataGroupingDefaults from './DataGroupingDefaults.js';
+import U from '../../Core/Utilities.js';
+var addEvent = U.addEvent, extend = U.extend, merge = U.merge, pick = U.pick;
+/* *
+ *
+ *  Constants
+ *
+ * */
+var composedMembers = [];
+/* *
+ *
+ *  Variables
+ *
+ * */
+var AxisConstructor;
+/* *
+ *
+ *  Functions
+ *
+ * */
+/**
+ * Check the groupPixelWidth and apply the grouping if needed.
+ * Fired only after processing the data.
+ *
+ * @product highstock
+ *
+ * @function Highcharts.Axis#applyGrouping
+ */
+function applyGrouping(e) {
+    var axis = this, series = axis.series;
+    // Reset the groupPixelWidth for all series, #17141.
+    series.forEach(function (series) {
+        series.groupPixelWidth = void 0; // #2110
+    });
+    series.forEach(function (series) {
+        series.groupPixelWidth = (axis.getGroupPixelWidth &&
+            axis.getGroupPixelWidth());
+        if (series.groupPixelWidth) {
+            series.hasProcessed = true; // #2692
+        }
+        // Fire independing on series.groupPixelWidth to always set a proper
+        // dataGrouping state, (#16238)
+        series.applyGrouping(!!e.hasExtremesChanged);
+    });
+}
+/**
+ * @private
+ */
+function compose(AxisClass) {
+    AxisConstructor = AxisClass;
+    if (composedMembers.indexOf(AxisClass) === -1) {
+        composedMembers.push(AxisClass);
+        addEvent(AxisClass, 'afterSetScale', onAfterSetScale);
+        // When all series are processed, calculate the group pixel width and
+        // then if this value is different than zero apply groupings.
+        addEvent(AxisClass, 'postProcessData', applyGrouping);
+        extend(AxisClass.prototype, {
+            applyGrouping: applyGrouping,
+            getGroupPixelWidth: getGroupPixelWidth,
+            setDataGrouping: setDataGrouping
+        });
+    }
+}
+/**
+ * Get the data grouping pixel width based on the greatest defined individual
+ * width of the axis' series, and if whether one of the axes need grouping.
+ * @private
+ */
+function getGroupPixelWidth() {
+    var series = this.series;
+    var i = series.length, groupPixelWidth = 0, doGrouping = false, dataLength, dgOptions;
+    // If one of the series needs grouping, apply it to all (#1634)
+    while (i--) {
+        dgOptions = series[i].options.dataGrouping;
+        if (dgOptions) { // #2692
+            // If multiple series are compared on the same x axis, give them the
+            // same group pixel width (#334)
+            groupPixelWidth = Math.max(groupPixelWidth, 
+            // Fallback to commonOptions (#9693)
+            pick(dgOptions.groupPixelWidth, DataGroupingDefaults.common.groupPixelWidth));
+            dataLength = (series[i].processedXData || series[i].data).length;
+            // Execute grouping if the amount of points is greater than the
+            // limit defined in groupPixelWidth
+            if (series[i].groupPixelWidth ||
+                (dataLength >
+                    (this.chart.plotSizeX / groupPixelWidth)) ||
+                (dataLength && dgOptions.forced)) {
+                doGrouping = true;
+            }
+        }
+    }
+    return doGrouping ? groupPixelWidth : 0;
+}
+/**
+ * When resetting the scale reset the hasProccessed flag to avoid taking
+ * previous data grouping of neighbour series into accound when determining
+ * group pixel width (#2692).
+ * @private
+ */
+function onAfterSetScale() {
+    this.series.forEach(function (series) {
+        series.hasProcessed = false;
+    });
+}
+/**
+ * Highcharts Stock only. Force data grouping on all the axis' series.
+ *
+ * @product highstock
+ *
+ * @function Highcharts.Axis#setDataGrouping
+ *
+ * @param {boolean|Highcharts.DataGroupingOptionsObject} [dataGrouping]
+ *        A `dataGrouping` configuration. Use `false` to disable data grouping
+ *        dynamically.
+ *
+ * @param {boolean} [redraw=true]
+ *        Whether to redraw the chart or wait for a later call to
+ *        {@link Chart#redraw}.
+ */
+function setDataGrouping(dataGrouping, redraw) {
+    var axis = this;
+    var i;
+    redraw = pick(redraw, true);
+    if (!dataGrouping) {
+        dataGrouping = {
+            forced: false,
+            units: null
+        };
+    }
+    // Axis is instantiated, update all series
+    if (this instanceof AxisConstructor) {
+        i = this.series.length;
+        while (i--) {
+            this.series[i].update({
+                dataGrouping: dataGrouping
+            }, false);
+        }
+        // Axis not yet instanciated, alter series options
+    }
+    else {
+        this.chart.options.series.forEach(function (seriesOptions) {
+            // Merging dataGrouping options with already defined options #16759
+            seriesOptions.dataGrouping = typeof dataGrouping === 'boolean' ?
+                dataGrouping :
+                merge(dataGrouping, seriesOptions.dataGrouping);
+        });
+    }
+    // Clear ordinal slope, so we won't accidentaly use the old one (#7827)
+    if (axis.ordinal) {
+        axis.ordinal.slope = void 0;
+    }
+    if (redraw) {
+        this.chart.redraw();
+    }
+}
+/* *
+ *
+ *  Default Export
+ *
+ * */
+var DataGroupingAxisComposition = {
+    compose: compose
+};
+export default DataGroupingAxisComposition;

package/es-modules/Extensions/DataGrouping/DataGroupingDefaults.js

@@ -0,0 +1,143 @@
+/* *
+ *
+ *  (c) 2010-2021 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+/* *
+ *
+ *  Constants
+ *
+ * */
+/**
+ * Common options
+ * @private
+ */
+var common = {
+    // enabled: null, // (true for stock charts, false for basic),
+    // forced: undefined,
+    groupPixelWidth: 2,
+    // the first one is the point or start value, the second is the start
+    // value if we're dealing with range, the third one is the end value if
+    // dealing with a range
+    dateTimeLabelFormats: {
+        millisecond: [
+            '%A, %b %e, %H:%M:%S.%L',
+            '%A, %b %e, %H:%M:%S.%L',
+            '-%H:%M:%S.%L'
+        ],
+        second: [
+            '%A, %b %e, %H:%M:%S',
+            '%A, %b %e, %H:%M:%S',
+            '-%H:%M:%S'
+        ],
+        minute: [
+            '%A, %b %e, %H:%M',
+            '%A, %b %e, %H:%M',
+            '-%H:%M'
+        ],
+        hour: [
+            '%A, %b %e, %H:%M',
+            '%A, %b %e, %H:%M',
+            '-%H:%M'
+        ],
+        day: [
+            '%A, %b %e, %Y',
+            '%A, %b %e',
+            '-%A, %b %e, %Y'
+        ],
+        week: [
+            'Week from %A, %b %e, %Y',
+            '%A, %b %e',
+            '-%A, %b %e, %Y'
+        ],
+        month: [
+            '%B %Y',
+            '%B',
+            '-%B %Y'
+        ],
+        year: [
+            '%Y',
+            '%Y',
+            '-%Y'
+        ]
+    }
+    // smoothed = false, // enable this for navigator series only
+};
+/**
+ * Extends common options
+ * @private
+ */
+var seriesSpecific = {
+    line: {},
+    spline: {},
+    area: {},
+    areaspline: {},
+    arearange: {},
+    column: {
+        groupPixelWidth: 10
+    },
+    columnrange: {
+        groupPixelWidth: 10
+    },
+    candlestick: {
+        groupPixelWidth: 10
+    },
+    ohlc: {
+        groupPixelWidth: 5
+    },
+    hlc: {
+        groupPixelWidth: 5
+        // Move to HeikinAshiSeries.ts aftre refactoring data grouping.
+    },
+    heikinashi: {
+        groupPixelWidth: 10
+    }
+};
+/**
+ * Units are defined in a separate array to allow complete overriding in
+ * case of a user option.
+ * @private
+ */
+var units = [
+    [
+        'millisecond',
+        [1, 2, 5, 10, 20, 25, 50, 100, 200, 500] // allowed multiples
+    ], [
+        'second',
+        [1, 2, 5, 10, 15, 30]
+    ], [
+        'minute',
+        [1, 2, 5, 10, 15, 30]
+    ], [
+        'hour',
+        [1, 2, 3, 4, 6, 8, 12]
+    ], [
+        'day',
+        [1]
+    ], [
+        'week',
+        [1]
+    ], [
+        'month',
+        [1, 3, 6]
+    ], [
+        'year',
+        null
+    ]
+];
+/* *
+ *
+ *  Default Export
+ *
+ * */
+var DataGroupingDefaults = {
+    common: common,
+    seriesSpecific: seriesSpecific,
+    units: units
+};
+export default DataGroupingDefaults;