highcharts 10.2.0 → 10.2.1

package/es-modules/Extensions/Boost/BoostOptions.js

@@ -1,245 +0,0 @@
-/* *
- *
- *  Copyright (c) 2019-2021 Highsoft AS
- *
- *  Boost module: stripped-down renderer for higher performance
- *
- *  License: highcharts.com/license
- *
- *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
-'use strict';
-import '../../Core/Globals.js';
-/**
- * Options for the Boost module. The Boost module allows certain series types
- * to be rendered by WebGL instead of the default SVG. This allows hundreds of
- * thousands of data points to be rendered in milliseconds. In addition to the
- * WebGL rendering it saves time by skipping processing and inspection of the
- * data wherever possible. This introduces some limitations to what features are
- * available in boost mode. See [the docs](
- * https://www.highcharts.com/docs/advanced-chart-features/boost-module) for
- * details.
- *
- * In addition to the global `boost` option, each series has a
- * [boostThreshold](#plotOptions.series.boostThreshold) that defines when the
- * boost should kick in.
- *
- * Requires the `modules/boost.js` module.
- *
- * @sample {highstock} highcharts/boost/line-series-heavy-stock
- *         Stock chart
- * @sample {highstock} highcharts/boost/line-series-heavy-dynamic
- *         Dynamic stock chart
- * @sample highcharts/boost/line
- *         Line chart
- * @sample highcharts/boost/line-series-heavy
- *         Line chart with hundreds of series
- * @sample highcharts/boost/scatter
- *         Scatter chart
- * @sample highcharts/boost/area
- *         Area chart
- * @sample highcharts/boost/arearange
- *         Area range chart
- * @sample highcharts/boost/column
- *         Column chart
- * @sample highcharts/boost/columnrange
- *         Column range chart
- * @sample highcharts/boost/bubble
- *         Bubble chart
- * @sample highcharts/boost/heatmap
- *         Heat map
- * @sample highcharts/boost/treemap
- *         Tree map
- *
- * @product   highcharts highstock
- * @requires  modules/boost
- * @apioption boost
- */
-/**
- * Set the series threshold for when the boost should kick in globally.
- *
- * Setting to e.g. 20 will cause the whole chart to enter boost mode
- * if there are 20 or more series active. When the chart is in boost mode,
- * every series in it will be rendered to a common canvas. This offers
- * a significant speed improvment in charts with a very high
- * amount of series.
- *
- * @type      {number}
- * @default   50
- * @apioption boost.seriesThreshold
- */
-/**
- * Enable or disable boost on a chart.
- *
- * @type      {boolean}
- * @default   true
- * @apioption boost.enabled
- */
-/**
- * Debugging options for boost.
- * Useful for benchmarking, and general timing.
- *
- * @apioption boost.debug
- */
-/**
- * Time the series rendering.
- *
- * This outputs the time spent on actual rendering in the console when
- * set to true.
- *
- * @type      {boolean}
- * @default   false
- * @apioption boost.debug.timeRendering
- */
-/**
- * Time the series processing.
- *
- * This outputs the time spent on transforming the series data to
- * vertex buffers when set to true.
- *
- * @type      {boolean}
- * @default   false
- * @apioption boost.debug.timeSeriesProcessing
- */
-/**
- * Time the the WebGL setup.
- *
- * This outputs the time spent on setting up the WebGL context,
- * creating shaders, and textures.
- *
- * @type      {boolean}
- * @default   false
- * @apioption boost.debug.timeSetup
- */
-/**
- * Time the building of the k-d tree.
- *
- * This outputs the time spent building the k-d tree used for
- * markers etc.
- *
- * Note that the k-d tree is built async, and runs post-rendering.
- * Following, it does not affect the performance of the rendering itself.
- *
- * @type      {boolean}
- * @default   false
- * @apioption boost.debug.timeKDTree
- */
-/**
- * Show the number of points skipped through culling.
- *
- * When set to true, the number of points skipped in series processing
- * is outputted. Points are skipped if they are closer than 1 pixel from
- * each other.
- *
- * @type      {boolean}
- * @default   false
- * @apioption boost.debug.showSkipSummary
- */
-/**
- * Time the WebGL to SVG buffer copy
- *
- * After rendering, the result is copied to an image which is injected
- * into the SVG.
- *
- * If this property is set to true, the time it takes for the buffer copy
- * to complete is outputted.
- *
- * @type      {boolean}
- * @default   false
- * @apioption boost.debug.timeBufferCopy
- */
-/**
- * The pixel ratio for the WebGL content. If 0, the `window.devicePixelRatio` is
- * used. This ensures sharp graphics on high DPI displays like Apple's Retina,
- * as well as when a page is zoomed.
- *
- * The default is left at 1 for now, as this is a new feature that has the
- * potential to break existing setups. Over time, when it has been battle
- * tested, the intention is to set it to 0 by default.
- *
- * Another use case for this option is to set it to 2 in order to make exported
- * and upscaled charts render sharp.
- *
- * One limitation when using the `pixelRatio` is that the line width of graphs
- * is scaled down. Since the Boost module currently can only render 1px line
- * widths, it is scaled down to a thin 0.5 pixels on a Retina display.
- *
- * @sample    highcharts/boost/line-devicepixelratio
- *            Enable the `devicePixelRatio`
- * @sample    highcharts/boost/line-export-pixelratio
- *            Sharper graphics in export
- *
- * @type      {number}
- * @since 10.0.0
- * @default   1
- * @apioption boost.pixelRatio
- */
-/**
- * Enable or disable GPU translations. GPU translations are faster than doing
- * the translation in JavaScript.
- *
- * This option may cause rendering issues with certain datasets.
- * Namely, if your dataset has large numbers with small increments (such as
- * timestamps), it won't work correctly. This is due to floating point
- * precission.
- *
- * @type      {boolean}
- * @default   false
- * @apioption boost.useGPUTranslations
- */
-/**
- * Enable or disable pre-allocation of vertex buffers.
- *
- * Enabling this will make it so that the binary data arrays required for
- * storing the series data will be allocated prior to transforming the data
- * to a WebGL-compatible format.
- *
- * This saves a copy operation on the order of O(n) and so is significantly more
- * performant. However, this is currently an experimental option, and may cause
- * visual artifacts with some datasets.
- *
- * As such, care should be taken when using this setting to make sure that
- * it doesn't cause any rendering glitches with the given use-case.
- *
- * @type      {boolean}
- * @default   false
- * @apioption boost.usePreallocated
- */
-/**
- * Set the point threshold for when a series should enter boost mode.
- *
- * Setting it to e.g. 2000 will cause the series to enter boost mode when there
- * are 2000 or more points in the series.
- *
- * To disable boosting on the series, set the `boostThreshold` to 0. Setting it
- * to 1 will force boosting.
- *
- * Note that the [cropThreshold](plotOptions.series.cropThreshold) also affects
- * this setting. When zooming in on a series that has fewer points than the
- * `cropThreshold`, all points are rendered although outside the visible plot
- * area, and the `boostThreshold` won't take effect.
- *
- * @type      {number}
- * @default   5000
- * @requires  modules/boost
- * @apioption plotOptions.series.boostThreshold
- */
-/**
- * If set to true, the whole chart will be boosted if one of the series
- * crosses its threshold, and all the series can be boosted.
- *
- * @type      {boolean}
- * @default   true
- * @apioption boost.allowForce
- */
-/**
- * Sets the color blending in the boost module.
- *
- * @type       {string}
- * @default    undefined
- * @validvalue ["add", "multiply", "darken"]
- * @requires   modules/boost
- * @apioption  plotOptions.series.boostBlending
- */
-''; // adds doclets above to transpiled file

