/** * @license Highcharts Gantt JS v11.4.1 (2024-04-04) * * Gantt series * * (c) 2016-2024 Lars A. V. Cabrera * * License: www.highcharts.com/license */ (function (factory) { if (typeof module === 'object' && module.exports) { factory['default'] = factory; module.exports = factory; } else if (typeof define === 'function' && define.amd) { define('highcharts/modules/gantt', ['highcharts'], function (Highcharts) { factory(Highcharts); factory.Highcharts = Highcharts; return factory; }); } else { factory(typeof Highcharts !== 'undefined' ? Highcharts : undefined); } }(function (Highcharts) { 'use strict'; var _modules = Highcharts ? Highcharts._modules : {}; function _registerModule(obj, path, args, fn) { if (!obj.hasOwnProperty(path)) { obj[path] = fn.apply(null, args); if (typeof CustomEvent === 'function') { window.dispatchEvent(new CustomEvent( 'HighchartsModuleLoaded', { detail: { path: path, module: obj[path] } } )); } } } _registerModule(_modules, 'Extensions/ArrowSymbols.js', [], function () { /* * * * (c) 2017 Highsoft AS * Authors: Lars A. V. Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ /* * * * Functions * * */ /** * Creates an arrow symbol. Like a triangle, except not filled. * ``` * o * o * o * o * o * o * o * ``` * * @private * @function * * @param {number} x * x position of the arrow * * @param {number} y * y position of the arrow * * @param {number} w * width of the arrow * * @param {number} h * height of the arrow * * @return {Highcharts.SVGPathArray} * Path array */ function arrow(x, y, w, h) { return [ ['M', x, y + h / 2], ['L', x + w, y], ['L', x, y + h / 2], ['L', x + w, y + h] ]; } /** * Creates a half-width arrow symbol. Like a triangle, except not filled. * ``` * o * o * o * o * o * ``` * * @private * @function * * @param {number} x * x position of the arrow * * @param {number} y * y position of the arrow * * @param {number} w * width of the arrow * * @param {number} h * height of the arrow * * @return {Highcharts.SVGPathArray} * Path array */ function arrowHalf(x, y, w, h) { return arrow(x, y, w / 2, h); } /** * @private */ function compose(SVGRendererClass) { const symbols = SVGRendererClass.prototype.symbols; symbols.arrow = arrow; symbols['arrow-filled'] = triangleLeft; symbols['arrow-filled-half'] = triangleLeftHalf; symbols['arrow-half'] = arrowHalf; symbols['triangle-left'] = triangleLeft; symbols['triangle-left-half'] = triangleLeftHalf; } /** * Creates a left-oriented triangle. * ``` * o * ooooooo * ooooooooooooo * ooooooo * o * ``` * * @private * @function * * @param {number} x * x position of the triangle * * @param {number} y * y position of the triangle * * @param {number} w * width of the triangle * * @param {number} h * height of the triangle * * @return {Highcharts.SVGPathArray} * Path array */ function triangleLeft(x, y, w, h) { return [ ['M', x + w, y], ['L', x, y + h / 2], ['L', x + w, y + h], ['Z'] ]; } /** * Creates a half-width, left-oriented triangle. * ``` * o * oooo * ooooooo * oooo * o * ``` * * @private * @function * * @param {number} x * x position of the triangle * * @param {number} y * y position of the triangle * * @param {number} w * width of the triangle * * @param {number} h * height of the triangle * * @return {Highcharts.SVGPathArray} * Path array */ function triangleLeftHalf(x, y, w, h) { return triangleLeft(x, y, w / 2, h); } /* * * * Default Export * * */ const ArrowSymbols = { compose }; return ArrowSymbols; }); _registerModule(_modules, 'Gantt/Connection.js', [_modules['Core/Globals.js'], _modules['Core/Utilities.js']], function (H, U) { /* * * * (c) 2016 Highsoft AS * Authors: Øystein Moseng, Lars A. V. Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { defined, error, merge, objectEach } = U; /* * * * Constants * * */ const deg2rad = H.deg2rad, max = Math.max, min = Math.min; /* * * * Class * * */ /** * The Connection class. Used internally to represent a connection between two * points. * * @private * @class * @name Highcharts.Connection * * @param {Highcharts.Point} from * Connection runs from this Point. * * @param {Highcharts.Point} to * Connection runs to this Point. * * @param {Highcharts.ConnectorsOptions} [options] * Connection options. */ class Connection { constructor(from, to, options) { this.init(from, to, options); } /** * Initialize the Connection object. Used as constructor only. * * @function Highcharts.Connection#init * * @param {Highcharts.Point} from * Connection runs from this Point. * * @param {Highcharts.Point} to * Connection runs to this Point. * * @param {Highcharts.ConnectorsOptions} [options] * Connection options. */ init(from, to, options) { this.fromPoint = from; this.toPoint = to; this.options = options; this.chart = from.series.chart; this.pathfinder = this.chart.pathfinder; } /** * Add (or update) this connection's path on chart. Stores reference to the * created element on this.graphics.path. * * @function Highcharts.Connection#renderPath * * @param {Highcharts.SVGPathArray} path * Path to render, in array format. E.g. ['M', 0, 0, 'L', 10, 10] * * @param {Highcharts.SVGAttributes} [attribs] * SVG attributes for the path. * * @param {Partial} [animation] * Animation options for the rendering. */ renderPath(path, attribs) { const connection = this, chart = this.chart, styledMode = chart.styledMode, pathfinder = this.pathfinder, anim = {}; let pathGraphic = connection.graphics && connection.graphics.path; // Add the SVG element of the pathfinder group if it doesn't exist if (!pathfinder.group) { pathfinder.group = chart.renderer.g() .addClass('highcharts-pathfinder-group') .attr({ zIndex: -1 }) .add(chart.seriesGroup); } // Shift the group to compensate for plot area. // Note: Do this always (even when redrawing a path) to avoid issues // when updating chart in a way that changes plot metrics. pathfinder.group.translate(chart.plotLeft, chart.plotTop); // Create path if does not exist if (!(pathGraphic && pathGraphic.renderer)) { pathGraphic = chart.renderer.path() .add(pathfinder.group); if (!styledMode) { pathGraphic.attr({ opacity: 0 }); } } // Set path attribs and animate to the new path pathGraphic.attr(attribs); anim.d = path; if (!styledMode) { anim.opacity = 1; } pathGraphic.animate(anim); // Store reference on connection this.graphics = this.graphics || {}; this.graphics.path = pathGraphic; } /** * Calculate and add marker graphics for connection to the chart. The * created/updated elements are stored on this.graphics.start and * this.graphics.end. * * @function Highcharts.Connection#addMarker * * @param {string} type * Marker type, either 'start' or 'end'. * * @param {Highcharts.ConnectorsMarkerOptions} options * All options for this marker. Not calculated or merged with other * options. * * @param {Highcharts.SVGPathArray} path * Connection path in array format. This is used to calculate the * rotation angle of the markers. */ addMarker(type, options, path) { const connection = this, chart = connection.fromPoint.series.chart, pathfinder = chart.pathfinder, renderer = chart.renderer, point = (type === 'start' ? connection.fromPoint : connection.toPoint), anchor = point.getPathfinderAnchorPoint(options); let markerVector, radians, rotation, box, width, height, pathVector, segment; if (!options.enabled) { return; } // Last vector before start/end of path, used to get angle if (type === 'start') { segment = path[1]; } else { // 'end' segment = path[path.length - 2]; } if (segment && segment[0] === 'M' || segment[0] === 'L') { pathVector = { x: segment[1], y: segment[2] }; // Get angle between pathVector and anchor point and use it to // create marker position. radians = point.getRadiansToVector(pathVector, anchor); markerVector = point.getMarkerVector(radians, options.radius, anchor); // Rotation of marker is calculated from angle between pathVector // and markerVector. // (Note: // Used to recalculate radians between markerVector and pathVector, // but this should be the same as between pathVector and anchor.) rotation = -radians / deg2rad; if (options.width && options.height) { width = options.width; height = options.height; } else { width = height = options.radius * 2; } // Add graphics object if it does not exist connection.graphics = connection.graphics || {}; box = { x: markerVector.x - (width / 2), y: markerVector.y - (height / 2), width: width, height: height, rotation: rotation, rotationOriginX: markerVector.x, rotationOriginY: markerVector.y }; if (!connection.graphics[type]) { // Create new marker element connection.graphics[type] = renderer .symbol(options.symbol) .addClass('highcharts-point-connecting-path-' + type + '-marker' + ' highcharts-color-' + this.fromPoint.colorIndex) .attr(box) .add(pathfinder.group); if (!renderer.styledMode) { connection.graphics[type].attr({ fill: options.color || connection.fromPoint.color, stroke: options.lineColor, 'stroke-width': options.lineWidth, opacity: 0 }) .animate({ opacity: 1 }, point.series.options.animation); } } else { connection.graphics[type].animate(box); } } } /** * Calculate and return connection path. * Note: Recalculates chart obstacles on demand if they aren't calculated. * * @function Highcharts.Connection#getPath * * @param {Highcharts.ConnectorsOptions} options * Connector options. Not calculated or merged with other options. * * @return {object|undefined} * Calculated SVG path data in array format. */ getPath(options) { const pathfinder = this.pathfinder, chart = this.chart, algorithm = pathfinder.algorithms[options.type]; let chartObstacles = pathfinder.chartObstacles; if (typeof algorithm !== 'function') { error('"' + options.type + '" is not a Pathfinder algorithm.'); return { path: [], obstacles: [] }; } // This function calculates obstacles on demand if they don't exist if (algorithm.requiresObstacles && !chartObstacles) { chartObstacles = pathfinder.chartObstacles = pathfinder.getChartObstacles(options); // If the algorithmMargin was computed, store the result in default // options. chart.options.connectors.algorithmMargin = options.algorithmMargin; // Cache some metrics too pathfinder.chartObstacleMetrics = pathfinder.getObstacleMetrics(chartObstacles); } // Get the SVG path return algorithm( // From this.fromPoint.getPathfinderAnchorPoint(options.startMarker), // To this.toPoint.getPathfinderAnchorPoint(options.endMarker), merge({ chartObstacles: chartObstacles, lineObstacles: pathfinder.lineObstacles || [], obstacleMetrics: pathfinder.chartObstacleMetrics, hardBounds: { xMin: 0, xMax: chart.plotWidth, yMin: 0, yMax: chart.plotHeight }, obstacleOptions: { margin: options.algorithmMargin }, startDirectionX: pathfinder.getAlgorithmStartDirection(options.startMarker) }, options)); } /** * (re)Calculate and (re)draw the connection. * * @function Highcharts.Connection#render */ render() { const connection = this, fromPoint = connection.fromPoint, series = fromPoint.series, chart = series.chart, pathfinder = chart.pathfinder, attribs = {}; let options = merge(chart.options.connectors, series.options.connectors, fromPoint.options.connectors, connection.options); // Set path attribs if (!chart.styledMode) { attribs.stroke = options.lineColor || fromPoint.color; attribs['stroke-width'] = options.lineWidth; if (options.dashStyle) { attribs.dashstyle = options.dashStyle; } } attribs['class'] = // eslint-disable-line dot-notation 'highcharts-point-connecting-path ' + 'highcharts-color-' + fromPoint.colorIndex; options = merge(attribs, options); // Set common marker options if (!defined(options.marker.radius)) { options.marker.radius = min(max(Math.ceil((options.algorithmMargin || 8) / 2) - 1, 1), 5); } // Get the path const pathResult = connection.getPath(options), path = pathResult.path; // Always update obstacle storage with obstacles from this path. // We don't know if future calls will need this for their algorithm. if (pathResult.obstacles) { pathfinder.lineObstacles = pathfinder.lineObstacles || []; pathfinder.lineObstacles = pathfinder.lineObstacles.concat(pathResult.obstacles); } // Add the calculated path to the pathfinder group connection.renderPath(path, attribs); // Render the markers connection.addMarker('start', merge(options.marker, options.startMarker), path); connection.addMarker('end', merge(options.marker, options.endMarker), path); } /** * Destroy connection by destroying the added graphics elements. * * @function Highcharts.Connection#destroy */ destroy() { if (this.graphics) { objectEach(this.graphics, function (val) { val.destroy(); }); delete this.graphics; } } } /* * * * Default Export * * */ /* * * * API Declarations * * */ /** * The default pathfinder algorithm to use for a chart. It is possible to define * your own algorithms by adding them to the * `Highcharts.Pathfinder.prototype.algorithms` * object before the chart has been created. * * The default algorithms are as follows: * * `straight`: Draws a straight line between the connecting * points. Does not avoid other points when drawing. * * `simpleConnect`: Finds a path between the points using right angles * only. Takes only starting/ending points into * account, and will not avoid other points. * * `fastAvoid`: Finds a path between the points using right angles * only. Will attempt to avoid other points, but its * focus is performance over accuracy. Works well with * less dense datasets. * * @typedef {"fastAvoid"|"simpleConnect"|"straight"|string} Highcharts.PathfinderTypeValue */ ''; // Keeps doclets above in JS file return Connection; }); _registerModule(_modules, 'Extensions/CurrentDateIndication.js', [_modules['Core/Globals.js'], _modules['Core/Utilities.js']], function (H, U) { /* * * * (c) 2016-2024 Highsoft AS * * Author: Lars A. V. Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { composed } = H; const { addEvent, merge, pushUnique, wrap } = U; /* * * * Constants * * */ /** * Show an indicator on the axis for the current date and time. Can be a * boolean or a configuration object similar to * [xAxis.plotLines](#xAxis.plotLines). * * @sample gantt/current-date-indicator/demo * Current date indicator enabled * @sample gantt/current-date-indicator/object-config * Current date indicator with custom options * * @declare Highcharts.CurrentDateIndicatorOptions * @type {boolean|CurrentDateIndicatorOptions} * @default true * @extends xAxis.plotLines * @excluding value * @product gantt * @apioption xAxis.currentDateIndicator */ const defaultOptions = { color: "#ccd3ff" /* Palette.highlightColor20 */, width: 2, /** * @declare Highcharts.AxisCurrentDateIndicatorLabelOptions */ label: { /** * Format of the label. This options is passed as the fist argument to * [dateFormat](/class-reference/Highcharts.Time#dateFormat) function. * * @type {string} * @default %a, %b %d %Y, %H:%M * @product gantt * @apioption xAxis.currentDateIndicator.label.format */ format: '%a, %b %d %Y, %H:%M', formatter: function (value, format) { return this.axis.chart.time.dateFormat(format || '', value); }, rotation: 0, /** * @type {Highcharts.CSSObject} */ style: { /** @internal */ fontSize: '0.7em' } } }; /* * * * Functions * * */ /** * @private */ function compose(AxisClass, PlotLineOrBandClass) { if (pushUnique(composed, 'CurrentDateIndication')) { addEvent(AxisClass, 'afterSetOptions', onAxisAfterSetOptions); addEvent(PlotLineOrBandClass, 'render', onPlotLineOrBandRender); wrap(PlotLineOrBandClass.prototype, 'getLabelText', wrapPlotLineOrBandGetLabelText); } } /** * @private */ function onAxisAfterSetOptions() { const options = this.options, cdiOptions = options.currentDateIndicator; if (cdiOptions) { const plotLineOptions = typeof cdiOptions === 'object' ? merge(defaultOptions, cdiOptions) : merge(defaultOptions); plotLineOptions.value = Date.now(); plotLineOptions.className = 'highcharts-current-date-indicator'; if (!options.plotLines) { options.plotLines = []; } options.plotLines.push(plotLineOptions); } } /** * @private */ function onPlotLineOrBandRender() { // If the label already exists, update its text if (this.label) { this.label.attr({ text: this.getLabelText(this.options.label) }); } } /** * @private */ function wrapPlotLineOrBandGetLabelText(defaultMethod, defaultLabelOptions) { const options = this.options; if (options && options.className && options.className.indexOf('highcharts-current-date-indicator') !== -1 && options.label && typeof options.label.formatter === 'function') { options.value = Date.now(); return options.label.formatter .call(this, options.value, options.label.format); } return defaultMethod.call(this, defaultLabelOptions); } /* * * * Default Export * * */ const CurrentDateIndication = { compose }; return CurrentDateIndication; }); _registerModule(_modules, 'Core/Chart/GanttChart.js', [_modules['Core/Chart/Chart.js'], _modules['Core/Defaults.js'], _modules['Core/Utilities.js']], function (Chart, D, U) { /* * * * (c) 2016-2024 Highsoft AS * * Author: Lars A. V. Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { defaultOptions } = D; const { isArray, merge, splat } = U; /* * * * Class * * */ /** * Gantt-optimized chart. Use {@link Highcharts.Chart|Chart} for common charts. * * @requires modules/gantt * * @class * @name Highcharts.GanttChart * @extends Highcharts.Chart */ class GanttChart extends Chart { /* * * * Functions * * */ /** * Initializes the chart. The constructor's arguments are passed on * directly. * * @function Highcharts.GanttChart#init * * @param {Highcharts.Options} userOptions * Custom options. * * @param {Function} [callback] * Function to run when the chart has loaded and all external * images are loaded. * * * @emits Highcharts.GanttChart#event:init * @emits Highcharts.GanttChart#event:afterInit */ init(userOptions, callback) { const xAxisOptions = userOptions.xAxis, yAxisOptions = userOptions.yAxis; let defaultLinkedTo; // Avoid doing these twice userOptions.xAxis = userOptions.yAxis = void 0; const options = merge(true, { chart: { type: 'gantt' }, title: { text: '' }, legend: { enabled: false }, navigator: { series: { type: 'gantt' }, // Bars were clipped, #14060. yAxis: { type: 'category' } } }, userOptions, // User's options // forced options { isGantt: true }); userOptions.xAxis = xAxisOptions; userOptions.yAxis = yAxisOptions; // Apply X axis options to both single and multi x axes If user hasn't // defined axes as array, make it into an array and add a second axis by // default. options.xAxis = (!isArray(userOptions.xAxis) ? [userOptions.xAxis || {}, {}] : userOptions.xAxis).map((xAxisOptions, i) => { if (i === 1) { // Second xAxis defaultLinkedTo = 0; } return merge( // Defaults { grid: { borderColor: "#cccccc" /* Palette.neutralColor20 */, enabled: true }, opposite: defaultOptions.xAxis?.opposite ?? xAxisOptions.opposite ?? true, linkedTo: defaultLinkedTo }, // User options xAxisOptions, // Forced options { type: 'datetime' }); }); // Apply Y axis options to both single and multi y axes options.yAxis = (splat(userOptions.yAxis || {})).map((yAxisOptions) => merge( // Defaults { grid: { borderColor: "#cccccc" /* Palette.neutralColor20 */, enabled: true }, staticScale: 50, reversed: true, // Set default type treegrid, but only if 'categories' is // undefined type: yAxisOptions.categories ? yAxisOptions.type : 'treegrid' }, // User options yAxisOptions)); super.init(options, callback); } } /* * * * Class Namespace * * */ (function (GanttChart) { /* * * * Functions * * */ /* eslint-disable jsdoc/check-param-names */ /** * The factory function for creating new gantt charts. Creates a new {@link * Highcharts.GanttChart|GanttChart} object with different default options * than the basic Chart. * * @example * // Render a chart in to div#container * let chart = Highcharts.ganttChart('container', { * title: { * text: 'My chart' * }, * series: [{ * data: ... * }] * }); * * @function Highcharts.ganttChart * * @param {string|Highcharts.HTMLDOMElement} renderTo * The DOM element to render to, or its id. * * @param {Highcharts.Options} options * The chart options structure. * * @param {Highcharts.ChartCallbackFunction} [callback] * Function to run when the chart has loaded and all external * images are loaded. Defining a * [chart.events.load](https://api.highcharts.com/highcharts/chart.events.load) * handler is equivalent. * * @return {Highcharts.GanttChart} * Returns the Chart object. */ function ganttChart(a, b, c) { return new GanttChart(a, b, c); } GanttChart.ganttChart = ganttChart; /* eslint-enable jsdoc/check-param-names */ })(GanttChart || (GanttChart = {})); /* * * * Default Export * * */ return GanttChart; }); _registerModule(_modules, 'Stock/Navigator/ChartNavigatorComposition.js', [_modules['Core/Globals.js'], _modules['Core/Utilities.js']], function (H, U) { /* * * * (c) 2010-2024 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { isTouchDevice } = H; const { addEvent, merge, pick } = U; /* * * * Constants * * */ const composedMembers = []; /* * * * Variables * * */ let NavigatorConstructor; /* * * * Functions * * */ /** * @private */ function compose(ChartClass, NavigatorClass) { if (U.pushUnique(composedMembers, ChartClass)) { const chartProto = ChartClass.prototype; NavigatorConstructor = NavigatorClass; 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); } } /** * 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() { const legend = this.legend, navigator = this.navigator; let legendOptions, xAxis, yAxis; if (navigator) { legendOptions = legend && legend.options; xAxis = navigator.xAxis; yAxis = navigator.yAxis; const { scrollbarHeight, scrollButtonSize } = navigator; // Compute the top position if (this.inverted) { navigator.left = navigator.opposite ? this.chartWidth - scrollbarHeight - navigator.height : this.spacing[3] + scrollbarHeight; navigator.top = this.plotTop + scrollButtonSize; } else { navigator.left = pick(xAxis.left, this.plotLeft + scrollButtonSize); navigator.top = navigator.navigatorOptions.top || this.chartHeight - navigator.height - scrollbarHeight - (this.scrollbar?.options.margin || 0) - 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() { const 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() { const chartOptions = this.options, navigator = chartOptions.navigator, rangeSelector = chartOptions.rangeSelector; if (((navigator && navigator.enabled) || (rangeSelector && rangeSelector.enabled)) && ((!isTouchDevice && this.zooming.type === 'x') || (isTouchDevice && this.zooming.pinchType === 'x'))) { return false; } } /** * @private */ function onChartCallback(chart) { const navigator = chart.navigator; // Initialize the navigator if (navigator && chart.xAxis[0]) { const extremes = chart.xAxis[0].getExtremes(); navigator.render(extremes.min, extremes.max); } } /** * Merge options, if no scrolling exists yet * @private */ function onChartUpdate(e) { const 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; } } /* * * * Default Export * * */ const ChartNavigatorComposition = { compose }; return ChartNavigatorComposition; }); _registerModule(_modules, 'Core/Axis/NavigatorAxisComposition.js', [_modules['Core/Globals.js'], _modules['Core/Utilities.js']], function (H, U) { /* * * * (c) 2010-2024 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { isTouchDevice } = H; const { addEvent, correctFloat, defined, isNumber, pick } = U; /* * * * Functions * * */ /** * @private */ function onAxisInit() { const axis = this; if (!axis.navigatorAxis) { axis.navigatorAxis = new NavigatorAxisAdditions(axis); } } /** * For Stock charts, override selection zooming with some special features * because X axis zooming is already allowed by the Navigator and Range * selector. * @private */ function onAxisSetExtremes(e) { const axis = this, chart = axis.chart, chartOptions = chart.options, navigator = chartOptions.navigator, navigatorAxis = axis.navigatorAxis, pinchType = chart.zooming.pinchType, rangeSelector = chartOptions.rangeSelector, zoomType = chart.zooming.type; let zoomed; if (axis.isXAxis && (navigator?.enabled || rangeSelector?.enabled)) { // For y only zooming, ignore the X axis completely if (zoomType === 'y' && e.trigger === 'zoom') { zoomed = false; // For xy zooming, record the state of the zoom before zoom selection, // then when the reset button is pressed, revert to this state. This // should apply only if the chart is initialized with a range (#6612), // otherwise zoom all the way out. } else if (((e.trigger === 'zoom' && zoomType === 'xy') || (isTouchDevice && pinchType === 'xy')) && axis.options.range) { const previousZoom = navigatorAxis.previousZoom; // Minimum defined, zooming in if (defined(e.min)) { navigatorAxis.previousZoom = [axis.min, axis.max]; // Minimum undefined, resetting zoom } else if (previousZoom) { e.min = previousZoom[0]; e.max = previousZoom[1]; navigatorAxis.previousZoom = void 0; } } } if (typeof zoomed !== 'undefined') { e.preventDefault(); } } /* * * * Class * * */ /** * @private * @class */ class NavigatorAxisAdditions { /* * * * Static Functions * * */ /** * @private */ static compose(AxisClass) { if (!AxisClass.keepProps.includes('navigatorAxis')) { AxisClass.keepProps.push('navigatorAxis'); addEvent(AxisClass, 'init', onAxisInit); addEvent(AxisClass, 'setExtremes', onAxisSetExtremes); } } /* * * * Constructors * * */ constructor(axis) { this.axis = axis; } /* * * * Functions * * */ /** * @private */ destroy() { this.axis = void 0; } /** * Add logic to normalize the zoomed range in order to preserve the pressed * state of range selector buttons * * @private * @function Highcharts.Axis#toFixedRange */ toFixedRange(pxMin, pxMax, fixedMin, fixedMax) { const axis = this.axis, halfPointRange = (axis.pointRange || 0) / 2; let newMin = pick(fixedMin, axis.translate(pxMin, true, !axis.horiz)), newMax = pick(fixedMax, axis.translate(pxMax, true, !axis.horiz)); // Add/remove half point range to/from the extremes (#1172) if (!defined(fixedMin)) { newMin = correctFloat(newMin + halfPointRange); } if (!defined(fixedMax)) { newMax = correctFloat(newMax - halfPointRange); } if (!isNumber(newMin) || !isNumber(newMax)) { // #1195, #7411 newMin = newMax = void 0; } return { min: newMin, max: newMax }; } } /* * * * Default Export * * */ return NavigatorAxisAdditions; }); _registerModule(_modules, 'Stock/Navigator/NavigatorDefaults.js', [_modules['Core/Color/Color.js'], _modules['Core/Series/SeriesRegistry.js']], function (Color, SeriesRegistry) { /* * * * (c) 2010-2024 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { parse: color } = Color; const { seriesTypes } = SeriesRegistry; /* * * * 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 */ const 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/demo/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} * @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("#667aff" /* 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: "#999999" /* Palette.neutralColor40 */, /** * 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} */ 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, /** * @ignore-option */ sonification: { enabled: false }, /** * Unless data is explicitly defined, the data is borrowed from the * first series in the chart. * * @type {Array|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 the value is set in terms of axis values, * percentage or pixels. * * If it's a number, it is interpreted as axis values, which in a * datetime axis equals milliseconds. * * If it's a percentage string, is interpreted as percentages of the * axis length. An overscroll of 50% will make a 100px axis 50px longer. * * If it's a pixel string, it is interpreted as a fixed pixel value, but * limited to 90% of the axis length. * * If it's undefined, the value is inherited from `xAxis.overscroll`. * * Can be set for both, main xAxis and navigator's xAxis. * * @type {number | string | undefined} * @since 6.0.0 * @apioption navigator.xAxis.overscroll */ 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: "#000000" /* Palette.neutralColor100 */, /** @ignore */ fontSize: '0.7em', /** @ignore */ opacity: 0.6, /** @ignore */ textOutline: '2px contrast' }, 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 * * */ /* * * * 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 return NavigatorDefaults; }); _registerModule(_modules, 'Stock/Navigator/NavigatorSymbols.js', [], function () { /* * * * (c) 2010-2024 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ /* * * * Constants * * */ /** * Draw one of the handles on the side of the zoomed range in the navigator. * @private */ function navigatorHandle(_x, _y, width, height, options = {}) { const halfWidth = options.width ? options.width / 2 : width, markerPosition = Math.round(halfWidth / 3) + 0.5; height = options.height || height; return [ ['M', -halfWidth - 1, 0.5], ['L', halfWidth, 0.5], ['L', halfWidth, height + 0.5], ['L', -halfWidth - 1, height + 0.5], ['L', -halfWidth - 1, 0.5], ['M', -markerPosition, 4], ['L', -markerPosition, height - 3], ['M', markerPosition - 1, 4], ['L', markerPosition - 1, height - 3] ]; } /* * * * Default Export * * */ const NavigatorSymbols = { 'navigator-handle': navigatorHandle }; return NavigatorSymbols; }); _registerModule(_modules, 'Stock/Utilities/StockUtilities.js', [_modules['Core/Utilities.js']], function (U) { /* * * * (c) 2010-2024 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { defined } = U; /* * * * Functions * * */ /** * Sets the chart.fixedRange to the specified value. If the value is larger * than actual range, sets it to the maximum possible range. (#20327) * * @private * @function Highcharts.StockChart#setFixedRange * @param {number|undefined} range * Range to set in axis units. */ function setFixedRange(range) { const xAxis = this.xAxis[0]; if (defined(xAxis.dataMax) && defined(xAxis.dataMin) && range) { this.fixedRange = Math.min(range, xAxis.dataMax - xAxis.dataMin); } else { this.fixedRange = range; } } const StockUtilities = { setFixedRange }; return StockUtilities; }); _registerModule(_modules, 'Stock/Navigator/NavigatorComposition.js', [_modules['Core/Defaults.js'], _modules['Core/Globals.js'], _modules['Core/Axis/NavigatorAxisComposition.js'], _modules['Stock/Navigator/NavigatorDefaults.js'], _modules['Stock/Navigator/NavigatorSymbols.js'], _modules['Core/Renderer/RendererRegistry.js'], _modules['Stock/Utilities/StockUtilities.js'], _modules['Core/Utilities.js']], function (D, H, NavigatorAxisAdditions, NavigatorDefaults, NavigatorSymbols, RendererRegistry, StockUtilities, U) { /* * * * (c) 2010-2024 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { setOptions } = D; const { composed } = H; const { getRendererType } = RendererRegistry; const { setFixedRange } = StockUtilities; const { addEvent, extend, pushUnique } = U; /* * * * Variables * * */ /* * * * Functions * * */ /** * @private */ function compose(ChartClass, AxisClass, SeriesClass) { NavigatorAxisAdditions.compose(AxisClass); if (pushUnique(composed, 'Navigator')) { ChartClass.prototype.setFixedRange = setFixedRange; extend(getRendererType().prototype.symbols, NavigatorSymbols); addEvent(SeriesClass, 'afterUpdate', onSeriesAfterUpdate); setOptions({ navigator: NavigatorDefaults }); } } /** * Handle updating series * @private */ function onSeriesAfterUpdate() { if (this.chart.navigator && !this.options.isInternal) { this.chart.navigator.setBaseSeries(null, false); } } /* * * * Default Export * * */ const NavigatorComposition = { compose }; return NavigatorComposition; }); _registerModule(_modules, 'Core/Axis/ScrollbarAxis.js', [_modules['Core/Globals.js'], _modules['Core/Utilities.js']], function (H, U) { /* * * * (c) 2010-2024 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { composed } = H; const { addEvent, defined, pick, pushUnique } = U; /* * * * Composition * * */ var ScrollbarAxis; (function (ScrollbarAxis) { /* * * * Variables * * */ let Scrollbar; /* * * * Functions * * */ /** * Attaches to axis events to create scrollbars if enabled. * * @private * * @param {Highcharts.Axis} AxisClass * Axis class to extend. * * @param {Highcharts.Scrollbar} ScrollbarClass * Scrollbar class to use. */ function compose(AxisClass, ScrollbarClass) { if (pushUnique(composed, 'Axis.Scrollbar')) { Scrollbar = ScrollbarClass; addEvent(AxisClass, 'afterGetOffset', onAxisAfterGetOffset); addEvent(AxisClass, 'afterInit', onAxisAfterInit); addEvent(AxisClass, 'afterRender', onAxisAfterRender); } } ScrollbarAxis.compose = compose; /** @private */ function getExtremes(axis) { const axisMin = pick(axis.options && axis.options.min, axis.min); const axisMax = pick(axis.options && axis.options.max, axis.max); return { axisMin, axisMax, scrollMin: defined(axis.dataMin) ? Math.min(axisMin, axis.min, axis.dataMin, pick(axis.threshold, Infinity)) : axisMin, scrollMax: defined(axis.dataMax) ? Math.max(axisMax, axis.max, axis.dataMax, pick(axis.threshold, -Infinity)) : axisMax }; } /** * Make space for a scrollbar. * @private */ function onAxisAfterGetOffset() { const axis = this, scrollbar = axis.scrollbar, opposite = scrollbar && !scrollbar.options.opposite, index = axis.horiz ? 2 : opposite ? 3 : 1; if (scrollbar) { // Reset scrollbars offsets axis.chart.scrollbarsOffsets = [0, 0]; axis.chart.axisOffset[index] += scrollbar.size + (scrollbar.options.margin || 0); } } /** * Wrap axis initialization and create scrollbar if enabled. * @private */ function onAxisAfterInit() { const axis = this; if (axis.options && axis.options.scrollbar && axis.options.scrollbar.enabled) { // Predefined options: axis.options.scrollbar.vertical = !axis.horiz; axis.options.startOnTick = axis.options.endOnTick = false; axis.scrollbar = new Scrollbar(axis.chart.renderer, axis.options.scrollbar, axis.chart); addEvent(axis.scrollbar, 'changed', function (e) { const { axisMin, axisMax, scrollMin: unitedMin, scrollMax: unitedMax } = getExtremes(axis), range = unitedMax - unitedMin; let to, from; // #12834, scroll when show/hide series, wrong extremes if (!defined(axisMin) || !defined(axisMax)) { return; } if ((axis.horiz && !axis.reversed) || (!axis.horiz && axis.reversed)) { to = unitedMin + range * this.to; from = unitedMin + range * this.from; } else { // Y-values in browser are reversed, but this also // applies for reversed horizontal axis: to = unitedMin + range * (1 - this.from); from = unitedMin + range * (1 - this.to); } if (this.shouldUpdateExtremes(e.DOMType)) { // #17977, set animation to undefined instead of true const animate = e.DOMType === 'mousemove' || e.DOMType === 'touchmove' ? false : void 0; axis.setExtremes(from, to, true, animate, e); } else { // When live redraw is disabled, don't change extremes // Only change the position of the scrollbar thumb this.setRange(this.from, this.to); } }); } } /** * Wrap rendering axis, and update scrollbar if one is created. * @private */ function onAxisAfterRender() { const axis = this, { scrollMin, scrollMax } = getExtremes(axis), scrollbar = axis.scrollbar, offset = (axis.axisTitleMargin + (axis.titleOffset || 0)), scrollbarsOffsets = axis.chart.scrollbarsOffsets, axisMargin = axis.options.margin || 0; let offsetsIndex, from, to; if (scrollbar && scrollbarsOffsets) { if (axis.horiz) { // Reserve space for labels/title if (!axis.opposite) { scrollbarsOffsets[1] += offset; } scrollbar.position(axis.left, (axis.top + axis.height + 2 + scrollbarsOffsets[1] - (axis.opposite ? axisMargin : 0)), axis.width, axis.height); // Next scrollbar should reserve space for margin (if set) if (!axis.opposite) { scrollbarsOffsets[1] += axisMargin; } offsetsIndex = 1; } else { // Reserve space for labels/title if (axis.opposite) { scrollbarsOffsets[0] += offset; } let xPosition; if (!scrollbar.options.opposite) { xPosition = axis.opposite ? 0 : axisMargin; } else { xPosition = axis.left + axis.width + 2 + scrollbarsOffsets[0] - (axis.opposite ? 0 : axisMargin); } scrollbar.position(xPosition, axis.top, axis.width, axis.height); // Next scrollbar should reserve space for margin (if set) if (axis.opposite) { scrollbarsOffsets[0] += axisMargin; } offsetsIndex = 0; } scrollbarsOffsets[offsetsIndex] += scrollbar.size + (scrollbar.options.margin || 0); if (isNaN(scrollMin) || isNaN(scrollMax) || !defined(axis.min) || !defined(axis.max) || axis.min === axis.max // #10733 ) { // Default action: when extremes are the same or there is // not extremes on the axis, but scrollbar exists, make it // full size scrollbar.setRange(0, 1); } else { from = ((axis.min - scrollMin) / (scrollMax - scrollMin)); to = ((axis.max - scrollMin) / (scrollMax - scrollMin)); if ((axis.horiz && !axis.reversed) || (!axis.horiz && axis.reversed)) { scrollbar.setRange(from, to); } else { // Inverse vertical axis scrollbar.setRange(1 - to, 1 - from); } } } } })(ScrollbarAxis || (ScrollbarAxis = {})); /* * * * Default Export * * */ return ScrollbarAxis; }); _registerModule(_modules, 'Stock/Scrollbar/ScrollbarDefaults.js', [], function () { /* * * * (c) 2010-2024 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ /* * * * Constant * * */ /** * * The scrollbar is a means of panning over the X axis of a stock chart. * Scrollbars can also be applied to other types of axes. * * Another approach to scrollable charts is the [chart.scrollablePlotArea]( * https://api.highcharts.com/highcharts/chart.scrollablePlotArea) option that * is especially suitable for simpler cartesian charts on mobile. * * In styled mode, all the presentational options for the * scrollbar are replaced by the classes `.highcharts-scrollbar-thumb`, * `.highcharts-scrollbar-arrow`, `.highcharts-scrollbar-button`, * `.highcharts-scrollbar-rifles` and `.highcharts-scrollbar-track`. * * @sample stock/yaxis/inverted-bar-scrollbar/ * A scrollbar on a simple bar chart * * @product highstock gantt * @optionparent scrollbar * * @private */ const ScrollbarDefaults = { /** * The height of the scrollbar. If `buttonsEnabled` is true , the height * also applies to the width of the scroll arrows so that they are always * squares. * * @sample stock/scrollbar/style/ * Non-default height * * @type {number} */ height: 10, /** * The border rounding radius of the bar. * * @sample stock/scrollbar/style/ * Scrollbar styling */ barBorderRadius: 5, /** * The corner radius of the scrollbar buttons. * * @sample stock/scrollbar/style/ * Scrollbar styling */ buttonBorderRadius: 0, /** * Enable or disable the buttons at the end of the scrollbar. * * @since 11.0.0 */ buttonsEnabled: false, /** * Enable or disable the scrollbar. * * @sample stock/scrollbar/enabled/ * Disable the scrollbar, only use navigator * * @type {boolean} * @default true * @apioption scrollbar.enabled */ /** * Whether to redraw the main chart as the scrollbar or the navigator * zoomed window is moved. Defaults to `true` for modern browsers and * `false` for legacy IE browsers as well as mobile devices. * * @sample stock/scrollbar/liveredraw * Setting live redraw to false * * @type {boolean} * @since 1.3 */ liveRedraw: void 0, /** * The margin between the scrollbar and its axis when the scrollbar is * applied directly to an axis, or the navigator in case that is enabled. * Defaults to 10 for axis, 0 for navigator. * * @type {number|undefined} */ margin: void 0, /** * The minimum width of the scrollbar. * * @since 1.2.5 */ minWidth: 6, /** @ignore-option */ opposite: true, /** * Whether to show or hide the scrollbar when the scrolled content is * zoomed out to it full extent. * * @type {boolean} * @default true * @apioption scrollbar.showFull */ step: 0.2, /** * The z index of the scrollbar group. */ zIndex: 3, /** * The background color of the scrollbar itself. * * @sample stock/scrollbar/style/ * Scrollbar styling * * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} */ barBackgroundColor: "#cccccc" /* Palette.neutralColor20 */, /** * The width of the bar's border. * * @sample stock/scrollbar/style/ * Scrollbar styling */ barBorderWidth: 0, /** * The color of the scrollbar's border. * * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} */ barBorderColor: "#cccccc" /* Palette.neutralColor20 */, /** * The color of the small arrow inside the scrollbar buttons. * * @sample stock/scrollbar/style/ * Scrollbar styling * * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} */ buttonArrowColor: "#333333" /* Palette.neutralColor80 */, /** * The color of scrollbar buttons. * * @sample stock/scrollbar/style/ * Scrollbar styling * * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} */ buttonBackgroundColor: "#e6e6e6" /* Palette.neutralColor10 */, /** * The color of the border of the scrollbar buttons. * * @sample stock/scrollbar/style/ * Scrollbar styling * * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} */ buttonBorderColor: "#cccccc" /* Palette.neutralColor20 */, /** * The border width of the scrollbar buttons. * * @sample stock/scrollbar/style/ * Scrollbar styling */ buttonBorderWidth: 1, /** * The color of the small rifles in the middle of the scrollbar. * * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} */ rifleColor: 'none', /** * The color of the track background. * * @sample stock/scrollbar/style/ * Scrollbar styling * * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} */ trackBackgroundColor: 'rgba(255, 255, 255, 0.001)', /** * The color of the border of the scrollbar track. * * @sample stock/scrollbar/style/ * Scrollbar styling * * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} */ trackBorderColor: "#cccccc" /* Palette.neutralColor20 */, /** * The corner radius of the border of the scrollbar track. * * @sample stock/scrollbar/style/ * Scrollbar styling */ trackBorderRadius: 5, /** * The width of the border of the scrollbar track. * * @sample stock/scrollbar/style/ * Scrollbar styling */ trackBorderWidth: 1 }; /* * * * Default Export * * */ return ScrollbarDefaults; }); _registerModule(_modules, 'Stock/Scrollbar/Scrollbar.js', [_modules['Core/Defaults.js'], _modules['Core/Globals.js'], _modules['Core/Axis/ScrollbarAxis.js'], _modules['Stock/Scrollbar/ScrollbarDefaults.js'], _modules['Core/Utilities.js']], function (D, H, ScrollbarAxis, ScrollbarDefaults, U) { /* * * * (c) 2010-2024 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { defaultOptions } = D; const { addEvent, correctFloat, defined, destroyObjectProperties, fireEvent, merge, pick, removeEvent } = U; /* * * * Constants * * */ /* eslint-disable no-invalid-this, valid-jsdoc */ /** * A reusable scrollbar, internally used in Highcharts Stock's * navigator and optionally on individual axes. * * @private * @class * @name Highcharts.Scrollbar * @param {Highcharts.SVGRenderer} renderer * @param {Highcharts.ScrollbarOptions} options * @param {Highcharts.Chart} chart */ class Scrollbar { /* * * * Static Functions * * */ static compose(AxisClass) { ScrollbarAxis.compose(AxisClass, Scrollbar); } /** * When we have vertical scrollbar, rifles and arrow in buttons should be * rotated. The same method is used in Navigator's handles, to rotate them. * * @function Highcharts.swapXY * * @param {Highcharts.SVGPathArray} path * Path to be rotated. * * @param {boolean} [vertical] * If vertical scrollbar, swap x-y values. * * @return {Highcharts.SVGPathArray} * Rotated path. * * @requires modules/stock */ static swapXY(path, vertical) { if (vertical) { path.forEach((seg) => { const len = seg.length; let temp; for (let i = 0; i < len; i += 2) { temp = seg[i + 1]; if (typeof temp === 'number') { seg[i + 1] = seg[i + 2]; seg[i + 2] = temp; } } }); } return path; } /* * * * Constructors * * */ constructor(renderer, options, chart) { /* * * * Properties * * */ this._events = []; this.chartX = 0; this.chartY = 0; this.from = 0; this.scrollbarButtons = []; this.scrollbarLeft = 0; this.scrollbarStrokeWidth = 1; this.scrollbarTop = 0; this.size = 0; this.to = 0; this.trackBorderWidth = 1; this.x = 0; this.y = 0; this.init(renderer, options, chart); } /* * * * Functions * * */ /** * Set up the mouse and touch events for the Scrollbar * * @private * @function Highcharts.Scrollbar#addEvents */ addEvents() { const buttonsOrder = this.options.inverted ? [1, 0] : [0, 1], buttons = this.scrollbarButtons, bar = this.scrollbarGroup.element, track = this.track.element, mouseDownHandler = this.mouseDownHandler.bind(this), mouseMoveHandler = this.mouseMoveHandler.bind(this), mouseUpHandler = this.mouseUpHandler.bind(this); const _events = [ // Mouse events [ buttons[buttonsOrder[0]].element, 'click', this.buttonToMinClick.bind(this) ], [ buttons[buttonsOrder[1]].element, 'click', this.buttonToMaxClick.bind(this) ], [track, 'click', this.trackClick.bind(this)], [bar, 'mousedown', mouseDownHandler], [bar.ownerDocument, 'mousemove', mouseMoveHandler], [bar.ownerDocument, 'mouseup', mouseUpHandler], // Touch events [bar, 'touchstart', mouseDownHandler], [bar.ownerDocument, 'touchmove', mouseMoveHandler], [bar.ownerDocument, 'touchend', mouseUpHandler] ]; // Add them all _events.forEach(function (args) { addEvent.apply(null, args); }); this._events = _events; } buttonToMaxClick(e) { const scroller = this; const range = ((scroller.to - scroller.from) * pick(scroller.options.step, 0.2)); scroller.updatePosition(scroller.from + range, scroller.to + range); fireEvent(scroller, 'changed', { from: scroller.from, to: scroller.to, trigger: 'scrollbar', DOMEvent: e }); } buttonToMinClick(e) { const scroller = this; const range = correctFloat(scroller.to - scroller.from) * pick(scroller.options.step, 0.2); scroller.updatePosition(correctFloat(scroller.from - range), correctFloat(scroller.to - range)); fireEvent(scroller, 'changed', { from: scroller.from, to: scroller.to, trigger: 'scrollbar', DOMEvent: e }); } /** * Get normalized (0-1) cursor position over the scrollbar * * @private * @function Highcharts.Scrollbar#cursorToScrollbarPosition * * @param {*} normalizedEvent * normalized event, with chartX and chartY values * * @return {Highcharts.Dictionary} * Local position {chartX, chartY} */ cursorToScrollbarPosition(normalizedEvent) { const scroller = this, options = scroller.options, minWidthDifference = options.minWidth > scroller.calculatedWidth ? options.minWidth : 0; // `minWidth` distorts translation return { chartX: (normalizedEvent.chartX - scroller.x - scroller.xOffset) / (scroller.barWidth - minWidthDifference), chartY: (normalizedEvent.chartY - scroller.y - scroller.yOffset) / (scroller.barWidth - minWidthDifference) }; } /** * Destroys allocated elements. * * @private * @function Highcharts.Scrollbar#destroy */ destroy() { const scroller = this, navigator = scroller.chart.scroller; // Disconnect events added in addEvents scroller.removeEvents(); // Destroy properties [ 'track', 'scrollbarRifles', 'scrollbar', 'scrollbarGroup', 'group' ].forEach(function (prop) { if (scroller[prop] && scroller[prop].destroy) { scroller[prop] = scroller[prop].destroy(); } }); // #6421, chart may have more scrollbars if (navigator && scroller === navigator.scrollbar) { navigator.scrollbar = null; // Destroy elements in collection destroyObjectProperties(navigator.scrollbarButtons); } } /** * Draw the scrollbar buttons with arrows * * @private * @function Highcharts.Scrollbar#drawScrollbarButton * @param {number} index * 0 is left, 1 is right */ drawScrollbarButton(index) { const scroller = this, renderer = scroller.renderer, scrollbarButtons = scroller.scrollbarButtons, options = scroller.options, size = scroller.size, group = renderer.g().add(scroller.group); scrollbarButtons.push(group); if (options.buttonsEnabled) { // Create a rectangle for the scrollbar button const rect = renderer.rect() .addClass('highcharts-scrollbar-button') .add(group); // Presentational attributes if (!scroller.chart.styledMode) { rect.attr({ stroke: options.buttonBorderColor, 'stroke-width': options.buttonBorderWidth, fill: options.buttonBackgroundColor }); } // Place the rectangle based on the rendered stroke width rect.attr(rect.crisp({ x: -0.5, y: -0.5, // +1 to compensate for crispifying in rect method width: size + 1, height: size + 1, r: options.buttonBorderRadius }, rect.strokeWidth())); // Button arrow const arrow = renderer .path(Scrollbar.swapXY([[ 'M', size / 2 + (index ? -1 : 1), size / 2 - 3 ], [ 'L', size / 2 + (index ? -1 : 1), size / 2 + 3 ], [ 'L', size / 2 + (index ? 2 : -2), size / 2 ]], options.vertical)) .addClass('highcharts-scrollbar-arrow') .add(scrollbarButtons[index]); if (!scroller.chart.styledMode) { arrow.attr({ fill: options.buttonArrowColor }); } } } /** * @private * @function Highcharts.Scrollbar#init * @param {Highcharts.SVGRenderer} renderer * @param {Highcharts.ScrollbarOptions} options * @param {Highcharts.Chart} chart */ init(renderer, options, chart) { const scroller = this; scroller.scrollbarButtons = []; scroller.renderer = renderer; scroller.userOptions = options; scroller.options = merge(ScrollbarDefaults, defaultOptions.scrollbar, options); scroller.options.margin = pick(scroller.options.margin, 10); scroller.chart = chart; // Backward compatibility scroller.size = pick(scroller.options.size, scroller.options.height); // Init if (options.enabled) { scroller.render(); scroller.addEvents(); } } mouseDownHandler(e) { const scroller = this, normalizedEvent = scroller.chart.pointer?.normalize(e) || e, mousePosition = scroller.cursorToScrollbarPosition(normalizedEvent); scroller.chartX = mousePosition.chartX; scroller.chartY = mousePosition.chartY; scroller.initPositions = [scroller.from, scroller.to]; scroller.grabbedCenter = true; } /** * Event handler for the mouse move event. * @private */ mouseMoveHandler(e) { const scroller = this, normalizedEvent = scroller.chart.pointer?.normalize(e) || e, options = scroller.options, direction = options.vertical ? 'chartY' : 'chartX', initPositions = scroller.initPositions || []; let scrollPosition, chartPosition, change; // In iOS, a mousemove event with e.pageX === 0 is fired when // holding the finger down in the center of the scrollbar. This // should be ignored. if (scroller.grabbedCenter && // #4696, scrollbar failed on Android (!e.touches || e.touches[0][direction] !== 0)) { chartPosition = scroller.cursorToScrollbarPosition(normalizedEvent)[direction]; scrollPosition = scroller[direction]; change = chartPosition - scrollPosition; scroller.hasDragged = true; scroller.updatePosition(initPositions[0] + change, initPositions[1] + change); if (scroller.hasDragged) { fireEvent(scroller, 'changed', { from: scroller.from, to: scroller.to, trigger: 'scrollbar', DOMType: e.type, DOMEvent: e }); } } } /** * Event handler for the mouse up event. * @private */ mouseUpHandler(e) { const scroller = this; if (scroller.hasDragged) { fireEvent(scroller, 'changed', { from: scroller.from, to: scroller.to, trigger: 'scrollbar', DOMType: e.type, DOMEvent: e }); } scroller.grabbedCenter = scroller.hasDragged = scroller.chartX = scroller.chartY = null; } /** * Position the scrollbar, method called from a parent with defined * dimensions. * * @private * @function Highcharts.Scrollbar#position * @param {number} x * x-position on the chart * @param {number} y * y-position on the chart * @param {number} width * width of the scrollbar * @param {number} height * height of the scrollbar */ position(x, y, width, height) { const scroller = this, options = scroller.options, { buttonsEnabled, margin = 0, vertical } = options, method = scroller.rendered ? 'animate' : 'attr'; let xOffset = height, yOffset = 0; // Make the scrollbar visible when it is repositioned, #15763. scroller.group.show(); scroller.x = x; scroller.y = y + this.trackBorderWidth; scroller.width = width; // Width with buttons scroller.height = height; scroller.xOffset = xOffset; scroller.yOffset = yOffset; // If Scrollbar is a vertical type, swap options: if (vertical) { scroller.width = scroller.yOffset = width = yOffset = scroller.size; scroller.xOffset = xOffset = 0; scroller.yOffset = yOffset = buttonsEnabled ? scroller.size : 0; // Width without buttons scroller.barWidth = height - (buttonsEnabled ? width * 2 : 0); scroller.x = x = x + margin; } else { scroller.height = height = scroller.size; scroller.xOffset = xOffset = buttonsEnabled ? scroller.size : 0; // Width without buttons scroller.barWidth = width - (buttonsEnabled ? height * 2 : 0); scroller.y = scroller.y + margin; } // Set general position for a group: scroller.group[method]({ translateX: x, translateY: scroller.y }); // Resize background/track: scroller.track[method]({ width: width, height: height }); // Move right/bottom button to its place: scroller.scrollbarButtons[1][method]({ translateX: vertical ? 0 : width - xOffset, translateY: vertical ? height - yOffset : 0 }); } /** * Removes the event handlers attached previously with addEvents. * * @private * @function Highcharts.Scrollbar#removeEvents */ removeEvents() { this._events.forEach(function (args) { removeEvent.apply(null, args); }); this._events.length = 0; } /** * Render scrollbar with all required items. * * @private * @function Highcharts.Scrollbar#render */ render() { const scroller = this, renderer = scroller.renderer, options = scroller.options, size = scroller.size, styledMode = scroller.chart.styledMode, group = renderer.g('scrollbar') .attr({ zIndex: options.zIndex }) .hide() // Initially hide the scrollbar #15863 .add(); // Draw the scrollbar group scroller.group = group; // Draw the scrollbar track: scroller.track = renderer.rect() .addClass('highcharts-scrollbar-track') .attr({ r: options.trackBorderRadius || 0, height: size, width: size }).add(group); if (!styledMode) { scroller.track.attr({ fill: options.trackBackgroundColor, stroke: options.trackBorderColor, 'stroke-width': options.trackBorderWidth }); } const trackBorderWidth = scroller.trackBorderWidth = scroller.track.strokeWidth(); scroller.track.attr({ x: -trackBorderWidth % 2 / 2, y: -trackBorderWidth % 2 / 2 }); // Draw the scrollbar itself scroller.scrollbarGroup = renderer.g().add(group); scroller.scrollbar = renderer.rect() .addClass('highcharts-scrollbar-thumb') .attr({ height: size - trackBorderWidth, width: size - trackBorderWidth, r: options.barBorderRadius || 0 }).add(scroller.scrollbarGroup); scroller.scrollbarRifles = renderer .path(Scrollbar.swapXY([ ['M', -3, size / 4], ['L', -3, 2 * size / 3], ['M', 0, size / 4], ['L', 0, 2 * size / 3], ['M', 3, size / 4], ['L', 3, 2 * size / 3] ], options.vertical)) .addClass('highcharts-scrollbar-rifles') .add(scroller.scrollbarGroup); if (!styledMode) { scroller.scrollbar.attr({ fill: options.barBackgroundColor, stroke: options.barBorderColor, 'stroke-width': options.barBorderWidth }); scroller.scrollbarRifles.attr({ stroke: options.rifleColor, 'stroke-width': 1 }); } scroller.scrollbarStrokeWidth = scroller.scrollbar.strokeWidth(); scroller.scrollbarGroup.translate(-scroller.scrollbarStrokeWidth % 2 / 2, -scroller.scrollbarStrokeWidth % 2 / 2); // Draw the buttons: scroller.drawScrollbarButton(0); scroller.drawScrollbarButton(1); } /** * Set scrollbar size, with a given scale. * * @private * @function Highcharts.Scrollbar#setRange * @param {number} from * scale (0-1) where bar should start * @param {number} to * scale (0-1) where bar should end */ setRange(from, to) { const scroller = this, options = scroller.options, vertical = options.vertical, minWidth = options.minWidth, fullWidth = scroller.barWidth, method = (this.rendered && !this.hasDragged && !(this.chart.navigator && this.chart.navigator.hasDragged)) ? 'animate' : 'attr'; if (!defined(fullWidth)) { return; } const toPX = fullWidth * Math.min(to, 1); let fromPX, newSize; from = Math.max(from, 0); fromPX = Math.ceil(fullWidth * from); scroller.calculatedWidth = newSize = correctFloat(toPX - fromPX); // We need to recalculate position, if minWidth is used if (newSize < minWidth) { fromPX = (fullWidth - minWidth + newSize) * from; newSize = minWidth; } const newPos = Math.floor(fromPX + scroller.xOffset + scroller.yOffset); const newRiflesPos = newSize / 2 - 0.5; // -0.5 -> rifle line width / 2 // Store current position: scroller.from = from; scroller.to = to; if (!vertical) { scroller.scrollbarGroup[method]({ translateX: newPos }); scroller.scrollbar[method]({ width: newSize }); scroller.scrollbarRifles[method]({ translateX: newRiflesPos }); scroller.scrollbarLeft = newPos; scroller.scrollbarTop = 0; } else { scroller.scrollbarGroup[method]({ translateY: newPos }); scroller.scrollbar[method]({ height: newSize }); scroller.scrollbarRifles[method]({ translateY: newRiflesPos }); scroller.scrollbarTop = newPos; scroller.scrollbarLeft = 0; } if (newSize <= 12) { scroller.scrollbarRifles.hide(); } else { scroller.scrollbarRifles.show(); } // Show or hide the scrollbar based on the showFull setting if (options.showFull === false) { if (from <= 0 && to >= 1) { scroller.group.hide(); } else { scroller.group.show(); } } scroller.rendered = true; } /** * Checks if the extremes should be updated in response to a scrollbar * change event. * * @private * @function Highcharts.Scrollbar#shouldUpdateExtremes */ shouldUpdateExtremes(eventType) { return (pick(this.options.liveRedraw, H.svg && !H.isTouchDevice && !this.chart.boosted) || // Mouseup always should change extremes eventType === 'mouseup' || eventType === 'touchend' || // Internal events !defined(eventType)); } trackClick(e) { const scroller = this; const normalizedEvent = scroller.chart.pointer?.normalize(e) || e, range = scroller.to - scroller.from, top = scroller.y + scroller.scrollbarTop, left = scroller.x + scroller.scrollbarLeft; if ((scroller.options.vertical && normalizedEvent.chartY > top) || (!scroller.options.vertical && normalizedEvent.chartX > left)) { // On the top or on the left side of the track: scroller.updatePosition(scroller.from + range, scroller.to + range); } else { // On the bottom or the right side of the track: scroller.updatePosition(scroller.from - range, scroller.to - range); } fireEvent(scroller, 'changed', { from: scroller.from, to: scroller.to, trigger: 'scrollbar', DOMEvent: e }); } /** * Update the scrollbar with new options * * @private * @function Highcharts.Scrollbar#update * @param {Highcharts.ScrollbarOptions} options */ update(options) { this.destroy(); this.init(this.chart.renderer, merge(true, this.options, options), this.chart); } /** * Update position option in the Scrollbar, with normalized 0-1 scale * * @private * @function Highcharts.Scrollbar#updatePosition * @param {number} from * @param {number} to */ updatePosition(from, to) { if (to > 1) { from = correctFloat(1 - correctFloat(to - from)); to = 1; } if (from < 0) { to = correctFloat(to - from); from = 0; } this.from = from; this.to = to; } } /* * * * Static Properties * * */ Scrollbar.defaultOptions = ScrollbarDefaults; /* * * * Registry * * */ defaultOptions.scrollbar = merge(true, Scrollbar.defaultOptions, defaultOptions.scrollbar); /* * * * Default Export * * */ return Scrollbar; }); _registerModule(_modules, 'Stock/Navigator/Navigator.js', [_modules['Core/Axis/Axis.js'], _modules['Stock/Navigator/ChartNavigatorComposition.js'], _modules['Core/Defaults.js'], _modules['Core/Globals.js'], _modules['Core/Axis/NavigatorAxisComposition.js'], _modules['Stock/Navigator/NavigatorComposition.js'], _modules['Stock/Scrollbar/Scrollbar.js'], _modules['Core/Utilities.js']], function (Axis, ChartNavigatorComposition, D, H, NavigatorAxisAdditions, NavigatorComposition, Scrollbar, U) { /* * * * (c) 2010-2024 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { defaultOptions } = D; const { isTouchDevice } = H; const { addEvent, clamp, correctFloat, defined, destroyObjectProperties, erase, extend, find, fireEvent, isArray, isNumber, merge, pick, removeEvent, splat } = U; /* * * * Functions * * */ /** * Finding the min or max of a set of variables where we don't know if they are * defined, is a pattern that is repeated several places in Highcharts. Consider * making this a global utility method. * @private */ function numExt(extreme, ...args) { const numbers = [].filter.call(args, isNumber); if (numbers.length) { return Math[extreme].apply(0, numbers); } } /* * * * Class * * */ /** * The Navigator class * * @private * @class * @name Highcharts.Navigator * * @param {Highcharts.Chart} chart * Chart object */ class Navigator { /* * * * Static Properties * * */ static compose(ChartClass, AxisClass, SeriesClass) { ChartNavigatorComposition.compose(ChartClass, Navigator); NavigatorComposition.compose(ChartClass, AxisClass, SeriesClass); } /* * * * Constructor * * */ constructor(chart) { this.scrollbarHeight = 0; this.init(chart); } /* * * * Functions * * */ /** * Draw one of the handles on the side of the zoomed range in the navigator. * * @private * @function Highcharts.Navigator#drawHandle * * @param {number} x * The x center for the handle * * @param {number} index * 0 for left and 1 for right * * @param {boolean|undefined} inverted * Flag for chart.inverted * * @param {string} verb * Use 'animate' or 'attr' */ drawHandle(x, index, inverted, verb) { const navigator = this, height = navigator.navigatorOptions.handles.height; // Place it navigator.handles[index][verb](inverted ? { translateX: Math.round(navigator.left + navigator.height / 2), translateY: Math.round(navigator.top + parseInt(x, 10) + 0.5 - height) } : { translateX: Math.round(navigator.left + parseInt(x, 10)), translateY: Math.round(navigator.top + navigator.height / 2 - height / 2 - 1) }); } /** * Render outline around the zoomed range * * @private * @function Highcharts.Navigator#drawOutline * * @param {number} zoomedMin * in pixels position where zoomed range starts * * @param {number} zoomedMax * in pixels position where zoomed range ends * * @param {boolean|undefined} inverted * flag if chart is inverted * * @param {string} verb * use 'animate' or 'attr' */ drawOutline(zoomedMin, zoomedMax, inverted, verb) { const navigator = this, maskInside = navigator.navigatorOptions.maskInside, outlineWidth = navigator.outline.strokeWidth(), halfOutline = outlineWidth / 2, outlineCorrection = (outlineWidth % 2) / 2, // #5800 scrollButtonSize = navigator.scrollButtonSize, navigatorSize = navigator.size, navigatorTop = navigator.top, height = navigator.height, lineTop = navigatorTop - halfOutline, lineBtm = navigatorTop + height; let left = navigator.left, verticalMin, path; if (inverted) { verticalMin = navigatorTop + zoomedMax + outlineCorrection; zoomedMax = navigatorTop + zoomedMin + outlineCorrection; path = [ [ 'M', left + height, navigatorTop - scrollButtonSize - outlineCorrection ], // Top right of zoomed range ['L', left + height, verticalMin], ['L', left, verticalMin], ['M', left, zoomedMax], ['L', left + height, zoomedMax], [ 'L', left + height, navigatorTop + navigatorSize + scrollButtonSize ] ]; if (maskInside) { path.push( // Upper left of zoomed range ['M', left + height, verticalMin - halfOutline], // Upper right of z.r. [ 'L', left + height, zoomedMax + halfOutline ]); } } else { left -= scrollButtonSize; zoomedMin += left + scrollButtonSize - outlineCorrection; zoomedMax += left + scrollButtonSize - outlineCorrection; path = [ // Left ['M', left, lineTop], // Upper left of zoomed range ['L', zoomedMin, lineTop], // Lower left of z.r. ['L', zoomedMin, lineBtm], // Lower right of z.r. ['M', zoomedMax, lineBtm], // Upper right of z.r. ['L', zoomedMax, lineTop], // Right [ 'L', left + navigatorSize + scrollButtonSize * 2, navigatorTop + halfOutline ] ]; if (maskInside) { path.push( // Upper left of zoomed range ['M', zoomedMin - halfOutline, lineTop], // Upper right of z.r. ['L', zoomedMax + halfOutline, lineTop]); } } navigator.outline[verb]({ d: path }); } /** * Render outline around the zoomed range * * @private * @function Highcharts.Navigator#drawMasks * * @param {number} zoomedMin * in pixels position where zoomed range starts * * @param {number} zoomedMax * in pixels position where zoomed range ends * * @param {boolean|undefined} inverted * flag if chart is inverted * * @param {string} verb * use 'animate' or 'attr' */ drawMasks(zoomedMin, zoomedMax, inverted, verb) { const navigator = this, left = navigator.left, top = navigator.top, navigatorHeight = navigator.height; let height, width, x, y; // Determine rectangle position & size // According to (non)inverted position: if (inverted) { x = [left, left, left]; y = [top, top + zoomedMin, top + zoomedMax]; width = [navigatorHeight, navigatorHeight, navigatorHeight]; height = [ zoomedMin, zoomedMax - zoomedMin, navigator.size - zoomedMax ]; } else { x = [left, left + zoomedMin, left + zoomedMax]; y = [top, top, top]; width = [ zoomedMin, zoomedMax - zoomedMin, navigator.size - zoomedMax ]; height = [navigatorHeight, navigatorHeight, navigatorHeight]; } navigator.shades.forEach((shade, i) => { shade[verb]({ x: x[i], y: y[i], width: width[i], height: height[i] }); }); } /** * Generate DOM elements for a navigator: * * - main navigator group * * - all shades * * - outline * * - handles * * @private * @function Highcharts.Navigator#renderElements */ renderElements() { const navigator = this, navigatorOptions = navigator.navigatorOptions, maskInside = navigatorOptions.maskInside, chart = navigator.chart, inverted = chart.inverted, renderer = chart.renderer, mouseCursor = { cursor: inverted ? 'ns-resize' : 'ew-resize' }, // Create the main navigator group navigatorGroup = navigator.navigatorGroup = renderer .g('navigator') .attr({ zIndex: 8, visibility: 'hidden' }) .add(); // Create masks, each mask will get events and fill: [ !maskInside, maskInside, !maskInside ].forEach((hasMask, index) => { const shade = renderer.rect() .addClass('highcharts-navigator-mask' + (index === 1 ? '-inside' : '-outside')) .add(navigatorGroup); if (!chart.styledMode) { shade.attr({ fill: hasMask ? navigatorOptions.maskFill : 'rgba(0,0,0,0)' }); if (index === 1) { shade.css(mouseCursor); } } navigator.shades[index] = shade; }); // Create the outline: navigator.outline = renderer.path() .addClass('highcharts-navigator-outline') .add(navigatorGroup); if (!chart.styledMode) { navigator.outline.attr({ 'stroke-width': navigatorOptions.outlineWidth, stroke: navigatorOptions.outlineColor }); } // Create the handlers: if (navigatorOptions.handles && navigatorOptions.handles.enabled) { const handlesOptions = navigatorOptions.handles, { height, width } = handlesOptions; [0, 1].forEach((index) => { navigator.handles[index] = renderer.symbol(handlesOptions.symbols[index], -width / 2 - 1, 0, width, height, handlesOptions); if (chart.inverted) { navigator.handles[index].attr({ rotation: 90, rotationOriginX: Math.floor(-width / 2), rotationOriginY: (height + width) / 2 }); } // Z index is 6 for right handle, 7 for left. Can't be 10, // because of the tooltip in inverted chart (#2908). navigator.handles[index].attr({ zIndex: 7 - index }) .addClass('highcharts-navigator-handle ' + 'highcharts-navigator-handle-' + ['left', 'right'][index]).add(navigatorGroup); if (!chart.styledMode) { navigator.handles[index] .attr({ fill: handlesOptions.backgroundColor, stroke: handlesOptions.borderColor, 'stroke-width': handlesOptions.lineWidth }) .css(mouseCursor); } }); } } /** * Update navigator * * @private * @function Highcharts.Navigator#update * * @param {Highcharts.NavigatorOptions} options * Options to merge in when updating navigator */ update(options) { // Remove references to old navigator series in base series (this.series || []).forEach((series) => { if (series.baseSeries) { delete series.baseSeries.navigatorSeries; } }); // Destroy and rebuild navigator this.destroy(); const chartOptions = this.chart.options; merge(true, chartOptions.navigator, options); this.init(this.chart); } /** * Render the navigator * * @private * @function Highcharts.Navigator#render * @param {number} min * X axis value minimum * @param {number} max * X axis value maximum * @param {number} [pxMin] * Pixel value minimum * @param {number} [pxMax] * Pixel value maximum */ render(min, max, pxMin, pxMax) { const navigator = this, chart = navigator.chart, xAxis = navigator.xAxis, pointRange = xAxis.pointRange || 0, scrollbarXAxis = xAxis.navigatorAxis.fake ? chart.xAxis[0] : xAxis, navigatorEnabled = navigator.navigatorEnabled, rendered = navigator.rendered, inverted = chart.inverted, minRange = chart.xAxis[0].minRange, maxRange = chart.xAxis[0].options.maxRange, scrollButtonSize = navigator.scrollButtonSize; let navigatorWidth, scrollbarLeft, scrollbarTop, scrollbarHeight = navigator.scrollbarHeight, navigatorSize, verb; // Don't redraw while moving the handles (#4703). if (this.hasDragged && !defined(pxMin)) { return; } min = correctFloat(min - pointRange / 2); max = correctFloat(max + pointRange / 2); // Don't render the navigator until we have data (#486, #4202, #5172). if (!isNumber(min) || !isNumber(max)) { // However, if navigator was already rendered, we may need to resize // it. For example hidden series, but visible navigator (#6022). if (rendered) { pxMin = 0; pxMax = pick(xAxis.width, scrollbarXAxis.width); } else { return; } } navigator.left = pick(xAxis.left, // In case of scrollbar only, without navigator chart.plotLeft + scrollButtonSize + (inverted ? chart.plotWidth : 0)); let zoomedMax = navigator.size = navigatorSize = pick(xAxis.len, (inverted ? chart.plotHeight : chart.plotWidth) - 2 * scrollButtonSize); if (inverted) { navigatorWidth = scrollbarHeight; } else { navigatorWidth = navigatorSize + 2 * scrollButtonSize; } // Get the pixel position of the handles pxMin = pick(pxMin, xAxis.toPixels(min, true)); pxMax = pick(pxMax, xAxis.toPixels(max, true)); // Verify (#1851, #2238) if (!isNumber(pxMin) || Math.abs(pxMin) === Infinity) { pxMin = 0; pxMax = navigatorWidth; } // Are we below the minRange? (#2618, #6191) const newMin = xAxis.toValue(pxMin, true), newMax = xAxis.toValue(pxMax, true), currentRange = Math.abs(correctFloat(newMax - newMin)); if (currentRange < minRange) { if (this.grabbedLeft) { pxMin = xAxis.toPixels(newMax - minRange - pointRange, true); } else if (this.grabbedRight) { pxMax = xAxis.toPixels(newMin + minRange + pointRange, true); } } else if (defined(maxRange) && correctFloat(currentRange - pointRange) > maxRange) { if (this.grabbedLeft) { pxMin = xAxis.toPixels(newMax - maxRange - pointRange, true); } else if (this.grabbedRight) { pxMax = xAxis.toPixels(newMin + maxRange + pointRange, true); } } // Handles are allowed to cross, but never exceed the plot area navigator.zoomedMax = clamp(Math.max(pxMin, pxMax), 0, zoomedMax); navigator.zoomedMin = clamp(navigator.fixedWidth ? navigator.zoomedMax - navigator.fixedWidth : Math.min(pxMin, pxMax), 0, zoomedMax); navigator.range = navigator.zoomedMax - navigator.zoomedMin; zoomedMax = Math.round(navigator.zoomedMax); const zoomedMin = Math.round(navigator.zoomedMin); if (navigatorEnabled) { navigator.navigatorGroup.attr({ visibility: 'inherit' }); // Place elements verb = rendered && !navigator.hasDragged ? 'animate' : 'attr'; navigator.drawMasks(zoomedMin, zoomedMax, inverted, verb); navigator.drawOutline(zoomedMin, zoomedMax, inverted, verb); if (navigator.navigatorOptions.handles.enabled) { navigator.drawHandle(zoomedMin, 0, inverted, verb); navigator.drawHandle(zoomedMax, 1, inverted, verb); } } if (navigator.scrollbar) { if (inverted) { scrollbarTop = navigator.top - scrollButtonSize; scrollbarLeft = navigator.left - scrollbarHeight + (navigatorEnabled || !scrollbarXAxis.opposite ? 0 : // Multiple axes has offsets: (scrollbarXAxis.titleOffset || 0) + // Self margin from the axis.title scrollbarXAxis.axisTitleMargin); scrollbarHeight = navigatorSize + 2 * scrollButtonSize; } else { scrollbarTop = navigator.top + (navigatorEnabled ? navigator.height : -scrollbarHeight); scrollbarLeft = navigator.left - scrollButtonSize; } // Reposition scrollbar navigator.scrollbar.position(scrollbarLeft, scrollbarTop, navigatorWidth, scrollbarHeight); // Keep scale 0-1 navigator.scrollbar.setRange( // Use real value, not rounded because range can be very small // (#1716) navigator.zoomedMin / (navigatorSize || 1), navigator.zoomedMax / (navigatorSize || 1)); } navigator.rendered = true; fireEvent(this, 'afterRender'); } /** * Set up the mouse and touch events for the navigator * * @private * @function Highcharts.Navigator#addMouseEvents */ addMouseEvents() { const navigator = this, chart = navigator.chart, container = chart.container; let eventsToUnbind = [], mouseMoveHandler, mouseUpHandler; /** * Create mouse events' handlers. * Make them as separate functions to enable wrapping them: */ navigator.mouseMoveHandler = mouseMoveHandler = function (e) { navigator.onMouseMove(e); }; navigator.mouseUpHandler = mouseUpHandler = function (e) { navigator.onMouseUp(e); }; // Add shades and handles mousedown events eventsToUnbind = navigator.getPartsEvents('mousedown'); eventsToUnbind.push( // Add mouse move and mouseup events. These are bind to doc/div, // because Navigator.grabbedSomething flags are stored in mousedown // events addEvent(chart.renderTo, 'mousemove', mouseMoveHandler), addEvent(container.ownerDocument, 'mouseup', mouseUpHandler), // Touch events addEvent(chart.renderTo, 'touchmove', mouseMoveHandler), addEvent(container.ownerDocument, 'touchend', mouseUpHandler)); eventsToUnbind.concat(navigator.getPartsEvents('touchstart')); navigator.eventsToUnbind = eventsToUnbind; // Data events if (navigator.series && navigator.series[0]) { eventsToUnbind.push(addEvent(navigator.series[0].xAxis, 'foundExtremes', function () { chart.navigator.modifyNavigatorAxisExtremes(); })); } } /** * Generate events for handles and masks * * @private * @function Highcharts.Navigator#getPartsEvents * * @param {string} eventName * Event name handler, 'mousedown' or 'touchstart' * * @return {Array} * An array of functions to remove navigator functions from the * events again. */ getPartsEvents(eventName) { const navigator = this, events = []; ['shades', 'handles'].forEach(function (name) { navigator[name].forEach(function (navigatorItem, index) { events.push(addEvent(navigatorItem.element, eventName, function (e) { navigator[name + 'Mousedown'](e, index); })); }); }); return events; } /** * Mousedown on a shaded mask, either: * * - will be stored for future drag&drop * * - will directly shift to a new range * * @private * @function Highcharts.Navigator#shadesMousedown * * @param {Highcharts.PointerEventObject} e * Mouse event * * @param {number} index * Index of a mask in Navigator.shades array */ shadesMousedown(e, index) { e = this.chart.pointer?.normalize(e) || e; const navigator = this, chart = navigator.chart, xAxis = navigator.xAxis, zoomedMin = navigator.zoomedMin, navigatorSize = navigator.size, range = navigator.range; let navigatorPosition = navigator.left, chartX = e.chartX, fixedMax, fixedMin, ext, left; // For inverted chart, swap some options: if (chart.inverted) { chartX = e.chartY; navigatorPosition = navigator.top; } if (index === 1) { // Store information for drag&drop navigator.grabbedCenter = chartX; navigator.fixedWidth = range; navigator.dragOffset = chartX - zoomedMin; } else { // Shift the range by clicking on shaded areas left = chartX - navigatorPosition - range / 2; if (index === 0) { left = Math.max(0, left); } else if (index === 2 && left + range >= navigatorSize) { left = navigatorSize - range; if (navigator.reversedExtremes) { // #7713 left -= range; fixedMin = navigator.getUnionExtremes().dataMin; } else { // #2293, #3543 fixedMax = navigator.getUnionExtremes().dataMax; } } if (left !== zoomedMin) { // It has actually moved navigator.fixedWidth = range; // #1370 ext = xAxis.navigatorAxis.toFixedRange(left, left + range, fixedMin, fixedMax); if (defined(ext.min)) { // #7411 fireEvent(this, 'setRange', { min: Math.min(ext.min, ext.max), max: Math.max(ext.min, ext.max), redraw: true, eventArguments: { trigger: 'navigator' } }); } } } } /** * Mousedown on a handle mask. * Will store necessary information for drag&drop. * * @private * @function Highcharts.Navigator#handlesMousedown * @param {Highcharts.PointerEventObject} e * Mouse event * @param {number} index * Index of a handle in Navigator.handles array */ handlesMousedown(e, index) { e = this.chart.pointer?.normalize(e) || e; const navigator = this, chart = navigator.chart, baseXAxis = chart.xAxis[0], // For reversed axes, min and max are changed, // so the other extreme should be stored reverse = navigator.reversedExtremes; if (index === 0) { // Grab the left handle navigator.grabbedLeft = true; navigator.otherHandlePos = navigator.zoomedMax; navigator.fixedExtreme = reverse ? baseXAxis.min : baseXAxis.max; } else { // Grab the right handle navigator.grabbedRight = true; navigator.otherHandlePos = navigator.zoomedMin; navigator.fixedExtreme = reverse ? baseXAxis.max : baseXAxis.min; } chart.setFixedRange(void 0); } /** * Mouse move event based on x/y mouse position. * * @private * @function Highcharts.Navigator#onMouseMove * * @param {Highcharts.PointerEventObject} e * Mouse event */ onMouseMove(e) { const navigator = this, chart = navigator.chart, navigatorSize = navigator.navigatorSize, range = navigator.range, dragOffset = navigator.dragOffset, inverted = chart.inverted; let left = navigator.left, chartX; // In iOS, a mousemove event with e.pageX === 0 is fired when holding // the finger down in the center of the scrollbar. This should be // ignored. if (!e.touches || e.touches[0].pageX !== 0) { // #4696 e = chart.pointer?.normalize(e) || e; chartX = e.chartX; // Swap some options for inverted chart if (inverted) { left = navigator.top; chartX = e.chartY; } // Drag left handle or top handle if (navigator.grabbedLeft) { navigator.hasDragged = true; navigator.render(0, 0, chartX - left, navigator.otherHandlePos); // Drag right handle or bottom handle } else if (navigator.grabbedRight) { navigator.hasDragged = true; navigator.render(0, 0, navigator.otherHandlePos, chartX - left); // Drag scrollbar or open area in navigator } else if (navigator.grabbedCenter) { navigator.hasDragged = true; if (chartX < dragOffset) { // Outside left chartX = dragOffset; // Outside right } else if (chartX > navigatorSize + dragOffset - range) { chartX = navigatorSize + dragOffset - range; } navigator.render(0, 0, chartX - dragOffset, chartX - dragOffset + range); } if (navigator.hasDragged && navigator.scrollbar && pick(navigator.scrollbar.options.liveRedraw, // By default, don't run live redraw on touch // devices or if the chart is in boost. !isTouchDevice && !this.chart.boosted)) { e.DOMType = e.type; setTimeout(function () { navigator.onMouseUp(e); }, 0); } } } /** * Mouse up event based on x/y mouse position. * * @private * @function Highcharts.Navigator#onMouseUp * @param {Highcharts.PointerEventObject} e * Mouse event */ onMouseUp(e) { const navigator = this, chart = navigator.chart, xAxis = navigator.xAxis, scrollbar = navigator.scrollbar, DOMEvent = e.DOMEvent || e, inverted = chart.inverted, verb = navigator.rendered && !navigator.hasDragged ? 'animate' : 'attr'; let zoomedMax, zoomedMin, unionExtremes, fixedMin, fixedMax, ext; if ( // MouseUp is called for both, navigator and scrollbar (that order), // which causes calling afterSetExtremes twice. Prevent first call // by checking if scrollbar is going to set new extremes (#6334) (navigator.hasDragged && (!scrollbar || !scrollbar.hasDragged)) || e.trigger === 'scrollbar') { unionExtremes = navigator.getUnionExtremes(); // When dragging one handle, make sure the other one doesn't change if (navigator.zoomedMin === navigator.otherHandlePos) { fixedMin = navigator.fixedExtreme; } else if (navigator.zoomedMax === navigator.otherHandlePos) { fixedMax = navigator.fixedExtreme; } // Snap to right edge (#4076) if (navigator.zoomedMax === navigator.size) { fixedMax = navigator.reversedExtremes ? unionExtremes.dataMin : unionExtremes.dataMax; } // Snap to left edge (#7576) if (navigator.zoomedMin === 0) { fixedMin = navigator.reversedExtremes ? unionExtremes.dataMax : unionExtremes.dataMin; } ext = xAxis.navigatorAxis.toFixedRange(navigator.zoomedMin, navigator.zoomedMax, fixedMin, fixedMax); if (defined(ext.min)) { fireEvent(this, 'setRange', { min: Math.min(ext.min, ext.max), max: Math.max(ext.min, ext.max), redraw: true, animation: navigator.hasDragged ? false : null, eventArguments: { trigger: 'navigator', triggerOp: 'navigator-drag', DOMEvent: DOMEvent // #1838 } }); } } if (e.DOMType !== 'mousemove' && e.DOMType !== 'touchmove') { navigator.grabbedLeft = navigator.grabbedRight = navigator.grabbedCenter = navigator.fixedWidth = navigator.fixedExtreme = navigator.otherHandlePos = navigator.hasDragged = navigator.dragOffset = null; } // Update position of navigator shades, outline and handles (#12573) if (navigator.navigatorEnabled && isNumber(navigator.zoomedMin) && isNumber(navigator.zoomedMax)) { zoomedMin = Math.round(navigator.zoomedMin); zoomedMax = Math.round(navigator.zoomedMax); if (navigator.shades) { navigator.drawMasks(zoomedMin, zoomedMax, inverted, verb); } if (navigator.outline) { navigator.drawOutline(zoomedMin, zoomedMax, inverted, verb); } if (navigator.navigatorOptions.handles.enabled && Object.keys(navigator.handles).length === navigator.handles.length) { navigator.drawHandle(zoomedMin, 0, inverted, verb); navigator.drawHandle(zoomedMax, 1, inverted, verb); } } } /** * Removes the event handlers attached previously with addEvents. * * @private * @function Highcharts.Navigator#removeEvents */ removeEvents() { if (this.eventsToUnbind) { this.eventsToUnbind.forEach(function (unbind) { unbind(); }); this.eventsToUnbind = void 0; } this.removeBaseSeriesEvents(); } /** * Remove data events. * * @private * @function Highcharts.Navigator#removeBaseSeriesEvents */ removeBaseSeriesEvents() { const baseSeries = this.baseSeries || []; if (this.navigatorEnabled && baseSeries[0]) { if (this.navigatorOptions.adaptToUpdatedData !== false) { baseSeries.forEach(function (series) { removeEvent(series, 'updatedData', this.updatedDataHandler); }, this); } // We only listen for extremes-events on the first baseSeries if (baseSeries[0].xAxis) { removeEvent(baseSeries[0].xAxis, 'foundExtremes', this.modifyBaseAxisExtremes); } } } /** * Initialize the Navigator object * * @private * @function Highcharts.Navigator#init */ init(chart) { const chartOptions = chart.options, navigatorOptions = chartOptions.navigator || {}, navigatorEnabled = navigatorOptions.enabled, scrollbarOptions = chartOptions.scrollbar || {}, scrollbarEnabled = scrollbarOptions.enabled, height = navigatorEnabled && navigatorOptions.height || 0, scrollbarHeight = scrollbarEnabled && scrollbarOptions.height || 0, scrollButtonSize = scrollbarOptions.buttonsEnabled && scrollbarHeight || 0; this.handles = []; this.shades = []; this.chart = chart; this.setBaseSeries(); this.height = height; this.scrollbarHeight = scrollbarHeight; this.scrollButtonSize = scrollButtonSize; this.scrollbarEnabled = scrollbarEnabled; this.navigatorEnabled = navigatorEnabled; this.navigatorOptions = navigatorOptions; this.scrollbarOptions = scrollbarOptions; this.opposite = pick(navigatorOptions.opposite, Boolean(!navigatorEnabled && chart.inverted)); // #6262 const navigator = this, baseSeries = navigator.baseSeries, xAxisIndex = chart.xAxis.length, yAxisIndex = chart.yAxis.length, baseXaxis = baseSeries && baseSeries[0] && baseSeries[0].xAxis || chart.xAxis[0] || { options: {} }; chart.isDirtyBox = true; if (navigator.navigatorEnabled) { // An x axis is required for scrollbar also navigator.xAxis = new Axis(chart, merge({ // Inherit base xAxis' break, ordinal options and overscroll breaks: baseXaxis.options.breaks, ordinal: baseXaxis.options.ordinal, overscroll: baseXaxis.options.overscroll }, navigatorOptions.xAxis, { id: 'navigator-x-axis', yAxis: 'navigator-y-axis', type: 'datetime', index: xAxisIndex, isInternal: true, offset: 0, keepOrdinalPadding: true, startOnTick: false, endOnTick: false, minPadding: 0, maxPadding: 0, zoomEnabled: false }, chart.inverted ? { offsets: [scrollButtonSize, 0, -scrollButtonSize, 0], width: height } : { offsets: [0, -scrollButtonSize, 0, scrollButtonSize], height: height }), 'xAxis'); navigator.yAxis = new Axis(chart, merge(navigatorOptions.yAxis, { id: 'navigator-y-axis', alignTicks: false, offset: 0, index: yAxisIndex, isInternal: true, reversed: pick((navigatorOptions.yAxis && navigatorOptions.yAxis.reversed), (chart.yAxis[0] && chart.yAxis[0].reversed), false), zoomEnabled: false }, chart.inverted ? { width: height } : { height: height }), 'yAxis'); // If we have a base series, initialize the navigator series if (baseSeries || navigatorOptions.series.data) { navigator.updateNavigatorSeries(false); // If not, set up an event to listen for added series } else if (chart.series.length === 0) { navigator.unbindRedraw = addEvent(chart, 'beforeRedraw', function () { // We've got one, now add it as base if (chart.series.length > 0 && !navigator.series) { navigator.setBaseSeries(); navigator.unbindRedraw(); // Reset } }); } navigator.reversedExtremes = (chart.inverted && !navigator.xAxis.reversed) || (!chart.inverted && navigator.xAxis.reversed); // Render items, so we can bind events to them: navigator.renderElements(); // Add mouse events navigator.addMouseEvents(); // In case of scrollbar only, fake an x axis to get translation } else { navigator.xAxis = { chart, navigatorAxis: { fake: true }, translate: function (value, reverse) { const axis = chart.xAxis[0], ext = axis.getExtremes(), scrollTrackWidth = axis.len - 2 * scrollButtonSize, min = numExt('min', axis.options.min, ext.dataMin), valueRange = numExt('max', axis.options.max, ext.dataMax) - min; return reverse ? // From pixel to value (value * valueRange / scrollTrackWidth) + min : // From value to pixel scrollTrackWidth * (value - min) / valueRange; }, toPixels: function (value) { return this.translate(value); }, toValue: function (value) { return this.translate(value, true); } }; navigator.xAxis.navigatorAxis.axis = navigator.xAxis; navigator.xAxis.navigatorAxis.toFixedRange = (NavigatorAxisAdditions.prototype.toFixedRange.bind(navigator.xAxis.navigatorAxis)); } // Initialize the scrollbar if (chart.options.scrollbar.enabled) { const options = merge(chart.options.scrollbar, { vertical: chart.inverted }); if (!isNumber(options.margin) && navigator.navigatorEnabled) { options.margin = chart.inverted ? -3 : 3; } chart.scrollbar = navigator.scrollbar = new Scrollbar(chart.renderer, options, chart); addEvent(navigator.scrollbar, 'changed', function (e) { const range = navigator.size, to = range * this.to, from = range * this.from; navigator.hasDragged = navigator.scrollbar.hasDragged; navigator.render(0, 0, from, to); if (this.shouldUpdateExtremes(e.DOMType)) { setTimeout(function () { navigator.onMouseUp(e); }); } }); } // Add data events navigator.addBaseSeriesEvents(); // Add redraw events navigator.addChartEvents(); } /** * Get the union data extremes of the chart - the outer data extremes of the * base X axis and the navigator axis. * * @private * @function Highcharts.Navigator#getUnionExtremes */ getUnionExtremes(returnFalseOnNoBaseSeries) { const baseAxis = this.chart.xAxis[0], navAxis = this.xAxis, navAxisOptions = navAxis.options, baseAxisOptions = baseAxis.options; let ret; if (!returnFalseOnNoBaseSeries || baseAxis.dataMin !== null) { ret = { dataMin: pick(// #4053 navAxisOptions && navAxisOptions.min, numExt('min', baseAxisOptions.min, baseAxis.dataMin, navAxis.dataMin, navAxis.min)), dataMax: pick(navAxisOptions && navAxisOptions.max, numExt('max', baseAxisOptions.max, baseAxis.dataMax, navAxis.dataMax, navAxis.max)) }; } return ret; } /** * Set the base series and update the navigator series from this. With a bit * of modification we should be able to make this an API method to be called * from the outside * * @private * @function Highcharts.Navigator#setBaseSeries * @param {Highcharts.SeriesOptionsType} [baseSeriesOptions] * Additional series options for a navigator * @param {boolean} [redraw] * Whether to redraw after update. */ setBaseSeries(baseSeriesOptions, redraw) { const chart = this.chart, baseSeries = this.baseSeries = []; baseSeriesOptions = (baseSeriesOptions || chart.options && chart.options.navigator.baseSeries || (chart.series.length ? // Find the first non-navigator series (#8430) find(chart.series, (s) => (!s.options.isInternal)).index : 0)); // Iterate through series and add the ones that should be shown in // navigator. (chart.series || []).forEach((series, i) => { if ( // Don't include existing nav series !series.options.isInternal && (series.options.showInNavigator || (i === baseSeriesOptions || series.options.id === baseSeriesOptions) && series.options.showInNavigator !== false)) { baseSeries.push(series); } }); // When run after render, this.xAxis already exists if (this.xAxis && !this.xAxis.navigatorAxis.fake) { this.updateNavigatorSeries(true, redraw); } } /** * Update series in the navigator from baseSeries, adding new if does not * exist. * * @private * @function Highcharts.Navigator.updateNavigatorSeries */ updateNavigatorSeries(addEvents, redraw) { const navigator = this, chart = navigator.chart, baseSeries = navigator.baseSeries, navSeriesMixin = { enableMouseTracking: false, index: null, linkedTo: null, group: 'nav', padXAxis: false, xAxis: 'navigator-x-axis', yAxis: 'navigator-y-axis', showInLegend: false, stacking: void 0, isInternal: true, states: { inactive: { opacity: 1 } } }, // Remove navigator series that are no longer in the baseSeries navigatorSeries = navigator.series = (navigator.series || []).filter((navSeries) => { const base = navSeries.baseSeries; if (baseSeries.indexOf(base) < 0) { // Not in array // If there is still a base series connected to this // series, remove event handler and reference. if (base) { removeEvent(base, 'updatedData', navigator.updatedDataHandler); delete base.navigatorSeries; } // Kill the nav series. It may already have been // destroyed (#8715). if (navSeries.chart) { navSeries.destroy(); } return false; } return true; }); let baseOptions, mergedNavSeriesOptions, chartNavigatorSeriesOptions = navigator.navigatorOptions.series, baseNavigatorOptions; // Go through each base series and merge the options to create new // series if (baseSeries && baseSeries.length) { baseSeries.forEach((base) => { const linkedNavSeries = base.navigatorSeries, userNavOptions = extend( // Grab color and visibility from base as default { color: base.color, visible: base.visible }, !isArray(chartNavigatorSeriesOptions) ? chartNavigatorSeriesOptions : defaultOptions.navigator.series); // Don't update if the series exists in nav and we have disabled // adaptToUpdatedData. if (linkedNavSeries && navigator.navigatorOptions.adaptToUpdatedData === false) { return; } navSeriesMixin.name = 'Navigator ' + baseSeries.length; baseOptions = base.options || {}; baseNavigatorOptions = baseOptions.navigatorOptions || {}; // The dataLabels options are not merged correctly // if the settings are an array, #13847. userNavOptions.dataLabels = splat(userNavOptions.dataLabels); mergedNavSeriesOptions = merge(baseOptions, navSeriesMixin, userNavOptions, baseNavigatorOptions); // Once nav series type is resolved, pick correct pointRange mergedNavSeriesOptions.pointRange = pick( // Stricte set pointRange in options userNavOptions.pointRange, baseNavigatorOptions.pointRange, // Fallback to default values, e.g. `null` for column defaultOptions.plotOptions[mergedNavSeriesOptions.type || 'line'].pointRange); // Merge data separately. Do a slice to avoid mutating the // navigator options from base series (#4923). const navigatorSeriesData = baseNavigatorOptions.data || userNavOptions.data; navigator.hasNavigatorData = navigator.hasNavigatorData || !!navigatorSeriesData; mergedNavSeriesOptions.data = navigatorSeriesData || baseOptions.data && baseOptions.data.slice(0); // Update or add the series if (linkedNavSeries && linkedNavSeries.options) { linkedNavSeries.update(mergedNavSeriesOptions, redraw); } else { base.navigatorSeries = chart.initSeries(mergedNavSeriesOptions); // Set data on initial run with dataSorting enabled (#20318) chart.setSortedData(); base.navigatorSeries.baseSeries = base; // Store ref navigatorSeries.push(base.navigatorSeries); } }); } // If user has defined data (and no base series) or explicitly defined // navigator.series as an array, we create these series on top of any // base series. if (chartNavigatorSeriesOptions.data && !(baseSeries && baseSeries.length) || isArray(chartNavigatorSeriesOptions)) { navigator.hasNavigatorData = false; // Allow navigator.series to be an array chartNavigatorSeriesOptions = splat(chartNavigatorSeriesOptions); chartNavigatorSeriesOptions.forEach((userSeriesOptions, i) => { navSeriesMixin.name = 'Navigator ' + (navigatorSeries.length + 1); mergedNavSeriesOptions = merge(defaultOptions.navigator.series, { // Since we don't have a base series to pull color from, // try to fake it by using color from series with same // index. Otherwise pull from the colors array. We need // an explicit color as otherwise updates will increment // color counter and we'll get a new color for each // update of the nav series. color: chart.series[i] && !chart.series[i].options.isInternal && chart.series[i].color || chart.options.colors[i] || chart.options.colors[0] }, navSeriesMixin, userSeriesOptions); mergedNavSeriesOptions.data = userSeriesOptions.data; if (mergedNavSeriesOptions.data) { navigator.hasNavigatorData = true; navigatorSeries.push(chart.initSeries(mergedNavSeriesOptions)); } }); } if (addEvents) { this.addBaseSeriesEvents(); } } /** * Add data events. * For example when main series is updated we need to recalculate extremes * * @private * @function Highcharts.Navigator#addBaseSeriesEvent */ addBaseSeriesEvents() { const navigator = this, baseSeries = navigator.baseSeries || []; // Bind modified extremes event to first base's xAxis only. // In event of > 1 base-xAxes, the navigator will ignore those. // Adding this multiple times to the same axis is no problem, as // duplicates should be discarded by the browser. if (baseSeries[0] && baseSeries[0].xAxis) { baseSeries[0].eventsToUnbind.push(addEvent(baseSeries[0].xAxis, 'foundExtremes', this.modifyBaseAxisExtremes)); } baseSeries.forEach((base) => { // Link base series show/hide to navigator series visibility base.eventsToUnbind.push(addEvent(base, 'show', function () { if (this.navigatorSeries) { this.navigatorSeries.setVisible(true, false); } })); base.eventsToUnbind.push(addEvent(base, 'hide', function () { if (this.navigatorSeries) { this.navigatorSeries.setVisible(false, false); } })); // Respond to updated data in the base series, unless explicitly // not adapting to data changes. if (this.navigatorOptions.adaptToUpdatedData !== false) { if (base.xAxis) { base.eventsToUnbind.push(addEvent(base, 'updatedData', this.updatedDataHandler)); } } // Handle series removal base.eventsToUnbind.push(addEvent(base, 'remove', function () { if (this.navigatorSeries) { erase(navigator.series, this.navigatorSeries); if (defined(this.navigatorSeries.options)) { this.navigatorSeries.remove(false); } delete this.navigatorSeries; } })); }); } /** * Get minimum from all base series connected to the navigator * @private * @param {number} currentSeriesMin * Minium from the current series * @return {number} * Minimum from all series */ getBaseSeriesMin(currentSeriesMin) { return this.baseSeries.reduce(function (min, series) { // (#10193) return Math.min(min, series.xData && series.xData.length ? series.xData[0] : min); }, currentSeriesMin); } /** * Set the navigator x axis extremes to reflect the total. The navigator * extremes should always be the extremes of the union of all series in the * chart as well as the navigator series. * * @private * @function Highcharts.Navigator#modifyNavigatorAxisExtremes */ modifyNavigatorAxisExtremes() { const xAxis = this.xAxis; if (typeof xAxis.getExtremes !== 'undefined') { const unionExtremes = this.getUnionExtremes(true); if (unionExtremes && (unionExtremes.dataMin !== xAxis.min || unionExtremes.dataMax !== xAxis.max)) { xAxis.min = unionExtremes.dataMin; xAxis.max = unionExtremes.dataMax; } } } /** * Hook to modify the base axis extremes with information from the Navigator * * @private * @function Highcharts.Navigator#modifyBaseAxisExtremes */ modifyBaseAxisExtremes() { const baseXAxis = this, navigator = baseXAxis.chart.navigator, baseExtremes = baseXAxis.getExtremes(), baseMin = baseExtremes.min, baseMax = baseExtremes.max, baseDataMin = baseExtremes.dataMin, baseDataMax = baseExtremes.dataMax, range = baseMax - baseMin, stickToMin = navigator.stickToMin, stickToMax = navigator.stickToMax, overscroll = pick(baseXAxis.ordinal?.convertOverscroll(baseXAxis.options.overscroll), 0), navigatorSeries = navigator.series && navigator.series[0], hasSetExtremes = !!baseXAxis.setExtremes, // When the extremes have been set by range selector button, don't // stick to min or max. The range selector buttons will handle the // extremes. (#5489) unmutable = baseXAxis.eventArgs && baseXAxis.eventArgs.trigger === 'rangeSelectorButton'; let newMax, newMin; if (!unmutable) { // If the zoomed range is already at the min, move it to the right // as new data comes in if (stickToMin) { newMin = baseDataMin; newMax = newMin + range; } // If the zoomed range is already at the max, move it to the right // as new data comes in if (stickToMax) { newMax = baseDataMax + overscroll; // If stickToMin is true, the new min value is set above if (!stickToMin) { newMin = Math.max(baseDataMin, // Don't go below data extremes (#13184) newMax - range, navigator.getBaseSeriesMin(navigatorSeries && navigatorSeries.xData ? navigatorSeries.xData[0] : -Number.MAX_VALUE)); } } // Update the extremes if (hasSetExtremes && (stickToMin || stickToMax)) { if (isNumber(newMin)) { baseXAxis.min = baseXAxis.userMin = newMin; baseXAxis.max = baseXAxis.userMax = newMax; } } } // Reset navigator.stickToMin = navigator.stickToMax = null; } /** * Handler for updated data on the base series. When data is modified, the * navigator series must reflect it. This is called from the Chart.redraw * function before axis and series extremes are computed. * * @private * @function Highcharts.Navigator#updateDataHandler */ updatedDataHandler() { const navigator = this.chart.navigator, baseSeries = this, navigatorSeries = this.navigatorSeries, shouldStickToMax = navigator.reversedExtremes ? Math.round(navigator.zoomedMin) === 0 : Math.round(navigator.zoomedMax) >= Math.round(navigator.size); // If the scrollbar is scrolled all the way to the right, keep right as // new data comes in, unless user set navigator.stickToMax to false. navigator.stickToMax = pick(this.chart.options.navigator && this.chart.options.navigator.stickToMax, shouldStickToMax); navigator.stickToMin = navigator.shouldStickToMin(baseSeries, navigator); // Set the navigator series data to the new data of the base series if (navigatorSeries && !navigator.hasNavigatorData) { navigatorSeries.options.pointStart = baseSeries.xData[0]; navigatorSeries.setData(baseSeries.options.data, false, null, false); // #5414 } } /** * Detect if the zoomed area should stick to the minimum, #14742. * * @private * @function Highcharts.Navigator#shouldStickToMin */ shouldStickToMin(baseSeries, navigator) { const xDataMin = navigator.getBaseSeriesMin(baseSeries.xData[0]), xAxis = baseSeries.xAxis, max = xAxis.max, min = xAxis.min, range = xAxis.options.range; let stickToMin = true; if (isNumber(max) && isNumber(min)) { // If range declared, stick to the minimum only if the range // is smaller than the data set range. if (range && max - xDataMin > 0) { stickToMin = max - xDataMin < range; } else { // If the current axis minimum falls outside the new // updated dataset, we must adjust. stickToMin = min <= xDataMin; } } else { stickToMin = false; // #15864 } return stickToMin; } /** * Add chart events, like redrawing navigator, when chart requires that. * * @private * @function Highcharts.Navigator#addChartEvents */ addChartEvents() { if (!this.eventsToUnbind) { this.eventsToUnbind = []; } this.eventsToUnbind.push( // Move the scrollbar after redraw, like after data updata even if // axes don't redraw addEvent(this.chart, 'redraw', function () { const navigator = this.navigator, xAxis = navigator && (navigator.baseSeries && navigator.baseSeries[0] && navigator.baseSeries[0].xAxis || this.xAxis[0]); // #5709, #13114 if (xAxis) { navigator.render(xAxis.min, xAxis.max); } }), // Make room for the navigator, can be placed around the chart: addEvent(this.chart, 'getMargins', function () { const chart = this, navigator = chart.navigator; let marginName = navigator.opposite ? 'plotTop' : 'marginBottom'; if (chart.inverted) { marginName = navigator.opposite ? 'marginRight' : 'plotLeft'; } chart[marginName] = (chart[marginName] || 0) + (navigator.navigatorEnabled || !chart.inverted ? navigator.height + navigator.scrollbarHeight : 0) + navigator.navigatorOptions.margin; }), addEvent(Navigator, 'setRange', function (e) { this.chart.xAxis[0].setExtremes(e.min, e.max, e.redraw, e.animation, e.eventArguments); })); } /** * Destroys allocated elements. * * @private * @function Highcharts.Navigator#destroy */ destroy() { // Disconnect events added in addEvents this.removeEvents(); if (this.xAxis) { erase(this.chart.xAxis, this.xAxis); erase(this.chart.axes, this.xAxis); } if (this.yAxis) { erase(this.chart.yAxis, this.yAxis); erase(this.chart.axes, this.yAxis); } // Destroy series (this.series || []).forEach((s) => { if (s.destroy) { s.destroy(); } }); // Destroy properties [ 'series', 'xAxis', 'yAxis', 'shades', 'outline', 'scrollbarTrack', 'scrollbarRifles', 'scrollbarGroup', 'scrollbar', 'navigatorGroup', 'rendered' ].forEach((prop) => { if (this[prop] && this[prop].destroy) { this[prop].destroy(); } this[prop] = null; }); // Destroy elements in collection [this.handles].forEach((coll) => { destroyObjectProperties(coll); }); } } /* * * * Default Export * * */ return Navigator; }); _registerModule(_modules, 'Stock/RangeSelector/RangeSelectorDefaults.js', [], function () { /* * * * (c) 2010-2024 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ /* * * * Declarations * * */ /** * Language object. The language object is global and it can't be set * on each chart initialization. Instead, use `Highcharts.setOptions` to * set it before any chart is initialized. * * ```js * Highcharts.setOptions({ * lang: { * months: [ * 'Janvier', 'Février', 'Mars', 'Avril', * 'Mai', 'Juin', 'Juillet', 'Août', * 'Septembre', 'Octobre', 'Novembre', 'Décembre' * ], * weekdays: [ * 'Dimanche', 'Lundi', 'Mardi', 'Mercredi', * 'Jeudi', 'Vendredi', 'Samedi' * ] * } * }); * ``` * * @optionparent lang */ const lang = { /** * The text for the label for the range selector buttons. * * @product highstock gantt */ rangeSelectorZoom: 'Zoom', /** * The text for the label for the "from" input box in the range * selector. Since v9.0, this string is empty as the label is not * rendered by default. * * @product highstock gantt */ rangeSelectorFrom: '', /** * The text for the label for the "to" input box in the range selector. * * @product highstock gantt */ rangeSelectorTo: '→' }; /** * The range selector is a tool for selecting ranges to display within * the chart. It provides buttons to select preconfigured ranges in * the chart, like 1 day, 1 week, 1 month etc. It also provides input * boxes where min and max dates can be manually input. * * @product highstock gantt * @optionparent rangeSelector */ const rangeSelector = { /** * Whether to enable all buttons from the start. By default buttons are * only enabled if the corresponding time range exists on the X axis, * but enabling all buttons allows for dynamically loading different * time ranges. * * @sample {highstock} stock/rangeselector/allbuttonsenabled-true/ * All buttons enabled * * @since 2.0.3 */ allButtonsEnabled: false, /** * An array of configuration objects for the buttons. * * Defaults to: * ```js * buttons: [{ * type: 'month', * count: 1, * text: '1m', * title: 'View 1 month' * }, { * type: 'month', * count: 3, * text: '3m', * title: 'View 3 months' * }, { * type: 'month', * count: 6, * text: '6m', * title: 'View 6 months' * }, { * type: 'ytd', * text: 'YTD', * title: 'View year to date' * }, { * type: 'year', * count: 1, * text: '1y', * title: 'View 1 year' * }, { * type: 'all', * text: 'All', * title: 'View all' * }] * ``` * * @sample {highstock} stock/demo/rangeselector-datagrouping/ * Data grouping by buttons * * @type {Array<*>} */ buttons: void 0, /** * How many units of the defined type the button should span. If `type` * is "month" and `count` is 3, the button spans three months. * * @type {number} * @default 1 * @apioption rangeSelector.buttons.count */ /** * Fires when clicking on the rangeSelector button. One parameter, * event, is passed to the function, containing common event * information. * * ```js * click: function(e) { * console.log(this); * } * ``` * * Return false to stop default button's click action. * * @sample {highstock} stock/rangeselector/button-click/ * Click event on the button * * @type {Highcharts.RangeSelectorClickCallbackFunction} * @apioption rangeSelector.buttons.events.click */ /** * Additional range (in milliseconds) added to the end of the calculated * time span. * * @sample {highstock} stock/rangeselector/min-max-offsets/ * Button offsets * * @type {number} * @default 0 * @since 6.0.0 * @apioption rangeSelector.buttons.offsetMax */ /** * Additional range (in milliseconds) added to the start of the * calculated time span. * * @sample {highstock} stock/rangeselector/min-max-offsets/ * Button offsets * * @type {number} * @default 0 * @since 6.0.0 * @apioption rangeSelector.buttons.offsetMin */ /** * When buttons apply dataGrouping on a series, by default zooming * in/out will deselect buttons and unset dataGrouping. Enable this * option to keep buttons selected when extremes change. * * @sample {highstock} stock/rangeselector/preserve-datagrouping/ * Different preserveDataGrouping settings * * @type {boolean} * @default false * @since 6.1.2 * @apioption rangeSelector.buttons.preserveDataGrouping */ /** * A custom data grouping object for each button. * * @see [series.dataGrouping](#plotOptions.series.dataGrouping) * * @sample {highstock} stock/demo/rangeselector-datagrouping/ * Data grouping by range selector buttons * * @type {*} * @extends plotOptions.series.dataGrouping * @apioption rangeSelector.buttons.dataGrouping */ /** * The text for the button itself. * * @type {string} * @apioption rangeSelector.buttons.text */ /** * Explanation for the button, shown as a tooltip on hover, and used by * assistive technology. * * @type {string} * @apioption rangeSelector.buttons.title */ /** * Defined the time span for the button. Can be one of `millisecond`, * `second`, `minute`, `hour`, `day`, `week`, `month`, `year`, `ytd`, * and `all`. * * @type {Highcharts.RangeSelectorButtonTypeValue} * @apioption rangeSelector.buttons.type */ /** * The space in pixels between the buttons in the range selector. */ buttonSpacing: 5, /** * Whether to collapse the range selector buttons into a dropdown when * there is not enough room to show everything in a single row, instead * of dividing the range selector into multiple rows. * Can be one of the following: * - `always`: Always collapse * - `responsive`: Only collapse when there is not enough room * - `never`: Never collapse * * @sample {highstock} stock/rangeselector/dropdown/ * Dropdown option * * @validvalue ["always", "responsive", "never"] * @since 9.0.0 */ dropdown: 'responsive', /** * Enable or disable the range selector. Default to `true` for stock * charts, using the `stockChart` factory. * * @sample {highstock} stock/rangeselector/enabled/ * Disable the range selector * * @type {boolean|undefined} * @default {highstock} true */ enabled: void 0, /** * The vertical alignment of the rangeselector box. Allowed properties * are `top`, `middle`, `bottom`. * * @sample {highstock} stock/rangeselector/vertical-align-middle/ * Middle * @sample {highstock} stock/rangeselector/vertical-align-bottom/ * Bottom * * @type {Highcharts.VerticalAlignValue} * @since 6.0.0 */ verticalAlign: 'top', /** * A collection of attributes for the buttons. The object takes SVG * attributes like `fill`, `stroke`, `stroke-width`, as well as `style`, * a collection of CSS properties for the text. * * The object can also be extended with states, so you can set * presentational options for `hover`, `select` or `disabled` button * states. * * CSS styles for the text label. * * In styled mode, the buttons are styled by the * `.highcharts-range-selector-buttons .highcharts-button` rule with its * different states. * * @sample {highstock} stock/rangeselector/styling/ * Styling the buttons and inputs * * @type {Highcharts.SVGAttributes} */ buttonTheme: { /** @ignore */ width: 28, /** @ignore */ height: 18, /** @ignore */ padding: 2, /** @ignore */ zIndex: 7 // #484, #852 }, /** * When the rangeselector is floating, the plot area does not reserve * space for it. This opens for positioning anywhere on the chart. * * @sample {highstock} stock/rangeselector/floating/ * Placing the range selector between the plot area and the * navigator * * @since 6.0.0 */ floating: false, /** * The x offset of the range selector relative to its horizontal * alignment within `chart.spacingLeft` and `chart.spacingRight`. * * @since 6.0.0 */ x: 0, /** * The y offset of the range selector relative to its horizontal * alignment within `chart.spacingLeft` and `chart.spacingRight`. * * @since 6.0.0 */ y: 0, /** * Deprecated. The height of the range selector. Currently it is * calculated dynamically. * * @deprecated * @type {number|undefined} * @since 2.1.9 */ height: void 0, /** * The border color of the date input boxes. * * @sample {highstock} stock/rangeselector/styling/ * Styling the buttons and inputs * * @type {Highcharts.ColorString} * @since 1.3.7 */ inputBoxBorderColor: 'none', /** * The pixel height of the date input boxes. * * @sample {highstock} stock/rangeselector/styling/ * Styling the buttons and inputs * * @since 1.3.7 */ inputBoxHeight: 17, /** * The pixel width of the date input boxes. When `undefined`, the width * is fitted to the rendered content. * * @sample {highstock} stock/rangeselector/styling/ * Styling the buttons and inputs * * @type {number|undefined} * @since 1.3.7 */ inputBoxWidth: void 0, /** * The date format in the input boxes when not selected for editing. * Defaults to `%e %b %Y`. * * This is used to determine which type of input to show, * `datetime-local`, `date` or `time` and falling back to `text` when * the browser does not support the input type or the format contains * milliseconds. * * @sample {highstock} stock/rangeselector/input-type/ * Input types * @sample {highstock} stock/rangeselector/input-format/ * Milliseconds in the range selector * */ inputDateFormat: '%e %b %Y', /** * A custom callback function to parse values entered in the input boxes * and return a valid JavaScript time as milliseconds since 1970. * The first argument passed is a value to parse, * second is a boolean indicating use of the UTC time. * * This will only get called for inputs of type `text`. Since v8.2.3, * the input type is dynamically determined based on the granularity * of the `inputDateFormat` and the browser support. * * @sample {highstock} stock/rangeselector/input-format/ * Milliseconds in the range selector * * @type {Highcharts.RangeSelectorParseCallbackFunction} * @since 1.3.3 */ inputDateParser: void 0, /** * The date format in the input boxes when they are selected for * editing. This must be a format that is recognized by JavaScript * Date.parse. * * This will only be used for inputs of type `text`. Since v8.2.3, * the input type is dynamically determined based on the granularity * of the `inputDateFormat` and the browser support. * * @sample {highstock} stock/rangeselector/input-format/ * Milliseconds in the range selector * */ inputEditDateFormat: '%Y-%m-%d', /** * Enable or disable the date input boxes. */ inputEnabled: true, /** * Positioning for the input boxes. Allowed properties are `align`, * `x` and `y`. * * @since 1.2.4 */ inputPosition: { /** * The alignment of the input box. Allowed properties are `left`, * `center`, `right`. * * @sample {highstock} stock/rangeselector/input-button-position/ * Alignment * * @type {Highcharts.AlignValue} * @since 6.0.0 */ align: 'right', /** * X offset of the input row. */ x: 0, /** * Y offset of the input row. */ y: 0 }, /** * The space in pixels between the labels and the date input boxes in * the range selector. * * @since 9.0.0 */ inputSpacing: 5, /** * The index of the button to appear pre-selected. If the selected range * exceeds the total data range and the 'all' option is available, * the 'all' option, showing the full range, is automatically selected. * * @type {number} */ selected: void 0, /** * Positioning for the button row. * * @since 1.2.4 */ buttonPosition: { /** * The alignment of the input box. Allowed properties are `left`, * `center`, `right`. * * @sample {highstock} stock/rangeselector/input-button-position/ * Alignment * * @type {Highcharts.AlignValue} * @since 6.0.0 */ align: 'left', /** * X offset of the button row. */ x: 0, /** * Y offset of the button row. */ y: 0 }, /** * CSS for the HTML inputs in the range selector. * * In styled mode, the inputs are styled by the * `.highcharts-range-input text` rule in SVG mode, and * `input.highcharts-range-selector` when active. * * @sample {highstock} stock/rangeselector/styling/ * Styling the buttons and inputs * * @type {Highcharts.CSSObject} * @apioption rangeSelector.inputStyle */ inputStyle: { /** @ignore */ color: "#334eff" /* Palette.highlightColor80 */, /** @ignore */ cursor: 'pointer', /** @ignore */ fontSize: '0.8em' }, /** * CSS styles for the labels - the Zoom, From and To texts. * * In styled mode, the labels are styled by the * `.highcharts-range-label` class. * * @sample {highstock} stock/rangeselector/styling/ * Styling the buttons and inputs * * @type {Highcharts.CSSObject} */ labelStyle: { /** @ignore */ color: "#666666" /* Palette.neutralColor60 */, /** @ignore */ fontSize: '0.8em' } }; /* * * * Default Export * * */ const RangeSelectorDefaults = { lang, rangeSelector }; return RangeSelectorDefaults; }); _registerModule(_modules, 'Stock/RangeSelector/RangeSelectorComposition.js', [_modules['Core/Defaults.js'], _modules['Core/Globals.js'], _modules['Stock/RangeSelector/RangeSelectorDefaults.js'], _modules['Core/Utilities.js']], function (D, H, RangeSelectorDefaults, U) { /* * * * (c) 2010-2024 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { defaultOptions } = D; const { composed } = H; const { addEvent, defined, extend, find, isNumber, merge, pick, pushUnique } = U; /* * * * Constants * * */ const chartDestroyEvents = []; /* * * * Variables * * */ let RangeSelectorConstructor; /* * * * Functions * * */ /** * Get the axis min value based on the range option and the current max. For * stock charts this is extended via the {@link RangeSelector} so that if the * selected range is a multiple of months or years, it is compensated for * various month lengths. * * @private * @function Highcharts.Axis#minFromRange * @return {number|undefined} * The new minimum value. */ function axisMinFromRange() { const rangeOptions = this.range, type = rangeOptions.type, max = this.max, time = this.chart.time, // Get the true range from a start date getTrueRange = function (base, count) { const timeName = type === 'year' ? 'FullYear' : 'Month'; const date = new time.Date(base); const basePeriod = time.get(timeName, date); time.set(timeName, date, basePeriod + count); if (basePeriod === time.get(timeName, date)) { time.set('Date', date, 0); // #6537 } return date.getTime() - base; }; let min, range; if (isNumber(rangeOptions)) { min = max - rangeOptions; range = rangeOptions; } else if (rangeOptions) { min = max + getTrueRange(max, -(rangeOptions.count || 1)); // Let the fixedRange reflect initial settings (#5930) if (this.chart) { this.chart.setFixedRange(max - min); } } const dataMin = pick(this.dataMin, Number.MIN_VALUE); if (!isNumber(min)) { min = dataMin; } if (min <= dataMin) { min = dataMin; if (typeof range === 'undefined') { // #4501 range = getTrueRange(min, rangeOptions.count); } this.newMax = Math.min(min + range, pick(this.dataMax, Number.MAX_VALUE)); } if (!isNumber(max)) { min = void 0; } else if (!isNumber(rangeOptions) && rangeOptions && rangeOptions._offsetMin) { min += rangeOptions._offsetMin; } return min; } /** * @private */ function compose(AxisClass, ChartClass, RangeSelectorClass) { RangeSelectorConstructor = RangeSelectorClass; if (pushUnique(composed, 'RangeSelector')) { const chartProto = ChartClass.prototype; AxisClass.prototype.minFromRange = axisMinFromRange; addEvent(ChartClass, 'afterGetContainer', onChartAfterGetContainer); addEvent(ChartClass, 'beforeRender', onChartBeforeRender); addEvent(ChartClass, 'destroy', onChartDestroy); addEvent(ChartClass, 'getMargins', onChartGetMargins); addEvent(ChartClass, 'render', onChartRender); addEvent(ChartClass, 'update', onChartUpdate); chartProto.callbacks.push(onChartCallback); extend(defaultOptions, { rangeSelector: RangeSelectorDefaults.rangeSelector }); extend(defaultOptions.lang, RangeSelectorDefaults.lang); } } /** * Initialize rangeselector for stock charts * @private */ function onChartAfterGetContainer() { if (this.options.rangeSelector && this.options.rangeSelector.enabled) { this.rangeSelector = new RangeSelectorConstructor(this); } } /** * @private */ function onChartBeforeRender() { const chart = this, axes = chart.axes, rangeSelector = chart.rangeSelector; if (rangeSelector) { if (isNumber(rangeSelector.deferredYTDClick)) { rangeSelector.clickButton(rangeSelector.deferredYTDClick); delete rangeSelector.deferredYTDClick; } axes.forEach((axis) => { axis.updateNames(); axis.setScale(); }); chart.getAxisMargins(); rangeSelector.render(); const verticalAlign = rangeSelector.options.verticalAlign; if (!rangeSelector.options.floating) { if (verticalAlign === 'bottom') { this.extraBottomMargin = true; } else if (verticalAlign !== 'middle') { this.extraTopMargin = true; } } } } /** * @private */ function onChartCallback(chart) { let extremes, legend, alignTo, verticalAlign; const rangeSelector = chart.rangeSelector, redraw = () => { if (rangeSelector) { extremes = chart.xAxis[0].getExtremes(); legend = chart.legend; verticalAlign = (rangeSelector && rangeSelector.options.verticalAlign); if (isNumber(extremes.min)) { rangeSelector.render(extremes.min, extremes.max); } // Re-align the legend so that it's below the rangeselector if (legend.display && verticalAlign === 'top' && verticalAlign === legend.options.verticalAlign) { // Create a new alignment box for the legend. alignTo = merge(chart.spacingBox); if (legend.options.layout === 'vertical') { alignTo.y = chart.plotTop; } else { alignTo.y += rangeSelector.getHeight(); } legend.group.placed = false; // Don't animate the alignment. legend.align(alignTo); } } }; if (rangeSelector) { const events = find(chartDestroyEvents, (e) => e[0] === chart); if (!events) { chartDestroyEvents.push([chart, [ // Redraw the scroller on setExtremes addEvent(chart.xAxis[0], 'afterSetExtremes', function (e) { if (rangeSelector) { rangeSelector.render(e.min, e.max); } }), // Redraw the scroller chart resize addEvent(chart, 'redraw', redraw) ]]); } // Do it now redraw(); } } /** * Remove resize/afterSetExtremes at chart destroy. * @private */ function onChartDestroy() { for (let i = 0, iEnd = chartDestroyEvents.length; i < iEnd; ++i) { const events = chartDestroyEvents[i]; if (events[0] === this) { events[1].forEach((unbind) => unbind()); chartDestroyEvents.splice(i, 1); return; } } } /** * */ function onChartGetMargins() { const rangeSelector = this.rangeSelector; if (rangeSelector) { const rangeSelectorHeight = rangeSelector.getHeight(); if (this.extraTopMargin) { this.plotTop += rangeSelectorHeight; } if (this.extraBottomMargin) { this.marginBottom += rangeSelectorHeight; } } } /** * @private */ function onChartRender() { const chart = this, rangeSelector = chart.rangeSelector; if (rangeSelector && !rangeSelector.options.floating) { rangeSelector.render(); const verticalAlign = rangeSelector.options.verticalAlign; if (verticalAlign === 'bottom') { this.extraBottomMargin = true; } else if (verticalAlign !== 'middle') { this.extraTopMargin = true; } } } /** * @private */ function onChartUpdate(e) { const chart = this, options = e.options, optionsRangeSelector = options.rangeSelector, extraBottomMarginWas = this.extraBottomMargin, extraTopMarginWas = this.extraTopMargin; let rangeSelector = chart.rangeSelector; if (optionsRangeSelector && optionsRangeSelector.enabled && !defined(rangeSelector) && this.options.rangeSelector) { this.options.rangeSelector.enabled = true; this.rangeSelector = rangeSelector = new RangeSelectorConstructor(this); } this.extraBottomMargin = false; this.extraTopMargin = false; if (rangeSelector) { onChartCallback(this); const verticalAlign = (optionsRangeSelector && optionsRangeSelector.verticalAlign) || (rangeSelector.options && rangeSelector.options.verticalAlign); if (!rangeSelector.options.floating) { if (verticalAlign === 'bottom') { this.extraBottomMargin = true; } else if (verticalAlign !== 'middle') { this.extraTopMargin = true; } } if (this.extraBottomMargin !== extraBottomMarginWas || this.extraTopMargin !== extraTopMarginWas) { this.isDirtyBox = true; } } } /* * * * Default Export * * */ const RangeSelectorComposition = { compose }; return RangeSelectorComposition; }); _registerModule(_modules, 'Stock/RangeSelector/RangeSelector.js', [_modules['Core/Axis/Axis.js'], _modules['Core/Defaults.js'], _modules['Core/Globals.js'], _modules['Stock/RangeSelector/RangeSelectorComposition.js'], _modules['Core/Renderer/SVG/SVGElement.js'], _modules['Core/Utilities.js']], function (Axis, D, H, RangeSelectorComposition, SVGElement, U) { /* * * * (c) 2010-2024 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { defaultOptions } = D; const { addEvent, createElement, css, defined, destroyObjectProperties, discardElement, extend, fireEvent, isNumber, merge, objectEach, pad, pick, pInt, splat } = U; /* * * * Functions * * */ /** * Get the preferred input type based on a date format string. * * @private * @function preferredInputType */ function preferredInputType(format) { const ms = format.indexOf('%L') !== -1; if (ms) { return 'text'; } const date = ['a', 'A', 'd', 'e', 'w', 'b', 'B', 'm', 'o', 'y', 'Y'] .some((char) => format.indexOf('%' + char) !== -1); const time = ['H', 'k', 'I', 'l', 'M', 'S'] .some((char) => format.indexOf('%' + char) !== -1); if (date && time) { return 'datetime-local'; } if (date) { return 'date'; } if (time) { return 'time'; } return 'text'; } /* * * * Class * * */ /** * The range selector. * * @private * @class * @name Highcharts.RangeSelector * @param {Highcharts.Chart} chart */ class RangeSelector { /* * * * Static Functions * * */ /** * @private */ static compose(AxisClass, ChartClass) { RangeSelectorComposition.compose(AxisClass, ChartClass, RangeSelector); } /* * * * Constructor * * */ constructor(chart) { this.buttonOptions = RangeSelector.prototype.defaultButtons; this.initialButtonGroupWidth = 0; this.chart = chart; this.init(chart); } /* * * * Functions * * */ /** * The method to run when one of the buttons in the range selectors is * clicked * * @private * @function Highcharts.RangeSelector#clickButton * @param {number} i * The index of the button * @param {boolean} [redraw] */ clickButton(i, redraw) { const rangeSelector = this, chart = rangeSelector.chart, rangeOptions = rangeSelector.buttonOptions[i], baseAxis = chart.xAxis[0], unionExtremes = (chart.scroller && chart.scroller.getUnionExtremes()) || baseAxis || {}, type = rangeOptions.type, dataGrouping = rangeOptions.dataGrouping; let dataMin = unionExtremes.dataMin, dataMax = unionExtremes.dataMax, newMin, newMax = baseAxis && Math.round(Math.min(baseAxis.max, pick(dataMax, baseAxis.max))), // #1568 baseXAxisOptions, range = rangeOptions._range, rangeMin, minSetting, rangeSetting, ctx, ytdExtremes, addOffsetMin = true; // Chart has no data, base series is removed if (dataMin === null || dataMax === null) { return; } rangeSelector.setSelected(i); // Apply dataGrouping associated to button if (dataGrouping) { this.forcedDataGrouping = true; Axis.prototype.setDataGrouping.call(baseAxis || { chart: this.chart }, dataGrouping, false); this.frozenStates = rangeOptions.preserveDataGrouping; } // Apply range if (type === 'month' || type === 'year') { if (!baseAxis) { // This is set to the user options and picked up later when the // axis is instantiated so that we know the min and max. range = rangeOptions; } else { ctx = { range: rangeOptions, max: newMax, chart: chart, dataMin: dataMin, dataMax: dataMax }; newMin = baseAxis.minFromRange.call(ctx); if (isNumber(ctx.newMax)) { newMax = ctx.newMax; } // #15799: offsetMin is added in minFromRange so that it works // with pre-selected buttons as well addOffsetMin = false; } // Fixed times like minutes, hours, days } else if (range) { newMin = Math.max(newMax - range, dataMin); newMax = Math.min(newMin + range, dataMax); addOffsetMin = false; } else if (type === 'ytd') { // On user clicks on the buttons, or a delayed action running from // the beforeRender event (below), the baseAxis is defined. if (baseAxis) { // When "ytd" is the pre-selected button for the initial view, // its calculation is delayed and rerun in the beforeRender // event (below). When the series are initialized, but before // the chart is rendered, we have access to the xData array // (#942). if (typeof dataMax === 'undefined' || typeof dataMin === 'undefined') { dataMin = Number.MAX_VALUE; dataMax = Number.MIN_VALUE; chart.series.forEach((series) => { // Reassign it to the last item const xData = series.xData; if (xData) { dataMin = Math.min(xData[0], dataMin); dataMax = Math.max(xData[xData.length - 1], dataMax); } }); redraw = false; } ytdExtremes = rangeSelector.getYTDExtremes(dataMax, dataMin, chart.time.useUTC); newMin = rangeMin = ytdExtremes.min; newMax = ytdExtremes.max; // "ytd" is pre-selected. We don't yet have access to processed // point and extremes data (things like pointStart and pointInterval // are missing), so we delay the process (#942) } else { rangeSelector.deferredYTDClick = i; return; } } else if (type === 'all' && baseAxis) { // If the navigator exist and the axis range is declared reset that // range and from now on only use the range set by a user, #14742. if (chart.navigator && chart.navigator.baseSeries[0]) { chart.navigator.baseSeries[0].xAxis.options.range = void 0; } newMin = dataMin; newMax = dataMax; } if (addOffsetMin && rangeOptions._offsetMin && defined(newMin)) { newMin += rangeOptions._offsetMin; } if (rangeOptions._offsetMax && defined(newMax)) { newMax += rangeOptions._offsetMax; } if (this.dropdown) { this.dropdown.selectedIndex = i + 1; } // Update the chart if (!baseAxis) { // Axis not yet instantiated. Temporarily set min and range // options and remove them on chart load (#4317). baseXAxisOptions = splat(chart.options.xAxis)[0]; rangeSetting = baseXAxisOptions.range; baseXAxisOptions.range = range; minSetting = baseXAxisOptions.min; baseXAxisOptions.min = rangeMin; addEvent(chart, 'load', function resetMinAndRange() { chart.setFixedRange(rangeOptions._range); baseXAxisOptions.range = rangeSetting; baseXAxisOptions.min = minSetting; }); } else { // Existing axis object. Set extremes after render time. baseAxis.setExtremes(newMin, newMax, pick(redraw, true), void 0, // Auto animation { trigger: 'rangeSelectorButton', rangeSelectorButton: rangeOptions }); chart.setFixedRange(rangeOptions._range); } fireEvent(this, 'afterBtnClick'); } /** * Set the selected option. This method only sets the internal flag, it * doesn't update the buttons or the actual zoomed range. * * @private * @function Highcharts.RangeSelector#setSelected * @param {number} [selected] */ setSelected(selected) { this.selected = this.options.selected = selected; } /** * Initialize the range selector * * @private * @function Highcharts.RangeSelector#init * @param {Highcharts.Chart} chart */ init(chart) { const rangeSelector = this, options = chart.options.rangeSelector, buttonOptions = (options.buttons || rangeSelector.defaultButtons.slice()), selectedOption = options.selected, blurInputs = function () { const minInput = rangeSelector.minInput, maxInput = rangeSelector.maxInput; // #3274 in some case blur is not defined if (minInput && !!minInput.blur) { fireEvent(minInput, 'blur'); } if (maxInput && !!maxInput.blur) { fireEvent(maxInput, 'blur'); } }; rangeSelector.chart = chart; rangeSelector.options = options; rangeSelector.buttons = []; rangeSelector.buttonOptions = buttonOptions; this.eventsToUnbind = []; this.eventsToUnbind.push(addEvent(chart.container, 'mousedown', blurInputs)); this.eventsToUnbind.push(addEvent(chart, 'resize', blurInputs)); // Extend the buttonOptions with actual range buttonOptions.forEach(rangeSelector.computeButtonRange); // Zoomed range based on a pre-selected button index if (typeof selectedOption !== 'undefined' && buttonOptions[selectedOption]) { this.clickButton(selectedOption, false); } this.eventsToUnbind.push(addEvent(chart, 'load', function () { // If a data grouping is applied to the current button, release it // when extremes change if (chart.xAxis && chart.xAxis[0]) { addEvent(chart.xAxis[0], 'setExtremes', function (e) { if (isNumber(this.max) && isNumber(this.min) && this.max - this.min !== chart.fixedRange && e.trigger !== 'rangeSelectorButton' && e.trigger !== 'updatedData' && rangeSelector.forcedDataGrouping && !rangeSelector.frozenStates) { this.setDataGrouping(false, false); } }); } })); } /** * Dynamically update the range selector buttons after a new range has been * set * * @private * @function Highcharts.RangeSelector#updateButtonStates */ updateButtonStates() { const rangeSelector = this, chart = this.chart, dropdown = this.dropdown, baseAxis = chart.xAxis[0], actualRange = Math.round(baseAxis.max - baseAxis.min), hasNoData = !baseAxis.hasVisibleSeries, day = 24 * 36e5, // A single day in milliseconds unionExtremes = (chart.scroller && chart.scroller.getUnionExtremes()) || baseAxis, dataMin = unionExtremes.dataMin, dataMax = unionExtremes.dataMax, ytdExtremes = rangeSelector.getYTDExtremes(dataMax, dataMin, chart.time.useUTC), ytdMin = ytdExtremes.min, ytdMax = ytdExtremes.max, selected = rangeSelector.selected, allButtonsEnabled = rangeSelector.options.allButtonsEnabled, buttons = rangeSelector.buttons; let selectedExists = isNumber(selected), isSelectedTooGreat = false; rangeSelector.buttonOptions.forEach((rangeOptions, i) => { const range = rangeOptions._range, type = rangeOptions.type, count = rangeOptions.count || 1, button = buttons[i], offsetRange = rangeOptions._offsetMax - rangeOptions._offsetMin, isSelected = i === selected, // Disable buttons where the range exceeds what is allowed in // the current view isTooGreatRange = range > dataMax - dataMin, // Disable buttons where the range is smaller than the minimum // range isTooSmallRange = range < baseAxis.minRange; let state = 0, // Do not select the YTD button if not explicitly told so isYTDButNotSelected = false, // Disable the All button if we're already showing all isAllButAlreadyShowingAll = false, isSameRange = range === actualRange; if (isSelected && isTooGreatRange) { isSelectedTooGreat = true; } if (baseAxis.isOrdinal && baseAxis.ordinal?.positions && range && actualRange < range) { // Handle ordinal ranges const positions = baseAxis.ordinal.positions; if (positions[positions.length - 1] - positions[0] > range) { isSameRange = true; } } else if ( // Months and years have variable range so we check the extremes (type === 'month' || type === 'year') && (actualRange + 36e5 >= { month: 28, year: 365 }[type] * day * count - offsetRange) && (actualRange - 36e5 <= { month: 31, year: 366 }[type] * day * count + offsetRange)) { isSameRange = true; } else if (type === 'ytd') { isSameRange = (ytdMax - ytdMin + offsetRange) === actualRange; isYTDButNotSelected = !isSelected; } else if (type === 'all') { isSameRange = (baseAxis.max - baseAxis.min >= dataMax - dataMin); isAllButAlreadyShowingAll = (!isSelected && selectedExists && isSameRange); } // The new zoom area happens to match the range for a button - mark // it selected. This happens when scrolling across an ordinal gap. // It can be seen in the intraday demos when selecting 1h and scroll // across the night gap. const disable = (!allButtonsEnabled && !(isSelectedTooGreat && type === 'all') && (isTooGreatRange || isTooSmallRange || isAllButAlreadyShowingAll || hasNoData)); const select = ((isSelectedTooGreat && type === 'all') || (isSelected && isSameRange) || (isSameRange && !selectedExists && !isYTDButNotSelected) || (isSelected && rangeSelector.frozenStates)); if (disable) { state = 3; } else if (select) { selectedExists = true; // Only one button can be selected state = 2; } // If state has changed, update the button if (button.state !== state) { button.setState(state); if (dropdown) { dropdown.options[i + 1].disabled = disable; if (state === 2) { dropdown.selectedIndex = i + 1; } } // Reset (#9209) if (state === 0 && selected === i) { rangeSelector.setSelected(); } else if ((state === 2 && !defined(selected)) || isSelectedTooGreat) { rangeSelector.setSelected(i); } } }); } /** * Compute and cache the range for an individual button * * @private * @function Highcharts.RangeSelector#computeButtonRange * @param {Highcharts.RangeSelectorButtonsOptions} rangeOptions */ computeButtonRange(rangeOptions) { const type = rangeOptions.type, count = rangeOptions.count || 1, // These time intervals have a fixed number of milliseconds, as // opposed to month, ytd and year fixedTimes = { millisecond: 1, second: 1000, minute: 60 * 1000, hour: 3600 * 1000, day: 24 * 3600 * 1000, week: 7 * 24 * 3600 * 1000 }; // Store the range on the button object if (fixedTimes[type]) { rangeOptions._range = fixedTimes[type] * count; } else if (type === 'month' || type === 'year') { rangeOptions._range = { month: 30, year: 365 }[type] * 24 * 36e5 * count; } rangeOptions._offsetMin = pick(rangeOptions.offsetMin, 0); rangeOptions._offsetMax = pick(rangeOptions.offsetMax, 0); rangeOptions._range += rangeOptions._offsetMax - rangeOptions._offsetMin; } /** * Get the unix timestamp of a HTML input for the dates * * @private * @function Highcharts.RangeSelector#getInputValue */ getInputValue(name) { const input = name === 'min' ? this.minInput : this.maxInput; const options = this.chart.options .rangeSelector; const time = this.chart.time; if (input) { return ((input.type === 'text' && options.inputDateParser) || this.defaultInputDateParser)(input.value, time.useUTC, time); } return 0; } /** * Set the internal and displayed value of a HTML input for the dates * * @private * @function Highcharts.RangeSelector#setInputValue */ setInputValue(name, inputTime) { const options = this.options, time = this.chart.time, input = name === 'min' ? this.minInput : this.maxInput, dateBox = name === 'min' ? this.minDateBox : this.maxDateBox; if (input) { const hcTimeAttr = input.getAttribute('data-hc-time'); let updatedTime = defined(hcTimeAttr) ? Number(hcTimeAttr) : void 0; if (defined(inputTime)) { const previousTime = updatedTime; if (defined(previousTime)) { input.setAttribute('data-hc-time-previous', previousTime); } input.setAttribute('data-hc-time', inputTime); updatedTime = inputTime; } input.value = time.dateFormat((this.inputTypeFormats[input.type] || options.inputEditDateFormat), updatedTime); if (dateBox) { dateBox.attr({ text: time.dateFormat(options.inputDateFormat, updatedTime) }); } } } /** * Set the min and max value of a HTML input for the dates * * @private * @function Highcharts.RangeSelector#setInputExtremes */ setInputExtremes(name, min, max) { const input = name === 'min' ? this.minInput : this.maxInput; if (input) { const format = this.inputTypeFormats[input.type]; const time = this.chart.time; if (format) { const newMin = time.dateFormat(format, min); if (input.min !== newMin) { input.min = newMin; } const newMax = time.dateFormat(format, max); if (input.max !== newMax) { input.max = newMax; } } } } /** * @private * @function Highcharts.RangeSelector#showInput * @param {string} name */ showInput(name) { const dateBox = name === 'min' ? this.minDateBox : this.maxDateBox, input = name === 'min' ? this.minInput : this.maxInput; if (input && dateBox && this.inputGroup) { const isTextInput = input.type === 'text', { translateX = 0, translateY = 0 } = this.inputGroup, { x = 0, width = 0, height = 0 } = dateBox, { inputBoxWidth } = this.options; css(input, { width: isTextInput ? ((width + (inputBoxWidth ? -2 : 20)) + 'px') : 'auto', height: (height - 2) + 'px', border: '2px solid silver' }); if (isTextInput && inputBoxWidth) { css(input, { left: (translateX + x) + 'px', top: translateY + 'px' }); // Inputs of types date, time or datetime-local should be centered // on top of the dateBox } else { css(input, { left: Math.min(Math.round(x + translateX - (input.offsetWidth - width) / 2), this.chart.chartWidth - input.offsetWidth) + 'px', top: (translateY - (input.offsetHeight - height) / 2) + 'px' }); } } } /** * @private * @function Highcharts.RangeSelector#hideInput * @param {string} name */ hideInput(name) { const input = name === 'min' ? this.minInput : this.maxInput; if (input) { css(input, { top: '-9999em', border: 0, width: '1px', height: '1px' }); } } /** * @private * @function Highcharts.RangeSelector#defaultInputDateParser */ defaultInputDateParser(inputDate, useUTC, time) { const hasTimezone = (str) => str.length > 6 && (str.lastIndexOf('-') === str.length - 6 || str.lastIndexOf('+') === str.length - 6); let input = inputDate.split('/').join('-').split(' ').join('T'); if (input.indexOf('T') === -1) { input += 'T00:00'; } if (useUTC) { input += 'Z'; } else if (H.isSafari && !hasTimezone(input)) { const offset = new Date(input).getTimezoneOffset() / 60; input += offset <= 0 ? `+${pad(-offset)}:00` : `-${pad(offset)}:00`; } let date = Date.parse(input); // If the value isn't parsed directly to a value by the // browser's Date.parse method, try // parsing it a different way if (!isNumber(date)) { const parts = inputDate.split('-'); date = Date.UTC(pInt(parts[0]), pInt(parts[1]) - 1, pInt(parts[2])); } if (time && useUTC && isNumber(date)) { date += time.getTimezoneOffset(date); } return date; } /** * Draw either the 'from' or the 'to' HTML input box of the range selector * * @private * @function Highcharts.RangeSelector#drawInput */ drawInput(name) { const { chart, div, inputGroup } = this; const rangeSelector = this, chartStyle = chart.renderer.style || {}, renderer = chart.renderer, options = chart.options.rangeSelector, lang = defaultOptions.lang, isMin = name === 'min'; /** * @private */ function updateExtremes() { const { maxInput, minInput } = rangeSelector, chartAxis = chart.xAxis[0], unionExtremes = (chart.scroller && chart.scroller.getUnionExtremes()) || chartAxis, dataMin = unionExtremes.dataMin, dataMax = unionExtremes.dataMax; let value = rangeSelector.getInputValue(name); if (value !== Number(input.getAttribute('data-hc-time-previous')) && isNumber(value)) { input.setAttribute('data-hc-time-previous', value); // Validate the extremes. If it goes beyond the data min or // max, use the actual data extreme (#2438). if (isMin && maxInput && isNumber(dataMin)) { if (value > Number(maxInput.getAttribute('data-hc-time'))) { value = void 0; } else if (value < dataMin) { value = dataMin; } } else if (minInput && isNumber(dataMax)) { if (value < Number(minInput.getAttribute('data-hc-time'))) { value = void 0; } else if (value > dataMax) { value = dataMax; } } // Set the extremes if (typeof value !== 'undefined') { // @todo typeof undefined chartAxis.setExtremes(isMin ? value : chartAxis.min, isMin ? chartAxis.max : value, void 0, void 0, { trigger: 'rangeSelectorInput' }); } } } // Create the text label const text = lang[isMin ? 'rangeSelectorFrom' : 'rangeSelectorTo'] || ''; const label = renderer .label(text, 0) .addClass('highcharts-range-label') .attr({ padding: text ? 2 : 0, height: text ? options.inputBoxHeight : 0 }) .add(inputGroup); // Create an SVG label that shows updated date ranges and records click // events that bring in the HTML input. const dateBox = renderer .label('', 0) .addClass('highcharts-range-input') .attr({ padding: 2, width: options.inputBoxWidth, height: options.inputBoxHeight, 'text-align': 'center' }) .on('click', function () { // If it is already focused, the onfocus event doesn't fire // (#3713) rangeSelector.showInput(name); rangeSelector[name + 'Input'].focus(); }); if (!chart.styledMode) { dateBox.attr({ stroke: options.inputBoxBorderColor, 'stroke-width': 1 }); } dateBox.add(inputGroup); // Create the HTML input element. This is rendered as 1x1 pixel then set // to the right size when focused. const input = createElement('input', { name: name, className: 'highcharts-range-selector' }, void 0, div); // #14788: Setting input.type to an unsupported type throws in IE, so // we need to use setAttribute instead input.setAttribute('type', preferredInputType(options.inputDateFormat || '%e %b %Y')); if (!chart.styledMode) { // Styles label.css(merge(chartStyle, options.labelStyle)); dateBox.css(merge({ color: "#333333" /* Palette.neutralColor80 */ }, chartStyle, options.inputStyle)); css(input, extend({ position: 'absolute', border: 0, boxShadow: '0 0 15px rgba(0,0,0,0.3)', width: '1px', height: '1px', padding: 0, textAlign: 'center', fontSize: chartStyle.fontSize, fontFamily: chartStyle.fontFamily, top: '-9999em' // #4798 }, options.inputStyle)); } // Blow up the input box input.onfocus = () => { rangeSelector.showInput(name); }; // Hide away the input box input.onblur = () => { // Update extremes only when inputs are active if (input === H.doc.activeElement) { // Only when focused // Update also when no `change` event is triggered, like when // clicking inside the SVG (#4710) updateExtremes(); } // #10404 - move hide and blur outside focus rangeSelector.hideInput(name); rangeSelector.setInputValue(name); input.blur(); // #4606 }; let keyDown = false; // Handle changes in the input boxes input.onchange = () => { // Update extremes and blur input when clicking date input calendar if (!keyDown) { updateExtremes(); rangeSelector.hideInput(name); input.blur(); } }; input.onkeypress = (event) => { // IE does not fire onchange on enter if (event.keyCode === 13) { updateExtremes(); } }; input.onkeydown = (event) => { keyDown = true; // Arrow keys if (event.keyCode === 38 || event.keyCode === 40) { updateExtremes(); } }; input.onkeyup = () => { keyDown = false; }; return { dateBox, input, label }; } /** * Get the position of the range selector buttons and inputs. This can be * overridden from outside for custom positioning. * * @private * @function Highcharts.RangeSelector#getPosition */ getPosition() { const chart = this.chart, options = chart.options.rangeSelector, top = options.verticalAlign === 'top' ? chart.plotTop - chart.axisOffset[0] : 0; // Set offset only for verticalAlign top return { buttonTop: top + options.buttonPosition.y, inputTop: top + options.inputPosition.y - 10 }; } /** * Get the extremes of YTD. Will choose dataMax if its value is lower than * the current timestamp. Will choose dataMin if its value is higher than * the timestamp for the start of current year. * * @private * @function Highcharts.RangeSelector#getYTDExtremes * @return {*} * Returns min and max for the YTD */ getYTDExtremes(dataMax, dataMin, useUTC) { const time = this.chart.time, now = new time.Date(dataMax), year = time.get('FullYear', now), startOfYear = useUTC ? time.Date.UTC(year, 0, 1) : // eslint-disable-line new-cap +new time.Date(year, 0, 1), min = Math.max(dataMin, startOfYear), ts = now.getTime(); return { max: Math.min(dataMax || ts, ts), min }; } /** * Render the range selector including the buttons and the inputs. The first * time render is called, the elements are created and positioned. On * subsequent calls, they are moved and updated. * * @private * @function Highcharts.RangeSelector#render * @param {number} [min] * X axis minimum * @param {number} [max] * X axis maximum */ render(min, max) { const chart = this.chart, renderer = chart.renderer, container = chart.container, chartOptions = chart.options, options = chartOptions.rangeSelector, // Place inputs above the container inputsZIndex = pick(chartOptions.chart.style && chartOptions.chart.style.zIndex, 0) + 1, inputEnabled = options.inputEnabled, rendered = this.rendered; if (options.enabled === false) { return; } // Create the elements if (!rendered) { this.group = renderer.g('range-selector-group') .attr({ zIndex: 7 }) .add(); this.div = createElement('div', void 0, { position: 'relative', height: 0, zIndex: inputsZIndex }); if (this.buttonOptions.length) { this.renderButtons(); } // First create a wrapper outside the container in order to make // the inputs work and make export correct if (container.parentNode) { container.parentNode.insertBefore(this.div, container); } if (inputEnabled) { // Create the group to keep the inputs this.inputGroup = renderer.g('input-group').add(this.group); const minElems = this.drawInput('min'); this.minDateBox = minElems.dateBox; this.minLabel = minElems.label; this.minInput = minElems.input; const maxElems = this.drawInput('max'); this.maxDateBox = maxElems.dateBox; this.maxLabel = maxElems.label; this.maxInput = maxElems.input; } } if (inputEnabled) { // Set or reset the input values this.setInputValue('min', min); this.setInputValue('max', max); const unionExtremes = (chart.scroller && chart.scroller.getUnionExtremes()) || chart.xAxis[0] || {}; if (defined(unionExtremes.dataMin) && defined(unionExtremes.dataMax)) { const minRange = chart.xAxis[0].minRange || 0; this.setInputExtremes('min', unionExtremes.dataMin, Math.min(unionExtremes.dataMax, this.getInputValue('max')) - minRange); this.setInputExtremes('max', Math.max(unionExtremes.dataMin, this.getInputValue('min')) + minRange, unionExtremes.dataMax); } // Reflow if (this.inputGroup) { let x = 0; [ this.minLabel, this.minDateBox, this.maxLabel, this.maxDateBox ].forEach((label) => { if (label) { const { width } = label.getBBox(); if (width) { label.attr({ x }); x += width + options.inputSpacing; } } }); } } this.alignElements(); this.rendered = true; } /** * Render the range buttons. This only runs the first time, later the * positioning is laid out in alignElements. * * @private * @function Highcharts.RangeSelector#renderButtons */ renderButtons() { const { buttons, chart, options } = this; const lang = defaultOptions.lang; const renderer = chart.renderer; const buttonTheme = merge(options.buttonTheme); const states = buttonTheme && buttonTheme.states; // Prevent the button from resetting the width when the button state // changes since we need more control over the width when collapsing // the buttons const width = buttonTheme.width || 28; delete buttonTheme.width; delete buttonTheme.states; this.buttonGroup = renderer.g('range-selector-buttons').add(this.group); const dropdown = this.dropdown = createElement('select', void 0, { position: 'absolute', width: '1px', height: '1px', padding: 0, border: 0, top: '-9999em', cursor: 'pointer', opacity: 0.0001 }, this.div); // Prevent page zoom on iPhone addEvent(dropdown, 'touchstart', () => { dropdown.style.fontSize = '16px'; }); // Forward events from select to button [ [H.isMS ? 'mouseover' : 'mouseenter'], [H.isMS ? 'mouseout' : 'mouseleave'], ['change', 'click'] ].forEach(([from, to]) => { addEvent(dropdown, from, () => { const button = buttons[this.currentButtonIndex()]; if (button) { fireEvent(button.element, to || from); } }); }); this.zoomText = renderer .label((lang && lang.rangeSelectorZoom) || '', 0) .attr({ padding: options.buttonTheme.padding, height: options.buttonTheme.height, paddingLeft: 0, paddingRight: 0 }) .add(this.buttonGroup); if (!this.chart.styledMode) { this.zoomText.css(options.labelStyle); buttonTheme['stroke-width'] = pick(buttonTheme['stroke-width'], 0); } createElement('option', { textContent: this.zoomText.textStr, disabled: true }, void 0, dropdown); this.buttonOptions.forEach((rangeOptions, i) => { createElement('option', { textContent: rangeOptions.title || rangeOptions.text }, void 0, dropdown); buttons[i] = renderer .button(rangeOptions.text, 0, 0, (e) => { // Extract events from button object and call const buttonEvents = (rangeOptions.events && rangeOptions.events.click); let callDefaultEvent; if (buttonEvents) { callDefaultEvent = buttonEvents.call(rangeOptions, e); } if (callDefaultEvent !== false) { this.clickButton(i); } this.isActive = true; }, buttonTheme, states && states.hover, states && states.select, states && states.disabled) .attr({ 'text-align': 'center', width }) .add(this.buttonGroup); if (rangeOptions.title) { buttons[i].attr('title', rangeOptions.title); } }); } /** * Align the elements horizontally and vertically. * * @private * @function Highcharts.RangeSelector#alignElements */ alignElements() { const { buttonGroup, buttons, chart, group, inputGroup, options, zoomText } = this; const chartOptions = chart.options; const navButtonOptions = (chartOptions.exporting && chartOptions.exporting.enabled !== false && chartOptions.navigation && chartOptions.navigation.buttonOptions); const { buttonPosition, inputPosition, verticalAlign } = options; // Get the X offset required to avoid overlapping with the exporting // button. This is used both by the buttonGroup and the inputGroup. const getXOffsetForExportButton = (group, position) => { if (navButtonOptions && this.titleCollision(chart) && verticalAlign === 'top' && position.align === 'right' && ((position.y - group.getBBox().height - 12) < ((navButtonOptions.y || 0) + (navButtonOptions.height || 0) + chart.spacing[0]))) { return -40; } return 0; }; let plotLeft = chart.plotLeft; if (group && buttonPosition && inputPosition) { let translateX = buttonPosition.x - chart.spacing[3]; if (buttonGroup) { this.positionButtons(); if (!this.initialButtonGroupWidth) { let width = 0; if (zoomText) { width += zoomText.getBBox().width + 5; } buttons.forEach((button, i) => { width += button.width || 0; if (i !== buttons.length - 1) { width += options.buttonSpacing; } }); this.initialButtonGroupWidth = width; } plotLeft -= chart.spacing[3]; this.updateButtonStates(); // Detect collision between button group and exporting const xOffsetForExportButton = getXOffsetForExportButton(buttonGroup, buttonPosition); this.alignButtonGroup(xOffsetForExportButton); // Skip animation group.placed = buttonGroup.placed = chart.hasLoaded; } let xOffsetForExportButton = 0; if (inputGroup) { // Detect collision between the input group and exporting button xOffsetForExportButton = getXOffsetForExportButton(inputGroup, inputPosition); if (inputPosition.align === 'left') { translateX = plotLeft; } else if (inputPosition.align === 'right') { translateX = -Math.max(chart.axisOffset[1], -xOffsetForExportButton); } // Update the alignment to the updated spacing box inputGroup.align({ y: inputPosition.y, width: inputGroup.getBBox().width, align: inputPosition.align, // Fix wrong getBBox() value on right align x: inputPosition.x + translateX - 2 }, true, chart.spacingBox); // Skip animation inputGroup.placed = chart.hasLoaded; } this.handleCollision(xOffsetForExportButton); // Vertical align group.align({ verticalAlign }, true, chart.spacingBox); const alignTranslateY = group.alignAttr.translateY; // Set position let groupHeight = group.getBBox().height + 20; // # 20 padding let translateY = 0; // Calculate bottom position if (verticalAlign === 'bottom') { const legendOptions = chart.legend && chart.legend.options; const legendHeight = (legendOptions && legendOptions.verticalAlign === 'bottom' && legendOptions.enabled && !legendOptions.floating ? (chart.legend.legendHeight + pick(legendOptions.margin, 10)) : 0); groupHeight = groupHeight + legendHeight - 20; translateY = (alignTranslateY - groupHeight - (options.floating ? 0 : options.y) - (chart.titleOffset ? chart.titleOffset[2] : 0) - 10 // 10 spacing ); } if (verticalAlign === 'top') { if (options.floating) { translateY = 0; } if (chart.titleOffset && chart.titleOffset[0]) { translateY = chart.titleOffset[0]; } translateY += ((chart.margin[0] - chart.spacing[0]) || 0); } else if (verticalAlign === 'middle') { if (inputPosition.y === buttonPosition.y) { translateY = alignTranslateY; } else if (inputPosition.y || buttonPosition.y) { if (inputPosition.y < 0 || buttonPosition.y < 0) { translateY -= Math.min(inputPosition.y, buttonPosition.y); } else { translateY = alignTranslateY - groupHeight; } } } group.translate(options.x, options.y + Math.floor(translateY)); // Translate HTML inputs const { minInput, maxInput, dropdown } = this; if (options.inputEnabled && minInput && maxInput) { minInput.style.marginTop = group.translateY + 'px'; maxInput.style.marginTop = group.translateY + 'px'; } if (dropdown) { dropdown.style.marginTop = group.translateY + 'px'; } } } /** * Align the button group horizontally and vertically. * * @private * @function Highcharts.RangeSelector#alignButtonGroup * @param {number} xOffsetForExportButton * @param {number} [width] */ alignButtonGroup(xOffsetForExportButton, width) { const { chart, options, buttonGroup } = this; const { buttonPosition } = options; const plotLeft = chart.plotLeft - chart.spacing[3]; let translateX = buttonPosition.x - chart.spacing[3]; if (buttonPosition.align === 'right') { translateX += xOffsetForExportButton - plotLeft; // #13014 } else if (buttonPosition.align === 'center') { translateX -= plotLeft / 2; } if (buttonGroup) { // Align button group buttonGroup.align({ y: buttonPosition.y, width: pick(width, this.initialButtonGroupWidth), align: buttonPosition.align, x: translateX }, true, chart.spacingBox); } } /** * @private * @function Highcharts.RangeSelector#positionButtons */ positionButtons() { const { buttons, chart, options, zoomText } = this; const verb = chart.hasLoaded ? 'animate' : 'attr'; const { buttonPosition } = options; const plotLeft = chart.plotLeft; let buttonLeft = plotLeft; if (zoomText && zoomText.visibility !== 'hidden') { // #8769, allow dynamically updating margins zoomText[verb]({ x: pick(plotLeft + buttonPosition.x, plotLeft) }); // Button start position buttonLeft += buttonPosition.x + zoomText.getBBox().width + 5; } for (let i = 0, iEnd = this.buttonOptions.length; i < iEnd; ++i) { if (buttons[i].visibility !== 'hidden') { buttons[i][verb]({ x: buttonLeft }); // Increase the button position for the next button buttonLeft += (buttons[i].width || 0) + options.buttonSpacing; } else { buttons[i][verb]({ x: plotLeft }); } } } /** * Handle collision between the button group and the input group * * @private * @function Highcharts.RangeSelector#handleCollision * * @param {number} xOffsetForExportButton * The X offset of the group required to make room for the * exporting button */ handleCollision(xOffsetForExportButton) { const { chart, buttonGroup, inputGroup } = this; const { buttonPosition, dropdown, inputPosition } = this.options; const maxButtonWidth = () => { let buttonWidth = 0; this.buttons.forEach((button) => { const bBox = button.getBBox(); if (bBox.width > buttonWidth) { buttonWidth = bBox.width; } }); return buttonWidth; }; const groupsOverlap = (buttonGroupWidth) => { if (inputGroup && buttonGroup) { const inputGroupX = (inputGroup.alignAttr.translateX + inputGroup.alignOptions.x - xOffsetForExportButton + // `getBBox` for detecing left margin inputGroup.getBBox().x + // 2px padding to not overlap input and label 2); const inputGroupWidth = inputGroup.alignOptions.width; const buttonGroupX = buttonGroup.alignAttr.translateX + buttonGroup.getBBox().x; return (buttonGroupX + buttonGroupWidth > inputGroupX) && (inputGroupX + inputGroupWidth > buttonGroupX) && (buttonPosition.y < (inputPosition.y + inputGroup.getBBox().height)); } return false; }; const moveInputsDown = () => { if (inputGroup && buttonGroup) { inputGroup.attr({ translateX: inputGroup.alignAttr.translateX + (chart.axisOffset[1] >= -xOffsetForExportButton ? 0 : -xOffsetForExportButton), translateY: inputGroup.alignAttr.translateY + buttonGroup.getBBox().height + 10 }); } }; if (buttonGroup) { if (dropdown === 'always') { this.collapseButtons(xOffsetForExportButton); if (groupsOverlap(maxButtonWidth())) { // Move the inputs down if there is still a collision // after collapsing the buttons moveInputsDown(); } return; } if (dropdown === 'never') { this.expandButtons(); } } // Detect collision if (inputGroup && buttonGroup) { if ((inputPosition.align === buttonPosition.align) || // 20 is minimal spacing between elements groupsOverlap(this.initialButtonGroupWidth + 20)) { if (dropdown === 'responsive') { this.collapseButtons(xOffsetForExportButton); if (groupsOverlap(maxButtonWidth())) { moveInputsDown(); } } else { moveInputsDown(); } } else if (dropdown === 'responsive') { this.expandButtons(); } } else if (buttonGroup && dropdown === 'responsive') { if (this.initialButtonGroupWidth > chart.plotWidth) { this.collapseButtons(xOffsetForExportButton); } else { this.expandButtons(); } } } /** * Collapse the buttons and put the select element on top. * * @private * @function Highcharts.RangeSelector#collapseButtons * @param {number} xOffsetForExportButton */ collapseButtons(xOffsetForExportButton) { const { buttons, buttonOptions, chart, dropdown, options, zoomText } = this; // If the buttons are already collapsed do nothing. if (this.isCollapsed === true) { return; } this.isCollapsed = true; const userButtonTheme = (chart.userOptions.rangeSelector && chart.userOptions.rangeSelector.buttonTheme) || {}; const getAttribs = (text) => ({ text: text ? `${text} ▾` : '▾', width: 'auto', paddingLeft: pick(options.buttonTheme.paddingLeft, userButtonTheme.padding, 8), paddingRight: pick(options.buttonTheme.paddingRight, userButtonTheme.padding, 8) }); if (zoomText) { zoomText.hide(); } let hasActiveButton = false; buttonOptions.forEach((rangeOptions, i) => { const button = buttons[i]; if (button.state !== 2) { button.hide(); } else { button.show(); button.attr(getAttribs(rangeOptions.text)); hasActiveButton = true; } }); if (!hasActiveButton) { if (dropdown) { dropdown.selectedIndex = 0; } buttons[0].show(); buttons[0].attr(getAttribs(this.zoomText && this.zoomText.textStr)); } const { align } = options.buttonPosition; this.positionButtons(); if (align === 'right' || align === 'center') { this.alignButtonGroup(xOffsetForExportButton, buttons[this.currentButtonIndex()].getBBox().width); } this.showDropdown(); } /** * Show all the buttons and hide the select element. * * @private * @function Highcharts.RangeSelector#expandButtons */ expandButtons() { const { buttons, buttonOptions, options, zoomText } = this; this.hideDropdown(); // If buttons are already not collapsed, do nothing. if (this.isCollapsed === false) { return; } this.isCollapsed = false; if (zoomText) { zoomText.show(); } buttonOptions.forEach((rangeOptions, i) => { const button = buttons[i]; button.show(); button.attr({ text: rangeOptions.text, width: options.buttonTheme.width || 28, paddingLeft: pick(options.buttonTheme.paddingLeft, 'unset'), paddingRight: pick(options.buttonTheme.paddingRight, 'unset') }); if (button.state < 2) { button.setState(0); } }); this.positionButtons(); } /** * Get the index of the visible button when the buttons are collapsed. * * @private * @function Highcharts.RangeSelector#currentButtonIndex */ currentButtonIndex() { const { dropdown } = this; if (dropdown && dropdown.selectedIndex > 0) { return dropdown.selectedIndex - 1; } return 0; } /** * Position the select element on top of the button. * * @private * @function Highcharts.RangeSelector#showDropdown */ showDropdown() { const { buttonGroup, buttons, chart, dropdown } = this; if (buttonGroup && dropdown) { const { translateX = 0, translateY = 0 } = buttonGroup, bBox = buttons[this.currentButtonIndex()].getBBox(); css(dropdown, { left: (chart.plotLeft + translateX) + 'px', top: (translateY + 0.5) + 'px', width: bBox.width + 'px', height: bBox.height + 'px' }); this.hasVisibleDropdown = true; } } /** * @private * @function Highcharts.RangeSelector#hideDropdown */ hideDropdown() { const { dropdown } = this; if (dropdown) { css(dropdown, { top: '-9999em', width: '1px', height: '1px' }); this.hasVisibleDropdown = false; } } /** * Extracts height of range selector * * @private * @function Highcharts.RangeSelector#getHeight * @return {number} * Returns rangeSelector height */ getHeight() { const rangeSelector = this, options = rangeSelector.options, rangeSelectorGroup = rangeSelector.group, inputPosition = options.inputPosition, buttonPosition = options.buttonPosition, yPosition = options.y, buttonPositionY = buttonPosition.y, inputPositionY = inputPosition.y; let rangeSelectorHeight = 0; if (options.height) { return options.height; } // Align the elements before we read the height in case we're switching // between wrapped and non-wrapped layout this.alignElements(); rangeSelectorHeight = rangeSelectorGroup ? // 13px to keep back compatibility (rangeSelectorGroup.getBBox(true).height) + 13 + yPosition : 0; const minPosition = Math.min(inputPositionY, buttonPositionY); if ((inputPositionY < 0 && buttonPositionY < 0) || (inputPositionY > 0 && buttonPositionY > 0)) { rangeSelectorHeight += Math.abs(minPosition); } return rangeSelectorHeight; } /** * Detect collision with title or subtitle * * @private * @function Highcharts.RangeSelector#titleCollision * @return {boolean} * Returns collision status */ titleCollision(chart) { return !(chart.options.title.text || chart.options.subtitle.text); } /** * Update the range selector with new options * * @private * @function Highcharts.RangeSelector#update * @param {Highcharts.RangeSelectorOptions} options */ update(options) { const chart = this.chart; merge(true, chart.options.rangeSelector, options); this.destroy(); this.init(chart); this.render(); } /** * Destroys allocated elements. * * @private * @function Highcharts.RangeSelector#destroy */ destroy() { const rSelector = this, minInput = rSelector.minInput, maxInput = rSelector.maxInput; if (rSelector.eventsToUnbind) { rSelector.eventsToUnbind.forEach((unbind) => unbind()); rSelector.eventsToUnbind = void 0; } // Destroy elements in collections destroyObjectProperties(rSelector.buttons); // Clear input element events if (minInput) { minInput.onfocus = minInput.onblur = minInput.onchange = null; } if (maxInput) { maxInput.onfocus = maxInput.onblur = maxInput.onchange = null; } // Destroy HTML and SVG elements objectEach(rSelector, function (val, key) { if (val && key !== 'chart') { if (val instanceof SVGElement) { // SVGElement val.destroy(); } else if (val instanceof window.HTMLElement) { // HTML element discardElement(val); } } if (val !== RangeSelector.prototype[key]) { rSelector[key] = null; } }, this); } } extend(RangeSelector.prototype, { /** * The default buttons for pre-selecting time frames. * @private */ defaultButtons: [{ type: 'month', count: 1, text: '1m', title: 'View 1 month' }, { type: 'month', count: 3, text: '3m', title: 'View 3 months' }, { type: 'month', count: 6, text: '6m', title: 'View 6 months' }, { type: 'ytd', text: 'YTD', title: 'View year to date' }, { type: 'year', count: 1, text: '1y', title: 'View 1 year' }, { type: 'all', text: 'All', title: 'View all' }], /** * The date formats to use when setting min, max and value on date inputs. * @private */ inputTypeFormats: { 'datetime-local': '%Y-%m-%dT%H:%M:%S', 'date': '%Y-%m-%d', 'time': '%H:%M:%S' } }); /* * * * Default Export * * */ /* * * * API Options * * */ /** * Define the time span for the button * * @typedef {"all"|"day"|"hour"|"millisecond"|"minute"|"month"|"second"|"week"|"year"|"ytd"} Highcharts.RangeSelectorButtonTypeValue */ /** * Callback function to react on button clicks. * * @callback Highcharts.RangeSelectorClickCallbackFunction * * @param {global.Event} e * Event arguments. * * @param {boolean|undefined} * Return false to cancel the default button event. */ /** * Callback function to parse values entered in the input boxes and return a * valid JavaScript time as milliseconds since 1970. * * @callback Highcharts.RangeSelectorParseCallbackFunction * * @param {string} value * Input value to parse. * * @return {number} * Parsed JavaScript time value. */ (''); // Keeps doclets above in JS file return RangeSelector; }); _registerModule(_modules, 'Series/PathUtilities.js', [], function () { /* * * * (c) 2010-2024 Pawel Lysy * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const getLinkPath = { 'default': getDefaultPath, straight: getStraightPath, curved: getCurvedPath }; /** * */ function getDefaultPath(pathParams) { const { x1, y1, x2, y2, width = 0, inverted = false, radius, parentVisible } = pathParams; const path = [ ['M', x1, y1], ['L', x1, y1], ['C', x1, y1, x1, y2, x1, y2], ['L', x1, y2], ['C', x1, y1, x1, y2, x1, y2], ['L', x1, y2] ]; return parentVisible ? applyRadius([ ['M', x1, y1], ['L', x1 + width * (inverted ? -0.5 : 0.5), y1], ['L', x1 + width * (inverted ? -0.5 : 0.5), y2], ['L', x2, y2] ], radius) : path; } /** * */ function getStraightPath(pathParams) { const { x1, y1, x2, y2, width = 0, inverted = false, parentVisible } = pathParams; return parentVisible ? [ ['M', x1, y1], ['L', x1 + width * (inverted ? -1 : 1), y2], ['L', x2, y2] ] : [ ['M', x1, y1], ['L', x1, y2], ['L', x1, y2] ]; } /** * */ function getCurvedPath(pathParams) { const { x1, y1, x2, y2, offset = 0, width = 0, inverted = false, parentVisible } = pathParams; return parentVisible ? [ ['M', x1, y1], [ 'C', x1 + offset, y1, x1 - offset + width * (inverted ? -1 : 1), y2, x1 + width * (inverted ? -1 : 1), y2 ], ['L', x2, y2] ] : [ ['M', x1, y1], ['C', x1, y1, x1, y2, x1, y2], ['L', x2, y2] ]; } /** * General function to apply corner radius to a path * @private */ function applyRadius(path, r) { const d = []; for (let i = 0; i < path.length; i++) { const x = path[i][1]; const y = path[i][2]; if (typeof x === 'number' && typeof y === 'number') { // MoveTo if (i === 0) { d.push(['M', x, y]); } else if (i === path.length - 1) { d.push(['L', x, y]); // CurveTo } else if (r) { const prevSeg = path[i - 1]; const nextSeg = path[i + 1]; if (prevSeg && nextSeg) { const x1 = prevSeg[1], y1 = prevSeg[2], x2 = nextSeg[1], y2 = nextSeg[2]; // Only apply to breaks if (typeof x1 === 'number' && typeof x2 === 'number' && typeof y1 === 'number' && typeof y2 === 'number' && x1 !== x2 && y1 !== y2) { const directionX = x1 < x2 ? 1 : -1, directionY = y1 < y2 ? 1 : -1; d.push([ 'L', x - directionX * Math.min(Math.abs(x - x1), r), y - directionY * Math.min(Math.abs(y - y1), r) ], [ 'C', x, y, x, y, x + directionX * Math.min(Math.abs(x - x2), r), y + directionY * Math.min(Math.abs(y - y2), r) ]); } } // LineTo } else { d.push(['L', x, y]); } } } return d; } const PathUtilities = { applyRadius, getLinkPath }; return PathUtilities; }); _registerModule(_modules, 'Gantt/PathfinderAlgorithms.js', [_modules['Series/PathUtilities.js'], _modules['Core/Utilities.js']], function (PathUtilities, U) { /* * * * (c) 2016 Highsoft AS * Author: Øystein Moseng * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { pick } = U; /* * * * Constants * * */ const { min, max, abs } = Math; /* * * * Functions * * */ /** * Get index of last obstacle before xMin. Employs a type of binary search, and * thus requires that obstacles are sorted by xMin value. * * @private * @function findLastObstacleBefore * * @param {Array} obstacles * Array of obstacles to search in. * * @param {number} xMin * The xMin threshold. * * @param {number} [startIx] * Starting index to search from. Must be within array range. * * @return {number} * The index of the last obstacle element before xMin. */ function findLastObstacleBefore(obstacles, xMin, startIx) { const min = xMin - 0.0000001; // Make sure we include all obstacles at xMin let left = startIx || 0, // Left limit right = obstacles.length - 1, // Right limit cursor, cmp; while (left <= right) { cursor = (right + left) >> 1; cmp = min - obstacles[cursor].xMin; if (cmp > 0) { left = cursor + 1; } else if (cmp < 0) { right = cursor - 1; } else { return cursor; } } return left > 0 ? left - 1 : 0; } /** * Test if a point lays within an obstacle. * * @private * @function pointWithinObstacle * * @param {Object} obstacle * Obstacle to test. * * @param {Highcharts.Point} point * Point with x/y props. * * @return {boolean} * Whether point is within the obstacle or not. */ function pointWithinObstacle(obstacle, point) { return (point.x <= obstacle.xMax && point.x >= obstacle.xMin && point.y <= obstacle.yMax && point.y >= obstacle.yMin); } /** * Find the index of an obstacle that wraps around a point. * Returns -1 if not found. * * @private * @function findObstacleFromPoint * * @param {Array} obstacles * Obstacles to test. * * @param {Highcharts.Point} point * Point with x/y props. * * @return {number} * Ix of the obstacle in the array, or -1 if not found. */ function findObstacleFromPoint(obstacles, point) { let i = findLastObstacleBefore(obstacles, point.x + 1) + 1; while (i--) { if (obstacles[i].xMax >= point.x && // Optimization using lazy evaluation pointWithinObstacle(obstacles[i], point)) { return i; } } return -1; } /** * Get SVG path array from array of line segments. * * @private * @function pathFromSegments * * @param {Array} segments * The segments to build the path from. * * @return {Highcharts.SVGPathArray} * SVG path array as accepted by the SVG Renderer. */ function pathFromSegments(segments) { const path = []; if (segments.length) { path.push(['M', segments[0].start.x, segments[0].start.y]); for (let i = 0; i < segments.length; ++i) { path.push(['L', segments[i].end.x, segments[i].end.y]); } } return path; } /** * Limits obstacle max/mins in all directions to bounds. Modifies input * obstacle. * * @private * @function limitObstacleToBounds * * @param {Object} obstacle * Obstacle to limit. * * @param {Object} bounds * Bounds to use as limit. * * @return {void} */ function limitObstacleToBounds(obstacle, bounds) { obstacle.yMin = max(obstacle.yMin, bounds.yMin); obstacle.yMax = min(obstacle.yMax, bounds.yMax); obstacle.xMin = max(obstacle.xMin, bounds.xMin); obstacle.xMax = min(obstacle.xMax, bounds.xMax); } /** * Get an SVG path from a starting coordinate to an ending coordinate. * Draws a straight line. * * @function Highcharts.Pathfinder.algorithms.straight * * @param {Highcharts.PositionObject} start * Starting coordinate, object with x/y props. * * @param {Highcharts.PositionObject} end * Ending coordinate, object with x/y props. * * @return {Object} * An object with the SVG path in Array form as accepted by the SVG * renderer, as well as an array of new obstacles making up this * path. */ function straight(start, end) { return { path: [ ['M', start.x, start.y], ['L', end.x, end.y] ], obstacles: [{ start: start, end: end }] }; } /** * Find a path from a starting coordinate to an ending coordinate, using * right angles only, and taking only starting/ending obstacle into * consideration. * * @function Highcharts.Pathfinder.algorithms.simpleConnect * * @param {Highcharts.PositionObject} start * Starting coordinate, object with x/y props. * * @param {Highcharts.PositionObject} end * Ending coordinate, object with x/y props. * * @param {Object} options * Options for the algorithm: * - chartObstacles: Array of chart obstacles to avoid * - startDirectionX: Optional. True if starting in the X direction. * If not provided, the algorithm starts in the direction that is * the furthest between start/end. * * @return {Object} * An object with the SVG path in Array form as accepted by the SVG * renderer, as well as an array of new obstacles making up this * path. */ const simpleConnect = function (start, end, options) { const segments = [], chartObstacles = options.chartObstacles, startObstacleIx = findObstacleFromPoint(chartObstacles, start), endObstacleIx = findObstacleFromPoint(chartObstacles, end); let endSegment, dir = pick(options.startDirectionX, abs(end.x - start.x) > abs(end.y - start.y)) ? 'x' : 'y', startObstacle, endObstacle, waypoint, useMax, endPoint; // eslint-disable-next-line valid-jsdoc /** * Return a clone of a point with a property set from a target object, * optionally with an offset * @private */ function copyFromPoint(from, fromKey, to, toKey, offset) { const point = { x: from.x, y: from.y }; point[fromKey] = to[toKey || fromKey] + (offset || 0); return point; } // eslint-disable-next-line valid-jsdoc /** * Return waypoint outside obstacle. * @private */ function getMeOut(obstacle, point, direction) { const useMax = abs(point[direction] - obstacle[direction + 'Min']) > abs(point[direction] - obstacle[direction + 'Max']); return copyFromPoint(point, direction, obstacle, direction + (useMax ? 'Max' : 'Min'), useMax ? 1 : -1); } // Pull out end point if (endObstacleIx > -1) { endObstacle = chartObstacles[endObstacleIx]; waypoint = getMeOut(endObstacle, end, dir); endSegment = { start: waypoint, end: end }; endPoint = waypoint; } else { endPoint = end; } // If an obstacle envelops the start point, add a segment to get out, // and around it. if (startObstacleIx > -1) { startObstacle = chartObstacles[startObstacleIx]; waypoint = getMeOut(startObstacle, start, dir); segments.push({ start: start, end: waypoint }); // If we are going back again, switch direction to get around start // obstacle. if ( // Going towards max from start: waypoint[dir] >= start[dir] === // Going towards min to end: waypoint[dir] >= endPoint[dir]) { dir = dir === 'y' ? 'x' : 'y'; useMax = start[dir] < end[dir]; segments.push({ start: waypoint, end: copyFromPoint(waypoint, dir, startObstacle, dir + (useMax ? 'Max' : 'Min'), useMax ? 1 : -1) }); // Switch direction again dir = dir === 'y' ? 'x' : 'y'; } } // We are around the start obstacle. Go towards the end in one // direction. const prevWaypoint = segments.length ? segments[segments.length - 1].end : start; waypoint = copyFromPoint(prevWaypoint, dir, endPoint); segments.push({ start: prevWaypoint, end: waypoint }); // Final run to end point in the other direction dir = dir === 'y' ? 'x' : 'y'; const waypoint2 = copyFromPoint(waypoint, dir, endPoint); segments.push({ start: waypoint, end: waypoint2 }); // Finally add the endSegment segments.push(endSegment); const path = PathUtilities.applyRadius(pathFromSegments(segments), options.radius); return { path, obstacles: segments }; }; simpleConnect.requiresObstacles = true; /** * Find a path from a starting coordinate to an ending coordinate, taking * obstacles into consideration. Might not always find the optimal path, * but is fast, and usually good enough. * * @function Highcharts.Pathfinder.algorithms.fastAvoid * * @param {Highcharts.PositionObject} start * Starting coordinate, object with x/y props. * * @param {Highcharts.PositionObject} end * Ending coordinate, object with x/y props. * * @param {Object} options * Options for the algorithm. * - chartObstacles: Array of chart obstacles to avoid * - lineObstacles: Array of line obstacles to jump over * - obstacleMetrics: Object with metrics of chartObstacles cached * - hardBounds: Hard boundaries to not cross * - obstacleOptions: Options for the obstacles, including margin * - startDirectionX: Optional. True if starting in the X direction. * If not provided, the algorithm starts in the * direction that is the furthest between * start/end. * * @return {Object} * An object with the SVG path in Array form as accepted by the SVG * renderer, as well as an array of new obstacles making up this * path. */ function fastAvoid(start, end, options) { /* Algorithm rules/description - Find initial direction - Determine soft/hard max for each direction. - Move along initial direction until obstacle. - Change direction. - If hitting obstacle, first try to change length of previous line before changing direction again. Soft min/max x = start/destination x +/- widest obstacle + margin Soft min/max y = start/destination y +/- tallest obstacle + margin @todo: - Make retrospective, try changing prev segment to reduce corners - Fix logic for breaking out of end-points - not always picking the best direction currently - When going around the end obstacle we should not always go the shortest route, rather pick the one closer to the end point */ const dirIsX = pick(options.startDirectionX, abs(end.x - start.x) > abs(end.y - start.y)), dir = dirIsX ? 'x' : 'y', endSegments = [], // Boundaries to stay within. If beyond soft boundary, prefer to // change direction ASAP. If at hard max, always change immediately. metrics = options.obstacleMetrics, softMinX = min(start.x, end.x) - metrics.maxWidth - 10, softMaxX = max(start.x, end.x) + metrics.maxWidth + 10, softMinY = min(start.y, end.y) - metrics.maxHeight - 10, softMaxY = max(start.y, end.y) + metrics.maxHeight + 10; let segments, useMax, extractedEndPoint, forceObstacleBreak = false, // Used in clearPathTo to keep track of // when to force break through an obstacle. // Obstacles chartObstacles = options.chartObstacles, endObstacleIx = findLastObstacleBefore(chartObstacles, softMaxX); const startObstacleIx = findLastObstacleBefore(chartObstacles, softMinX); // eslint-disable-next-line valid-jsdoc /** * How far can you go between two points before hitting an obstacle? * Does not work for diagonal lines (because it doesn't have to). * @private */ function pivotPoint(fromPoint, toPoint, directionIsX) { const searchDirection = fromPoint.x < toPoint.x ? 1 : -1; let firstPoint, lastPoint, highestPoint, lowestPoint; if (fromPoint.x < toPoint.x) { firstPoint = fromPoint; lastPoint = toPoint; } else { firstPoint = toPoint; lastPoint = fromPoint; } if (fromPoint.y < toPoint.y) { lowestPoint = fromPoint; highestPoint = toPoint; } else { lowestPoint = toPoint; highestPoint = fromPoint; } // Go through obstacle range in reverse if toPoint is before // fromPoint in the X-dimension. let i = searchDirection < 0 ? // Searching backwards, start at last obstacle before last point min(findLastObstacleBefore(chartObstacles, lastPoint.x), chartObstacles.length - 1) : // Forwards. Since we're not sorted by xMax, we have to look // at all obstacles. 0; // Go through obstacles in this X range while (chartObstacles[i] && (searchDirection > 0 && chartObstacles[i].xMin <= lastPoint.x || searchDirection < 0 && chartObstacles[i].xMax >= firstPoint.x)) { // If this obstacle is between from and to points in a straight // line, pivot at the intersection. if (chartObstacles[i].xMin <= lastPoint.x && chartObstacles[i].xMax >= firstPoint.x && chartObstacles[i].yMin <= highestPoint.y && chartObstacles[i].yMax >= lowestPoint.y) { if (directionIsX) { return { y: fromPoint.y, x: fromPoint.x < toPoint.x ? chartObstacles[i].xMin - 1 : chartObstacles[i].xMax + 1, obstacle: chartObstacles[i] }; } // Else ... return { x: fromPoint.x, y: fromPoint.y < toPoint.y ? chartObstacles[i].yMin - 1 : chartObstacles[i].yMax + 1, obstacle: chartObstacles[i] }; } i += searchDirection; } return toPoint; } /** * Decide in which direction to dodge or get out of an obstacle. * Considers desired direction, which way is shortest, soft and hard * bounds. * * (? Returns a string, either xMin, xMax, yMin or yMax.) * * @private * @function * * @param {Object} obstacle * Obstacle to dodge/escape. * * @param {Object} fromPoint * Point with x/y props that's dodging/escaping. * * @param {Object} toPoint * Goal point. * * @param {boolean} dirIsX * Dodge in X dimension. * * @param {Object} bounds * Hard and soft boundaries. * * @return {boolean} * Use max or not. */ function getDodgeDirection(obstacle, fromPoint, toPoint, dirIsX, bounds) { const softBounds = bounds.soft, hardBounds = bounds.hard, dir = dirIsX ? 'x' : 'y', toPointMax = { x: fromPoint.x, y: fromPoint.y }, toPointMin = { x: fromPoint.x, y: fromPoint.y }, maxOutOfSoftBounds = obstacle[dir + 'Max'] >= softBounds[dir + 'Max'], minOutOfSoftBounds = obstacle[dir + 'Min'] <= softBounds[dir + 'Min'], maxOutOfHardBounds = obstacle[dir + 'Max'] >= hardBounds[dir + 'Max'], minOutOfHardBounds = obstacle[dir + 'Min'] <= hardBounds[dir + 'Min'], // Find out if we should prefer one direction over the other if // we can choose freely minDistance = abs(obstacle[dir + 'Min'] - fromPoint[dir]), maxDistance = abs(obstacle[dir + 'Max'] - fromPoint[dir]); let // If it's a small difference, pick the one leading towards dest // point. Otherwise pick the shortest distance useMax = abs(minDistance - maxDistance) < 10 ? fromPoint[dir] < toPoint[dir] : maxDistance < minDistance; // Check if we hit any obstacles trying to go around in either // direction. toPointMin[dir] = obstacle[dir + 'Min']; toPointMax[dir] = obstacle[dir + 'Max']; const minPivot = pivotPoint(fromPoint, toPointMin, dirIsX)[dir] !== toPointMin[dir], maxPivot = pivotPoint(fromPoint, toPointMax, dirIsX)[dir] !== toPointMax[dir]; useMax = minPivot ? (maxPivot ? useMax : true) : (maxPivot ? false : useMax); // `useMax` now contains our preferred choice, bounds not taken into // account. If both or neither direction is out of bounds we want to // use this. // Deal with soft bounds useMax = minOutOfSoftBounds ? (maxOutOfSoftBounds ? useMax : true) : // Out on min (maxOutOfSoftBounds ? false : useMax); // Not out on min // Deal with hard bounds useMax = minOutOfHardBounds ? (maxOutOfHardBounds ? useMax : true) : // Out on min (maxOutOfHardBounds ? false : useMax); // Not out on min return useMax; } // eslint-disable-next-line valid-jsdoc /** * Find a clear path between point. * @private */ function clearPathTo(fromPoint, toPoint, dirIsX) { // Don't waste time if we've hit goal if (fromPoint.x === toPoint.x && fromPoint.y === toPoint.y) { return []; } const dir = dirIsX ? 'x' : 'y', obstacleMargin = options.obstacleOptions.margin, bounds = { soft: { xMin: softMinX, xMax: softMaxX, yMin: softMinY, yMax: softMaxY }, hard: options.hardBounds }; let pivot, segments, waypoint, waypointUseMax, envelopingObstacle, secondEnvelopingObstacle, envelopWaypoint; // If fromPoint is inside an obstacle we have a problem. Break out // by just going to the outside of this obstacle. We prefer to go to // the nearest edge in the chosen direction. envelopingObstacle = findObstacleFromPoint(chartObstacles, fromPoint); if (envelopingObstacle > -1) { envelopingObstacle = chartObstacles[envelopingObstacle]; waypointUseMax = getDodgeDirection(envelopingObstacle, fromPoint, toPoint, dirIsX, bounds); // Cut obstacle to hard bounds to make sure we stay within limitObstacleToBounds(envelopingObstacle, options.hardBounds); envelopWaypoint = dirIsX ? { y: fromPoint.y, x: envelopingObstacle[waypointUseMax ? 'xMax' : 'xMin'] + (waypointUseMax ? 1 : -1) } : { x: fromPoint.x, y: envelopingObstacle[waypointUseMax ? 'yMax' : 'yMin'] + (waypointUseMax ? 1 : -1) }; // If we crashed into another obstacle doing this, we put the // waypoint between them instead secondEnvelopingObstacle = findObstacleFromPoint(chartObstacles, envelopWaypoint); if (secondEnvelopingObstacle > -1) { secondEnvelopingObstacle = chartObstacles[secondEnvelopingObstacle]; // Cut obstacle to hard bounds limitObstacleToBounds(secondEnvelopingObstacle, options.hardBounds); // Modify waypoint to lay between obstacles envelopWaypoint[dir] = waypointUseMax ? max(envelopingObstacle[dir + 'Max'] - obstacleMargin + 1, (secondEnvelopingObstacle[dir + 'Min'] + envelopingObstacle[dir + 'Max']) / 2) : min((envelopingObstacle[dir + 'Min'] + obstacleMargin - 1), ((secondEnvelopingObstacle[dir + 'Max'] + envelopingObstacle[dir + 'Min']) / 2)); // We are not going anywhere. If this happens for the first // time, do nothing. Otherwise, try to go to the extreme of // the obstacle pair in the current direction. if (fromPoint.x === envelopWaypoint.x && fromPoint.y === envelopWaypoint.y) { if (forceObstacleBreak) { envelopWaypoint[dir] = waypointUseMax ? max(envelopingObstacle[dir + 'Max'], secondEnvelopingObstacle[dir + 'Max']) + 1 : min(envelopingObstacle[dir + 'Min'], secondEnvelopingObstacle[dir + 'Min']) - 1; } // Toggle on if off, and the opposite forceObstacleBreak = !forceObstacleBreak; } else { // This point is not identical to previous. // Clear break trigger. forceObstacleBreak = false; } } segments = [{ start: fromPoint, end: envelopWaypoint }]; } else { // If not enveloping, use standard pivot calculation pivot = pivotPoint(fromPoint, { x: dirIsX ? toPoint.x : fromPoint.x, y: dirIsX ? fromPoint.y : toPoint.y }, dirIsX); segments = [{ start: fromPoint, end: { x: pivot.x, y: pivot.y } }]; // Pivot before goal, use a waypoint to dodge obstacle if (pivot[dirIsX ? 'x' : 'y'] !== toPoint[dirIsX ? 'x' : 'y']) { // Find direction of waypoint waypointUseMax = getDodgeDirection(pivot.obstacle, pivot, toPoint, !dirIsX, bounds); // Cut waypoint to hard bounds limitObstacleToBounds(pivot.obstacle, options.hardBounds); waypoint = { x: dirIsX ? pivot.x : pivot.obstacle[waypointUseMax ? 'xMax' : 'xMin'] + (waypointUseMax ? 1 : -1), y: dirIsX ? pivot.obstacle[waypointUseMax ? 'yMax' : 'yMin'] + (waypointUseMax ? 1 : -1) : pivot.y }; // We're changing direction here, store that to make sure we // also change direction when adding the last segment array // after handling waypoint. dirIsX = !dirIsX; segments = segments.concat(clearPathTo({ x: pivot.x, y: pivot.y }, waypoint, dirIsX)); } } // Get segments for the other direction too // Recursion is our friend segments = segments.concat(clearPathTo(segments[segments.length - 1].end, toPoint, !dirIsX)); return segments; } // eslint-disable-next-line valid-jsdoc /** * Extract point to outside of obstacle in whichever direction is * closest. Returns new point outside obstacle. * @private */ function extractFromObstacle(obstacle, point, goalPoint) { const dirIsX = min(obstacle.xMax - point.x, point.x - obstacle.xMin) < min(obstacle.yMax - point.y, point.y - obstacle.yMin), bounds = { soft: options.hardBounds, hard: options.hardBounds }, useMax = getDodgeDirection(obstacle, point, goalPoint, dirIsX, bounds); return dirIsX ? { y: point.y, x: obstacle[useMax ? 'xMax' : 'xMin'] + (useMax ? 1 : -1) } : { x: point.x, y: obstacle[useMax ? 'yMax' : 'yMin'] + (useMax ? 1 : -1) }; } // Cut the obstacle array to soft bounds for optimization in large // datasets. chartObstacles = chartObstacles.slice(startObstacleIx, endObstacleIx + 1); // If an obstacle envelops the end point, move it out of there and add // a little segment to where it was. if ((endObstacleIx = findObstacleFromPoint(chartObstacles, end)) > -1) { extractedEndPoint = extractFromObstacle(chartObstacles[endObstacleIx], end, start); endSegments.push({ end: end, start: extractedEndPoint }); end = extractedEndPoint; } // If it's still inside one or more obstacles, get out of there by // force-moving towards the start point. while ((endObstacleIx = findObstacleFromPoint(chartObstacles, end)) > -1) { useMax = end[dir] - start[dir] < 0; extractedEndPoint = { x: end.x, y: end.y }; extractedEndPoint[dir] = chartObstacles[endObstacleIx][useMax ? dir + 'Max' : dir + 'Min'] + (useMax ? 1 : -1); endSegments.push({ end: end, start: extractedEndPoint }); end = extractedEndPoint; } // Find the path segments = clearPathTo(start, end, dirIsX); // Add the end-point segments segments = segments.concat(endSegments.reverse()); return { path: pathFromSegments(segments), obstacles: segments }; } fastAvoid.requiresObstacles = true; /* * * * Default Export * * */ // Define the available pathfinding algorithms. // Algorithms take up to 3 arguments: starting point, ending point, and an // options object. const algorithms = { fastAvoid, straight, simpleConnect }; return algorithms; }); _registerModule(_modules, 'Gantt/ConnectorsDefaults.js', [], function () { /* * * * (c) 2016 Highsoft AS * Authors: Øystein Moseng, Lars A. V. Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ /* * * * API Defaults * * */ /* @todo: - Document how to write your own algorithms - Consider adding a Point.pathTo method that wraps creating a connection and rendering it */ const connectorsDefaults = { /** * The Pathfinder module allows you to define connections between any two * points, represented as lines - optionally with markers for the start * and/or end points. Multiple algorithms are available for calculating how * the connecting lines are drawn. * * Connector functionality requires Highcharts Gantt to be loaded. In Gantt * charts, the connectors are used to draw dependencies between tasks. * * @see [dependency](series.gantt.data.dependency) * * @sample gantt/pathfinder/demo * Pathfinder connections * * @declare Highcharts.ConnectorsOptions * @product gantt * @optionparent connectors */ connectors: { /** * Enable connectors for this chart. Requires Highcharts Gantt. * * @type {boolean} * @default true * @since 6.2.0 * @apioption connectors.enabled */ /** * Set the default dash style for this chart's connecting lines. * * @type {string} * @default solid * @since 6.2.0 * @apioption connectors.dashStyle */ /** * Set the default color for this chart's Pathfinder connecting lines. * Defaults to the color of the point being connected. * * @type {Highcharts.ColorString} * @since 6.2.0 * @apioption connectors.lineColor */ /** * Set the default pathfinder margin to use, in pixels. Some Pathfinder * algorithms attempt to avoid obstacles, such as other points in the * chart. These algorithms use this margin to determine how close lines * can be to an obstacle. The default is to compute this automatically * from the size of the obstacles in the chart. * * To draw connecting lines close to existing points, set this to a low * number. For more space around existing points, set this number * higher. * * @sample gantt/pathfinder/algorithm-margin * Small algorithmMargin * * @type {number} * @since 6.2.0 * @apioption connectors.algorithmMargin */ /** * Set the default pathfinder algorithm to use for this chart. It is * possible to define your own algorithms by adding them to the * Highcharts.Pathfinder.prototype.algorithms object before the chart * has been created. * * The default algorithms are as follows: * * `straight`: Draws a straight line between the connecting * points. Does not avoid other points when drawing. * * `simpleConnect`: Finds a path between the points using right angles * only. Takes only starting/ending points into * account, and will not avoid other points. * * `fastAvoid`: Finds a path between the points using right angles * only. Will attempt to avoid other points, but its * focus is performance over accuracy. Works well with * less dense datasets. * * Default value: `straight` is used as default for most series types, * while `simpleConnect` is used as default for Gantt series, to show * dependencies between points. * * @sample gantt/pathfinder/demo * Different types used * * @type {Highcharts.PathfinderTypeValue} * @default undefined * @since 6.2.0 */ type: 'straight', /** * The corner radius for the connector line. * * @since 11.2.0 */ radius: 0, /** * Set the default pixel width for this chart's Pathfinder connecting * lines. * * @since 6.2.0 */ lineWidth: 1, /** * Marker options for this chart's Pathfinder connectors. Note that * this option is overridden by the `startMarker` and `endMarker` * options. * * @declare Highcharts.ConnectorsMarkerOptions * @since 6.2.0 */ marker: { /** * Set the radius of the connector markers. The default is * automatically computed based on the algorithmMargin setting. * * Setting marker.width and marker.height will override this * setting. * * @type {number} * @since 6.2.0 * @apioption connectors.marker.radius */ /** * Set the width of the connector markers. If not supplied, this * is inferred from the marker radius. * * @type {number} * @since 6.2.0 * @apioption connectors.marker.width */ /** * Set the height of the connector markers. If not supplied, this * is inferred from the marker radius. * * @type {number} * @since 6.2.0 * @apioption connectors.marker.height */ /** * Set the color of the connector markers. By default this is the * same as the connector color. * * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} * @since 6.2.0 * @apioption connectors.marker.color */ /** * Set the line/border color of the connector markers. By default * this is the same as the marker color. * * @type {Highcharts.ColorString} * @since 6.2.0 * @apioption connectors.marker.lineColor */ /** * Enable markers for the connectors. */ enabled: false, /** * Horizontal alignment of the markers relative to the points. * * @type {Highcharts.AlignValue} */ align: 'center', /** * Vertical alignment of the markers relative to the points. * * @type {Highcharts.VerticalAlignValue} */ verticalAlign: 'middle', /** * Whether or not to draw the markers inside the points. */ inside: false, /** * Set the line/border width of the pathfinder markers. */ lineWidth: 1 }, /** * Marker options specific to the start markers for this chart's * Pathfinder connectors. Overrides the generic marker options. * * @declare Highcharts.ConnectorsStartMarkerOptions * @extends connectors.marker * @since 6.2.0 */ startMarker: { /** * Set the symbol of the connector start markers. */ symbol: 'diamond' }, /** * Marker options specific to the end markers for this chart's * Pathfinder connectors. Overrides the generic marker options. * * @declare Highcharts.ConnectorsEndMarkerOptions * @extends connectors.marker * @since 6.2.0 */ endMarker: { /** * Set the symbol of the connector end markers. */ symbol: 'arrow-filled' } } }; /* * * * Default Export * * */ /* * * * API Options * * */ /** * Override Pathfinder connector options for a series. Requires Highcharts Gantt * to be loaded. * * @declare Highcharts.SeriesConnectorsOptionsObject * @extends connectors * @since 6.2.0 * @excluding enabled, algorithmMargin * @product gantt * @apioption plotOptions.series.connectors */ /** * Connect to a point. This option can be either a string, referring to the ID * of another point, or an object, or an array of either. If the option is an * array, each element defines a connection. * * @sample gantt/pathfinder/demo * Different connection types * * @declare Highcharts.XrangePointConnectorsOptionsObject * @type {string|Array|*} * @extends plotOptions.series.connectors * @since 6.2.0 * @excluding enabled * @product gantt * @requires highcharts-gantt * @apioption series.xrange.data.connect */ /** * The ID of the point to connect to. * * @type {string} * @since 6.2.0 * @product gantt * @apioption series.xrange.data.connect.to */ ''; // Keeps doclets above in JS file return connectorsDefaults; }); _registerModule(_modules, 'Gantt/PathfinderComposition.js', [_modules['Gantt/ConnectorsDefaults.js'], _modules['Core/Defaults.js'], _modules['Core/Utilities.js']], function (ConnectorsDefaults, D, U) { /* * * * (c) 2016 Highsoft AS * Authors: Øystein Moseng, Lars A. V. Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { setOptions } = D; const { defined, error, merge } = U; /* * * * Functions * * */ /** * Get point bounding box using plotX/plotY and shapeArgs. If using * graphic.getBBox() directly, the bbox will be affected by animation. * * @private * @function * * @param {Highcharts.Point} point * The point to get BB of. * * @return {Highcharts.Dictionary|null} * Result xMax, xMin, yMax, yMin. */ function getPointBB(point) { const shapeArgs = point.shapeArgs; // Prefer using shapeArgs (columns) if (shapeArgs) { return { xMin: shapeArgs.x || 0, xMax: (shapeArgs.x || 0) + (shapeArgs.width || 0), yMin: shapeArgs.y || 0, yMax: (shapeArgs.y || 0) + (shapeArgs.height || 0) }; } // Otherwise use plotX/plotY and bb const bb = point.graphic && point.graphic.getBBox(); return bb ? { xMin: point.plotX - bb.width / 2, xMax: point.plotX + bb.width / 2, yMin: point.plotY - bb.height / 2, yMax: point.plotY + bb.height / 2 } : null; } /** * Warn if using legacy options. Copy the options over. Note that this will * still break if using the legacy options in chart.update, addSeries etc. * @private */ function warnLegacy(chart) { if (chart.options.pathfinder || chart.series.reduce(function (acc, series) { if (series.options) { merge(true, (series.options.connectors = series.options.connectors || {}), series.options.pathfinder); } return acc || series.options && series.options.pathfinder; }, false)) { merge(true, (chart.options.connectors = chart.options.connectors || {}), chart.options.pathfinder); error('WARNING: Pathfinder options have been renamed. ' + 'Use "chart.connectors" or "series.connectors" instead.'); } } /* * * * Composition * * */ var ConnectionComposition; (function (ConnectionComposition) { /* * * * Functions * * */ /** @private */ function compose(ChartClass, PathfinderClass, PointClass) { const pointProto = PointClass.prototype; if (!pointProto.getPathfinderAnchorPoint) { // Initialize Pathfinder for charts ChartClass.prototype.callbacks.push(function (chart) { const options = chart.options; if (options.connectors.enabled !== false) { warnLegacy(chart); this.pathfinder = new PathfinderClass(this); this.pathfinder.update(true); // First draw, defer render } }); pointProto.getMarkerVector = pointGetMarkerVector; pointProto.getPathfinderAnchorPoint = pointGetPathfinderAnchorPoint; pointProto.getRadiansToVector = pointGetRadiansToVector; // Set default Pathfinder options setOptions(ConnectorsDefaults); } } ConnectionComposition.compose = compose; /** * Get coordinates of anchor point for pathfinder connection. * * @private * @function Highcharts.Point#getPathfinderAnchorPoint * * @param {Highcharts.ConnectorsMarkerOptions} markerOptions * Connection options for position on point. * * @return {Highcharts.PositionObject} * An object with x/y properties for the position. Coordinates are * in plot values, not relative to point. */ function pointGetPathfinderAnchorPoint(markerOptions) { const bb = getPointBB(this); let x, y; switch (markerOptions.align) { // eslint-disable-line default-case case 'right': x = 'xMax'; break; case 'left': x = 'xMin'; } switch (markerOptions.verticalAlign) { // eslint-disable-line default-case case 'top': y = 'yMin'; break; case 'bottom': y = 'yMax'; } return { x: x ? bb[x] : (bb.xMin + bb.xMax) / 2, y: y ? bb[y] : (bb.yMin + bb.yMax) / 2 }; } /** * Utility to get the angle from one point to another. * * @private * @function Highcharts.Point#getRadiansToVector * * @param {Highcharts.PositionObject} v1 * The first vector, as an object with x/y properties. * * @param {Highcharts.PositionObject} v2 * The second vector, as an object with x/y properties. * * @return {number} * The angle in degrees */ function pointGetRadiansToVector(v1, v2) { let box; if (!defined(v2)) { box = getPointBB(this); if (box) { v2 = { x: (box.xMin + box.xMax) / 2, y: (box.yMin + box.yMax) / 2 }; } } return Math.atan2(v2.y - v1.y, v1.x - v2.x); } /** * Utility to get the position of the marker, based on the path angle and * the marker's radius. * * @private * @function Highcharts.Point#getMarkerVector * * @param {number} radians * The angle in radians from the point center to another vector. * * @param {number} markerRadius * The radius of the marker, to calculate the additional distance to * the center of the marker. * * @param {Object} anchor * The anchor point of the path and marker as an object with x/y * properties. * * @return {Object} * The marker vector as an object with x/y properties. */ function pointGetMarkerVector(radians, markerRadius, anchor) { const twoPI = Math.PI * 2.0, bb = getPointBB(this), rectWidth = bb.xMax - bb.xMin, rectHeight = bb.yMax - bb.yMin, rAtan = Math.atan2(rectHeight, rectWidth), rectHalfWidth = rectWidth / 2.0, rectHalfHeight = rectHeight / 2.0, rectHorizontalCenter = bb.xMin + rectHalfWidth, rectVerticalCenter = bb.yMin + rectHalfHeight, edgePoint = { x: rectHorizontalCenter, y: rectVerticalCenter }; let theta = radians, tanTheta = 1, leftOrRightRegion = false, xFactor = 1, yFactor = 1; while (theta < -Math.PI) { theta += twoPI; } while (theta > Math.PI) { theta -= twoPI; } tanTheta = Math.tan(theta); if ((theta > -rAtan) && (theta <= rAtan)) { // Right side yFactor = -1; leftOrRightRegion = true; } else if (theta > rAtan && theta <= (Math.PI - rAtan)) { // Top side yFactor = -1; } else if (theta > (Math.PI - rAtan) || theta <= -(Math.PI - rAtan)) { // Left side xFactor = -1; leftOrRightRegion = true; } else { // Bottom side xFactor = -1; } // Correct the edgePoint according to the placement of the marker if (leftOrRightRegion) { edgePoint.x += xFactor * (rectHalfWidth); edgePoint.y += yFactor * (rectHalfWidth) * tanTheta; } else { edgePoint.x += xFactor * (rectHeight / (2.0 * tanTheta)); edgePoint.y += yFactor * (rectHalfHeight); } if (anchor.x !== rectHorizontalCenter) { edgePoint.x = anchor.x; } if (anchor.y !== rectVerticalCenter) { edgePoint.y = anchor.y; } return { x: edgePoint.x + (markerRadius * Math.cos(theta)), y: edgePoint.y - (markerRadius * Math.sin(theta)) }; } })(ConnectionComposition || (ConnectionComposition = {})); /* * * * Default Export * * */ return ConnectionComposition; }); _registerModule(_modules, 'Gantt/Pathfinder.js', [_modules['Gantt/Connection.js'], _modules['Gantt/PathfinderAlgorithms.js'], _modules['Gantt/PathfinderComposition.js'], _modules['Core/Series/Point.js'], _modules['Core/Utilities.js']], function (Connection, PathfinderAlgorithms, PathfinderComposition, Point, U) { /* * * * (c) 2016 Highsoft AS * Authors: Øystein Moseng, Lars A. V. Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { addEvent, defined, pick, splat } = U; /* * * * Constants * * */ const max = Math.max, min = Math.min; /* * * * Functions * * */ /** * Get point bounding box using plotX/plotY and shapeArgs. If using * graphic.getBBox() directly, the bbox will be affected by animation. * * @private * @function * * @param {Highcharts.Point} point * The point to get BB of. * * @return {Highcharts.Dictionary|null} * Result xMax, xMin, yMax, yMin. */ function getPointBB(point) { const shapeArgs = point.shapeArgs; // Prefer using shapeArgs (columns) if (shapeArgs) { return { xMin: shapeArgs.x || 0, xMax: (shapeArgs.x || 0) + (shapeArgs.width || 0), yMin: shapeArgs.y || 0, yMax: (shapeArgs.y || 0) + (shapeArgs.height || 0) }; } // Otherwise use plotX/plotY and bb const bb = point.graphic && point.graphic.getBBox(); return bb ? { xMin: point.plotX - bb.width / 2, xMax: point.plotX + bb.width / 2, yMin: point.plotY - bb.height / 2, yMax: point.plotY + bb.height / 2 } : null; } /** * Compute smallest distance between two rectangles. * @private */ function calculateObstacleDistance(a, b, bbMargin) { // Count the distance even if we are slightly off const margin = pick(bbMargin, 10), yOverlap = a.yMax + margin > b.yMin - margin && a.yMin - margin < b.yMax + margin, xOverlap = a.xMax + margin > b.xMin - margin && a.xMin - margin < b.xMax + margin, xDistance = yOverlap ? (a.xMin > b.xMax ? a.xMin - b.xMax : b.xMin - a.xMax) : Infinity, yDistance = xOverlap ? (a.yMin > b.yMax ? a.yMin - b.yMax : b.yMin - a.yMax) : Infinity; // If the rectangles collide, try recomputing with smaller margin. // If they collide anyway, discard the obstacle. if (xOverlap && yOverlap) { return (margin ? calculateObstacleDistance(a, b, Math.floor(margin / 2)) : Infinity); } return min(xDistance, yDistance); } /** * Calculate margin to place around obstacles for the pathfinder in pixels. * Returns a minimum of 1 pixel margin. * * @private * @function * * @param {Array} obstacles * Obstacles to calculate margin from. * * @return {number} * The calculated margin in pixels. At least 1. */ function calculateObstacleMargin(obstacles) { const len = obstacles.length, distances = []; let onstacleDistance; // Go over all obstacles and compare them to the others. for (let i = 0; i < len; ++i) { // Compare to all obstacles ahead. We will already have compared this // obstacle to the ones before. for (let j = i + 1; j < len; ++j) { onstacleDistance = calculateObstacleDistance(obstacles[i], obstacles[j]); // TODO: Magic number 80 if (onstacleDistance < 80) { // Ignore large distances distances.push(onstacleDistance); } } } // Ensure we always have at least one value, even in very spacious charts distances.push(80); return max(Math.floor(distances.sort(function (a, b) { return (a - b); })[ // Discard first 10% of the relevant distances, and then grab // the smallest one. Math.floor(distances.length / 10)] / 2 - 1 // Divide the distance by 2 and subtract 1. ), 1 // 1 is the minimum margin ); } /* * * * Class * * */ /** * The Pathfinder class. * * @private * @class * @name Highcharts.Pathfinder * * @param {Highcharts.Chart} chart * The chart to operate on. */ class Pathfinder { /* * * * Static Functions * * */ static compose(ChartClass, PointClass) { PathfinderComposition.compose(ChartClass, Pathfinder, PointClass); } /* * * * Constructor * * */ constructor(chart) { this.init(chart); } /* * * * Functions * * */ /** * Initialize the Pathfinder object. * * @function Highcharts.Pathfinder#init * * @param {Highcharts.Chart} chart * The chart context. */ init(chart) { // Initialize pathfinder with chart context this.chart = chart; // Init connection reference list this.connections = []; // Recalculate paths/obstacles on chart redraw addEvent(chart, 'redraw', function () { this.pathfinder.update(); }); } /** * Update Pathfinder connections from scratch. * * @function Highcharts.Pathfinder#update * * @param {boolean} [deferRender] * Whether or not to defer rendering of connections until * series.afterAnimate event has fired. Used on first render. */ update(deferRender) { const chart = this.chart, pathfinder = this, oldConnections = pathfinder.connections; // Rebuild pathfinder connections from options pathfinder.connections = []; chart.series.forEach(function (series) { if (series.visible && !series.options.isInternal) { series.points.forEach(function (point) { const ganttPointOptions = point.options; // For Gantt series the connect could be // defined as a dependency if (ganttPointOptions && ganttPointOptions.dependency) { ganttPointOptions.connect = ganttPointOptions .dependency; } const connects = (point.options?.connect && splat(point.options.connect)); let to; if (point.visible && point.isInside !== false && connects) { connects.forEach(function (connect) { to = chart.get(typeof connect === 'string' ? connect : connect.to); if (to instanceof Point && to.series.visible && to.visible && to.isInside !== false) { // Add new connection pathfinder.connections.push(new Connection(point, // From to, typeof connect === 'string' ? {} : connect)); } }); } }); } }); // Clear connections that should not be updated, and move old info over // to new connections. for (let j = 0, k, found, lenOld = oldConnections.length, lenNew = pathfinder.connections.length; j < lenOld; ++j) { found = false; const oldCon = oldConnections[j]; for (k = 0; k < lenNew; ++k) { const newCon = pathfinder.connections[k]; if ((oldCon.options && oldCon.options.type) === (newCon.options && newCon.options.type) && oldCon.fromPoint === newCon.fromPoint && oldCon.toPoint === newCon.toPoint) { newCon.graphics = oldCon.graphics; found = true; break; } } if (!found) { oldCon.destroy(); } } // Clear obstacles to force recalculation. This must be done on every // redraw in case positions have changed. Recalculation is handled in // Connection.getPath on demand. delete this.chartObstacles; delete this.lineObstacles; // Draw the pending connections pathfinder.renderConnections(deferRender); } /** * Draw the chart's connecting paths. * * @function Highcharts.Pathfinder#renderConnections * * @param {boolean} [deferRender] * Whether or not to defer render until series animation is finished. * Used on first render. */ renderConnections(deferRender) { if (deferRender) { // Render after series are done animating this.chart.series.forEach(function (series) { const render = function () { // Find pathfinder connections belonging to this series // that haven't rendered, and render them now. const pathfinder = series.chart.pathfinder, conns = pathfinder && pathfinder.connections || []; conns.forEach(function (connection) { if (connection.fromPoint && connection.fromPoint.series === series) { connection.render(); } }); if (series.pathfinderRemoveRenderEvent) { series.pathfinderRemoveRenderEvent(); delete series.pathfinderRemoveRenderEvent; } }; if (series.options.animation === false) { render(); } else { series.pathfinderRemoveRenderEvent = addEvent(series, 'afterAnimate', render); } }); } else { // Go through connections and render them this.connections.forEach(function (connection) { connection.render(); }); } } /** * Get obstacles for the points in the chart. Does not include connecting * lines from Pathfinder. Applies algorithmMargin to the obstacles. * * @function Highcharts.Pathfinder#getChartObstacles * * @param {Object} options * Options for the calculation. Currently only * `options.algorithmMargin`. * * @param {number} options.algorithmMargin * The algorithm margin to use for the obstacles. * @return {Array} * An array of calculated obstacles. Each obstacle is defined as an * object with xMin, xMax, yMin and yMax properties. */ getChartObstacles(options) { const series = this.chart.series, margin = pick(options.algorithmMargin, 0); let obstacles = [], calculatedMargin; for (let i = 0, sLen = series.length; i < sLen; ++i) { if (series[i].visible && !series[i].options.isInternal) { for (let j = 0, pLen = series[i].points.length, bb, point; j < pLen; ++j) { point = series[i].points[j]; if (point.visible) { bb = getPointBB(point); if (bb) { obstacles.push({ xMin: bb.xMin - margin, xMax: bb.xMax + margin, yMin: bb.yMin - margin, yMax: bb.yMax + margin }); } } } } } // Sort obstacles by xMin for optimization obstacles = obstacles.sort(function (a, b) { return a.xMin - b.xMin; }); // Add auto-calculated margin if the option is not defined if (!defined(options.algorithmMargin)) { calculatedMargin = options.algorithmMargin = calculateObstacleMargin(obstacles); obstacles.forEach(function (obstacle) { obstacle.xMin -= calculatedMargin; obstacle.xMax += calculatedMargin; obstacle.yMin -= calculatedMargin; obstacle.yMax += calculatedMargin; }); } return obstacles; } /** * Utility function to get metrics for obstacles: * - Widest obstacle width * - Tallest obstacle height * * @function Highcharts.Pathfinder#getObstacleMetrics * * @param {Array} obstacles * An array of obstacles to inspect. * * @return {Object} * The calculated metrics, as an object with maxHeight and maxWidth * properties. */ getObstacleMetrics(obstacles) { let maxWidth = 0, maxHeight = 0, width, height, i = obstacles.length; while (i--) { width = obstacles[i].xMax - obstacles[i].xMin; height = obstacles[i].yMax - obstacles[i].yMin; if (maxWidth < width) { maxWidth = width; } if (maxHeight < height) { maxHeight = height; } } return { maxHeight: maxHeight, maxWidth: maxWidth }; } /** * Utility to get which direction to start the pathfinding algorithm * (X vs Y), calculated from a set of marker options. * * @function Highcharts.Pathfinder#getAlgorithmStartDirection * * @param {Highcharts.ConnectorsMarkerOptions} markerOptions * Marker options to calculate from. * * @return {boolean} * Returns true for X, false for Y, and undefined for autocalculate. */ getAlgorithmStartDirection(markerOptions) { const xCenter = markerOptions.align !== 'left' && markerOptions.align !== 'right', yCenter = markerOptions.verticalAlign !== 'top' && markerOptions.verticalAlign !== 'bottom'; return xCenter ? (yCenter ? void 0 : false) : // When x is centered (yCenter ? true : void 0); // When x is off-center } } /** * @name Highcharts.Pathfinder#algorithms * @type {Highcharts.Dictionary} */ Pathfinder.prototype.algorithms = PathfinderAlgorithms; /* * * * Default Export * * */ /* * * * API Options * * */ /** * The default pathfinder algorithm to use for a chart. It is possible to define * your own algorithms by adding them to the * `Highcharts.Pathfinder.prototype.algorithms` * object before the chart has been created. * * The default algorithms are as follows: * * `straight`: Draws a straight line between the connecting * points. Does not avoid other points when drawing. * * `simpleConnect`: Finds a path between the points using right angles * only. Takes only starting/ending points into * account, and will not avoid other points. * * `fastAvoid`: Finds a path between the points using right angles * only. Will attempt to avoid other points, but its * focus is performance over accuracy. Works well with * less dense datasets. * * @typedef {"fastAvoid"|"simpleConnect"|"straight"|string} Highcharts.PathfinderTypeValue */ ''; // Keeps doclets above in JS file return Pathfinder; }); _registerModule(_modules, 'masters/modules/pathfinder.src.js', [_modules['Core/Globals.js'], _modules['Gantt/Pathfinder.js'], _modules['Extensions/ArrowSymbols.js']], function (Highcharts, Pathfinder, ArrowSymbols) { const G = Highcharts; G.Pathfinder = G.Pathfinder || Pathfinder; ArrowSymbols.compose(G.SVGRenderer); G.Pathfinder.compose(G.Chart, G.Point); return Highcharts; }); _registerModule(_modules, 'Extensions/StaticScale.js', [_modules['Core/Utilities.js']], function (U) { /* * * * (c) 2016-2024 Torstein Honsi, Lars Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { addEvent, defined, isNumber, pick } = U; /* * * * Composition * * */ /** @private */ function compose(AxisClass, ChartClass) { const chartProto = ChartClass.prototype; if (!chartProto.adjustHeight) { addEvent(AxisClass, 'afterSetOptions', onAxisAfterSetOptions); chartProto.adjustHeight = chartAdjustHeight; addEvent(ChartClass, 'render', chartProto.adjustHeight); } } /** @private */ function onAxisAfterSetOptions() { const chartOptions = this.chart.options.chart; if (!this.horiz && isNumber(this.options.staticScale) && (!chartOptions.height || (chartOptions.scrollablePlotArea && chartOptions.scrollablePlotArea.minHeight))) { this.staticScale = this.options.staticScale; } } /** @private */ function chartAdjustHeight() { const chart = this; if (chart.redrawTrigger !== 'adjustHeight') { for (const axis of (chart.axes || [])) { const chart = axis.chart, animate = !!chart.initiatedScale && chart.options.animation, staticScale = axis.options.staticScale; if (axis.staticScale && defined(axis.min)) { let height = pick(axis.brokenAxis && axis.brokenAxis.unitLength, axis.max + axis.tickInterval - axis.min) * staticScale; // Minimum height is 1 x staticScale. height = Math.max(height, staticScale); const diff = height - chart.plotHeight; if (!chart.scrollablePixelsY && Math.abs(diff) >= 1) { chart.plotHeight = height; chart.redrawTrigger = 'adjustHeight'; chart.setSize(void 0, chart.chartHeight + diff, animate); } // Make sure clip rects have the right height before initial // animation. axis.series.forEach(function (series) { const clipRect = series.sharedClipKey && chart.sharedClips[series.sharedClipKey]; if (clipRect) { clipRect.attr(chart.inverted ? { width: chart.plotHeight } : { height: chart.plotHeight }); } }); } } this.initiatedScale = true; } this.redrawTrigger = null; } /* * * * Default Export * * */ const StaticScale = { compose }; /* * * * API Options * * */ /** * For vertical axes only. Setting the static scale ensures that each tick unit * is translated into a fixed pixel height. For example, setting the static * scale to 24 results in each Y axis category taking up 24 pixels, and the * height of the chart adjusts. Adding or removing items will make the chart * resize. * * @sample gantt/xrange-series/demo/ * X-range series with static scale * * @type {number} * @default 50 * @since 6.2.0 * @product gantt * @apioption yAxis.staticScale */ ''; // Keeps doclets above in JS file return StaticScale; }); _registerModule(_modules, 'masters/modules/static-scale.src.js', [_modules['Core/Globals.js'], _modules['Extensions/StaticScale.js']], function (Highcharts, StaticScale) { const G = Highcharts; StaticScale.compose(G.Axis, G.Chart); return Highcharts; }); _registerModule(_modules, 'Series/XRange/XRangeSeriesDefaults.js', [_modules['Core/Utilities.js']], function (U) { /* * * * X-range series module * * (c) 2010-2024 Torstein Honsi, Lars A. V. Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { correctFloat, isNumber, isObject } = U; /* * * * Constants * * */ /** * The X-range series displays ranges on the X axis, typically time * intervals with a start and end date. * * @sample {highcharts} highcharts/demo/x-range/ * X-range * @sample {highcharts} highcharts/css/x-range/ * Styled mode X-range * @sample {highcharts} highcharts/chart/inverted-xrange/ * Inverted X-range * * @extends plotOptions.column * @since 6.0.0 * @product highcharts highstock gantt * @excluding boostThreshold, crisp, cropThreshold, depth, edgeColor, * edgeWidth, findNearestPointBy, getExtremesFromAll, * negativeColor, pointInterval, pointIntervalUnit, * pointPlacement, pointRange, pointStart, softThreshold, * stacking, threshold, data, dataSorting, boostBlending * @requires modules/xrange * @optionparent plotOptions.xrange */ const XRangeSeriesDefaults = { /** * A partial fill for each point, typically used to visualize how much * of a task is performed. The partial fill object can be set either on * series or point level. * * @sample {highcharts} highcharts/demo/x-range * X-range with partial fill * * @product highcharts highstock gantt * @apioption plotOptions.xrange.partialFill */ /** * The fill color to be used for partial fills. Defaults to a darker * shade of the point color. * * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} * @product highcharts highstock gantt * @apioption plotOptions.xrange.partialFill.fill */ /** * A partial fill for each point, typically used to visualize how much * of a task is performed. See [completed](series.gantt.data.completed). * * @sample gantt/demo/progress-indicator * Gantt with progress indicator * * @product gantt * @apioption plotOptions.gantt.partialFill */ /** * In an X-range series, this option makes all points of the same Y-axis * category the same color. */ colorByPoint: true, dataLabels: { formatter: function () { let amount = this.point.partialFill; if (isObject(amount)) { amount = amount.amount; } if (isNumber(amount) && amount > 0) { return correctFloat(amount * 100) + '%'; } }, inside: true, verticalAlign: 'middle', style: { whiteSpace: 'nowrap' } }, tooltip: { headerFormat: '{point.x} - {point.x2}
', pointFormat: '\u25CF {series.name}: {point.yCategory}
' }, borderRadius: 3, pointRange: 0 }; /* * * * Export Default * * */ /* * * * API Options * * */ /** * An `xrange` series. If the [type](#series.xrange.type) option is not * specified, it is inherited from [chart.type](#chart.type). * * @extends series,plotOptions.xrange * @excluding boostThreshold, crisp, cropThreshold, depth, edgeColor, edgeWidth, * findNearestPointBy, getExtremesFromAll, negativeColor, * pointInterval, pointIntervalUnit, pointPlacement, pointRange, * pointStart, softThreshold, stacking, threshold, dataSorting, * boostBlending * @product highcharts highstock gantt * @requires modules/xrange * @apioption series.xrange */ /** * An array of data points for the series. For the `xrange` series type, * points can be given in the following ways: * * 1. An array of objects with named values. The objects are point configuration * objects as seen below. * ```js * data: [{ * x: Date.UTC(2017, 0, 1), * x2: Date.UTC(2017, 0, 3), * name: "Test", * y: 0, * color: "#00FF00" * }, { * x: Date.UTC(2017, 0, 4), * x2: Date.UTC(2017, 0, 5), * name: "Deploy", * y: 1, * color: "#FF0000" * }] * ``` * * @sample {highcharts} highcharts/series/data-array-of-objects/ * Config objects * * @declare Highcharts.XrangePointOptionsObject * @type {Array<*>} * @extends series.line.data * @product highcharts highstock gantt * @apioption series.xrange.data */ /** * The starting X value of the range point. * * @sample {highcharts} highcharts/demo/x-range * X-range * * @type {number} * @product highcharts highstock gantt * @apioption series.xrange.data.x */ /** * The ending X value of the range point. * * @sample {highcharts} highcharts/demo/x-range * X-range * * @type {number} * @product highcharts highstock gantt * @apioption series.xrange.data.x2 */ /** * The Y value of the range point. * * @sample {highcharts} highcharts/demo/x-range * X-range * * @type {number} * @product highcharts highstock gantt * @apioption series.xrange.data.y */ /** * A partial fill for each point, typically used to visualize how much of * a task is performed. The partial fill object can be set either on series * or point level. * * @sample {highcharts} highcharts/demo/x-range * X-range with partial fill * * @declare Highcharts.XrangePointPartialFillOptionsObject * @product highcharts highstock gantt * @apioption series.xrange.data.partialFill */ /** * The amount of the X-range point to be filled. Values can be 0-1 and are * converted to percentages in the default data label formatter. * * @type {number} * @product highcharts highstock gantt * @apioption series.xrange.data.partialFill.amount */ /** * The fill color to be used for partial fills. Defaults to a darker shade * of the point color. * * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} * @product highcharts highstock gantt * @apioption series.xrange.data.partialFill.fill */ (''); // Adds doclets above to transpiled file return XRangeSeriesDefaults; }); _registerModule(_modules, 'Series/XRange/XRangePoint.js', [_modules['Core/Series/SeriesRegistry.js'], _modules['Core/Utilities.js']], function (SeriesRegistry, U) { /* * * * X-range series module * * (c) 2010-2024 Torstein Honsi, Lars A. V. Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { column: { prototype: { pointClass: ColumnPoint } } } = SeriesRegistry.seriesTypes; const { extend } = U; /* * * * Class * * */ class XRangePoint extends ColumnPoint { /* * * * Static Functions * * */ /** * Return color of a point based on its category. * * @private * @function getColorByCategory * * @param {object} series * The series which the point belongs to. * * @param {object} point * The point to calculate its color for. * * @return {object} * Returns an object containing the properties color and colorIndex. */ static getColorByCategory(series, point) { const colors = series.options.colors || series.chart.options.colors, colorCount = colors ? colors.length : series.chart.options.chart.colorCount, colorIndex = point.y % colorCount, color = colors && colors[colorIndex]; return { colorIndex: colorIndex, color: color }; } /* * * * Functions * * */ /** * @private */ resolveColor() { const series = this.series; if (series.options.colorByPoint && !this.options.color) { const colorByPoint = XRangePoint.getColorByCategory(series, this); if (!series.chart.styledMode) { this.color = colorByPoint.color; } if (!this.options.colorIndex) { this.colorIndex = colorByPoint.colorIndex; } } else { this.color = this.options.color || series.color; } } /** * Extend init to have y default to 0. * * @private */ constructor(series, options) { super(series, options); if (!this.y) { this.y = 0; } } /** * @private */ setState() { super.setState.apply(this, arguments); this.series.drawPoint(this, this.series.getAnimationVerb()); } /** * Add x2 and yCategory to the available properties for tooltip formats. * * @private */ getLabelConfig() { const cfg = super.getLabelConfig.call(this), yCats = this.series.yAxis.categories; cfg.x2 = this.x2; cfg.yCategory = this.yCategory = yCats && yCats[this.y]; // Use 'category' as 'key' to ensure tooltip datetime formatting. // Use 'name' only when 'category' is undefined. cfg.key = this.category || this.name; return cfg; } /** * @private */ isValid() { return typeof this.x === 'number' && typeof this.x2 === 'number'; } } extend(XRangePoint.prototype, { ttBelow: false, tooltipDateKeys: ['x', 'x2'] }); /* * * * Default Export * * */ /* * * * API Declarations * * */ /** * The ending X value of the range point. * @name Highcharts.Point#x2 * @type {number|undefined} * @requires modules/xrange */ /** * Extend applyOptions so that `colorByPoint` for x-range means that one * color is applied per Y axis category. * * @private * @function Highcharts.Point#applyOptions * * @return {Highcharts.Series} */ /** * @interface Highcharts.PointOptionsObject in parts/Point.ts */ /** * The ending X value of the range point. * @name Highcharts.PointOptionsObject#x2 * @type {number|undefined} * @requires modules/xrange */ (''); // Keeps doclets above in JS file return XRangePoint; }); _registerModule(_modules, 'Series/XRange/XRangeSeries.js', [_modules['Core/Globals.js'], _modules['Core/Color/Color.js'], _modules['Core/Series/SeriesRegistry.js'], _modules['Core/Utilities.js'], _modules['Series/XRange/XRangeSeriesDefaults.js'], _modules['Series/XRange/XRangePoint.js']], function (H, Color, SeriesRegistry, U, XRangeSeriesDefaults, XRangePoint) { /* * * * X-range series module * * (c) 2010-2024 Torstein Honsi, Lars A. V. Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { composed, noop } = H; const { parse: color } = Color; const { column: ColumnSeries } = SeriesRegistry.seriesTypes; const { addEvent, clamp, defined, extend, find, isNumber, isObject, merge, pick, pushUnique, relativeLength } = U; /* * * * Functions * * */ /** * Max x2 should be considered in xAxis extremes * @private */ function onAxisAfterGetSeriesExtremes() { let dataMax, modMax; if (this.isXAxis) { dataMax = pick(this.dataMax, -Number.MAX_VALUE); for (const series of this.series) { if (series.x2Data) { for (const val of series.x2Data) { if (val && val > dataMax) { dataMax = val; modMax = true; } } } } if (modMax) { this.dataMax = dataMax; } } } /* * * * Class * * */ /** * @private * @class * @name Highcharts.seriesTypes.xrange * * @augments Highcharts.Series */ class XRangeSeries extends ColumnSeries { /* * * * Static Functions * * */ static compose(AxisClass) { if (pushUnique(composed, 'Series.XRange')) { addEvent(AxisClass, 'afterGetSeriesExtremes', onAxisAfterGetSeriesExtremes); } } /* * * * Functions * * */ /** * @private */ init() { super.init.apply(this, arguments); this.options.stacking = void 0; // #13161 } /** * Borrow the column series metrics, but with swapped axes. This gives * free access to features like groupPadding, grouping, pointWidth etc. * @private */ getColumnMetrics() { const swapAxes = () => { for (const series of this.chart.series) { const xAxis = series.xAxis; series.xAxis = series.yAxis; series.yAxis = xAxis; } }; swapAxes(); const metrics = super.getColumnMetrics(); swapAxes(); return metrics; } /** * Override cropData to show a point where x or x2 is outside visible range, * but one of them is inside. * @private */ cropData(xData, yData, min, max) { // Replace xData with x2Data to find the appropriate cropStart const crop = super.cropData(this.x2Data, yData, min, max); // Re-insert the cropped xData crop.xData = xData.slice(crop.start, crop.end); return crop; } /** * Finds the index of an existing point that matches the given point * options. * * @private * * @param {Highcharts.XRangePointOptions} options * The options of the point. * * @return {number|undefined} * Returns index of a matching point, or undefined if no match is * found. */ findPointIndex(options) { const { cropStart, points } = this; const { id } = options; let pointIndex; if (id) { const point = find(points, (point) => point.id === id); pointIndex = point ? point.index : void 0; } if (typeof pointIndex === 'undefined') { const point = find(points, (point) => (point.x === options.x && point.x2 === options.x2 && !point.touched)); pointIndex = point ? point.index : void 0; } // Reduce pointIndex if data is cropped if (this.cropped && isNumber(pointIndex) && isNumber(cropStart) && pointIndex >= cropStart) { pointIndex -= cropStart; } return pointIndex; } alignDataLabel(point) { const oldPlotX = point.plotX; point.plotX = pick(point.dlBox && point.dlBox.centerX, point.plotX); if (point.dataLabel && point.shapeArgs?.width) { point.dataLabel.css({ width: `${point.shapeArgs.width}px` }); } super.alignDataLabel.apply(this, arguments); point.plotX = oldPlotX; } /** * @private */ translatePoint(point) { const xAxis = this.xAxis, yAxis = this.yAxis, metrics = this.columnMetrics, options = this.options, minPointLength = options.minPointLength || 0, oldColWidth = (point.shapeArgs && point.shapeArgs.width || 0) / 2, seriesXOffset = this.pointXOffset = metrics.offset, posX = pick(point.x2, point.x + (point.len || 0)), borderRadius = options.borderRadius, plotTop = this.chart.plotTop, plotLeft = this.chart.plotLeft; let plotX = point.plotX, plotX2 = xAxis.translate(posX, 0, 0, 0, 1); const length = Math.abs(plotX2 - plotX), inverted = this.chart.inverted, borderWidth = pick(options.borderWidth, 1), crisper = borderWidth % 2 / 2; let widthDifference, partialFill, yOffset = metrics.offset, pointHeight = Math.round(metrics.width), dlLeft, dlRight, dlWidth, clipRectWidth; if (minPointLength) { widthDifference = minPointLength - length; if (widthDifference < 0) { widthDifference = 0; } plotX -= widthDifference / 2; plotX2 += widthDifference / 2; } plotX = Math.max(plotX, -10); plotX2 = clamp(plotX2, -10, xAxis.len + 10); // Handle individual pointWidth if (defined(point.options.pointWidth)) { yOffset -= ((Math.ceil(point.options.pointWidth) - pointHeight) / 2); pointHeight = Math.ceil(point.options.pointWidth); } // Apply pointPlacement to the Y axis if (options.pointPlacement && isNumber(point.plotY) && yAxis.categories) { point.plotY = yAxis.translate(point.y, 0, 1, 0, 1, options.pointPlacement); } const x = Math.floor(Math.min(plotX, plotX2)) + crisper, x2 = Math.floor(Math.max(plotX, plotX2)) + crisper, width = x2 - x; const r = Math.min(relativeLength((typeof borderRadius === 'object' ? borderRadius.radius : borderRadius || 0), pointHeight), Math.min(width, pointHeight) / 2); const shapeArgs = { x, y: Math.floor(point.plotY + yOffset) + crisper, width, height: pointHeight, r }; point.shapeArgs = shapeArgs; // Move tooltip to default position if (!inverted) { point.tooltipPos[0] -= oldColWidth + seriesXOffset - shapeArgs.width / 2; } else { point.tooltipPos[1] += seriesXOffset + oldColWidth; } // Align data labels inside the shape and inside the plot area dlLeft = shapeArgs.x; dlRight = dlLeft + shapeArgs.width; if (dlLeft < 0 || dlRight > xAxis.len) { dlLeft = clamp(dlLeft, 0, xAxis.len); dlRight = clamp(dlRight, 0, xAxis.len); dlWidth = dlRight - dlLeft; point.dlBox = merge(shapeArgs, { x: dlLeft, width: dlRight - dlLeft, centerX: dlWidth ? dlWidth / 2 : null }); } else { point.dlBox = null; } // Tooltip position const tooltipPos = point.tooltipPos; const xIndex = !inverted ? 0 : 1; const yIndex = !inverted ? 1 : 0; const tooltipYOffset = (this.columnMetrics ? this.columnMetrics.offset : -metrics.width / 2); // Centering tooltip position (#14147) if (inverted) { tooltipPos[xIndex] += shapeArgs.width / 2; } else { tooltipPos[xIndex] = clamp(tooltipPos[xIndex] + (xAxis.reversed ? -1 : 0) * shapeArgs.width, xAxis.left - plotLeft, xAxis.left + xAxis.len - plotLeft - 1); } tooltipPos[yIndex] = clamp(tooltipPos[yIndex] + ((inverted ? -1 : 1) * tooltipYOffset), yAxis.top - plotTop, yAxis.top + yAxis.len - plotTop - 1); // Add a partShapeArgs to the point, based on the shapeArgs property partialFill = point.partialFill; if (partialFill) { // Get the partial fill amount if (isObject(partialFill)) { partialFill = partialFill.amount; } // If it was not a number, assume 0 if (!isNumber(partialFill)) { partialFill = 0; } point.partShapeArgs = merge(shapeArgs); clipRectWidth = Math.max(Math.round(length * partialFill + point.plotX - plotX), 0); point.clipRectArgs = { x: xAxis.reversed ? // #10717 shapeArgs.x + length - clipRectWidth : shapeArgs.x, y: shapeArgs.y, width: clipRectWidth, height: shapeArgs.height }; } } /** * @private */ translate() { super.translate.apply(this, arguments); for (const point of this.points) { this.translatePoint(point); } } /** * Draws a single point in the series. Needed for partial fill. * * This override turns point.graphic into a group containing the * original graphic and an overlay displaying the partial fill. * * @private * * @param {Highcharts.Point} point * An instance of Point in the series. * * @param {"animate"|"attr"} verb * 'animate' (animates changes) or 'attr' (sets options) */ drawPoint(point, verb) { const seriesOpts = this.options, renderer = this.chart.renderer, type = point.shapeType, shapeArgs = point.shapeArgs, partShapeArgs = point.partShapeArgs, clipRectArgs = point.clipRectArgs, pointState = point.state, stateOpts = (seriesOpts.states[pointState || 'normal'] || {}), pointStateVerb = typeof pointState === 'undefined' ? 'attr' : verb, pointAttr = this.pointAttribs(point, pointState), animation = pick(this.chart.options.chart.animation, stateOpts.animation); let graphic = point.graphic, pfOptions = point.partialFill; if (!point.isNull && point.visible !== false) { // Original graphic if (graphic) { // Update graphic.rect[verb](shapeArgs); } else { point.graphic = graphic = renderer.g('point') .addClass(point.getClassName()) .add(point.group || this.group); graphic.rect = renderer[type](merge(shapeArgs)) .addClass(point.getClassName()) .addClass('highcharts-partfill-original') .add(graphic); } // Partial fill graphic if (partShapeArgs) { if (graphic.partRect) { graphic.partRect[verb](merge(partShapeArgs)); graphic.partialClipRect[verb](merge(clipRectArgs)); } else { graphic.partialClipRect = renderer.clipRect(clipRectArgs.x, clipRectArgs.y, clipRectArgs.width, clipRectArgs.height); graphic.partRect = renderer[type](partShapeArgs) .addClass('highcharts-partfill-overlay') .add(graphic) .clip(graphic.partialClipRect); } } // Presentational if (!this.chart.styledMode) { graphic .rect[verb](pointAttr, animation) .shadow(seriesOpts.shadow); if (partShapeArgs) { // Ensure pfOptions is an object if (!isObject(pfOptions)) { pfOptions = {}; } if (isObject(seriesOpts.partialFill)) { pfOptions = merge(seriesOpts.partialFill, pfOptions); } const fill = (pfOptions.fill || color(pointAttr.fill).brighten(-0.3).get() || color(point.color || this.color) .brighten(-0.3).get()); pointAttr.fill = fill; graphic .partRect[pointStateVerb](pointAttr, animation) .shadow(seriesOpts.shadow); } } } else if (graphic) { point.graphic = graphic.destroy(); // #1269 } } /** * @private */ drawPoints() { const verb = this.getAnimationVerb(); // Draw the columns for (const point of this.points) { this.drawPoint(point, verb); } } /** * Returns "animate", or "attr" if the number of points is above the * animation limit. * * @private */ getAnimationVerb() { return (this.chart.pointCount < (this.options.animationLimit || 250) ? 'animate' : 'attr'); } /** * @private */ isPointInside(point) { const shapeArgs = point.shapeArgs, plotX = point.plotX, plotY = point.plotY; if (!shapeArgs) { return super.isPointInside.apply(this, arguments); } const isInside = typeof plotX !== 'undefined' && typeof plotY !== 'undefined' && plotY >= 0 && plotY <= this.yAxis.len && (shapeArgs.x || 0) + (shapeArgs.width || 0) >= 0 && plotX <= this.xAxis.len; return isInside; } } /* * * * Static Properties * * */ XRangeSeries.defaultOptions = merge(ColumnSeries.defaultOptions, XRangeSeriesDefaults); extend(XRangeSeries.prototype, { pointClass: XRangePoint, pointArrayMap: ['x2', 'y'], getExtremesFromAll: true, parallelArrays: ['x', 'x2', 'y'], requireSorting: false, type: 'xrange', animate: SeriesRegistry.series.prototype.animate, autoIncrement: noop, buildKDTree: noop }); SeriesRegistry.registerSeriesType('xrange', XRangeSeries); /* * * * Default Export * * */ return XRangeSeries; }); _registerModule(_modules, 'masters/modules/xrange.src.js', [_modules['Core/Globals.js'], _modules['Series/XRange/XRangeSeries.js']], function (Highcharts, XRangeSeries) { const G = Highcharts; XRangeSeries.compose(G.Axis); return Highcharts; }); _registerModule(_modules, 'Series/Gantt/GanttPoint.js', [_modules['Core/Series/SeriesRegistry.js'], _modules['Core/Utilities.js']], function (SeriesRegistry, U) { /* * * * (c) 2016-2024 Highsoft AS * * Author: Lars A. V. Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { xrange: { prototype: { pointClass: XRangePoint } } } = SeriesRegistry.seriesTypes; const { pick } = U; /* * * * Class * * */ class GanttPoint extends XRangePoint { /* * * * Static Functions * * */ /** * @private */ static setGanttPointAliases(options) { /** * Add a value to options if the value exists. * @private */ function addIfExists(prop, val) { if (typeof val !== 'undefined') { options[prop] = val; } } addIfExists('x', pick(options.start, options.x)); addIfExists('x2', pick(options.end, options.x2)); addIfExists('partialFill', pick(options.completed, options.partialFill)); } /* * * * Functions * * */ /** * Applies the options containing the x and y data and possible some * extra properties. This is called on point init or from point.update. * * @private * @function Highcharts.Point#applyOptions * * @param {Object} options * The point options * * @param {number} x * The x value * * @return {Highcharts.Point} * The Point instance */ applyOptions(options, x) { const ganttPoint = super.applyOptions(options, x); GanttPoint.setGanttPointAliases(ganttPoint); return ganttPoint; } isValid() { return ((typeof this.start === 'number' || typeof this.x === 'number') && (typeof this.end === 'number' || typeof this.x2 === 'number' || this.milestone)); } } /* * * * Default Export * * */ return GanttPoint; }); _registerModule(_modules, 'Series/Gantt/GanttSeriesDefaults.js', [_modules['Core/Utilities.js']], function (U) { /* * * * (c) 2016-2024 Highsoft AS * * Author: Lars A. V. Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { isNumber } = U; /* * * * API Options * * */ /** * A `gantt` series. If the [type](#series.gantt.type) option is not specified, * it is inherited from [chart.type](#chart.type). * * @extends plotOptions.xrange * @product gantt * @requires highcharts-gantt * @optionparent plotOptions.gantt */ const GanttSeriesDefaults = { // Options - default options merged with parent grouping: false, dataLabels: { enabled: true }, tooltip: { headerFormat: '{series.name}
', pointFormat: null, pointFormatter: function () { const point = this, series = point.series, xAxis = series.xAxis, formats = series.tooltipOptions.dateTimeLabelFormats, startOfWeek = xAxis.options.startOfWeek, ttOptions = series.tooltipOptions, milestone = point.options.milestone; let format = ttOptions.xDateFormat, retVal = '' + (point.name || point.yCategory) + ''; if (ttOptions.pointFormat) { return point.tooltipFormatter(ttOptions.pointFormat); } if (!format && isNumber(point.start)) { format = series.chart.time.getDateFormat(xAxis.closestPointRange, point.start, startOfWeek, formats || {}); } const start = series.chart.time.dateFormat(format, point.start), end = series.chart.time.dateFormat(format, point.end); retVal += '
'; if (!milestone) { retVal += 'Start: ' + start + '
'; retVal += 'End: ' + end + '
'; } else { retVal += start + '
'; } return retVal; } }, connectors: { type: 'simpleConnect', /** * @declare Highcharts.ConnectorsAnimationOptionsObject */ animation: { reversed: true // Dependencies go from child to parent }, radius: 0, startMarker: { enabled: true, symbol: 'arrow-filled', radius: 4, fill: '#fa0', align: 'left' }, endMarker: { enabled: false, align: 'right' } } }; /** * A `gantt` series. * * @extends series,plotOptions.gantt * @excluding boostThreshold, dashStyle, findNearestPointBy, * getExtremesFromAll, marker, negativeColor, pointInterval, * pointIntervalUnit, pointPlacement, pointStart * @product gantt * @requires highcharts-gantt * @apioption series.gantt */ /** * Data for a Gantt series. * * @declare Highcharts.GanttPointOptionsObject * @type {Array<*>} * @extends series.xrange.data * @excluding className, connect, dataLabels, events, * partialFill, selected, x, x2 * @product gantt * @apioption series.gantt.data */ /** * Whether the grid node belonging to this point should start as collapsed. Used * in axes of type treegrid. * * @sample {gantt} gantt/treegrid-axis/collapsed/ * Start as collapsed * * @type {boolean} * @default false * @product gantt * @apioption series.gantt.data.collapsed */ /** * The start time of a task. * * @type {number} * @product gantt * @apioption series.gantt.data.start */ /** * The end time of a task. * * @type {number} * @product gantt * @apioption series.gantt.data.end */ /** * The Y value of a task. * * @type {number} * @product gantt * @apioption series.gantt.data.y */ /** * The name of a task. If a `treegrid` y-axis is used (default in Gantt charts), * this will be picked up automatically, and used to calculate the y-value. * * @type {string} * @product gantt * @apioption series.gantt.data.name */ /** * Progress indicator, how much of the task completed. If it is a number, the * `fill` will be applied automatically. * * @sample {gantt} gantt/demo/progress-indicator * Progress indicator * * @type {number|*} * @extends series.xrange.data.partialFill * @product gantt * @apioption series.gantt.data.completed */ /** * The amount of the progress indicator, ranging from 0 (not started) to 1 * (finished). * * @type {number} * @default 0 * @apioption series.gantt.data.completed.amount */ /** * The fill of the progress indicator. Defaults to a darkened variety of the * main color. * * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} * @apioption series.gantt.data.completed.fill */ /** * The ID of the point (task) that this point depends on in Gantt charts. * Aliases [connect](series.xrange.data.connect). Can also be an object, * specifying further connecting [options](series.gantt.connectors) between the * points. Multiple connections can be specified by providing an array. * * @sample gantt/demo/project-management * Dependencies * @sample gantt/pathfinder/demo * Different connection types * * @type {string|Array|*} * @extends series.xrange.data.connect * @since 6.2.0 * @product gantt * @apioption series.gantt.data.dependency */ /** * Whether this point is a milestone. If so, only the `start` option is handled, * while `end` is ignored. * * @sample gantt/gantt/milestones * Milestones * * @type {boolean} * @since 6.2.0 * @product gantt * @apioption series.gantt.data.milestone */ /** * The ID of the parent point (task) of this point in Gantt charts. * * @sample gantt/demo/subtasks * Gantt chart with subtasks * * @type {string} * @since 6.2.0 * @product gantt * @apioption series.gantt.data.parent */ /** * @excluding afterAnimate * @apioption series.gantt.events */ ''; // Detachs doclets above /* * * * Default Export * * */ return GanttSeriesDefaults; }); _registerModule(_modules, 'Core/Axis/BrokenAxis.js', [_modules['Core/Axis/Stacking/StackItem.js'], _modules['Core/Utilities.js']], function (StackItem, U) { /* * * * (c) 2009-2024 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { addEvent, find, fireEvent, isArray, isNumber, pick } = U; /* * * * Composition * * */ /** * Axis with support of broken data rows. * @private */ var BrokenAxis; (function (BrokenAxis) { /* * * * Declarations * * */ /* * * * Functions * * */ /** * Adds support for broken axes. * @private */ function compose(AxisClass, SeriesClass) { if (!AxisClass.keepProps.includes('brokenAxis')) { AxisClass.keepProps.push('brokenAxis'); addEvent(AxisClass, 'init', onAxisInit); addEvent(AxisClass, 'afterInit', onAxisAfterInit); addEvent(AxisClass, 'afterSetTickPositions', onAxisAfterSetTickPositions); addEvent(AxisClass, 'afterSetOptions', onAxisAfterSetOptions); const seriesProto = SeriesClass.prototype; seriesProto.drawBreaks = seriesDrawBreaks; seriesProto.gappedPath = seriesGappedPath; addEvent(SeriesClass, 'afterGeneratePoints', onSeriesAfterGeneratePoints); addEvent(SeriesClass, 'afterRender', onSeriesAfterRender); } return AxisClass; } BrokenAxis.compose = compose; /** * @private */ function onAxisAfterInit() { if (typeof this.brokenAxis !== 'undefined') { this.brokenAxis.setBreaks(this.options.breaks, false); } } /** * Force Axis to be not-ordinal when breaks are defined. * @private */ function onAxisAfterSetOptions() { const axis = this; if (axis.brokenAxis?.hasBreaks) { axis.options.ordinal = false; } } /** * @private */ function onAxisAfterSetTickPositions() { const axis = this, brokenAxis = axis.brokenAxis; if (brokenAxis?.hasBreaks) { const tickPositions = axis.tickPositions, info = axis.tickPositions.info, newPositions = []; for (let i = 0; i < tickPositions.length; i++) { if (!brokenAxis.isInAnyBreak(tickPositions[i])) { newPositions.push(tickPositions[i]); } } axis.tickPositions = newPositions; axis.tickPositions.info = info; } } /** * @private */ function onAxisInit() { const axis = this; if (!axis.brokenAxis) { axis.brokenAxis = new Additions(axis); } } /** * @private */ function onSeriesAfterGeneratePoints() { const { isDirty, options: { connectNulls }, points, xAxis, yAxis } = this; // Set, or reset visibility of the points. Axis.setBreaks marks // the series as isDirty if (isDirty) { let i = points.length; while (i--) { const point = points[i]; // Respect nulls inside the break (#4275) const nullGap = point.y === null && connectNulls === false; const isPointInBreak = (!nullGap && (xAxis?.brokenAxis?.isInAnyBreak(point.x, true) || yAxis?.brokenAxis?.isInAnyBreak(point.y, true))); // Set point.visible if in any break. // If not in break, reset visible to original value. point.visible = isPointInBreak ? false : point.options.visible !== false; } } } /** * @private */ function onSeriesAfterRender() { this.drawBreaks(this.xAxis, ['x']); this.drawBreaks(this.yAxis, pick(this.pointArrayMap, ['y'])); } /** * @private */ function seriesDrawBreaks(axis, keys) { const series = this, points = series.points; let breaks, threshold, y; if (axis?.brokenAxis?.hasBreaks) { const brokenAxis = axis.brokenAxis; keys.forEach(function (key) { breaks = brokenAxis?.breakArray || []; threshold = axis.isXAxis ? axis.min : pick(series.options.threshold, axis.min); // Array of breaks that have been "zoomed-out" which means that // they were shown previously, but now after zoom, they are not // (#19885). const breaksOutOfRange = axis?.options?.breaks?.filter(function (brk) { let isOut = true; // Iterate to see if "brk" is in axis range for (let i = 0; i < breaks.length; i++) { const otherBreak = breaks[i]; if (otherBreak.from === brk.from && otherBreak.to === brk.to) { isOut = false; break; } } return isOut; }); points.forEach(function (point) { y = pick(point['stack' + key.toUpperCase()], point[key]); breaks.forEach(function (brk) { if (isNumber(threshold) && isNumber(y)) { let eventName = ''; if ((threshold < brk.from && y > brk.to) || (threshold > brk.from && y < brk.from)) { eventName = 'pointBreak'; } else if ((threshold < brk.from && y > brk.from && y < brk.to) || (threshold > brk.from && y > brk.to && y < brk.from)) { eventName = 'pointInBreak'; } if (eventName) { fireEvent(axis, eventName, { point, brk }); } } }); breaksOutOfRange?.forEach(function (brk) { fireEvent(axis, 'pointOutsideOfBreak', { point, brk }); }); }); }); } } /** * Extend getGraphPath by identifying gaps in the data so that we * can draw a gap in the line or area. This was moved from ordinal * axis module to broken axis module as of #5045. * * @private * @function Highcharts.Series#gappedPath * * @return {Highcharts.SVGPathArray} * Gapped path */ function seriesGappedPath() { const currentDataGrouping = this.currentDataGrouping, groupingSize = currentDataGrouping?.gapSize, points = this.points.slice(), yAxis = this.yAxis; let gapSize = this.options.gapSize, i = points.length - 1, stack; /** * Defines when to display a gap in the graph, together with the * [gapUnit](plotOptions.series.gapUnit) option. * * In case when `dataGrouping` is enabled, points can be grouped * into a larger time span. This can make the grouped points to * have a greater distance than the absolute value of `gapSize` * property, which will result in disappearing graph completely. * To prevent this situation the mentioned distance between * grouped points is used instead of previously defined * `gapSize`. * * In practice, this option is most often used to visualize gaps * in time series. In a stock chart, intraday data is available * for daytime hours, while gaps will appear in nights and * weekends. * * @see [gapUnit](plotOptions.series.gapUnit) * @see [xAxis.breaks](#xAxis.breaks) * * @sample {highstock} stock/plotoptions/series-gapsize/ * Setting the gap size to 2 introduces gaps for weekends in * daily datasets. * * @type {number} * @default 0 * @product highstock * @requires modules/broken-axis * @apioption plotOptions.series.gapSize */ /** * Together with [gapSize](plotOptions.series.gapSize), this * option defines where to draw gaps in the graph. * * When the `gapUnit` is `"relative"` (default), a gap size of 5 * means that if the distance between two points is greater than * 5 times that of the two closest points, the graph will be * broken. * * When the `gapUnit` is `"value"`, the gap is based on absolute * axis values, which on a datetime axis is milliseconds. This * also applies to the navigator series that inherits gap * options from the base series. * * @see [gapSize](plotOptions.series.gapSize) * * @type {string} * @default relative * @since 5.0.13 * @product highstock * @validvalue ["relative", "value"] * @requires modules/broken-axis * @apioption plotOptions.series.gapUnit */ if (gapSize && i > 0) { // #5008 // Gap unit is relative if (this.options.gapUnit !== 'value') { gapSize *= this.basePointRange; } // Setting a new gapSize in case dataGrouping is enabled // (#7686) if (groupingSize && groupingSize > gapSize && // Except when DG is forced (e.g. from other series) // and has lower granularity than actual points (#11351) groupingSize >= this.basePointRange) { gapSize = groupingSize; } // Extension for ordinal breaks let current, next; while (i--) { // Reassign next if it is not visible if (!(next && next.visible !== false)) { next = points[i + 1]; } current = points[i]; // Skip iteration if one of the points is not visible if (next.visible === false || current.visible === false) { continue; } if (next.x - current.x > gapSize) { const xRange = (current.x + next.x) / 2; points.splice(// Insert after this one i + 1, 0, { isNull: true, x: xRange }); // For stacked chart generate empty stack items, #6546 if (yAxis.stacking && this.options.stacking) { stack = yAxis.stacking.stacks[this.stackKey][xRange] = new StackItem(yAxis, yAxis.options.stackLabels, false, xRange, this.stack); stack.total = 0; } } // Assign current to next for the upcoming iteration next = current; } } // Call base method return this.getGraphPath(points); } /* * * * Class * * */ /** * Provides support for broken axes. * @private * @class */ class Additions { /* * * * Static Functions * * */ /** * @private */ static isInBreak(brk, val) { const repeat = brk.repeat || Infinity, from = brk.from, length = brk.to - brk.from, test = (val >= from ? (val - from) % repeat : repeat - ((from - val) % repeat)); let ret; if (!brk.inclusive) { ret = test < length && test !== 0; } else { ret = test <= length; } return ret; } /** * @private */ static lin2Val(val) { const axis = this; const brokenAxis = axis.brokenAxis; const breakArray = brokenAxis && brokenAxis.breakArray; if (!breakArray || !isNumber(val)) { return val; } let nval = val, brk, i; for (i = 0; i < breakArray.length; i++) { brk = breakArray[i]; if (brk.from >= nval) { break; } else if (brk.to < nval) { nval += brk.len; } else if (Additions.isInBreak(brk, nval)) { nval += brk.len; } } return nval; } /** * @private */ static val2Lin(val) { const axis = this; const brokenAxis = axis.brokenAxis; const breakArray = brokenAxis && brokenAxis.breakArray; if (!breakArray || !isNumber(val)) { return val; } let nval = val, brk, i; for (i = 0; i < breakArray.length; i++) { brk = breakArray[i]; if (brk.to <= val) { nval -= brk.len; } else if (brk.from >= val) { break; } else if (Additions.isInBreak(brk, val)) { nval -= (val - brk.from); break; } } return nval; } /* * * * Constructors * * */ constructor(axis) { this.hasBreaks = false; this.axis = axis; } /* * * * Functions * * */ /** * Returns the first break found where the x is larger then break.from * and smaller then break.to. * * @param {number} x * The number which should be within a break. * * @param {Array} breaks * The array of breaks to search within. * * @return {Highcharts.XAxisBreaksOptions|undefined} * Returns the first break found that matches, returns false if no break * is found. */ findBreakAt(x, breaks) { return find(breaks, function (b) { return b.from < x && x < b.to; }); } /** * @private */ isInAnyBreak(val, testKeep) { const brokenAxis = this, axis = brokenAxis.axis, breaks = axis.options.breaks || []; let i = breaks.length, inbrk, keep, ret; if (i && isNumber(val)) { while (i--) { if (Additions.isInBreak(breaks[i], val)) { inbrk = true; if (!keep) { keep = pick(breaks[i].showPoints, !axis.isXAxis); } } } if (inbrk && testKeep) { ret = inbrk && !keep; } else { ret = inbrk; } } return ret; } /** * Dynamically set or unset breaks in an axis. This function in lighter * than using Axis.update, and it also preserves animation. * * @private * @function Highcharts.Axis#setBreaks * * @param {Array} [breaks] * The breaks to add. When `undefined` it removes existing breaks. * * @param {boolean} [redraw=true] * Whether to redraw the chart immediately. */ setBreaks(breaks, redraw) { const brokenAxis = this; const axis = brokenAxis.axis; const hasBreaks = isArray(breaks) && !!breaks.length && !!Object.keys(breaks[0]).length; // Check for [{}], #16368. axis.isDirty = brokenAxis.hasBreaks !== hasBreaks; brokenAxis.hasBreaks = hasBreaks; if (breaks !== axis.options.breaks) { axis.options.breaks = axis.userOptions.breaks = breaks; } axis.forceRedraw = true; // Force recalculation in setScale // Recalculate series related to the axis. axis.series.forEach(function (series) { series.isDirty = true; }); if (!hasBreaks && axis.val2lin === Additions.val2Lin) { // Revert to prototype functions delete axis.val2lin; delete axis.lin2val; } if (hasBreaks) { axis.userOptions.ordinal = false; axis.lin2val = Additions.lin2Val; axis.val2lin = Additions.val2Lin; axis.setExtremes = function (newMin, newMax, redraw, animation, eventArguments) { // If trying to set extremes inside a break, extend min to // after, and max to before the break ( #3857 ) if (brokenAxis.hasBreaks) { const breaks = (this.options.breaks || []); let axisBreak; while ((axisBreak = brokenAxis.findBreakAt(newMin, breaks))) { newMin = axisBreak.to; } while ((axisBreak = brokenAxis.findBreakAt(newMax, breaks))) { newMax = axisBreak.from; } // If both min and max is within the same break. if (newMax < newMin) { newMax = newMin; } } axis.constructor.prototype.setExtremes.call(this, newMin, newMax, redraw, animation, eventArguments); }; axis.setAxisTranslation = function () { axis.constructor.prototype.setAxisTranslation.call(this); brokenAxis.unitLength = void 0; if (brokenAxis.hasBreaks) { const breaks = axis.options.breaks || [], // Temporary one: breakArrayT = [], breakArray = [], pointRangePadding = pick(axis.pointRangePadding, 0); let length = 0, inBrk, repeat, min = axis.userMin || axis.min, max = axis.userMax || axis.max, start, i; // Min & max check (#4247) breaks.forEach(function (brk) { repeat = brk.repeat || Infinity; if (isNumber(min) && isNumber(max)) { if (Additions.isInBreak(brk, min)) { min += ((brk.to % repeat) - (min % repeat)); } if (Additions.isInBreak(brk, max)) { max -= ((max % repeat) - (brk.from % repeat)); } } }); // Construct an array holding all breaks in the axis breaks.forEach(function (brk) { start = brk.from; repeat = brk.repeat || Infinity; if (isNumber(min) && isNumber(max)) { while (start - repeat > min) { start -= repeat; } while (start < min) { start += repeat; } for (i = start; i < max; i += repeat) { breakArrayT.push({ value: i, move: 'in' }); breakArrayT.push({ value: i + brk.to - brk.from, move: 'out', size: brk.breakSize }); } } }); breakArrayT.sort(function (a, b) { return ((a.value === b.value) ? ((a.move === 'in' ? 0 : 1) - (b.move === 'in' ? 0 : 1)) : a.value - b.value); }); // Simplify the breaks inBrk = 0; start = min; breakArrayT.forEach(function (brk) { inBrk += (brk.move === 'in' ? 1 : -1); if (inBrk === 1 && brk.move === 'in') { start = brk.value; } if (inBrk === 0 && isNumber(start)) { breakArray.push({ from: start, to: brk.value, len: brk.value - start - (brk.size || 0) }); length += (brk.value - start - (brk.size || 0)); } }); brokenAxis.breakArray = breakArray; // Used with staticScale, and below the actual axis // length, when breaks are subtracted. if (isNumber(min) && isNumber(max) && isNumber(axis.min)) { brokenAxis.unitLength = max - min - length + pointRangePadding; fireEvent(axis, 'afterBreaks'); if (axis.staticScale) { axis.transA = axis.staticScale; } else if (brokenAxis.unitLength) { axis.transA *= (max - axis.min + pointRangePadding) / brokenAxis.unitLength; } if (pointRangePadding) { axis.minPixelPadding = axis.transA * (axis.minPointOffset || 0); } axis.min = min; axis.max = max; } } }; } if (pick(redraw, true)) { axis.chart.redraw(); } } } BrokenAxis.Additions = Additions; })(BrokenAxis || (BrokenAxis = {})); /* * * * Default Export * * */ return BrokenAxis; }); _registerModule(_modules, 'Core/Axis/GridAxis.js', [_modules['Core/Axis/Axis.js'], _modules['Core/Globals.js'], _modules['Core/Utilities.js']], function (Axis, H, U) { /* * * * (c) 2016 Highsoft AS * Authors: Lars A. V. Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { dateFormats } = H; const { addEvent, defined, erase, find, isArray, isNumber, merge, pick, timeUnits, wrap } = U; /* * * * Enums * * */ /** * Enum for which side the axis is on. Maps to axis.side. * @private */ var GridAxisSide; (function (GridAxisSide) { GridAxisSide[GridAxisSide["top"] = 0] = "top"; GridAxisSide[GridAxisSide["right"] = 1] = "right"; GridAxisSide[GridAxisSide["bottom"] = 2] = "bottom"; GridAxisSide[GridAxisSide["left"] = 3] = "left"; })(GridAxisSide || (GridAxisSide = {})); /* * * * Functions * * */ /** * @private */ function argsToArray(args) { return Array.prototype.slice.call(args, 1); } /** * @private */ function isObject(x) { // Always use strict mode return U.isObject(x, true); } /** * @private */ function applyGridOptions(axis) { const options = axis.options; // Center-align by default /* if (!options.labels) { options.labels = {}; } */ options.labels.align = pick(options.labels.align, 'center'); // @todo: Check against tickLabelPlacement between/on etc /* Prevents adding the last tick label if the axis is not a category axis. Since numeric labels are normally placed at starts and ends of a range of value, and this module makes the label point at the value, an "extra" label would appear. */ if (!axis.categories) { options.showLastLabel = false; } // Prevents rotation of labels when squished, as rotating them would not // help. axis.labelRotation = 0; options.labels.rotation = 0; // Allow putting ticks closer than their data points. options.minTickInterval = 1; } /** * Extends axis class with grid support. * @private */ function compose(AxisClass, ChartClass, TickClass) { if (!AxisClass.keepProps.includes('grid')) { AxisClass.keepProps.push('grid'); AxisClass.prototype.getMaxLabelDimensions = getMaxLabelDimensions; wrap(AxisClass.prototype, 'unsquish', wrapUnsquish); wrap(AxisClass.prototype, 'getOffset', wrapGetOffset); // Add event handlers addEvent(AxisClass, 'init', onInit); addEvent(AxisClass, 'afterGetTitlePosition', onAfterGetTitlePosition); addEvent(AxisClass, 'afterInit', onAfterInit); addEvent(AxisClass, 'afterRender', onAfterRender); addEvent(AxisClass, 'afterSetAxisTranslation', onAfterSetAxisTranslation); addEvent(AxisClass, 'afterSetOptions', onAfterSetOptions); addEvent(AxisClass, 'afterSetOptions', onAfterSetOptions2); addEvent(AxisClass, 'afterSetScale', onAfterSetScale); addEvent(AxisClass, 'afterTickSize', onAfterTickSize); addEvent(AxisClass, 'trimTicks', onTrimTicks); addEvent(AxisClass, 'destroy', onDestroy); addEvent(ChartClass, 'afterSetChartSize', onChartAfterSetChartSize); addEvent(TickClass, 'afterGetLabelPosition', onTickAfterGetLabelPosition); addEvent(TickClass, 'labelFormat', onTickLabelFormat); } return AxisClass; } /** * Get the largest label width and height. * * @private * @function Highcharts.Axis#getMaxLabelDimensions * * @param {Highcharts.Dictionary} ticks * All the ticks on one axis. * * @param {Array} tickPositions * All the tick positions on one axis. * * @return {Highcharts.SizeObject} * Object containing the properties height and width. * * @todo Move this to the generic axis implementation, as it is used there. */ function getMaxLabelDimensions(ticks, tickPositions) { const dimensions = { width: 0, height: 0 }; tickPositions.forEach(function (pos) { const tick = ticks[pos]; let labelHeight = 0, labelWidth = 0, label; if (isObject(tick)) { label = isObject(tick.label) ? tick.label : {}; // Find width and height of label labelHeight = label.getBBox ? label.getBBox().height : 0; if (label.textStr && !isNumber(label.textPxLength)) { label.textPxLength = label.getBBox().width; } labelWidth = isNumber(label.textPxLength) ? // Math.round ensures crisp lines Math.round(label.textPxLength) : 0; if (label.textStr) { // Set the tickWidth same as the label width after ellipsis // applied #10281 labelWidth = Math.round(label.getBBox().width); } // Update the result if width and/or height are larger dimensions.height = Math.max(labelHeight, dimensions.height); dimensions.width = Math.max(labelWidth, dimensions.width); } }); // For tree grid, add indentation if (this.options.type === 'treegrid' && this.treeGrid && this.treeGrid.mapOfPosToGridNode) { const treeDepth = this.treeGrid.mapOfPosToGridNode[-1].height || 0; dimensions.width += (this.options.labels.indentation * (treeDepth - 1)); } return dimensions; } /** * Handle columns and getOffset. * @private */ function wrapGetOffset(proceed) { const { grid } = this, // On the left side we handle the columns first because the offset is // calculated from the plot area and out columnsFirst = this.side === 3; if (!columnsFirst) { proceed.apply(this); } if (!grid?.isColumn) { let columns = grid?.columns || []; if (columnsFirst) { columns = columns.slice().reverse(); } columns .forEach((column) => { column.getOffset(); }); } if (columnsFirst) { proceed.apply(this); } } /** * @private */ function onAfterGetTitlePosition(e) { const axis = this; const options = axis.options; const gridOptions = options.grid || {}; if (gridOptions.enabled === true) { // Compute anchor points for each of the title align options const { axisTitle, height: axisHeight, horiz, left: axisLeft, offset, opposite, options, top: axisTop, width: axisWidth } = axis; const tickSize = axis.tickSize(); const titleWidth = axisTitle && axisTitle.getBBox().width; const xOption = options.title.x; const yOption = options.title.y; const titleMargin = pick(options.title.margin, horiz ? 5 : 10); const titleFontSize = axisTitle ? axis.chart.renderer.fontMetrics(axisTitle).f : 0; const crispCorr = tickSize ? tickSize[0] / 2 : 0; // TODO account for alignment // the position in the perpendicular direction of the axis const offAxis = ((horiz ? axisTop + axisHeight : axisLeft) + (horiz ? 1 : -1) * // Horizontal axis reverses the margin (opposite ? -1 : 1) * // So does opposite axes crispCorr + (axis.side === GridAxisSide.bottom ? titleFontSize : 0)); e.titlePosition.x = horiz ? axisLeft - (titleWidth || 0) / 2 - titleMargin + xOption : offAxis + (opposite ? axisWidth : 0) + offset + xOption; e.titlePosition.y = horiz ? (offAxis - (opposite ? axisHeight : 0) + (opposite ? titleFontSize : -titleFontSize) / 2 + offset + yOption) : axisTop - titleMargin + yOption; } } /** * @private */ function onAfterInit() { const axis = this; const { chart, options: { grid: gridOptions = {} }, userOptions } = axis; if (gridOptions.enabled) { applyGridOptions(axis); } if (gridOptions.columns) { const columns = axis.grid.columns = []; let columnIndex = axis.grid.columnIndex = 0; // Handle columns, each column is a grid axis while (++columnIndex < gridOptions.columns.length) { const columnOptions = merge(userOptions, gridOptions.columns[columnIndex], { isInternal: true, linkedTo: 0, // Disable by default the scrollbar on the grid axis scrollbar: { enabled: false } }, // Avoid recursion { grid: { columns: void 0 } }); const column = new Axis(axis.chart, columnOptions, 'yAxis'); column.grid.isColumn = true; column.grid.columnIndex = columnIndex; // Remove column axis from chart axes array, and place it // in the columns array. erase(chart.axes, column); erase(chart[axis.coll] || [], column); columns.push(column); } } } /** * Draw an extra line on the far side of the outermost axis, * creating floor/roof/wall of a grid. And some padding. * ``` * Make this: * (axis.min) __________________________ (axis.max) * | | | | | * Into this: * (axis.min) __________________________ (axis.max) * ___|____|____|____|____|__ * ``` * @private */ function onAfterRender() { const axis = this, { axisTitle, grid, options } = axis, gridOptions = options.grid || {}; if (gridOptions.enabled === true) { const min = axis.min || 0, max = axis.max || 0, firstTick = axis.ticks[axis.tickPositions[0]]; // Adjust the title max width to the column width (#19657) if (axisTitle && !axis.chart.styledMode && firstTick?.slotWidth && !axis.options.title.style.width) { axisTitle.css({ width: `${firstTick.slotWidth}px` }); } // @todo actual label padding (top, bottom, left, right) axis.maxLabelDimensions = axis.getMaxLabelDimensions(axis.ticks, axis.tickPositions); // Remove right wall before rendering if updating if (axis.rightWall) { axis.rightWall.destroy(); } /* Draw an extra axis line on outer axes > Make this: |______|______|______|___ > _________________________ Into this: |______|______|______|__| */ if (axis.grid && axis.grid.isOuterAxis() && axis.axisLine) { const lineWidth = options.lineWidth; if (lineWidth) { const linePath = axis.getLinePath(lineWidth), startPoint = linePath[0], endPoint = linePath[1], // Negate distance if top or left axis // Subtract 1px to draw the line at the end of the tick tickLength = (axis.tickSize('tick') || [1])[0], distance = (tickLength - 1) * ((axis.side === GridAxisSide.top || axis.side === GridAxisSide.left) ? -1 : 1); // If axis is horizontal, reposition line path vertically if (startPoint[0] === 'M' && endPoint[0] === 'L') { if (axis.horiz) { startPoint[2] += distance; endPoint[2] += distance; } else { startPoint[1] += distance; endPoint[1] += distance; } } // If it doesn't exist, add an upper and lower border // for the vertical grid axis. if (!axis.horiz && axis.chart.marginRight) { const upperBorderStartPoint = startPoint, upperBorderEndPoint = [ 'L', axis.left, startPoint[2] || 0 ], upperBorderPath = [ upperBorderStartPoint, upperBorderEndPoint ], lowerBorderEndPoint = [ 'L', axis.chart.chartWidth - axis.chart.marginRight, axis.toPixels(max + axis.tickmarkOffset) ], lowerBorderStartPoint = [ 'M', endPoint[1] || 0, axis.toPixels(max + axis.tickmarkOffset) ], lowerBorderPath = [ lowerBorderStartPoint, lowerBorderEndPoint ]; if (!axis.grid.upperBorder && min % 1 !== 0) { axis.grid.upperBorder = axis.grid.renderBorder(upperBorderPath); } if (axis.grid.upperBorder) { axis.grid.upperBorder.attr({ stroke: options.lineColor, 'stroke-width': options.lineWidth }); axis.grid.upperBorder.animate({ d: upperBorderPath }); } if (!axis.grid.lowerBorder && max % 1 !== 0) { axis.grid.lowerBorder = axis.grid.renderBorder(lowerBorderPath); } if (axis.grid.lowerBorder) { axis.grid.lowerBorder.attr({ stroke: options.lineColor, 'stroke-width': options.lineWidth }); axis.grid.lowerBorder.animate({ d: lowerBorderPath }); } } // Render an extra line parallel to the existing axes, to // close the grid. if (!axis.grid.axisLineExtra) { axis.grid.axisLineExtra = axis.grid.renderBorder(linePath); } else { axis.grid.axisLineExtra.attr({ stroke: options.lineColor, 'stroke-width': options.lineWidth }); axis.grid.axisLineExtra.animate({ d: linePath }); } // Show or hide the line depending on options.showEmpty axis.axisLine[axis.showAxis ? 'show' : 'hide'](); } } (grid && grid.columns || []).forEach((column) => column.render()); // Manipulate the tick mark visibility // based on the axis.max- allows smooth scrolling. if (!axis.horiz && axis.chart.hasRendered && (axis.scrollbar || (axis.linkedParent && axis.linkedParent.scrollbar)) && axis.tickPositions.length) { const tickmarkOffset = axis.tickmarkOffset, lastTick = axis.tickPositions[axis.tickPositions.length - 1], firstTick = axis.tickPositions[0]; let label, tickMark; while ((label = axis.hiddenLabels.pop()) && label.element) { label.show(); // #15453 } while ((tickMark = axis.hiddenMarks.pop()) && tickMark.element) { tickMark.show(); // #16439 } // Hide/show first tick label. label = axis.ticks[firstTick].label; if (label) { if (min - firstTick > tickmarkOffset) { axis.hiddenLabels.push(label.hide()); } else { label.show(); } } // Hide/show last tick mark/label. label = axis.ticks[lastTick].label; if (label) { if (lastTick - max > tickmarkOffset) { axis.hiddenLabels.push(label.hide()); } else { label.show(); } } const mark = axis.ticks[lastTick].mark; if (mark && lastTick - max < tickmarkOffset && lastTick - max > 0 && axis.ticks[lastTick].isLast) { axis.hiddenMarks.push(mark.hide()); } } } } /** * @private */ function onAfterSetAxisTranslation() { const axis = this; const tickInfo = axis.tickPositions && axis.tickPositions.info; const options = axis.options; const gridOptions = options.grid || {}; const userLabels = axis.userOptions.labels || {}; // Fire this only for the Gantt type chart, #14868. if (gridOptions.enabled) { if (axis.horiz) { axis.series.forEach((series) => { series.options.pointRange = 0; }); // Lower level time ticks, like hours or minutes, represent // points in time and not ranges. These should be aligned // left in the grid cell by default. The same applies to // years of higher order. if (tickInfo && options.dateTimeLabelFormats && options.labels && !defined(userLabels.align) && (options.dateTimeLabelFormats[tickInfo.unitName] .range === false || tickInfo.count > 1 // Years )) { options.labels.align = 'left'; if (!defined(userLabels.x)) { options.labels.x = 3; } } } else { // Don't trim ticks which not in min/max range but // they are still in the min/max plus tickInterval. if (this.options.type !== 'treegrid' && axis.grid && axis.grid.columns) { this.minPointOffset = this.tickInterval; } } } } /** * Creates a left and right wall on horizontal axes: * - Places leftmost tick at the start of the axis, to create a left * wall * - Ensures that the rightmost tick is at the end of the axis, to * create a right wall. * @private */ function onAfterSetOptions(e) { const options = this.options, userOptions = e.userOptions, gridOptions = ((options && isObject(options.grid)) ? options.grid : {}); let gridAxisOptions; if (gridOptions.enabled === true) { // Merge the user options into default grid axis options so // that when a user option is set, it takes precedence. gridAxisOptions = merge(true, { className: ('highcharts-grid-axis ' + (userOptions.className || '')), dateTimeLabelFormats: { hour: { list: ['%H:%M', '%H'] }, day: { list: ['%A, %e. %B', '%a, %e. %b', '%E'] }, week: { list: ['Week %W', 'W%W'] }, month: { list: ['%B', '%b', '%o'] } }, grid: { borderWidth: 1 }, labels: { padding: 2, style: { fontSize: '0.9em' } }, margin: 0, title: { text: null, reserveSpace: false, rotation: 0, style: { textOverflow: 'ellipsis' } }, // In a grid axis, only allow one unit of certain types, // for example we shouldn't have one grid cell spanning // two days. units: [[ 'millisecond', [1, 10, 100] ], [ 'second', [1, 10] ], [ 'minute', [1, 5, 15] ], [ 'hour', [1, 6] ], [ 'day', [1] ], [ 'week', [1] ], [ 'month', [1] ], [ 'year', null ]] }, userOptions); // X-axis specific options if (this.coll === 'xAxis') { // For linked axes, tickPixelInterval is used only if // the tickPositioner below doesn't run or returns // undefined (like multiple years) if (defined(userOptions.linkedTo) && !defined(userOptions.tickPixelInterval)) { gridAxisOptions.tickPixelInterval = 350; } // For the secondary grid axis, use the primary axis' // tick intervals and return ticks one level higher. if ( // Check for tick pixel interval in options !defined(userOptions.tickPixelInterval) && // Only for linked axes defined(userOptions.linkedTo) && !defined(userOptions.tickPositioner) && !defined(userOptions.tickInterval) && !defined(userOptions.units)) { gridAxisOptions.tickPositioner = function (min, max) { const parentInfo = (this.linkedParent && this.linkedParent.tickPositions && this.linkedParent.tickPositions.info); if (parentInfo) { const units = (gridAxisOptions.units || []); let unitIdx, count = 1, unitName = 'year'; for (let i = 0; i < units.length; i++) { const unit = units[i]; if (unit && unit[0] === parentInfo.unitName) { unitIdx = i; break; } } // Get the first allowed count on the next unit. const unit = (isNumber(unitIdx) && units[unitIdx + 1]); if (unit) { unitName = unit[0] || 'year'; const counts = unit[1]; count = counts && counts[0] || 1; // In case the base X axis shows years, make the // secondary axis show ten times the years (#11427) } else if (parentInfo.unitName === 'year') { // `unitName` is 'year' count = parentInfo.count * 10; } const unitRange = timeUnits[unitName]; this.tickInterval = unitRange * count; return this.chart.time.getTimeTicks({ unitRange, count, unitName }, min, max, this.options.startOfWeek); } }; } } // Now merge the combined options into the axis options merge(true, this.options, gridAxisOptions); if (this.horiz) { /* _________________________ Make this: ___|_____|_____|_____|__| ^ ^ _________________________ Into this: |_____|_____|_____|_____| ^ ^ */ options.minPadding = pick(userOptions.minPadding, 0); options.maxPadding = pick(userOptions.maxPadding, 0); } // If borderWidth is set, then use its value for tick and // line width. if (isNumber(options.grid.borderWidth)) { options.tickWidth = options.lineWidth = gridOptions.borderWidth; } } } /** * @private */ function onAfterSetOptions2(e) { const axis = this; const userOptions = e.userOptions; const gridOptions = userOptions && userOptions.grid || {}; const columns = gridOptions.columns; // Add column options to the parent axis. Children has their column options // set on init in onGridAxisAfterInit. if (gridOptions.enabled && columns) { merge(true, axis.options, columns[0]); } } /** * Handle columns and setScale. * @private */ function onAfterSetScale() { const axis = this; (axis.grid.columns || []).forEach((column) => column.setScale()); } /** * Draw vertical axis ticks extra long to create cell floors and roofs. * Overrides the tickLength for vertical axes. * @private */ function onAfterTickSize(e) { const { horiz, maxLabelDimensions, options: { grid: gridOptions = {} } } = this; if (gridOptions.enabled && maxLabelDimensions) { const labelPadding = this.options.labels.distance * 2; const distance = horiz ? (gridOptions.cellHeight || labelPadding + maxLabelDimensions.height) : labelPadding + maxLabelDimensions.width; if (isArray(e.tickSize)) { e.tickSize[0] = distance; } else { e.tickSize = [distance, 0]; } } } /** * @private */ function onChartAfterSetChartSize() { this.axes.forEach((axis) => { (axis.grid && axis.grid.columns || []).forEach((column) => { column.setAxisSize(); column.setAxisTranslation(); }); }); } /** * @private */ function onDestroy(e) { const { grid } = this; (grid.columns || []).forEach((column) => column.destroy(e.keepEvents)); grid.columns = void 0; } /** * Wraps axis init to draw cell walls on vertical axes. * @private */ function onInit(e) { const axis = this; const userOptions = e.userOptions || {}; const gridOptions = userOptions.grid || {}; if (gridOptions.enabled && defined(gridOptions.borderColor)) { userOptions.tickColor = userOptions.lineColor = (gridOptions.borderColor); } if (!axis.grid) { axis.grid = new GridAxisAdditions(axis); } axis.hiddenLabels = []; axis.hiddenMarks = []; } /** * Center tick labels in cells. * @private */ function onTickAfterGetLabelPosition(e) { const tick = this, label = tick.label, axis = tick.axis, reversed = axis.reversed, chart = axis.chart, options = axis.options, gridOptions = options.grid || {}, labelOpts = axis.options.labels, align = labelOpts.align, // `verticalAlign` is currently not supported for axis.labels. verticalAlign = 'middle', // LabelOpts.verticalAlign, side = GridAxisSide[axis.side], tickmarkOffset = e.tickmarkOffset, tickPositions = axis.tickPositions, tickPos = tick.pos - tickmarkOffset, nextTickPos = (isNumber(tickPositions[e.index + 1]) ? tickPositions[e.index + 1] - tickmarkOffset : (axis.max || 0) + tickmarkOffset), tickSize = axis.tickSize('tick'), tickWidth = tickSize ? tickSize[0] : 0, crispCorr = tickSize ? tickSize[1] / 2 : 0; // Only center tick labels in grid axes if (gridOptions.enabled === true) { let bottom, top, left, right; // Calculate top and bottom positions of the cell. if (side === 'top') { bottom = axis.top + axis.offset; top = bottom - tickWidth; } else if (side === 'bottom') { top = chart.chartHeight - axis.bottom + axis.offset; bottom = top + tickWidth; } else { bottom = axis.top + axis.len - (axis.translate(reversed ? nextTickPos : tickPos) || 0); top = axis.top + axis.len - (axis.translate(reversed ? tickPos : nextTickPos) || 0); } // Calculate left and right positions of the cell. if (side === 'right') { left = chart.chartWidth - axis.right + axis.offset; right = left + tickWidth; } else if (side === 'left') { right = axis.left + axis.offset; left = right - tickWidth; } else { left = Math.round(axis.left + (axis.translate(reversed ? nextTickPos : tickPos) || 0)) - crispCorr; right = Math.min(// #15742 Math.round(axis.left + (axis.translate(reversed ? tickPos : nextTickPos) || 0)) - crispCorr, axis.left + axis.len); } tick.slotWidth = right - left; // Calculate the positioning of the label based on // alignment. e.pos.x = (align === 'left' ? left : align === 'right' ? right : left + ((right - left) / 2) // Default to center ); e.pos.y = (verticalAlign === 'top' ? top : verticalAlign === 'bottom' ? bottom : top + ((bottom - top) / 2) // Default to middle ); if (label) { const lblMetrics = chart.renderer.fontMetrics(label), labelHeight = label.getBBox().height; // Adjustment to y position to align the label correctly. // Would be better to have a setter or similar for this. if (!labelOpts.useHTML) { const lines = Math.round(labelHeight / lblMetrics.h); e.pos.y += ( // Center the label // TODO: why does this actually center the label? ((lblMetrics.b - (lblMetrics.h - lblMetrics.f)) / 2) + // Adjust for height of additional lines. -(((lines - 1) * lblMetrics.h) / 2)); } else { e.pos.y += ( // Readjust yCorr in htmlUpdateTransform lblMetrics.b + // Adjust for height of html label -(labelHeight / 2)); } } e.pos.x += (axis.horiz && labelOpts.x) || 0; } } /** * @private */ function onTickLabelFormat(ctx) { const { axis, value } = ctx; if (axis.options.grid && axis.options.grid.enabled) { const tickPos = axis.tickPositions; const series = (axis.linkedParent || axis).series[0]; const isFirst = value === tickPos[0]; const isLast = value === tickPos[tickPos.length - 1]; const point = series && find(series.options.data, function (p) { return p[axis.isXAxis ? 'x' : 'y'] === value; }); let pointCopy; if (point && series.is('gantt')) { // For the Gantt set point aliases to the pointCopy // to do not change the original point pointCopy = merge(point); H.seriesTypes.gantt.prototype.pointClass .setGanttPointAliases(pointCopy); } // Make additional properties available for the // formatter ctx.isFirst = isFirst; ctx.isLast = isLast; ctx.point = pointCopy; } } /** * Makes tick labels which are usually ignored in a linked axis * displayed if they are within range of linkedParent.min. * ``` * _____________________________ * | | | | | * Make this: | | 2 | 3 | 4 | * |___|_______|_______|_______| * ^ * _____________________________ * | | | | | * Into this: | 1 | 2 | 3 | 4 | * |___|_______|_______|_______| * ^ * ``` * @private * @todo Does this function do what the drawing says? Seems to affect * ticks and not the labels directly? */ function onTrimTicks() { const axis = this, options = axis.options, gridOptions = options.grid || {}, categoryAxis = axis.categories, tickPositions = axis.tickPositions, firstPos = tickPositions[0], secondPos = tickPositions[1], lastPos = tickPositions[tickPositions.length - 1], beforeLastPos = tickPositions[tickPositions.length - 2], linkedMin = axis.linkedParent && axis.linkedParent.min, linkedMax = axis.linkedParent && axis.linkedParent.max, min = linkedMin || axis.min, max = linkedMax || axis.max, tickInterval = axis.tickInterval, startLessThanMin = ( // #19845 isNumber(min) && min >= firstPos + tickInterval && min < secondPos), endMoreThanMin = (isNumber(min) && firstPos < min && firstPos + tickInterval > min), startLessThanMax = (isNumber(max) && lastPos > max && lastPos - tickInterval < max), endMoreThanMax = (isNumber(max) && max <= lastPos - tickInterval && max > beforeLastPos); if (gridOptions.enabled === true && !categoryAxis && (axis.isXAxis || axis.isLinked)) { if ((endMoreThanMin || startLessThanMin) && !options.startOnTick) { tickPositions[0] = min; } if ((startLessThanMax || endMoreThanMax) && !options.endOnTick) { tickPositions[tickPositions.length - 1] = max; } } } /** * Avoid altering tickInterval when reserving space. * @private */ function wrapUnsquish(proceed) { const axis = this; const { options: { grid: gridOptions = {} } } = axis; if (gridOptions.enabled === true && axis.categories) { return axis.tickInterval; } return proceed.apply(axis, argsToArray(arguments)); } /* * * * Class * * */ /** * Additions for grid axes. * @private * @class */ class GridAxisAdditions { /* * * * Constructors * * */ constructor(axis) { this.axis = axis; } /* * * * Functions * * */ /** * Checks if an axis is the outer axis in its dimension. Since * axes are placed outwards in order, the axis with the highest * index is the outermost axis. * * Example: If there are multiple x-axes at the top of the chart, * this function returns true if the axis supplied is the last * of the x-axes. * * @private * * @return {boolean} * True if the axis is the outermost axis in its dimension; false if * not. */ isOuterAxis() { const axis = this.axis; const chart = axis.chart; const columnIndex = axis.grid.columnIndex; const columns = (axis.linkedParent?.grid.columns || axis.grid.columns || []); const parentAxis = columnIndex ? axis.linkedParent : axis; let thisIndex = -1, lastIndex = 0; // On the left side, when we have columns (not only multiple axes), the // main axis is to the left if (axis.side === 3 && !chart.inverted && columns.length) { return !axis.linkedParent; } (chart[axis.coll] || []).forEach((otherAxis, index) => { if (otherAxis.side === axis.side && !otherAxis.options.isInternal) { lastIndex = index; if (otherAxis === parentAxis) { // Get the index of the axis in question thisIndex = index; } } }); return (lastIndex === thisIndex && (isNumber(columnIndex) ? columns.length === columnIndex : true)); } /** * Add extra border based on the provided path. * @private * @param {SVGPath} path * The path of the border. * @return {Highcharts.SVGElement} * Border */ renderBorder(path) { const axis = this.axis, renderer = axis.chart.renderer, options = axis.options, extraBorderLine = renderer.path(path) .addClass('highcharts-axis-line') .add(axis.axisGroup); if (!renderer.styledMode) { extraBorderLine.attr({ stroke: options.lineColor, 'stroke-width': options.lineWidth, zIndex: 7 }); } return extraBorderLine; } } /* * * * Registry * * */ // First letter of the day of the week, e.g. 'M' for 'Monday'. dateFormats.E = function (timestamp) { return this.dateFormat('%a', timestamp, true).charAt(0); }; // Adds week date format dateFormats.W = function (timestamp) { const time = this, d = new this.Date(timestamp), unitsToOmit = ['Hours', 'Milliseconds', 'Minutes', 'Seconds']; unitsToOmit.forEach(function (format) { time.set(format, d, 0); }); const firstDay = (this.get('Day', d) + 6) % 7; const thursday = new this.Date(d.valueOf()); this.set('Date', thursday, this.get('Date', d) - firstDay + 3); const firstThursday = new this.Date(this.get('FullYear', thursday), 0, 1); if (this.get('Day', firstThursday) !== 4) { this.set('Month', d, 0); this.set('Date', d, 1 + (11 - this.get('Day', firstThursday)) % 7); } return (1 + Math.floor((thursday.valueOf() - firstThursday.valueOf()) / 604800000)).toString(); }; /* * * * Default Export * * */ const GridAxis = { compose }; /* * * * API Options * * */ /** * @productdesc {gantt} * For grid axes (like in Gantt charts), * it is possible to declare as a list to provide different * formats depending on available space. * * Defaults to: * ```js * { * hour: { list: ['%H:%M', '%H'] }, * day: { list: ['%A, %e. %B', '%a, %e. %b', '%E'] }, * week: { list: ['Week %W', 'W%W'] }, * month: { list: ['%B', '%b', '%o'] } * } * ``` * * @sample {gantt} gantt/grid-axis/date-time-label-formats * Gantt chart with custom axis date format. * * @apioption xAxis.dateTimeLabelFormats */ /** * Set grid options for the axis labels. Requires Highcharts Gantt. * * @since 6.2.0 * @product gantt * @apioption xAxis.grid */ /** * Enable grid on the axis labels. Defaults to true for Gantt charts. * * @type {boolean} * @default true * @since 6.2.0 * @product gantt * @apioption xAxis.grid.enabled */ /** * Set specific options for each column (or row for horizontal axes) in the * grid. Each extra column/row is its own axis, and the axis options can be set * here. * * @sample gantt/demo/left-axis-table * Left axis as a table * @sample gantt/demo/treegrid-columns * Collapsible tree grid with columns * * @type {Array} * @apioption xAxis.grid.columns */ /** * Set border color for the label grid lines. * * @type {Highcharts.ColorString} * @default #e6e6e6 * @apioption xAxis.grid.borderColor */ /** * Set border width of the label grid lines. * * @type {number} * @default 1 * @apioption xAxis.grid.borderWidth */ /** * Set cell height for grid axis labels. By default this is calculated from font * size. This option only applies to horizontal axes. For vertical axes, check * the [#yAxis.staticScale](yAxis.staticScale) option. * * @sample gantt/grid-axis/cellheight * Gant chart with custom cell height * @type {number} * @apioption xAxis.grid.cellHeight */ ''; // Keeps doclets above in JS file return GridAxis; }); _registerModule(_modules, 'Gantt/Tree.js', [_modules['Core/Utilities.js']], function (U) { /* * * * (c) 2016-2024 Highsoft AS * * Authors: Jon Arild Nygard * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ /* * * * Imports * * */ const { extend, isNumber, pick } = U; /* * * * Functions * * */ /** * Creates an object map from parent id to children's index. * * @private * @function Highcharts.Tree#getListOfParents * * @param {Array<*>} data * List of points set in options. `Array.parent` is parent id of point. * * @return {Highcharts.Dictionary>} * Map from parent id to children index in data */ function getListOfParents(data) { const root = '', ids = [], listOfParents = data.reduce((prev, curr) => { const { parent = '', id } = curr; if (typeof prev[parent] === 'undefined') { prev[parent] = []; } prev[parent].push(curr); if (id) { ids.push(id); } return prev; }, {}); Object.keys(listOfParents).forEach((node) => { if ((node !== root) && (ids.indexOf(node) === -1)) { const adoptedByRoot = listOfParents[node].map(function (orphan) { const { ...parentExcluded } = orphan; // #15196 return parentExcluded; }); listOfParents[root].push(...adoptedByRoot); delete listOfParents[node]; } }); return listOfParents; } /** @private */ function getNode(id, parent, level, data, mapOfIdToChildren, options) { const after = options && options.after, before = options && options.before, node = { data, depth: level - 1, id, level, parent: (parent || '') }; let descendants = 0, height = 0, start, end; // Allow custom logic before the children has been created. if (typeof before === 'function') { before(node, options); } // Call getNode recursively on the children. Calculate the height of the // node, and the number of descendants. const children = ((mapOfIdToChildren[id] || [])).map((child) => { const node = getNode(child.id, id, (level + 1), child, mapOfIdToChildren, options), childStart = child.start || NaN, childEnd = (child.milestone === true ? childStart : child.end || NaN); // Start should be the lowest child.start. start = ((!isNumber(start) || childStart < start) ? childStart : start); // End should be the largest child.end. // If child is milestone, then use start as end. end = ((!isNumber(end) || childEnd > end) ? childEnd : end); descendants = descendants + 1 + node.descendants; height = Math.max(node.height + 1, height); return node; }); // Calculate start and end for point if it is not already explicitly set. if (data) { data.start = pick(data.start, start); data.end = pick(data.end, end); } extend(node, { children: children, descendants: descendants, height: height }); // Allow custom logic after the children has been created. if (typeof after === 'function') { after(node, options); } return node; } /** @private */ function getTree(data, options) { return getNode('', null, 1, null, getListOfParents(data), options); } /* * * * Default Export * * */ const Tree = { getNode, getTree }; return Tree; }); _registerModule(_modules, 'Core/Axis/TreeGrid/TreeGridTick.js', [_modules['Core/Utilities.js']], function (U) { /* * * * (c) 2016 Highsoft AS * Authors: Jon Arild Nygard * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { addEvent, removeEvent, isObject, isNumber, pick, wrap } = U; /* * * * Functions * * */ /** * @private */ function onTickInit() { const tick = this; if (!tick.treeGrid) { tick.treeGrid = new TreeGridTickAdditions(tick); } } /** * @private */ function onTickHover(label) { label.addClass('highcharts-treegrid-node-active'); if (!label.renderer.styledMode) { label.css({ textDecoration: 'underline' }); } } /** * @private */ function onTickHoverExit(label, options) { const css = isObject(options.style) ? options.style : {}; label.removeClass('highcharts-treegrid-node-active'); if (!label.renderer.styledMode) { label.css({ textDecoration: (css.textDecoration || 'none') }); } } /** * @private */ function renderLabelIcon(tick, params) { const treeGrid = tick.treeGrid, isNew = !treeGrid.labelIcon, renderer = params.renderer, labelBox = params.xy, options = params.options, width = options.width || 0, height = options.height || 0, padding = options.padding ?? tick.axis.linkedParent ? 0 : 5, iconCenter = { x: labelBox.x - (width / 2) - padding, y: labelBox.y - (height / 2) }, rotation = params.collapsed ? 90 : 180, shouldRender = params.show && isNumber(iconCenter.y); let icon = treeGrid.labelIcon; if (!icon) { treeGrid.labelIcon = icon = renderer .path(renderer.symbols[options.type](options.x || 0, options.y || 0, width, height)) .addClass('highcharts-label-icon') .add(params.group); } // Set the new position, and show or hide icon[shouldRender ? 'show' : 'hide'](); // #14904, #1338 // Presentational attributes if (!renderer.styledMode) { icon .attr({ cursor: 'pointer', 'fill': pick(params.color, "#666666" /* Palette.neutralColor60 */), 'stroke-width': 1, stroke: options.lineColor, strokeWidth: options.lineWidth || 0 }); } // Update the icon positions icon[isNew ? 'attr' : 'animate']({ translateX: iconCenter.x, translateY: iconCenter.y, rotation: rotation }); } /** * @private */ function wrapGetLabelPosition(proceed, x, y, label, horiz, labelOptions, tickmarkOffset, index, step) { const tick = this, lbOptions = pick(tick.options && tick.options.labels, labelOptions), pos = tick.pos, axis = tick.axis, options = axis.options, isTreeGrid = options.type === 'treegrid', result = proceed.apply(tick, [x, y, label, horiz, lbOptions, tickmarkOffset, index, step]); let mapOfPosToGridNode, node, level; if (isTreeGrid) { const { width = 0, padding = axis.linkedParent ? 0 : 5 } = (lbOptions && isObject(lbOptions.symbol, true) ? lbOptions.symbol : {}), indentation = (lbOptions && isNumber(lbOptions.indentation) ? lbOptions.indentation : 0); mapOfPosToGridNode = axis.treeGrid.mapOfPosToGridNode; node = mapOfPosToGridNode && mapOfPosToGridNode[pos]; level = (node && node.depth) || 1; result.x += ( // Add space for symbols (width + (padding * 2)) + // Apply indentation ((level - 1) * indentation)); } return result; } /** * @private */ function wrapRenderLabel(proceed) { const tick = this, { pos, axis, label, treeGrid: tickGrid, options: tickOptions } = tick, icon = tickGrid?.labelIcon, labelElement = label?.element, { treeGrid: axisGrid, options: axisOptions, chart, tickPositions } = axis, mapOfPosToGridNode = axisGrid.mapOfPosToGridNode, labelOptions = pick(tickOptions?.labels, axisOptions?.labels), symbolOptions = (labelOptions && isObject(labelOptions.symbol, true) ? labelOptions.symbol : {}), node = mapOfPosToGridNode && mapOfPosToGridNode[pos], { descendants, depth } = node || {}, hasDescendants = node && descendants && descendants > 0, level = depth, isTreeGridElement = (axisOptions.type === 'treegrid') && labelElement, shouldRender = tickPositions.indexOf(pos) > -1, prefixClassName = 'highcharts-treegrid-node-', prefixLevelClass = prefixClassName + 'level-', styledMode = chart.styledMode; let collapsed, addClassName, removeClassName; if (isTreeGridElement && node) { // Add class name for hierarchical styling. label .removeClass(new RegExp(prefixLevelClass + '.*')) .addClass(prefixLevelClass + level); } proceed.apply(tick, Array.prototype.slice.call(arguments, 1)); if (isTreeGridElement && hasDescendants) { collapsed = axisGrid.isCollapsed(node); renderLabelIcon(tick, { color: (!styledMode && label.styles.color || ''), collapsed: collapsed, group: label.parentGroup, options: symbolOptions, renderer: label.renderer, show: shouldRender, xy: label.xy }); // Add class name for the node. addClassName = prefixClassName + (collapsed ? 'collapsed' : 'expanded'); removeClassName = prefixClassName + (collapsed ? 'expanded' : 'collapsed'); label .addClass(addClassName) .removeClass(removeClassName); if (!styledMode) { label.css({ cursor: 'pointer' }); } // Add events to both label text and icon [label, icon].forEach((object) => { if (object && !object.attachedTreeGridEvents) { // On hover addEvent(object.element, 'mouseover', function () { onTickHover(label); }); // On hover out addEvent(object.element, 'mouseout', function () { onTickHoverExit(label, labelOptions); }); addEvent(object.element, 'click', function () { tickGrid.toggleCollapse(); }); object.attachedTreeGridEvents = true; } }); } else if (icon) { removeEvent(labelElement); label?.css({ cursor: 'default' }); icon.destroy(); } } /* * * * Classes * * */ /** * @private * @class */ class TreeGridTickAdditions { /* * * * Static Functions * * */ /** * @private */ static compose(TickClass) { const tickProto = TickClass.prototype; if (!tickProto.toggleCollapse) { addEvent(TickClass, 'init', onTickInit); wrap(tickProto, 'getLabelPosition', wrapGetLabelPosition); wrap(tickProto, 'renderLabel', wrapRenderLabel); // Backwards compatibility tickProto.collapse = function (redraw) { this.treeGrid.collapse(redraw); }; tickProto.expand = function (redraw) { this.treeGrid.expand(redraw); }; tickProto.toggleCollapse = function (redraw) { this.treeGrid.toggleCollapse(redraw); }; } } /* * * * Constructors * * */ /** * @private */ constructor(tick) { this.tick = tick; } /* * * * Functions * * */ /** * Collapse the grid cell. Used when axis is of type treegrid. * * @see gantt/treegrid-axis/collapsed-dynamically/demo.js * * @private * @function Highcharts.Tick#collapse * * @param {boolean} [redraw=true] * Whether to redraw the chart or wait for an explicit call to * {@link Highcharts.Chart#redraw} */ collapse(redraw) { const tick = this.tick, axis = tick.axis, brokenAxis = axis.brokenAxis; if (brokenAxis && axis.treeGrid.mapOfPosToGridNode) { const pos = tick.pos, node = axis.treeGrid.mapOfPosToGridNode[pos], breaks = axis.treeGrid.collapse(node); brokenAxis.setBreaks(breaks, pick(redraw, true)); } } /** * Destroy remaining labelIcon if exist. * * @private * @function Highcharts.Tick#destroy */ destroy() { if (this.labelIcon) { this.labelIcon.destroy(); } } /** * Expand the grid cell. Used when axis is of type treegrid. * * @see gantt/treegrid-axis/collapsed-dynamically/demo.js * * @private * @function Highcharts.Tick#expand * * @param {boolean} [redraw=true] * Whether to redraw the chart or wait for an explicit call to * {@link Highcharts.Chart#redraw} */ expand(redraw) { const { pos, axis } = this.tick, { treeGrid, brokenAxis } = axis, posMappedNodes = treeGrid.mapOfPosToGridNode; if (brokenAxis && posMappedNodes) { const node = posMappedNodes[pos], breaks = treeGrid.expand(node); brokenAxis.setBreaks(breaks, pick(redraw, true)); } } /** * Toggle the collapse/expand state of the grid cell. Used when axis is * of type treegrid. * * @see gantt/treegrid-axis/collapsed-dynamically/demo.js * * @private * @function Highcharts.Tick#toggleCollapse * * @param {boolean} [redraw=true] * Whether to redraw the chart or wait for an explicit call to * {@link Highcharts.Chart#redraw} */ toggleCollapse(redraw) { const tick = this.tick, axis = tick.axis, brokenAxis = axis.brokenAxis; if (brokenAxis && axis.treeGrid.mapOfPosToGridNode) { const pos = tick.pos, node = axis.treeGrid.mapOfPosToGridNode[pos], breaks = axis.treeGrid.toggleCollapse(node); brokenAxis.setBreaks(breaks, pick(redraw, true)); } } } /* * * * Default Export * * */ return TreeGridTickAdditions; }); _registerModule(_modules, 'Series/TreeUtilities.js', [_modules['Core/Color/Color.js'], _modules['Core/Utilities.js']], function (Color, U) { /* * * * (c) 2014-2024 Highsoft AS * * Authors: Jon Arild Nygard / Oystein Moseng * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { extend, isArray, isNumber, isObject, merge, pick, relativeLength } = U; /* * * * Functions * * */ /* eslint-disable valid-jsdoc */ /** * @private */ function getColor(node, options) { const index = options.index, mapOptionsToLevel = options.mapOptionsToLevel, parentColor = options.parentColor, parentColorIndex = options.parentColorIndex, series = options.series, colors = options.colors, siblings = options.siblings, points = series.points, chartOptionsChart = series.chart.options.chart; let getColorByPoint, point, level, colorByPoint, colorIndexByPoint, color, colorIndex; /** * @private */ const variateColor = (color) => { const colorVariation = level && level.colorVariation; if (colorVariation && colorVariation.key === 'brightness' && index && siblings) { return Color.parse(color).brighten(colorVariation.to * (index / siblings)).get(); } return color; }; if (node) { point = points[node.i]; level = mapOptionsToLevel[node.level] || {}; getColorByPoint = point && level.colorByPoint; if (getColorByPoint) { colorIndexByPoint = point.index % (colors ? colors.length : chartOptionsChart.colorCount); colorByPoint = colors && colors[colorIndexByPoint]; } // Select either point color, level color or inherited color. if (!series.chart.styledMode) { color = pick(point && point.options.color, level && level.color, colorByPoint, parentColor && variateColor(parentColor), series.color); } colorIndex = pick(point && point.options.colorIndex, level && level.colorIndex, colorIndexByPoint, parentColorIndex, options.colorIndex); } return { color: color, colorIndex: colorIndex }; } /** * Creates a map from level number to its given options. * * @private * * @param {Object} params * Object containing parameters. * - `defaults` Object containing default options. The default options are * merged with the userOptions to get the final options for a specific * level. * - `from` The lowest level number. * - `levels` User options from series.levels. * - `to` The highest level number. * * @return {Highcharts.Dictionary|null} * Returns a map from level number to its given options. */ function getLevelOptions(params) { const result = {}; let defaults, converted, i, from, to, levels; if (isObject(params)) { from = isNumber(params.from) ? params.from : 1; levels = params.levels; converted = {}; defaults = isObject(params.defaults) ? params.defaults : {}; if (isArray(levels)) { converted = levels.reduce((obj, item) => { let level, levelIsConstant, options; if (isObject(item) && isNumber(item.level)) { options = merge({}, item); levelIsConstant = pick(options.levelIsConstant, defaults.levelIsConstant); // Delete redundant properties. delete options.levelIsConstant; delete options.level; // Calculate which level these options apply to. level = item.level + (levelIsConstant ? 0 : from - 1); if (isObject(obj[level])) { merge(true, obj[level], options); // #16329 } else { obj[level] = options; } } return obj; }, {}); } to = isNumber(params.to) ? params.to : 1; for (i = 0; i <= to; i++) { result[i] = merge({}, defaults, isObject(converted[i]) ? converted[i] : {}); } } return result; } /** * @private * @todo Combine buildTree and buildNode with setTreeValues * @todo Remove logic from Treemap and make it utilize this mixin. */ function setTreeValues(tree, options) { const before = options.before, idRoot = options.idRoot, mapIdToNode = options.mapIdToNode, nodeRoot = mapIdToNode[idRoot], levelIsConstant = (options.levelIsConstant !== false), points = options.points, point = points[tree.i], optionsPoint = point && point.options || {}, children = []; let childrenTotal = 0; tree.levelDynamic = tree.level - (levelIsConstant ? 0 : nodeRoot.level); tree.name = pick(point && point.name, ''); tree.visible = (idRoot === tree.id || options.visible === true); if (typeof before === 'function') { tree = before(tree, options); } // First give the children some values tree.children.forEach((child, i) => { const newOptions = extend({}, options); extend(newOptions, { index: i, siblings: tree.children.length, visible: tree.visible }); child = setTreeValues(child, newOptions); children.push(child); if (child.visible) { childrenTotal += child.val; } }); // Set the values const value = pick(optionsPoint.value, childrenTotal); tree.visible = value >= 0 && (childrenTotal > 0 || tree.visible); tree.children = children; tree.childrenTotal = childrenTotal; tree.isLeaf = tree.visible && !childrenTotal; tree.val = value; return tree; } /** * Update the rootId property on the series. Also makes sure that it is * accessible to exporting. * * @private * * @param {Object} series * The series to operate on. * * @return {string} * Returns the resulting rootId after update. */ function updateRootId(series) { let rootId, options; if (isObject(series)) { // Get the series options. options = isObject(series.options) ? series.options : {}; // Calculate the rootId. rootId = pick(series.rootNode, options.rootId, ''); // Set rootId on series.userOptions to pick it up in exporting. if (isObject(series.userOptions)) { series.userOptions.rootId = rootId; } // Set rootId on series to pick it up on next update. series.rootNode = rootId; } return rootId; } /** * Get the node width, which relies on the plot width and the nodeDistance * option. * * @private */ function getNodeWidth(series, columnCount) { const { chart, options } = series, { nodeDistance = 0, nodeWidth = 0 } = options, { plotSizeX = 1 } = chart; // Node width auto means they are evenly distributed along the width of // the plot area if (nodeWidth === 'auto') { if (typeof nodeDistance === 'string' && /%$/.test(nodeDistance)) { const fraction = parseFloat(nodeDistance) / 100, total = columnCount + fraction * (columnCount - 1); return plotSizeX / total; } const nDistance = Number(nodeDistance); return ((plotSizeX + nDistance) / (columnCount || 1)) - nDistance; } return relativeLength(nodeWidth, plotSizeX); } /* * * * Default Export * * */ const TreeUtilities = { getColor, getLevelOptions, getNodeWidth, setTreeValues, updateRootId }; return TreeUtilities; }); _registerModule(_modules, 'Core/Axis/TreeGrid/TreeGridAxis.js', [_modules['Core/Axis/BrokenAxis.js'], _modules['Core/Axis/GridAxis.js'], _modules['Gantt/Tree.js'], _modules['Core/Axis/TreeGrid/TreeGridTick.js'], _modules['Series/TreeUtilities.js'], _modules['Core/Utilities.js']], function (BrokenAxis, GridAxis, Tree, TreeGridTick, TU, U) { /* * * * (c) 2016 Highsoft AS * Authors: Jon Arild Nygard * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { getLevelOptions } = TU; const { addEvent, find, fireEvent, isArray, isObject, isString, merge, pick, removeEvent, wrap } = U; /* * * * Variables * * */ let TickConstructor; /* * * * Functions * * */ /** * @private */ function getBreakFromNode(node, max) { const to = node.collapseEnd || 0; let from = node.collapseStart || 0; // In broken-axis, the axis.max is minimized until it is not within a // break. Therefore, if break.to is larger than axis.max, the axis.to // should not add the 0.5 axis.tickMarkOffset, to avoid adding a break // larger than axis.max. // TODO consider simplifying broken-axis and this might solve itself if (to >= max) { from -= 0.5; } return { from: from, to: to, showPoints: false }; } /** * Creates a tree structure of the data, and the treegrid. Calculates * categories, and y-values of points based on the tree. * * @private * @function getTreeGridFromData * * @param {Array} data * All the data points to display in the axis. * * @param {boolean} uniqueNames * Whether or not the data node with the same name should share grid cell. If * true they do share cell. False by default. * * @param {number} numberOfSeries * * @return {Object} * Returns an object containing categories, mapOfIdToNode, * mapOfPosToGridNode, and tree. * * @todo There should be only one point per line. * @todo It should be optional to have one category per point, or merge * cells * @todo Add unit-tests. */ function getTreeGridFromData(data, uniqueNames, numberOfSeries) { const categories = [], collapsedNodes = [], mapOfIdToNode = {}, uniqueNamesEnabled = typeof uniqueNames === 'boolean' ? uniqueNames : false; let mapOfPosToGridNode = {}, posIterator = -1; // Build the tree from the series data. const treeParams = { // After the children has been created. after: function (node) { const gridNode = mapOfPosToGridNode[node.pos]; let height = 0, descendants = 0; gridNode.children.forEach(function (child) { descendants += (child.descendants || 0) + 1; height = Math.max((child.height || 0) + 1, height); }); gridNode.descendants = descendants; gridNode.height = height; if (gridNode.collapsed) { collapsedNodes.push(gridNode); } }, // Before the children has been created. before: function (node) { const data = isObject(node.data, true) ? node.data : {}, name = isString(data.name) ? data.name : '', parentNode = mapOfIdToNode[node.parent], parentGridNode = (isObject(parentNode, true) ? mapOfPosToGridNode[parentNode.pos] : null), hasSameName = function (x) { return x.name === name; }; let gridNode, pos; // If not unique names, look for sibling node with the same name if (uniqueNamesEnabled && isObject(parentGridNode, true) && !!(gridNode = find(parentGridNode.children, hasSameName))) { // If there is a gridNode with the same name, reuse position pos = gridNode.pos; // Add data node to list of nodes in the grid node. gridNode.nodes.push(node); } else { // If it is a new grid node, increment position. pos = posIterator++; } // Add new grid node to map. if (!mapOfPosToGridNode[pos]) { mapOfPosToGridNode[pos] = gridNode = { depth: parentGridNode ? parentGridNode.depth + 1 : 0, name: name, id: data.id, nodes: [node], children: [], pos: pos }; // If not root, then add name to categories. if (pos !== -1) { categories.push(name); } // Add name to list of children. if (isObject(parentGridNode, true)) { parentGridNode.children.push(gridNode); } } // Add data node to map if (isString(node.id)) { mapOfIdToNode[node.id] = node; } // If one of the points are collapsed, then start the grid node // in collapsed state. if (gridNode && data.collapsed === true) { gridNode.collapsed = true; } // Assign pos to data node node.pos = pos; } }; const updateYValuesAndTickPos = function (map, numberOfSeries) { const setValues = function (gridNode, start, result) { const nodes = gridNode.nodes, padding = 0.5; let end = start + (start === -1 ? 0 : numberOfSeries - 1); const diff = (end - start) / 2, pos = start + diff; nodes.forEach(function (node) { const data = node.data; if (isObject(data, true)) { // Update point data.y = start + (data.seriesIndex || 0); // Remove the property once used delete data.seriesIndex; } node.pos = pos; }); result[pos] = gridNode; gridNode.pos = pos; gridNode.tickmarkOffset = diff + padding; gridNode.collapseStart = end + padding; gridNode.children.forEach(function (child) { setValues(child, end + 1, result); end = (child.collapseEnd || 0) - padding; }); // Set collapseEnd to the end of the last child node. gridNode.collapseEnd = end + padding; return result; }; return setValues(map['-1'], -1, {}); }; // Create tree from data const tree = Tree.getTree(data, treeParams); // Update y values of data, and set calculate tick positions. mapOfPosToGridNode = updateYValuesAndTickPos(mapOfPosToGridNode, numberOfSeries); // Return the resulting data. return { categories: categories, mapOfIdToNode: mapOfIdToNode, mapOfPosToGridNode: mapOfPosToGridNode, collapsedNodes: collapsedNodes, tree: tree }; } /** * Builds the tree of categories and calculates its positions. * @private * @param {Object} e Event object * @param {Object} e.target The chart instance which the event was fired on. * @param {object[]} e.target.axes The axes of the chart. */ function onBeforeRender(e) { const chart = e.target, axes = chart.axes; axes.filter(function (axis) { return axis.options.type === 'treegrid'; }).forEach(function (axis) { const options = axis.options || {}, labelOptions = options.labels, uniqueNames = options.uniqueNames, max = options.max, // Check whether any of series is rendering for the first // time, visibility has changed, or its data is dirty, and // only then update. #10570, #10580. Also check if // mapOfPosToGridNode exists. #10887 isDirty = (!axis.treeGrid.mapOfPosToGridNode || axis.series.some(function (series) { return !series.hasRendered || series.isDirtyData || series.isDirty; })); let numberOfSeries = 0, data, treeGrid; if (isDirty) { // Concatenate data from all series assigned to this axis. data = axis.series.reduce(function (arr, s) { if (s.visible) { // Push all data to array (s.options.data || []).forEach(function (data) { // For using keys - rebuild the data structure if (s.options.keys && s.options.keys.length) { data = s.pointClass.prototype .optionsToObject .call({ series: s }, data); s.pointClass.setGanttPointAliases(data); } if (isObject(data, true)) { // Set series index on data. Removed again // after use. data.seriesIndex = (numberOfSeries); arr.push(data); } }); // Increment series index if (uniqueNames === true) { numberOfSeries++; } } return arr; }, []); // If max is higher than set data - add a // dummy data to render categories #10779 if (max && data.length < max) { for (let i = data.length; i <= max; i++) { data.push({ // Use the zero-width character // to avoid conflict with uniqueNames name: i + '\u200B' }); } } // `setScale` is fired after all the series is initialized, // which is an ideal time to update the axis.categories. treeGrid = getTreeGridFromData(data, uniqueNames || false, (uniqueNames === true) ? numberOfSeries : 1); // Assign values to the axis. axis.categories = treeGrid.categories; axis.treeGrid.mapOfPosToGridNode = (treeGrid.mapOfPosToGridNode); axis.hasNames = true; axis.treeGrid.tree = treeGrid.tree; // Update yData now that we have calculated the y values axis.series.forEach(function (series) { const axisData = (series.options.data || []).map(function (d) { if (isArray(d) && series.options.keys && series.options.keys.length) { // Get the axisData from the data array used to // build the treeGrid where has been modified data.forEach(function (point) { if (d.indexOf(point.x) >= 0 && d.indexOf(point.x2) >= 0) { d = point; } }); } return isObject(d, true) ? merge(d) : d; }); // Avoid destroying points when series is not visible if (series.visible) { series.setData(axisData, false); } }); // Calculate the label options for each level in the tree. axis.treeGrid.mapOptionsToLevel = getLevelOptions({ defaults: labelOptions, from: 1, levels: labelOptions && labelOptions.levels, to: axis.treeGrid.tree && axis.treeGrid.tree.height }); // Setting initial collapsed nodes if (e.type === 'beforeRender') { axis.treeGrid.collapsedNodes = treeGrid.collapsedNodes; } } }); } /** * Generates a tick for initial positioning. * * @private * @function Highcharts.GridAxis#generateTick * * @param {Function} proceed * The original generateTick function. * * @param {number} pos * The tick position in axis values. */ function wrapGenerateTick(proceed, pos) { const axis = this, mapOptionsToLevel = axis.treeGrid.mapOptionsToLevel || {}, isTreeGrid = axis.options.type === 'treegrid', ticks = axis.ticks; let tick = ticks[pos], levelOptions, options, gridNode; if (isTreeGrid && axis.treeGrid.mapOfPosToGridNode) { gridNode = axis.treeGrid.mapOfPosToGridNode[pos]; levelOptions = mapOptionsToLevel[gridNode.depth]; if (levelOptions) { options = { labels: levelOptions }; } if (!tick && TickConstructor) { ticks[pos] = tick = new TickConstructor(axis, pos, void 0, void 0, { category: gridNode.name, tickmarkOffset: gridNode.tickmarkOffset, options: options }); } else { // Update labels depending on tick interval tick.parameters.category = gridNode.name; tick.options = options; tick.addLabel(); } } else { proceed.apply(axis, Array.prototype.slice.call(arguments, 1)); } } /** * @private */ function wrapInit(proceed, chart, userOptions, coll) { const axis = this, isTreeGrid = userOptions.type === 'treegrid'; if (!axis.treeGrid) { axis.treeGrid = new TreeGridAxisAdditions(axis); } // Set default and forced options for TreeGrid if (isTreeGrid) { // Add event for updating the categories of a treegrid. // NOTE Preferably these events should be set on the axis. addEvent(chart, 'beforeRender', onBeforeRender); addEvent(chart, 'beforeRedraw', onBeforeRender); // Add new collapsed nodes on addseries addEvent(chart, 'addSeries', function (e) { if (e.options.data) { const treeGrid = getTreeGridFromData(e.options.data, userOptions.uniqueNames || false, 1); axis.treeGrid.collapsedNodes = (axis.treeGrid.collapsedNodes || []).concat(treeGrid.collapsedNodes); } }); // Collapse all nodes in axis.treegrid.collapsednodes // where collapsed equals true. addEvent(axis, 'foundExtremes', function () { if (axis.treeGrid.collapsedNodes) { axis.treeGrid.collapsedNodes.forEach(function (node) { const breaks = axis.treeGrid.collapse(node); if (axis.brokenAxis) { axis.brokenAxis.setBreaks(breaks, false); // Remove the node from the axis collapsedNodes if (axis.treeGrid.collapsedNodes) { axis.treeGrid.collapsedNodes = axis.treeGrid .collapsedNodes .filter((n) => ((node.collapseStart !== n.collapseStart) || node.collapseEnd !== n.collapseEnd)); } } }); } }); // If staticScale is not defined on the yAxis // and chart height is set, set axis.isDirty // to ensure collapsing works (#12012) addEvent(axis, 'afterBreaks', function () { if (axis.coll === 'yAxis' && !axis.staticScale && axis.chart.options.chart.height) { axis.isDirty = true; } }); userOptions = merge({ // Default options grid: { enabled: true }, // TODO: add support for align in treegrid. labels: { align: 'left', /** * Set options on specific levels in a tree grid axis. Takes * precedence over labels options. * * @sample {gantt} gantt/treegrid-axis/labels-levels * Levels on TreeGrid Labels * * @type {Array<*>} * @product gantt * @apioption yAxis.labels.levels * * @private */ levels: [{ /** * Specify the level which the options within this object * applies to. * * @type {number} * @product gantt * @apioption yAxis.labels.levels.level * * @private */ level: void 0 }, { level: 1, /** * @type {Highcharts.CSSObject} * @product gantt * @apioption yAxis.labels.levels.style * * @private */ style: { /** @ignore-option */ fontWeight: 'bold' } }], /** * The symbol for the collapse and expand icon in a * treegrid. * * @product gantt * @optionparent yAxis.labels.symbol * * @private */ symbol: { /** * The symbol type. Points to a definition function in * the `Highcharts.Renderer.symbols` collection. * * @type {Highcharts.SymbolKeyValue} * * @private */ type: 'triangle', x: -5, y: -5, height: 10, width: 10 } }, uniqueNames: false }, userOptions, { // Forced options reversed: true }); } // Now apply the original function with the original arguments, which are // sliced off this function's arguments proceed.apply(axis, [chart, userOptions, coll]); if (isTreeGrid) { axis.hasNames = true; axis.options.showLastLabel = true; } } /** * Set the tick positions, tickInterval, axis min and max. * * @private * @function Highcharts.GridAxis#setTickInterval * * @param {Function} proceed * The original setTickInterval function. */ function wrapSetTickInterval(proceed) { const axis = this, options = axis.options, linkedParent = typeof options.linkedTo === 'number' ? this.chart[axis.coll]?.[options.linkedTo] : void 0, isTreeGrid = options.type === 'treegrid'; if (isTreeGrid) { axis.min = pick(axis.userMin, options.min, axis.dataMin); axis.max = pick(axis.userMax, options.max, axis.dataMax); fireEvent(axis, 'foundExtremes'); // `setAxisTranslation` modifies the min and max according to axis // breaks. axis.setAxisTranslation(); axis.tickInterval = 1; axis.tickmarkOffset = 0.5; axis.tickPositions = axis.treeGrid.mapOfPosToGridNode ? axis.treeGrid.getTickPositions() : []; if (linkedParent) { const linkedParentExtremes = linkedParent.getExtremes(); axis.min = pick(linkedParentExtremes.min, linkedParentExtremes.dataMin); axis.max = pick(linkedParentExtremes.max, linkedParentExtremes.dataMax); axis.tickPositions = linkedParent.tickPositions; } axis.linkedParent = linkedParent; } else { proceed.apply(axis, Array.prototype.slice.call(arguments, 1)); } } /** * Wrap axis redraw to remove TreeGrid events from ticks * * @private * @function Highcharts.GridAxis#redraw * * @param {Function} proceed * The original setTickInterval function. */ function wrapRedraw(proceed) { const axis = this, options = axis.options, isTreeGrid = options.type === 'treegrid'; if (isTreeGrid && axis.visible) { axis.tickPositions.forEach(function (pos) { const tick = axis.ticks[pos]; if (tick.label && tick.label.attachedTreeGridEvents) { removeEvent(tick.label.element); tick.label.attachedTreeGridEvents = false; } }); } proceed.apply(axis, Array.prototype.slice.call(arguments, 1)); } /* * * * Classes * * */ /** * @private * @class */ class TreeGridAxisAdditions { /* * * * Static Functions * * */ /** * @private */ static compose(AxisClass, ChartClass, SeriesClass, TickClass) { if (!AxisClass.keepProps.includes('treeGrid')) { const axisProps = AxisClass.prototype; AxisClass.keepProps.push('treeGrid'); wrap(axisProps, 'generateTick', wrapGenerateTick); wrap(axisProps, 'init', wrapInit); wrap(axisProps, 'setTickInterval', wrapSetTickInterval); wrap(axisProps, 'redraw', wrapRedraw); // Make utility functions available for testing. axisProps.utils = { getNode: Tree.getNode }; if (!TickConstructor) { TickConstructor = TickClass; } } GridAxis.compose(AxisClass, ChartClass, TickClass); BrokenAxis.compose(AxisClass, SeriesClass); TreeGridTick.compose(TickClass); return AxisClass; } /* * * * Constructors * * */ /** * @private */ constructor(axis) { this.axis = axis; } /* * * * Functions * * */ /** * Set the collapse status. * * @private * * @param {Highcharts.Axis} axis * The axis to check against. * * @param {Highcharts.GridNode} node * The node to collapse. */ setCollapsedStatus(node) { const axis = this.axis, chart = axis.chart; axis.series.forEach(function (series) { const data = series.options.data; if (node.id && data) { const point = chart.get(node.id), dataPoint = data[series.data.indexOf(point)]; if (point && dataPoint) { point.collapsed = node.collapsed; dataPoint.collapsed = node.collapsed; } } }); } /** * Calculates the new axis breaks to collapse a node. * * @private * * @param {Highcharts.Axis} axis * The axis to check against. * * @param {Highcharts.GridNode} node * The node to collapse. * * @param {number} pos * The tick position to collapse. * * @return {Array} * Returns an array of the new breaks for the axis. */ collapse(node) { const axis = this.axis, breaks = (axis.options.breaks || []), obj = getBreakFromNode(node, axis.max); breaks.push(obj); // Change the collapsed flag #13838 node.collapsed = true; axis.treeGrid.setCollapsedStatus(node); return breaks; } /** * Calculates the new axis breaks to expand a node. * * @private * * @param {Highcharts.Axis} axis * The axis to check against. * * @param {Highcharts.GridNode} node * The node to expand. * * @param {number} pos * The tick position to expand. * * @return {Array} * Returns an array of the new breaks for the axis. */ expand(node) { const axis = this.axis, breaks = (axis.options.breaks || []), obj = getBreakFromNode(node, axis.max); // Change the collapsed flag #13838 node.collapsed = false; axis.treeGrid.setCollapsedStatus(node); // Remove the break from the axis breaks array. return breaks.reduce(function (arr, b) { if (b.to !== obj.to || b.from !== obj.from) { arr.push(b); } return arr; }, []); } /** * Creates a list of positions for the ticks on the axis. Filters out * positions that are outside min and max, or is inside an axis break. * * @private * * @return {Array} * List of positions. */ getTickPositions() { const axis = this.axis, roundedMin = Math.floor(axis.min / axis.tickInterval) * axis.tickInterval, roundedMax = Math.ceil(axis.max / axis.tickInterval) * axis.tickInterval; return Object.keys(axis.treeGrid.mapOfPosToGridNode || {}).reduce(function (arr, key) { const pos = +key; if (pos >= roundedMin && pos <= roundedMax && !(axis.brokenAxis && axis.brokenAxis.isInAnyBreak(pos))) { arr.push(pos); } return arr; }, []); } /** * Check if a node is collapsed. * * @private * * @param {Highcharts.Axis} axis * The axis to check against. * * @param {Object} node * The node to check if is collapsed. * * @param {number} pos * The tick position to collapse. * * @return {boolean} * Returns true if collapsed, false if expanded. */ isCollapsed(node) { const axis = this.axis, breaks = (axis.options.breaks || []), obj = getBreakFromNode(node, axis.max); return breaks.some(function (b) { return b.from === obj.from && b.to === obj.to; }); } /** * Calculates the new axis breaks after toggling the collapse/expand * state of a node. If it is collapsed it will be expanded, and if it is * expanded it will be collapsed. * * @private * * @param {Highcharts.Axis} axis * The axis to check against. * * @param {Highcharts.GridNode} node * The node to toggle. * * @return {Array} * Returns an array of the new breaks for the axis. */ toggleCollapse(node) { return (this.isCollapsed(node) ? this.expand(node) : this.collapse(node)); } } /* * * * Default Export * * */ return TreeGridAxisAdditions; }); _registerModule(_modules, 'Series/Gantt/GanttSeries.js', [_modules['Series/Gantt/GanttPoint.js'], _modules['Series/Gantt/GanttSeriesDefaults.js'], _modules['Gantt/Pathfinder.js'], _modules['Core/Series/SeriesRegistry.js'], _modules['Extensions/StaticScale.js'], _modules['Core/Axis/TreeGrid/TreeGridAxis.js'], _modules['Core/Utilities.js']], function (GanttPoint, GanttSeriesDefaults, Pathfinder, SeriesRegistry, StaticScale, TreeGridAxis, U) { /* * * * (c) 2016-2024 Highsoft AS * * Author: Lars A. V. Cabrera * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ const { series: Series, seriesTypes: { xrange: XRangeSeries } } = SeriesRegistry; const { extend, isNumber, merge } = U; /* * * * Class * * */ /** * @private * @class * @name Highcharts.seriesTypes.gantt * * @augments Highcharts.Series */ class GanttSeries extends XRangeSeries { /* * * * Static Functions * * */ static compose(AxisClass, ChartClass, SeriesClass, TickClass) { XRangeSeries.compose(AxisClass); if (!ChartClass) { return; } StaticScale.compose(AxisClass, ChartClass); if (!SeriesClass) { return; } Pathfinder.compose(ChartClass, SeriesClass.prototype.pointClass); if (!TickClass) { return; } TreeGridAxis.compose(AxisClass, ChartClass, SeriesClass, TickClass); } /* * * * Functions * * */ /** * Draws a single point in the series. * * This override draws the point as a diamond if point.options.milestone * is true, and uses the original drawPoint() if it is false or not set. * * @requires highcharts-gantt * * @private * @function Highcharts.seriesTypes.gantt#drawPoint * * @param {Highcharts.Point} point * An instance of Point in the series * * @param {"animate"|"attr"} verb * 'animate' (animates changes) or 'attr' (sets options) */ drawPoint(point, verb) { const series = this, seriesOpts = series.options, renderer = series.chart.renderer, shapeArgs = point.shapeArgs, plotY = point.plotY, state = point.selected && 'select', cutOff = seriesOpts.stacking && !seriesOpts.borderRadius; let graphic = point.graphic, diamondShape; if (point.options.milestone) { if (isNumber(plotY) && point.y !== null && point.visible !== false) { diamondShape = renderer.symbols.diamond(shapeArgs.x || 0, shapeArgs.y || 0, shapeArgs.width || 0, shapeArgs.height || 0); if (graphic) { graphic[verb]({ d: diamondShape }); } else { point.graphic = graphic = renderer.path(diamondShape) .addClass(point.getClassName(), true) .add(point.group || series.group); } // Presentational if (!series.chart.styledMode) { point.graphic .attr(series.pointAttribs(point, state)) .shadow(seriesOpts.shadow, null, cutOff); } } else if (graphic) { point.graphic = graphic.destroy(); // #1269 } } else { super.drawPoint(point, verb); } } /** * Handle milestones, as they have no x2. * @private */ translatePoint(point) { let shapeArgs, size; super.translatePoint(point); if (point.options.milestone) { shapeArgs = point.shapeArgs; size = shapeArgs.height || 0; point.shapeArgs = { x: (shapeArgs.x || 0) - (size / 2), y: shapeArgs.y, width: size, height: size }; } } } /* * * * Static Properties * * */ GanttSeries.defaultOptions = merge(XRangeSeries.defaultOptions, GanttSeriesDefaults); extend(GanttSeries.prototype, { pointArrayMap: ['start', 'end', 'y'], pointClass: GanttPoint, setData: Series.prototype.setData }); SeriesRegistry.registerSeriesType('gantt', GanttSeries); /* * * * Default Export * * */ return GanttSeries; }); _registerModule(_modules, 'masters/modules/gantt.src.js', [_modules['Core/Globals.js'], _modules['Extensions/ArrowSymbols.js'], _modules['Gantt/Connection.js'], _modules['Extensions/CurrentDateIndication.js'], _modules['Core/Chart/GanttChart.js'], _modules['Stock/Navigator/Navigator.js'], _modules['Stock/RangeSelector/RangeSelector.js'], _modules['Stock/Scrollbar/Scrollbar.js'], _modules['Series/Gantt/GanttSeries.js']], function (Highcharts, ArrowSymbols, Connection, CurrentDateIndication, GanttChart, Navigator, RangeSelector, Scrollbar, GanttSeries) { // Series const G = Highcharts; // Classes G.Connection = G.Connection || Connection; G.GanttChart = G.GanttChart || GanttChart; G.Navigator = G.Navigator || Navigator; G.RangeSelector = G.RangeSelector || RangeSelector; G.Scrollbar = G.Scrollbar || Scrollbar; // Functions G.ganttChart = G.GanttChart.ganttChart; // Compositions ArrowSymbols.compose(G.SVGRenderer); CurrentDateIndication.compose(G.Axis, G.PlotLineOrBand); GanttSeries.compose(G.Axis, G.Chart, G.Series, G.Tick); G.Navigator.compose(G.Chart, G.Axis, G.Series); G.RangeSelector.compose(G.Axis, G.Chart); G.Scrollbar.compose(G.Axis); return Highcharts; }); }));