highcharts 10.2.1 → 10.3.1

package/es-modules/Stock/Navigator/NavigatorComposition.js

@@ -0,0 +1,218 @@
+/* *
+ *
+ *  (c) 2010-2021 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+import D from '../../Core/Defaults.js';
+var defaultOptions = D.defaultOptions, setOptions = D.setOptions;
+import H from '../../Core/Globals.js';
+var isTouchDevice = H.isTouchDevice;
+import NavigatorAxisAdditions from '../../Core/Axis/NavigatorAxisComposition.js';
+import NavigatorDefaults from './NavigatorDefaults.js';
+import NavigatorSymbols from './NavigatorSymbols.js';
+import RendererRegistry from '../../Core/Renderer/RendererRegistry.js';
+var getRendererType = RendererRegistry.getRendererType;
+import U from '../../Core/Utilities.js';
+var addEvent = U.addEvent, extend = U.extend, merge = U.merge, pick = U.pick;
+/* *
+ *
+ *  Constants
+ *
+ * */
+var composedClasses = [];
+/* *
+ *
+ *  Variables
+ *
+ * */
+var NavigatorConstructor;
+/* *
+ *
+ *  Functions
+ *
+ * */
+/**
+ * @private
+ */
+function compose(AxisClass, ChartClass, NavigatorClass, SeriesClass) {
+    NavigatorAxisAdditions.compose(AxisClass);
+    NavigatorConstructor = NavigatorClass;
+    if (composedClasses.indexOf(ChartClass) === -1) {
+        composedClasses.push(ChartClass);
+        var chartProto = ChartClass.prototype;
+        chartProto.callbacks.push(onChartCallback);
+        addEvent(ChartClass, 'afterAddSeries', onChartAfterAddSeries);
+        addEvent(ChartClass, 'afterSetChartSize', onChartAfterSetChartSize);
+        addEvent(ChartClass, 'afterUpdate', onChartAfterUpdate);
+        addEvent(ChartClass, 'beforeRender', onChartBeforeRender);
+        addEvent(ChartClass, 'beforeShowResetZoom', onChartBeforeShowResetZoom);
+        addEvent(ChartClass, 'update', onChartUpdate);
+    }
+    if (composedClasses.indexOf(SeriesClass) === -1) {
+        composedClasses.push(SeriesClass);
+        addEvent(SeriesClass, 'afterUpdate', onSeriesAfterUpdate);
+    }
+    if (composedClasses.indexOf(getRendererType) === -1) {
+        composedClasses.push(getRendererType);
+        extend(getRendererType().prototype.symbols, NavigatorSymbols);
+    }
+    if (composedClasses.indexOf(setOptions) === -1) {
+        composedClasses.push(setOptions);
+        extend(defaultOptions, { navigator: NavigatorDefaults });
+    }
+}
+/**
+ * Handle adding new series.
+ * @private
+ */
+function onChartAfterAddSeries() {
+    if (this.navigator) {
+        // Recompute which series should be shown in navigator, and add them
+        this.navigator.setBaseSeries(null, false);
+    }
+}
+/**
+ * For stock charts, extend the Chart.setChartSize method so that we can set the
+ * final top position of the navigator once the height of the chart, including
+ * the legend, is determined. #367. We can't use Chart.getMargins, because
+ * labels offsets are not calculated yet.
+ * @private
+ */
+function onChartAfterSetChartSize() {
+    var legend = this.legend, navigator = this.navigator;
+    var scrollbarHeight, legendOptions, xAxis, yAxis;
+    if (navigator) {
+        legendOptions = legend && legend.options;
+        xAxis = navigator.xAxis;
+        yAxis = navigator.yAxis;
+        scrollbarHeight = navigator.scrollbarHeight;
+        // Compute the top position
+        if (this.inverted) {
+            navigator.left = navigator.opposite ?
+                this.chartWidth - scrollbarHeight -
+                    navigator.height :
+                this.spacing[3] + scrollbarHeight;
+            navigator.top = this.plotTop + scrollbarHeight;
+        }
+        else {
+            navigator.left = pick(xAxis.left, this.plotLeft + scrollbarHeight);
+            navigator.top = navigator.navigatorOptions.top ||
+                this.chartHeight -
+                    navigator.height -
+                    scrollbarHeight -
+                    this.spacing[2] -
+                    (this.rangeSelector && this.extraBottomMargin ?
+                        this.rangeSelector.getHeight() :
+                        0) -
+                    ((legendOptions &&
+                        legendOptions.verticalAlign === 'bottom' &&
+                        legendOptions.layout !== 'proximate' && // #13392
+                        legendOptions.enabled &&
+                        !legendOptions.floating) ?
+                        legend.legendHeight +
+                            pick(legendOptions.margin, 10) :
+                        0) -
+                    (this.titleOffset ? this.titleOffset[2] : 0);
+        }
+        if (xAxis && yAxis) { // false if navigator is disabled (#904)
+            if (this.inverted) {
+                xAxis.options.left = yAxis.options.left = navigator.left;
+            }
+            else {
+                xAxis.options.top = yAxis.options.top = navigator.top;
+            }
+            xAxis.setAxisSize();
+            yAxis.setAxisSize();
+        }
+    }
+}
+/**
+ * Initialize navigator, if no scrolling exists yet.
+ * @private
+ */
+function onChartAfterUpdate(event) {
+    if (!this.navigator && !this.scroller &&
+        (this.options.navigator.enabled ||
+            this.options.scrollbar.enabled)) {
+        this.scroller = this.navigator = new NavigatorConstructor(this);
+        if (pick(event.redraw, true)) {
+            this.redraw(event.animation); // #7067
+        }
+    }
+}
+/**
+ * Initialize navigator for stock charts
+ * @private
+ */
+function onChartBeforeRender() {
+    var options = this.options;
+    if (options.navigator.enabled ||
+        options.scrollbar.enabled) {
+        this.scroller = this.navigator = new NavigatorConstructor(this);
+    }
+}
+/**
+ * For Stock charts. For x only zooming, do not to create the zoom button
+ * because X axis zooming is already allowed by the Navigator and Range
+ * selector. (#9285)
+ * @private
+ */
+function onChartBeforeShowResetZoom() {
+    var chartOptions = this.options, navigator = chartOptions.navigator, rangeSelector = chartOptions.rangeSelector;
+    if (((navigator && navigator.enabled) ||
+        (rangeSelector && rangeSelector.enabled)) &&
+        ((!isTouchDevice &&
+            chartOptions.chart.zooming.type === 'x') ||
+            (isTouchDevice &&
+                chartOptions.chart.zooming.pinchType === 'x'))) {
+        return false;
+    }
+}
+/**
+ * @private
+ */
+function onChartCallback(chart) {
+    var navigator = chart.navigator;
+    // Initialize the navigator
+    if (navigator && chart.xAxis[0]) {
+        var extremes = chart.xAxis[0].getExtremes();
+        navigator.render(extremes.min, extremes.max);
+    }
+}
+/**
+ * Merge options, if no scrolling exists yet
+ * @private
+ */
+function onChartUpdate(e) {
+    var navigatorOptions = (e.options.navigator || {}), scrollbarOptions = (e.options.scrollbar || {});
+    if (!this.navigator && !this.scroller &&
+        (navigatorOptions.enabled || scrollbarOptions.enabled)) {
+        merge(true, this.options.navigator, navigatorOptions);
+        merge(true, this.options.scrollbar, scrollbarOptions);
+        delete e.options.navigator;
+        delete e.options.scrollbar;
+    }
+}
+/**
+ * Handle updating series
+ * @private
+ */
+function onSeriesAfterUpdate() {
+    if (this.chart.navigator && !this.options.isInternal) {
+        this.chart.navigator.setBaseSeries(null, false);
+    }
+}
+/* *
+ *
+ *  Default Export
+ *
+ * */
+var NavigatorComposition = {
+    compose: compose
+};
+export default NavigatorComposition;