package/es-modules/Extensions/Boost/BoostOverrides.js

@@ -1,386 +0,0 @@
-/* *
- *
- *  Copyright (c) 2019-2021 Highsoft AS
- *
- *  Boost module: stripped-down renderer for higher performance
- *
- *  License: highcharts.com/license
- *
- *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
-'use strict';
-import Chart from '../../Core/Chart/Chart.js';
-import D from '../../Core/DefaultOptions.js';
-var getOptions = D.getOptions;
-import Point from '../../Core/Series/Point.js';
-import Series from '../../Core/Series/Series.js';
-import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
-var seriesTypes = SeriesRegistry.seriesTypes;
-import U from '../../Core/Utilities.js';
-var addEvent = U.addEvent, error = U.error, isArray = U.isArray, isNumber = U.isNumber, pick = U.pick, wrap = U.wrap;
-import '../../Core/DefaultOptions.js';
-import butils from './BoostUtils.js';
-import boostable from './Boostables.js';
-import boostableMap from './BoostableMap.js';
-var boostEnabled = butils.boostEnabled, shouldForceChartSeriesBoosting = butils.shouldForceChartSeriesBoosting, plotOptions = getOptions().plotOptions;
-/**
- * Returns true if the chart is in series boost mode.
- *
- * @function Highcharts.Chart#isChartSeriesBoosting
- *
- * @param {Highcharts.Chart} chart
- *        the chart to check
- *
- * @return {boolean}
- *         true if the chart is in series boost mode
- */
-Chart.prototype.isChartSeriesBoosting = function () {
-    var isSeriesBoosting, threshold = pick(this.options.boost && this.options.boost.seriesThreshold, 50);
-    isSeriesBoosting = threshold <= this.series.length ||
-        shouldForceChartSeriesBoosting(this);
-    return isSeriesBoosting;
-};
-/* eslint-disable valid-jsdoc */
-/**
- * Get the clip rectangle for a target, either a series or the chart. For the
- * chart, we need to consider the maximum extent of its Y axes, in case of
- * Highcharts Stock panes and navigator.
- *
- * @private
- * @function Highcharts.Chart#getBoostClipRect
- */
-Chart.prototype.getBoostClipRect = function (target) {
-    var clipBox = {
-        x: this.plotLeft,
-        y: this.plotTop,
-        width: this.plotWidth,
-        height: this.plotHeight
-    };
-    if (target === this) {
-        var verticalAxes = this.inverted ? this.xAxis : this.yAxis; // #14444
-        if (verticalAxes.length <= 1) {
-            clipBox.y = Math.min(verticalAxes[0].pos, clipBox.y);
-            clipBox.height = (verticalAxes[0].pos -
-                this.plotTop +
-                verticalAxes[0].len);
-        }
-        else {
-            clipBox.height = this.plotHeight;
-        }
-    }
-    return clipBox;
-};
-/**
- * Return a full Point object based on the index.
- * The boost module uses stripped point objects for performance reasons.
- *
- * @function Highcharts.Series#getPoint
- *
- * @param {object|Highcharts.Point} boostPoint
- *        A stripped-down point object
- *
- * @return {Highcharts.Point}
- *         A Point object as per https://api.highcharts.com/highcharts#Point
- */
-Series.prototype.getPoint = function (boostPoint) {
-    var point = boostPoint, xData = (this.xData || this.options.xData || this.processedXData ||
-        false);
-    if (boostPoint && !(boostPoint instanceof this.pointClass)) {
-        point = (new this.pointClass()).init(// eslint-disable-line new-cap
-        this, this.options.data[boostPoint.i], xData ? xData[boostPoint.i] : void 0);
-        point.category = pick(this.xAxis.categories ?
-            this.xAxis.categories[point.x] :
-            point.x, // @todo simplify
-        point.x);
-        point.dist = boostPoint.dist;
-        point.distX = boostPoint.distX;
-        point.plotX = boostPoint.plotX;
-        point.plotY = boostPoint.plotY;
-        point.index = boostPoint.i;
-        point.isInside = this.isPointInside(boostPoint);
-    }
-    return point;
-};
-/* eslint-disable no-invalid-this */
-// Return a point instance from the k-d-tree
-wrap(Series.prototype, 'searchPoint', function (proceed) {
-    return this.getPoint(proceed.apply(this, [].slice.call(arguments, 1)));
-});
-// For inverted series, we need to swap X-Y values before running base methods
-wrap(Point.prototype, 'haloPath', function (proceed) {
-    var halo, point = this, series = point.series, chart = series.chart, plotX = point.plotX, plotY = point.plotY, inverted = chart.inverted;
-    if (series.isSeriesBoosting && inverted) {
-        point.plotX = series.yAxis.len - plotY;
-        point.plotY = series.xAxis.len - plotX;
-    }
-    halo = proceed.apply(this, Array.prototype.slice.call(arguments, 1));
-    if (series.isSeriesBoosting && inverted) {
-        point.plotX = plotX;
-        point.plotY = plotY;
-    }
-    return halo;
-});
-wrap(Series.prototype, 'markerAttribs', function (proceed, point) {
-    var attribs, series = this, chart = series.chart, plotX = point.plotX, plotY = point.plotY, inverted = chart.inverted;
-    if (series.isSeriesBoosting && inverted) {
-        point.plotX = series.yAxis.len - plotY;
-        point.plotY = series.xAxis.len - plotX;
-    }
-    attribs = proceed.apply(this, Array.prototype.slice.call(arguments, 1));
-    if (series.isSeriesBoosting && inverted) {
-        point.plotX = plotX;
-        point.plotY = plotY;
-    }
-    return attribs;
-});
-/*
- * Extend series.destroy to also remove the fake k-d-tree points (#5137).
- * Normally this is handled by Series.destroy that calls Point.destroy,
- * but the fake search points are not registered like that.
- */
-addEvent(Series, 'destroy', function () {
-    var series = this, chart = series.chart;
-    if (chart.markerGroup === series.markerGroup) {
-        series.markerGroup = null;
-    }
-    if (chart.hoverPoints) {
-        chart.hoverPoints = chart.hoverPoints.filter(function (point) {
-            return point.series === series;
-        });
-    }
-    if (chart.hoverPoint && chart.hoverPoint.series === series) {
-        chart.hoverPoint = null;
-    }
-});
-/*
- * Do not compute extremes when min and max are set.
- * If we use this in the core, we can add the hook
- * to hasExtremes to the methods directly.
- */
-wrap(Series.prototype, 'getExtremes', function (proceed) {
-    if (!this.isSeriesBoosting || (!this.hasExtremes || !this.hasExtremes())) {
-        return proceed.apply(this, Array.prototype.slice.call(arguments, 1));
-    }
-    return {};
-});
-/*
- * Override a bunch of methods the same way. If the number of points is
- * below the threshold, run the original method. If not, check for a
- * canvas version or do nothing.
- *
- * Note that we're not overriding any of these for heatmaps.
- */
-[
-    'translate',
-    'generatePoints',
-    'drawTracker',
-    'drawPoints',
-    'render'
-].forEach(function (method) {
-    /**
-     * @private
-     */
-    function branch(proceed) {
-        var letItPass = this.options.stacking &&
-            (method === 'translate' || method === 'generatePoints');
-        if (!this.isSeriesBoosting ||
-            letItPass ||
-            !boostEnabled(this.chart) ||
-            this.type === 'heatmap' ||
-            this.type === 'treemap' ||
-            !boostableMap[this.type] ||
-            this.options.boostThreshold === 0) {
-            proceed.call(this);
-            // If a canvas version of the method exists, like renderCanvas(), run
-        }
-        else if (this[method + 'Canvas']) {
-            this[method + 'Canvas']();
-        }
-    }
-    wrap(Series.prototype, method, branch);
-    // A special case for some types - their translate method is already wrapped
-    if (method === 'translate') {
-        [
-            'column',
-            'bar',
-            'arearange',
-            'columnrange',
-            'heatmap',
-            'treemap'
-        ].forEach(function (type) {
-            if (seriesTypes[type]) {
-                wrap(seriesTypes[type].prototype, method, branch);
-            }
-        });
-    }
-});
-// If the series is a heatmap or treemap, or if the series is not boosting
-// do the default behaviour. Otherwise, process if the series has no extremes.
-wrap(Series.prototype, 'processData', function (proceed) {
-    var series = this;
-    var dataToMeasure = this.options.data;
-    /**
-     * Used twice in this function, first on this.options.data, the second
-     * time it runs the check again after processedXData is built.
-     * If the data is going to be grouped, the series shouldn't be boosted.
-     * @private
-     */
-    function getSeriesBoosting(data) {
-        // Check if will be grouped.
-        if (series.forceCrop) {
-            return false;
-        }
-        return series.chart.isChartSeriesBoosting() || ((data ? data.length : 0) >=
-            (series.options.boostThreshold || Number.MAX_VALUE));
-    }
-    if (boostEnabled(this.chart) && boostableMap[this.type]) {
-        // If there are no extremes given in the options, we also need to
-        // process the data to read the data extremes. If this is a heatmap, do
-        // default behaviour.
-        if (!getSeriesBoosting(dataToMeasure) || // First pass with options.data
-            this.type === 'heatmap' ||
-            this.type === 'treemap' ||
-            this.options.stacking || // processedYData for the stack (#7481)
-            !this.hasExtremes ||
-            !this.hasExtremes(true)) {
-            proceed.apply(this, Array.prototype.slice.call(arguments, 1));
-            dataToMeasure = this.processedXData;
-        }
-        // Set the isBoosting flag, second pass with processedXData to see if we
-        // have zoomed.
-        this.isSeriesBoosting = getSeriesBoosting(dataToMeasure);
-        // Enter or exit boost mode
-        if (this.isSeriesBoosting) {
-            // Force turbo-mode:
-            var firstPoint = void 0;
-            if (this.options.data && this.options.data.length) {
-                firstPoint = this.getFirstValidPoint(this.options.data);
-                if (!isNumber(firstPoint) && !isArray(firstPoint)) {
-                    error(12, false, this.chart);
-                }
-            }
-            this.enterBoost();
-        }
-        else if (this.exitBoost) {
-            this.exitBoost();
-        }
-        // The series type is not boostable
-    }
-    else {
-        proceed.apply(this, Array.prototype.slice.call(arguments, 1));
-    }
-});
-addEvent(Series, 'hide', function () {
-    if (this.canvas && this.renderTarget) {
-        if (this.ogl) {
-            this.ogl.clear();
-        }
-        this.boostClear();
-    }
-});
-/**
- * Enter boost mode and apply boost-specific properties.
- *
- * @function Highcharts.Series#enterBoost
- */
-Series.prototype.enterBoost = function () {
-    this.alteredByBoost = [];
-    // Save the original values, including whether it was an own property or
-    // inherited from the prototype.
-    ['allowDG', 'directTouch', 'stickyTracking'].forEach(function (prop) {
-        this.alteredByBoost.push({
-            prop: prop,
-            val: this[prop],
-            own: Object.hasOwnProperty.call(this, prop)
-        });
-    }, this);
-    this.allowDG = false;
-    this.directTouch = false;
-    this.stickyTracking = true;
-    // Prevent animation when zooming in on boosted series(#13421).
-    this.finishedAnimating = true;
-    // Hide series label if any
-    if (this.labelBySeries) {
-        this.labelBySeries = this.labelBySeries.destroy();
-    }
-};
-/**
- * Exit from boost mode and restore non-boost properties.
- *
- * @function Highcharts.Series#exitBoost
- */
-Series.prototype.exitBoost = function () {
-    // Reset instance properties and/or delete instance properties and go back
-    // to prototype
-    (this.alteredByBoost || []).forEach(function (setting) {
-        if (setting.own) {
-            this[setting.prop] = setting.val;
-        }
-        else {
-            // Revert to prototype
-            delete this[setting.prop];
-        }
-    }, this);
-    // Clear previous run
-    if (this.boostClear) {
-        this.boostClear();
-    }
-};
-/**
- * @private
- * @function Highcharts.Series#hasExtremes
- */
-Series.prototype.hasExtremes = function (checkX) {
-    var options = this.options, data = options.data, xAxis = this.xAxis && this.xAxis.options, yAxis = this.yAxis && this.yAxis.options, colorAxis = this.colorAxis && this.colorAxis.options;
-    return data.length > (options.boostThreshold || Number.MAX_VALUE) &&
-        // Defined yAxis extremes
-        isNumber(yAxis.min) &&
-        isNumber(yAxis.max) &&
-        // Defined (and required) xAxis extremes
-        (!checkX ||
-            (isNumber(xAxis.min) && isNumber(xAxis.max))) &&
-        // Defined (e.g. heatmap) colorAxis extremes
-        (!colorAxis ||
-            (isNumber(colorAxis.min) && isNumber(colorAxis.max)));
-};
-/**
- * If implemented in the core, parts of this can probably be
- * shared with other similar methods in Highcharts.
- *
- * @function Highcharts.Series#destroyGraphics
- */
-Series.prototype.destroyGraphics = function () {
-    var _this = this;
-    var series = this, points = this.points, point, i;
-    if (points) {
-        for (i = 0; i < points.length; i = i + 1) {
-            point = points[i];
-            if (point && point.destroyElements) {
-                point.destroyElements(); // #7557
-            }
-        }
-    }
-    ['graph', 'area', 'tracker'].forEach(function (prop) {
-        if (series[prop]) {
-            series[prop] = series[prop].destroy();
-        }
-    });
-    if (this.getZonesGraphs) {
-        var props = this.getZonesGraphs([['graph', 'highcharts-graph']]);
-        props.forEach(function (prop) {
-            var zoneGraph = _this[prop[0]];
-            if (zoneGraph) {
-                _this[prop[0]] = zoneGraph.destroy();
-            }
-        });
-    }
-};
-// Set default options
-boostable.forEach(function (type) {
-    if (plotOptions[type]) {
-        plotOptions[type].boostThreshold = 5000;
-        plotOptions[type].boostData = [];
-        seriesTypes[type].prototype.fillOpacity = true;
-    }
-});