package/es-modules/Stock/Navigator/NavigatorDefaults.js

@@ -0,0 +1,490 @@
+/* *
+ *
+ *  (c) 2010-2021 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+import Color from '../../Core/Color/Color.js';
+var color = Color.parse;
+import SeriesRegistry from '../../Core/Series/SeriesRegistry.js';
+var seriesTypes = SeriesRegistry.seriesTypes;
+/* *
+ *
+ *  Constants
+ *
+ * */
+/**
+ * The navigator is a small series below the main series, displaying
+ * a view of the entire data set. It provides tools to zoom in and
+ * out on parts of the data as well as panning across the dataset.
+ *
+ * @product      highstock gantt
+ * @optionparent navigator
+ */
+var NavigatorDefaults = {
+    /**
+     * Whether the navigator and scrollbar should adapt to updated data
+     * in the base X axis. When loading data async, as in the demo below,
+     * this should be `false`. Otherwise new data will trigger navigator
+     * redraw, which will cause unwanted looping. In the demo below, the
+     * data in the navigator is set only once. On navigating, only the main
+     * chart content is updated.
+     *
+     * @sample {highstock} stock/demo/lazy-loading/
+     *         Set to false with async data loading
+     *
+     * @type      {boolean}
+     * @default   true
+     * @apioption navigator.adaptToUpdatedData
+     */
+    /**
+     * An integer identifying the index to use for the base series, or a
+     * string representing the id of the series.
+     *
+     * **Note**: As of Highcharts 5.0, this is now a deprecated option.
+     * Prefer [series.showInNavigator](#plotOptions.series.showInNavigator).
+     *
+     * @see [series.showInNavigator](#plotOptions.series.showInNavigator)
+     *
+     * @deprecated
+     * @type      {number|string}
+     * @default   0
+     * @apioption navigator.baseSeries
+     */
+    /**
+     * Enable or disable the navigator.
+     *
+     * @sample {highstock} stock/navigator/enabled/
+     *         Disable the navigator
+     *
+     * @type      {boolean}
+     * @default   true
+     * @apioption navigator.enabled
+     */
+    /**
+     * When the chart is inverted, whether to draw the navigator on the
+     * opposite side.
+     *
+     * @type      {boolean}
+     * @default   false
+     * @since     5.0.8
+     * @apioption navigator.opposite
+     */
+    /**
+     * The height of the navigator.
+     *
+     * @sample {highstock} stock/navigator/height/
+     *         A higher navigator
+     */
+    height: 40,
+    /**
+     * The distance from the nearest element, the X axis or X axis labels.
+     *
+     * @sample {highstock} stock/navigator/margin/
+     *         A margin of 2 draws the navigator closer to the X axis labels
+     */
+    margin: 25,
+    /**
+     * Whether the mask should be inside the range marking the zoomed
+     * range, or outside. In Highcharts Stock 1.x it was always `false`.
+     *
+     * @sample {highstock} stock/navigator/maskinside-false/
+     *         False, mask outside
+     *
+     * @since   2.0
+     */
+    maskInside: true,
+    /**
+     * Options for the handles for dragging the zoomed area.
+     *
+     * @sample {highstock} stock/navigator/handles/
+     *         Colored handles
+     */
+    handles: {
+        /**
+         * Width for handles.
+         *
+         * @sample {highstock} stock/navigator/styled-handles/
+         *         Styled handles
+         *
+         * @since   6.0.0
+         */
+        width: 7,
+        /**
+         * Height for handles.
+         *
+         * @sample {highstock} stock/navigator/styled-handles/
+         *         Styled handles
+         *
+         * @since   6.0.0
+         */
+        height: 15,
+        /**
+         * Array to define shapes of handles. 0-index for left, 1-index for
+         * right.
+         *
+         * Additionally, the URL to a graphic can be given on this form:
+         * `url(graphic.png)`. Note that for the image to be applied to
+         * exported charts, its URL needs to be accessible by the export
+         * server.
+         *
+         * Custom callbacks for symbol path generation can also be added to
+         * `Highcharts.SVGRenderer.prototype.symbols`. The callback is then
+         * used by its method name, as shown in the demo.
+         *
+         * @sample {highstock} stock/navigator/styled-handles/
+         *         Styled handles
+         *
+         * @type    {Array<string>}
+         * @default ["navigator-handle", "navigator-handle"]
+         * @since   6.0.0
+         */
+        symbols: ['navigator-handle', 'navigator-handle'],
+        /**
+         * Allows to enable/disable handles.
+         *
+         * @since   6.0.0
+         */
+        enabled: true,
+        /**
+         * The width for the handle border and the stripes inside.
+         *
+         * @sample {highstock} stock/navigator/styled-handles/
+         *         Styled handles
+         *
+         * @since     6.0.0
+         * @apioption navigator.handles.lineWidth
+         */
+        lineWidth: 1,
+        /**
+         * The fill for the handle.
+         *
+         * @type    {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+         */
+        backgroundColor: "#f2f2f2" /* Palette.neutralColor5 */,
+        /**
+         * The stroke for the handle border and the stripes inside.
+         *
+         * @type    {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+         */
+        borderColor: "#999999" /* Palette.neutralColor40 */
+    },
+    /**
+     * The color of the mask covering the areas of the navigator series
+     * that are currently not visible in the main series. The default
+     * color is bluish with an opacity of 0.3 to see the series below.
+     *
+     * @see In styled mode, the mask is styled with the
+     *      `.highcharts-navigator-mask` and
+     *      `.highcharts-navigator-mask-inside` classes.
+     *
+     * @sample {highstock} stock/navigator/maskfill/
+     *         Blue, semi transparent mask
+     *
+     * @type    {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+     * @default rgba(102,133,194,0.3)
+     */
+    maskFill: color("#6685c2" /* Palette.highlightColor60 */).setOpacity(0.3).get(),
+    /**
+     * The color of the line marking the currently zoomed area in the
+     * navigator.
+     *
+     * @sample {highstock} stock/navigator/outline/
+     *         2px blue outline
+     *
+     * @type    {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+     * @default #cccccc
+     */
+    outlineColor: "#cccccc" /* Palette.neutralColor20 */,
+    /**
+     * The width of the line marking the currently zoomed area in the
+     * navigator.
+     *
+     * @see In styled mode, the outline stroke width is set with the
+     *      `.highcharts-navigator-outline` class.
+     *
+     * @sample {highstock} stock/navigator/outline/
+     *         2px blue outline
+     *
+     * @type    {number}
+     */
+    outlineWidth: 1,
+    /**
+     * Options for the navigator series. Available options are the same
+     * as any series, documented at [plotOptions](#plotOptions.series)
+     * and [series](#series).
+     *
+     * Unless data is explicitly defined on navigator.series, the data
+     * is borrowed from the first series in the chart.
+     *
+     * Default series options for the navigator series are:
+     * ```js
+     * series: {
+     *     type: 'areaspline',
+     *     fillOpacity: 0.05,
+     *     dataGrouping: {
+     *         smoothed: true
+     *     },
+     *     lineWidth: 1,
+     *     marker: {
+     *         enabled: false
+     *     }
+     * }
+     * ```
+     *
+     * @see In styled mode, the navigator series is styled with the
+     *      `.highcharts-navigator-series` class.
+     *
+     * @sample {highstock} stock/navigator/series-data/
+     *         Using a separate data set for the navigator
+     * @sample {highstock} stock/navigator/series/
+     *         A green navigator series
+     *
+     * @type {*|Array<*>|Highcharts.SeriesOptionsType|Array<Highcharts.SeriesOptionsType>}
+     */
+    series: {
+        /**
+         * The type of the navigator series.
+         *
+         * Heads up:
+         * In column-type navigator, zooming is limited to at least one
+         * point with its `pointRange`.
+         *
+         * @sample {highstock} stock/navigator/column/
+         *         Column type navigator
+         *
+         * @type    {string}
+         * @default {highstock} `areaspline` if defined, otherwise `line`
+         * @default {gantt} gantt
+         */
+        type: (typeof seriesTypes.areaspline === 'undefined' ?
+            'line' :
+            'areaspline'),
+        /**
+         * The fill opacity of the navigator series.
+         */
+        fillOpacity: 0.05,
+        /**
+         * The pixel line width of the navigator series.
+         */
+        lineWidth: 1,
+        /**
+         * @ignore-option
+         */
+        compare: null,
+        /**
+         * Unless data is explicitly defined, the data is borrowed from the
+         * first series in the chart.
+         *
+         * @type      {Array<number|Array<number|string|null>|object|null>}
+         * @product   highstock
+         * @apioption navigator.series.data
+         */
+        /**
+         * Data grouping options for the navigator series.
+         *
+         * @extends plotOptions.series.dataGrouping
+         */
+        dataGrouping: {
+            approximation: 'average',
+            enabled: true,
+            groupPixelWidth: 2,
+            // Replace smoothed property by anchors, #12455.
+            firstAnchor: 'firstPoint',
+            anchor: 'middle',
+            lastAnchor: 'lastPoint',
+            // Day and week differs from plotOptions.series.dataGrouping
+            units: [
+                ['millisecond', [1, 2, 5, 10, 20, 25, 50, 100, 200, 500]],
+                ['second', [1, 2, 5, 10, 15, 30]],
+                ['minute', [1, 2, 5, 10, 15, 30]],
+                ['hour', [1, 2, 3, 4, 6, 8, 12]],
+                ['day', [1, 2, 3, 4]],
+                ['week', [1, 2, 3]],
+                ['month', [1, 3, 6]],
+                ['year', null]
+            ]
+        },
+        /**
+         * Data label options for the navigator series. Data labels are
+         * disabled by default on the navigator series.
+         *
+         * @extends plotOptions.series.dataLabels
+         */
+        dataLabels: {
+            enabled: false,
+            zIndex: 2 // #1839
+        },
+        id: 'highcharts-navigator-series',
+        className: 'highcharts-navigator-series',
+        /**
+         * Sets the fill color of the navigator series.
+         *
+         * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
+         * @apioption navigator.series.color
+         */
+        /**
+         * Line color for the navigator series. Allows setting the color
+         * while disallowing the default candlestick setting.
+         *
+         * @type {Highcharts.ColorString|null}
+         */
+        lineColor: null,
+        marker: {
+            enabled: false
+        },
+        /**
+         * Since Highcharts Stock v8, default value is the same as default
+         * `pointRange` defined for a specific type (e.g. `null` for
+         * column type).
+         *
+         * In Highcharts Stock version < 8, defaults to 0.
+         *
+         * @extends plotOptions.series.pointRange
+         * @type {number|null}
+         * @apioption navigator.series.pointRange
+         */
+        /**
+         * The threshold option. Setting it to 0 will make the default
+         * navigator area series draw its area from the 0 value and up.
+         *
+         * @type {number|null}
+         */
+        threshold: null
+    },
+    /**
+     * Enable or disable navigator sticking to right, while adding new
+     * points. If `undefined`, the navigator sticks to the axis maximum only
+     * if it was already at the maximum prior to adding points.
+     *
+     * @type      {boolean}
+     * @default   undefined
+     * @since 10.2.1
+     * @sample {highstock} stock/navigator/sticktomax-false/
+     * stickToMax set to false
+     * @apioption navigator.stickToMax
+     */
+    /**
+     * Options for the navigator X axis. Default series options for the
+     * navigator xAxis are:
+     * ```js
+     * xAxis: {
+     *     tickWidth: 0,
+     *     lineWidth: 0,
+     *     gridLineWidth: 1,
+     *     tickPixelInterval: 200,
+     *     labels: {
+     *            align: 'left',
+     *         style: {
+     *             color: '#888'
+     *         },
+     *         x: 3,
+     *         y: -4
+     *     }
+     * }
+     * ```
+     *
+     * @extends   xAxis
+     * @excluding linkedTo, maxZoom, minRange, opposite, range, scrollbar,
+     *            showEmpty, maxRange
+     */
+    xAxis: {
+        /**
+         * Additional range on the right side of the xAxis. Works similar to
+         * xAxis.maxPadding, but value is set in milliseconds.
+         * Can be set for both, main xAxis and navigator's xAxis.
+         *
+         * @since   6.0.0
+         */
+        overscroll: 0,
+        className: 'highcharts-navigator-xaxis',
+        tickLength: 0,
+        lineWidth: 0,
+        gridLineColor: "#e6e6e6" /* Palette.neutralColor10 */,
+        gridLineWidth: 1,
+        tickPixelInterval: 200,
+        labels: {
+            align: 'left',
+            /**
+             * @type {Highcharts.CSSObject}
+             */
+            style: {
+                /** @ignore */
+                color: "#999999" /* Palette.neutralColor40 */
+            },
+            x: 3,
+            y: -4
+        },
+        crosshair: false
+    },
+    /**
+     * Options for the navigator Y axis. Default series options for the
+     * navigator yAxis are:
+     * ```js
+     * yAxis: {
+     *     gridLineWidth: 0,
+     *     startOnTick: false,
+     *     endOnTick: false,
+     *     minPadding: 0.1,
+     *     maxPadding: 0.1,
+     *     labels: {
+     *         enabled: false
+     *     },
+     *     title: {
+     *         text: null
+     *     },
+     *     tickWidth: 0
+     * }
+     * ```
+     *
+     * @extends   yAxis
+     * @excluding height, linkedTo, maxZoom, minRange, ordinal, range,
+     *            showEmpty, scrollbar, top, units, maxRange, minLength,
+     *            maxLength, resize
+     */
+    yAxis: {
+        className: 'highcharts-navigator-yaxis',
+        gridLineWidth: 0,
+        startOnTick: false,
+        endOnTick: false,
+        minPadding: 0.1,
+        maxPadding: 0.1,
+        labels: {
+            enabled: false
+        },
+        crosshair: false,
+        title: {
+            text: null
+        },
+        tickLength: 0,
+        tickWidth: 0
+    }
+};
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default NavigatorDefaults;
+/* *
+ *
+ *  API Options
+ *
+ * */
+/**
+ * Maximum range which can be set using the navigator's handles.
+ * Opposite of [xAxis.minRange](#xAxis.minRange).
+ *
+ * @sample {highstock} stock/navigator/maxrange/
+ *         Defined max and min range
+ *
+ * @type      {number}
+ * @since     6.0.0
+ * @product   highstock gantt
+ * @apioption xAxis.maxRange
+ */
+(''); // keeps doclets above in JS file