/* * * * (c) 2010-2020 Torstein Honsi * * License: www.highcharts.com/license * * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! * * */ 'use strict'; import Highcharts from './Globals.js'; /** * One position in relation to an axis. * * @interface Highcharts.PointerAxisCoordinateObject */ /** * Related axis. * * @name Highcharts.PointerAxisCoordinateObject#axis * @type {Highcharts.Axis} */ /** * Axis value. * * @name Highcharts.PointerAxisCoordinateObject#value * @type {number} */ /** * Positions in terms of axis values. * * @interface Highcharts.PointerAxisCoordinatesObject */ /** * Positions on the x-axis. * @name Highcharts.PointerAxisCoordinatesObject#xAxis * @type {Array} */ /** * Positions on the y-axis. * @name Highcharts.PointerAxisCoordinatesObject#yAxis * @type {Array} */ /** * Pointer coordinates. * * @interface Highcharts.PointerCoordinatesObject */ /** * @name Highcharts.PointerCoordinatesObject#chartX * @type {number} */ /** * @name Highcharts.PointerCoordinatesObject#chartY * @type {number} */ /** * A native browser mouse or touch event, extended with position information * relative to the {@link Chart.container}. * * @interface Highcharts.PointerEventObject * @extends global.PointerEvent */ /** * The X coordinate of the pointer interaction relative to the chart. * * @name Highcharts.PointerEventObject#chartX * @type {number} */ /** * The Y coordinate of the pointer interaction relative to the chart. * * @name Highcharts.PointerEventObject#chartY * @type {number} */ /** * Axis-specific data of a selection. * * @interface Highcharts.SelectDataObject */ /** * @name Highcharts.SelectDataObject#axis * @type {Highcharts.Axis} */ /** * @name Highcharts.SelectDataObject#max * @type {number} */ /** * @name Highcharts.SelectDataObject#min * @type {number} */ /** * Object for select events. * * @interface Highcharts.SelectEventObject */ /** * @name Highcharts.SelectEventObject#originalEvent * @type {global.Event} */ /** * @name Highcharts.SelectEventObject#xAxis * @type {Array} */ /** * @name Highcharts.SelectEventObject#yAxis * @type {Array} */ import U from './Utilities.js'; var addEvent = U.addEvent, attr = U.attr, css = U.css, defined = U.defined, extend = U.extend, find = U.find, fireEvent = U.fireEvent, isNumber = U.isNumber, isObject = U.isObject, objectEach = U.objectEach, offset = U.offset, pick = U.pick, splat = U.splat; import Tooltip from './Tooltip.js'; import Color from './Color.js'; var color = Color.parse; var H = Highcharts, charts = H.charts, noop = H.noop; /* eslint-disable no-invalid-this, valid-jsdoc */ /** * The mouse and touch tracker object. Each {@link Chart} item has one * assosiated Pointer item that can be accessed from the {@link Chart.pointer} * property. * * @class * @name Highcharts.Pointer * * @param {Highcharts.Chart} chart * The chart instance. * * @param {Highcharts.Options} options * The root options object. The pointer uses options from the chart and * tooltip structures. */ var Pointer = /** @class */ (function () { /* * * * Constructors * * */ function Pointer(chart, options) { this.lastValidTouch = {}; this.pinchDown = []; this.runChartClick = false; this.chart = chart; this.hasDragged = false; this.options = options; this.unbindContainerMouseLeave = function () { }; this.init(chart, options); } /* * * * Functions * * */ /** * Set inactive state to all series that are not currently hovered, * or, if `inactiveOtherPoints` is set to true, set inactive state to * all points within that series. * * @function Highcharts.Pointer#applyInactiveState * * @private * * @param {Array} points * Currently hovered points * */ Pointer.prototype.applyInactiveState = function (points) { var activeSeries = [], series; // Get all active series from the hovered points (points || []).forEach(function (item) { series = item.series; // Include itself activeSeries.push(series); // Include parent series if (series.linkedParent) { activeSeries.push(series.linkedParent); } // Include all child series if (series.linkedSeries) { activeSeries = activeSeries.concat(series.linkedSeries); } // Include navigator series if (series.navigatorSeries) { activeSeries.push(series.navigatorSeries); } }); // Now loop over all series, filtering out active series this.chart.series.forEach(function (inactiveSeries) { if (activeSeries.indexOf(inactiveSeries) === -1) { // Inactive series inactiveSeries.setState('inactive', true); } else if (inactiveSeries.options.inactiveOtherPoints) { // Active series, but other points should be inactivated inactiveSeries.setAllPointsToState('inactive'); } }); }; /** * Destroys the Pointer object and disconnects DOM events. * * @function Highcharts.Pointer#destroy * * @return {void} */ Pointer.prototype.destroy = function () { var pointer = this; if (typeof pointer.unDocMouseMove !== 'undefined') { pointer.unDocMouseMove(); } this.unbindContainerMouseLeave(); if (!H.chartCount) { if (H.unbindDocumentMouseUp) { H.unbindDocumentMouseUp = H.unbindDocumentMouseUp(); } if (H.unbindDocumentTouchEnd) { H.unbindDocumentTouchEnd = H.unbindDocumentTouchEnd(); } } // memory and CPU leak clearInterval(pointer.tooltipTimeout); objectEach(pointer, function (val, prop) { pointer[prop] = null; }); }; /** * Perform a drag operation in response to a mousemove event while the mouse * is down. * * @private * @function Highcharts.Pointer#drag * * @param {Highcharts.PointerEventObject} e * * @return {void} */ Pointer.prototype.drag = function (e) { var chart = this.chart, chartOptions = chart.options.chart, chartX = e.chartX, chartY = e.chartY, zoomHor = this.zoomHor, zoomVert = this.zoomVert, plotLeft = chart.plotLeft, plotTop = chart.plotTop, plotWidth = chart.plotWidth, plotHeight = chart.plotHeight, clickedInside, size, selectionMarker = this.selectionMarker, mouseDownX = (this.mouseDownX || 0), mouseDownY = (this.mouseDownY || 0), panningEnabled = isObject(chartOptions.panning) ? chartOptions.panning && chartOptions.panning.enabled : chartOptions.panning, panKey = (chartOptions.panKey && e[chartOptions.panKey + 'Key']); // If the device supports both touch and mouse (like IE11), and we are // touch-dragging inside the plot area, don't handle the mouse event. // #4339. if (selectionMarker && selectionMarker.touch) { return; } // If the mouse is outside the plot area, adjust to cooordinates // inside to prevent the selection marker from going outside if (chartX < plotLeft) { chartX = plotLeft; } else if (chartX > plotLeft + plotWidth) { chartX = plotLeft + plotWidth; } if (chartY < plotTop) { chartY = plotTop; } else if (chartY > plotTop + plotHeight) { chartY = plotTop + plotHeight; } // determine if the mouse has moved more than 10px this.hasDragged = Math.sqrt(Math.pow(mouseDownX - chartX, 2) + Math.pow(mouseDownY - chartY, 2)); if (this.hasDragged > 10) { clickedInside = chart.isInsidePlot(mouseDownX - plotLeft, mouseDownY - plotTop); // make a selection if (chart.hasCartesianSeries && (this.zoomX || this.zoomY) && clickedInside && !panKey) { if (!selectionMarker) { this.selectionMarker = selectionMarker = chart.renderer.rect(plotLeft, plotTop, zoomHor ? 1 : plotWidth, zoomVert ? 1 : plotHeight, 0) .attr({ 'class': 'highcharts-selection-marker', zIndex: 7 }) .add(); if (!chart.styledMode) { selectionMarker.attr({ fill: (chartOptions.selectionMarkerFill || color('#335cad') .setOpacity(0.25).get()) }); } } } // adjust the width of the selection marker if (selectionMarker && zoomHor) { size = chartX - mouseDownX; selectionMarker.attr({ width: Math.abs(size), x: (size > 0 ? 0 : size) + mouseDownX }); } // adjust the height of the selection marker if (selectionMarker && zoomVert) { size = chartY - mouseDownY; selectionMarker.attr({ height: Math.abs(size), y: (size > 0 ? 0 : size) + mouseDownY }); } // panning if (clickedInside && !selectionMarker && panningEnabled) { chart.pan(e, chartOptions.panning); } } }; /** * Start a drag operation. * * @private * @function Highcharts.Pointer#dragStart * * @param {Highcharts.PointerEventObject} e * * @return {void} */ Pointer.prototype.dragStart = function (e) { var chart = this.chart; // Record the start position chart.mouseIsDown = e.type; chart.cancelClick = false; chart.mouseDownX = this.mouseDownX = e.chartX; chart.mouseDownY = this.mouseDownY = e.chartY; }; /** * On mouse up or touch end across the entire document, drop the selection. * * @private * @function Highcharts.Pointer#drop * * @param {global.Event} e */ Pointer.prototype.drop = function (e) { var pointer = this, chart = this.chart, hasPinched = this.hasPinched; if (this.selectionMarker) { var selectionData = { originalEvent: e, xAxis: [], yAxis: [] }, selectionBox = this.selectionMarker, selectionLeft = selectionBox.attr ? selectionBox.attr('x') : selectionBox.x, selectionTop = selectionBox.attr ? selectionBox.attr('y') : selectionBox.y, selectionWidth = selectionBox.attr ? selectionBox.attr('width') : selectionBox.width, selectionHeight = selectionBox.attr ? selectionBox.attr('height') : selectionBox.height, runZoom; // a selection has been made if (this.hasDragged || hasPinched) { // record each axis' min and max chart.axes.forEach(function (axis) { if (axis.zoomEnabled && defined(axis.min) && (hasPinched || pointer[{ xAxis: 'zoomX', yAxis: 'zoomY' }[axis.coll]])) { // #859, #3569 var horiz = axis.horiz, minPixelPadding = e.type === 'touchend' ? axis.minPixelPadding : 0, // #1207, #3075 selectionMin = axis.toValue((horiz ? selectionLeft : selectionTop) + minPixelPadding), selectionMax = axis.toValue((horiz ? selectionLeft + selectionWidth : selectionTop + selectionHeight) - minPixelPadding); selectionData[axis.coll].push({ axis: axis, // Min/max for reversed axes min: Math.min(selectionMin, selectionMax), max: Math.max(selectionMin, selectionMax) }); runZoom = true; } }); if (runZoom) { fireEvent(chart, 'selection', selectionData, function (args) { chart.zoom(extend(args, hasPinched ? { animation: false } : null)); }); } } if (isNumber(chart.index)) { this.selectionMarker = this.selectionMarker.destroy(); } // Reset scaling preview if (hasPinched) { this.scaleGroups(); } } // Reset all. Check isNumber because it may be destroyed on mouse up // (#877) if (chart && isNumber(chart.index)) { css(chart.container, { cursor: chart._cursor }); chart.cancelClick = this.hasDragged > 10; // #370 chart.mouseIsDown = this.hasDragged = this.hasPinched = false; this.pinchDown = []; } }; /** * Finds the closest point to a set of coordinates, using the k-d-tree * algorithm. * * @function Highcharts.Pointer#findNearestKDPoints * * @param {Array} series * All the series to search in. * * @param {boolean|undefined} shared * Whether it is a shared tooltip or not. * * @param {Highcharts.PointerEventObject} e * The pointer event object, containing chart coordinates of the * pointer. * * @return {Highcharts.Point|undefined} * The point closest to given coordinates. */ Pointer.prototype.findNearestKDPoint = function (series, shared, e) { var chart = this.chart; var hoverPoint = chart.hoverPoint; var tooltip = chart.tooltip; if (hoverPoint && tooltip && tooltip.isStickyOnContact()) { return hoverPoint; } var closest; /** @private */ function sort(p1, p2) { var isCloserX = p1.distX - p2.distX, isCloser = p1.dist - p2.dist, isAbove = (p2.series.group && p2.series.group.zIndex) - (p1.series.group && p1.series.group.zIndex), result; // We have two points which are not in the same place on xAxis // and shared tooltip: if (isCloserX !== 0 && shared) { // #5721 result = isCloserX; // Points are not exactly in the same place on x/yAxis: } else if (isCloser !== 0) { result = isCloser; // The same xAxis and yAxis position, sort by z-index: } else if (isAbove !== 0) { result = isAbove; // The same zIndex, sort by array index: } else { result = p1.series.index > p2.series.index ? -1 : 1; } return result; } series.forEach(function (s) { var noSharedTooltip = s.noSharedTooltip && shared, compareX = (!noSharedTooltip && s.options.findNearestPointBy.indexOf('y') < 0), point = s.searchPoint(e, compareX); if ( // Check that we actually found a point on the series. isObject(point, true) && // Use the new point if it is closer. (!isObject(closest, true) || (sort(closest, point) > 0))) { closest = point; } }); return closest; }; /** * @private * @function Highcharts.Pointer#getChartCoordinatesFromPoint * @param {Highcharts.Point} point * @param {boolean} [inverted] * @return {Highcharts.PointerCoordinatesObject|undefined} */ Pointer.prototype.getChartCoordinatesFromPoint = function (point, inverted) { var series = point.series, xAxis = series.xAxis, yAxis = series.yAxis, plotX = pick(point.clientX, point.plotX), shapeArgs = point.shapeArgs; if (xAxis && yAxis) { return inverted ? { chartX: xAxis.len + xAxis.pos - plotX, chartY: yAxis.len + yAxis.pos - point.plotY } : { chartX: plotX + xAxis.pos, chartY: point.plotY + yAxis.pos }; } if (shapeArgs && shapeArgs.x && shapeArgs.y) { // E.g. pies do not have axes return { chartX: shapeArgs.x, chartY: shapeArgs.y }; } }; /** * Return the cached chartPosition if it is available on the Pointer, * otherwise find it. Running offset is quite expensive, so it should be * avoided when we know the chart hasn't moved. * * @function Highcharts.Pointer#getChartPosition * * @return {Highcharts.OffsetObject} * The offset of the chart container within the page */ Pointer.prototype.getChartPosition = function () { return (this.chartPosition || (this.chartPosition = offset(this.chart.container))); }; /** * Get the click position in terms of axis values. * * @function Highcharts.Pointer#getCoordinates * * @param {Highcharts.PointerEventObject} e * Pointer event, extended with `chartX` and `chartY` properties. * * @return {Highcharts.PointerAxisCoordinatesObject} */ Pointer.prototype.getCoordinates = function (e) { var coordinates = { xAxis: [], yAxis: [] }; this.chart.axes.forEach(function (axis) { coordinates[axis.isXAxis ? 'xAxis' : 'yAxis'].push({ axis: axis, value: axis.toValue(e[axis.horiz ? 'chartX' : 'chartY']) }); }); return coordinates; }; /** * Calculates what is the current hovered point/points and series. * * @private * @function Highcharts.Pointer#getHoverData * * @param {Highcharts.Point|undefined} existingHoverPoint * The point currrently beeing hovered. * * @param {Highcharts.Series|undefined} existingHoverSeries * The series currently beeing hovered. * * @param {Array} series * All the series in the chart. * * @param {boolean} isDirectTouch * Is the pointer directly hovering the point. * * @param {boolean|undefined} shared * Whether it is a shared tooltip or not. * * @param {Highcharts.PointerEventObject} [e] * The triggering event, containing chart coordinates of the pointer. * * @return {object} * Object containing resulting hover data: hoverPoint, hoverSeries, * and hoverPoints. */ Pointer.prototype.getHoverData = function (existingHoverPoint, existingHoverSeries, series, isDirectTouch, shared, e) { var hoverPoint, hoverPoints = [], hoverSeries = existingHoverSeries, useExisting = !!(isDirectTouch && existingHoverPoint), notSticky = hoverSeries && !hoverSeries.stickyTracking, // Which series to look in for the hover point searchSeries, // Parameters needed for beforeGetHoverData event. eventArgs = { chartX: e ? e.chartX : void 0, chartY: e ? e.chartY : void 0, shared: shared }, filter = function (s) { return (s.visible && !(!shared && s.directTouch) && // #3821 pick(s.options.enableMouseTracking, true)); }; // Find chart.hoverPane and update filter method in polar. fireEvent(this, 'beforeGetHoverData', eventArgs); searchSeries = notSticky ? // Only search on hovered series if it has stickyTracking false [hoverSeries] : // Filter what series to look in. series.filter(function (s) { return eventArgs.filter ? eventArgs.filter(s) : filter(s) && s.stickyTracking; }); // Use existing hovered point or find the one closest to coordinates. hoverPoint = useExisting || !e ? existingHoverPoint : this.findNearestKDPoint(searchSeries, shared, e); // Assign hover series hoverSeries = hoverPoint && hoverPoint.series; // If we have a hoverPoint, assign hoverPoints. if (hoverPoint) { // When tooltip is shared, it displays more than one point if (shared && !hoverSeries.noSharedTooltip) { searchSeries = series.filter(function (s) { return eventArgs.filter ? eventArgs.filter(s) : filter(s) && !s.noSharedTooltip; }); // Get all points with the same x value as the hoverPoint searchSeries.forEach(function (s) { var point = find(s.points, function (p) { return p.x === hoverPoint.x && !p.isNull; }); if (isObject(point)) { /* * Boost returns a minimal point. Convert it to a usable * point for tooltip and states. */ if (s.chart.isBoosting) { point = s.getPoint(point); } hoverPoints.push(point); } }); } else { hoverPoints.push(hoverPoint); } } // Check whether the hoverPoint is inside pane we are hovering over. eventArgs = { hoverPoint: hoverPoint }; fireEvent(this, 'afterGetHoverData', eventArgs); return { hoverPoint: eventArgs.hoverPoint, hoverSeries: hoverSeries, hoverPoints: hoverPoints }; }; /** * @private * @function Highcharts.Pointer#getPointFromEvent * * @param {global.Event} e * * @return {Highcharts.Point|undefined} */ Pointer.prototype.getPointFromEvent = function (e) { var target = e.target, point; while (target && !point) { point = target.point; target = target.parentNode; } return point; }; /** * @private * @function Highcharts.Pointer#onTrackerMouseOut * * @param {Highcharts.PointerEventObject} e * * @return {void} */ Pointer.prototype.onTrackerMouseOut = function (e) { var chart = this.chart; var relatedTarget = e.relatedTarget || e.toElement; var series = chart.hoverSeries; this.isDirectTouch = false; if (series && relatedTarget && !series.stickyTracking && !this.inClass(relatedTarget, 'highcharts-tooltip') && (!this.inClass(relatedTarget, 'highcharts-series-' + series.index) || // #2499, #4465, #5553 !this.inClass(relatedTarget, 'highcharts-tracker'))) { series.onMouseOut(); } }; /** * Utility to detect whether an element has, or has a parent with, a * specificclass name. Used on detection of tracker objects and on deciding * whether hovering the tooltip should cause the active series to mouse out. * * @function Highcharts.Pointer#inClass * * @param {Highcharts.SVGDOMElement|Highcharts.HTMLDOMElement} element * The element to investigate. * * @param {string} className * The class name to look for. * * @return {boolean|undefined} * True if either the element or one of its parents has the given * class name. */ Pointer.prototype.inClass = function (element, className) { var elemClassName; while (element) { elemClassName = attr(element, 'class'); if (elemClassName) { if (elemClassName.indexOf(className) !== -1) { return true; } if (elemClassName.indexOf('highcharts-container') !== -1) { return false; } } element = element.parentNode; } }; /** * Initialize the Pointer. * * @private * @function Highcharts.Pointer#init * * @param {Highcharts.Chart} chart * The Chart instance. * * @param {Highcharts.Options} options * The root options object. The pointer uses options from the chart * and tooltip structures. * * @return {void} */ Pointer.prototype.init = function (chart, options) { // Store references this.options = options; this.chart = chart; // Do we need to handle click on a touch device? this.runChartClick = options.chart.events && !!options.chart.events.click; this.pinchDown = []; this.lastValidTouch = {}; if (Tooltip) { /** * Tooltip object for points of series. * * @name Highcharts.Chart#tooltip * @type {Highcharts.Tooltip} */ chart.tooltip = new Tooltip(chart, options.tooltip); this.followTouchMove = pick(options.tooltip.followTouchMove, true); } this.setDOMEvents(); }; /** * Takes a browser event object and extends it with custom Highcharts * properties `chartX` and `chartY` in order to work on the internal * coordinate system. * * @function Highcharts.Pointer#normalize * * @param {global.MouseEvent|global.PointerEvent|global.TouchEvent} e * Event object in standard browsers. * * @param {Highcharts.OffsetObject} [chartPosition] * Additional chart offset. * * @return {Highcharts.PointerEventObject} * A browser event with extended properties `chartX` and `chartY`. */ Pointer.prototype.normalize = function (e, chartPosition) { var touches = e.touches; // iOS (#2757) var ePos = (touches ? touches.length ? touches.item(0) : touches.changedTouches[0] : e); // Get mouse position if (!chartPosition) { chartPosition = this.getChartPosition(); } var chartX = ePos.pageX - chartPosition.left, chartY = ePos.pageY - chartPosition.top; // #11329 - when there is scaling on a parent element, we need to take // this into account var containerScaling = this.chart.containerScaling; if (containerScaling) { chartX /= containerScaling.scaleX; chartY /= containerScaling.scaleY; } return extend(e, { chartX: Math.round(chartX), chartY: Math.round(chartY) }); }; /** * @private * @function Highcharts.Pointer#onContainerClick * * @param {global.MouseEvent} e * * @return {void} */ Pointer.prototype.onContainerClick = function (e) { var chart = this.chart; var hoverPoint = chart.hoverPoint; var pEvt = this.normalize(e); var plotLeft = chart.plotLeft; var plotTop = chart.plotTop; if (!chart.cancelClick) { // On tracker click, fire the series and point events. #783, #1583 if (hoverPoint && this.inClass(pEvt.target, 'highcharts-tracker')) { // the series click event fireEvent(hoverPoint.series, 'click', extend(pEvt, { point: hoverPoint })); // the point click event if (chart.hoverPoint) { // it may be destroyed (#1844) hoverPoint.firePointEvent('click', pEvt); } // When clicking outside a tracker, fire a chart event } else { extend(pEvt, this.getCoordinates(pEvt)); // fire a click event in the chart if (chart.isInsidePlot((pEvt.chartX - plotLeft), (pEvt.chartY - plotTop))) { fireEvent(chart, 'click', pEvt); } } } }; /** * @private * @function Highcharts.Pointer#onContainerMouseDown * * @param {global.MouseEvent} e */ Pointer.prototype.onContainerMouseDown = function (e) { // Normalize before the 'if' for the legacy IE (#7850) e = this.normalize(e); // #11635, Firefox does not reliable fire move event after click scroll if (H.isFirefox && e.button !== 0) { this.onContainerMouseMove(e); } // #11635, limiting to primary button (incl. IE 8 support) if (typeof e.button === 'undefined' || ((e.buttons || e.button) & 1) === 1) { this.zoomOption(e); this.dragStart(e); } }; /** * When mouse leaves the container, hide the tooltip. * * @private * @function Highcharts.Pointer#onContainerMouseLeave * * @param {global.MouseEvent} e * * @return {void} */ Pointer.prototype.onContainerMouseLeave = function (e) { var chart = charts[pick(H.hoverChartIndex, -1)]; var tooltip = this.chart.tooltip; e = this.normalize(e); // #4886, MS Touch end fires mouseleave but with no related target if (chart && (e.relatedTarget || e.toElement)) { chart.pointer.reset(); // Also reset the chart position, used in #149 fix chart.pointer.chartPosition = void 0; } if ( // #11635, Firefox wheel scroll does not fire out events consistently tooltip && !tooltip.isHidden) { this.reset(); } }; /** * The mousemove, touchmove and touchstart event handler * * @private * @function Highcharts.Pointer#onContainerMouseMove * * @param {global.MouseEvent} e * * @return {void} */ Pointer.prototype.onContainerMouseMove = function (e) { var chart = this.chart; var pEvt = this.normalize(e); this.setHoverChartIndex(); // In IE8 we apparently need this returnValue set to false in order to // avoid text being selected. But in Chrome, e.returnValue is prevented, // plus we don't need to run e.preventDefault to prevent selected text // in modern browsers. So we set it conditionally. Remove it when IE8 is // no longer needed. #2251, #3224. if (!pEvt.preventDefault) { pEvt.returnValue = false; } if (chart.mouseIsDown === 'mousedown') { this.drag(pEvt); } // Show the tooltip and run mouse over events (#977) if (!chart.openMenu && (this.inClass(pEvt.target, 'highcharts-tracker') || chart.isInsidePlot((pEvt.chartX - chart.plotLeft), (pEvt.chartY - chart.plotTop)))) { this.runPointActions(pEvt); } }; /** * @private * @function Highcharts.Pointer#onDocumentTouchEnd * * @param {Highcharts.PointerEventObject} e * * @return {void} */ Pointer.prototype.onDocumentTouchEnd = function (e) { if (charts[H.hoverChartIndex]) { charts[H.hoverChartIndex].pointer.drop(e); } }; /** * @private * @function Highcharts.Pointer#onContainerTouchMove * * @param {Highcharts.PointerEventObject} e * * @return {void} */ Pointer.prototype.onContainerTouchMove = function (e) { this.touch(e); }; /** * @private * @function Highcharts.Pointer#onContainerTouchStart * * @param {Highcharts.PointerEventObject} e * * @return {void} */ Pointer.prototype.onContainerTouchStart = function (e) { this.zoomOption(e); this.touch(e, true); }; /** * Special handler for mouse move that will hide the tooltip when the mouse * leaves the plotarea. Issue #149 workaround. The mouseleave event does not * always fire. * * @private * @function Highcharts.Pointer#onDocumentMouseMove * * @param {global.MouseEvent} e * * @return {void} */ Pointer.prototype.onDocumentMouseMove = function (e) { var chart = this.chart; var chartPosition = this.chartPosition; var pEvt = this.normalize(e, chartPosition); var tooltip = chart.tooltip; // If we're outside, hide the tooltip if (chartPosition && (!tooltip || !tooltip.isStickyOnContact()) && !chart.isInsidePlot(pEvt.chartX - chart.plotLeft, pEvt.chartY - chart.plotTop) && !this.inClass(pEvt.target, 'highcharts-tracker')) { this.reset(); } }; /** * @private * @function Highcharts.Pointer#onDocumentMouseUp * * @param {global.MouseEvent} e * * @return {void} */ Pointer.prototype.onDocumentMouseUp = function (e) { var chart = charts[pick(H.hoverChartIndex, -1)]; if (chart) { chart.pointer.drop(e); } }; /** * Handle touch events with two touches * * @private * @function Highcharts.Pointer#pinch * * @param {Highcharts.PointerEventObject} e * * @return {void} */ Pointer.prototype.pinch = function (e) { var self = this, chart = self.chart, pinchDown = self.pinchDown, touches = (e.touches || []), touchesLength = touches.length, lastValidTouch = self.lastValidTouch, hasZoom = self.hasZoom, selectionMarker = self.selectionMarker, transform = {}, fireClickEvent = touchesLength === 1 && ((self.inClass(e.target, 'highcharts-tracker') && chart.runTrackerClick) || self.runChartClick), clip = {}; // Don't initiate panning until the user has pinched. This prevents us // from blocking page scrolling as users scroll down a long page // (#4210). if (touchesLength > 1) { self.initiated = true; } // On touch devices, only proceed to trigger click if a handler is // defined if (hasZoom && self.initiated && !fireClickEvent) { e.preventDefault(); } // Normalize each touch [].map.call(touches, function (e) { return self.normalize(e); }); // Register the touch start position if (e.type === 'touchstart') { [].forEach.call(touches, function (e, i) { pinchDown[i] = { chartX: e.chartX, chartY: e.chartY }; }); lastValidTouch.x = [pinchDown[0].chartX, pinchDown[1] && pinchDown[1].chartX]; lastValidTouch.y = [pinchDown[0].chartY, pinchDown[1] && pinchDown[1].chartY]; // Identify the data bounds in pixels chart.axes.forEach(function (axis) { if (axis.zoomEnabled) { var bounds = chart.bounds[axis.horiz ? 'h' : 'v'], minPixelPadding = axis.minPixelPadding, min = axis.toPixels(Math.min(pick(axis.options.min, axis.dataMin), axis.dataMin)), max = axis.toPixels(Math.max(pick(axis.options.max, axis.dataMax), axis.dataMax)), absMin = Math.min(min, max), absMax = Math.max(min, max); // Store the bounds for use in the touchmove handler bounds.min = Math.min(axis.pos, absMin - minPixelPadding); bounds.max = Math.max(axis.pos + axis.len, absMax + minPixelPadding); } }); self.res = true; // reset on next move // Optionally move the tooltip on touchmove } else if (self.followTouchMove && touchesLength === 1) { this.runPointActions(self.normalize(e)); // Event type is touchmove, handle panning and pinching } else if (pinchDown.length) { // can be 0 when releasing, if touchend // fires first // Set the marker if (!selectionMarker) { self.selectionMarker = selectionMarker = extend({ destroy: noop, touch: true }, chart.plotBox); } self.pinchTranslate(pinchDown, touches, transform, selectionMarker, clip, lastValidTouch); self.hasPinched = hasZoom; // Scale and translate the groups to provide visual feedback during // pinching self.scaleGroups(transform, clip); if (self.res) { self.res = false; this.reset(false, 0); } } }; /** * Run translation operations * * @private * @function Highcharts.Pointer#pinchTranslate * * @param {Array<*>} pinchDown * * @param {Array} touches * * @param {*} transform * * @param {*} selectionMarker * * @param {*} clip * * @param {*} lastValidTouch * * @return {void} */ Pointer.prototype.pinchTranslate = function (pinchDown, touches, transform, selectionMarker, clip, lastValidTouch) { if (this.zoomHor) { this.pinchTranslateDirection(true, pinchDown, touches, transform, selectionMarker, clip, lastValidTouch); } if (this.zoomVert) { this.pinchTranslateDirection(false, pinchDown, touches, transform, selectionMarker, clip, lastValidTouch); } }; /** * Run translation operations for each direction (horizontal and vertical) * independently. * * @private * @function Highcharts.Pointer#pinchTranslateDirection * * @param {boolean} horiz * * @param {Array<*>} pinchDown * * @param {Array} touches * * @param {*} transform * * @param {*} selectionMarker * * @param {*} clip * * @param {*} lastValidTouch * * @param {number|undefined} [forcedScale=1] * * @return {void} */ Pointer.prototype.pinchTranslateDirection = function (horiz, pinchDown, touches, transform, selectionMarker, clip, lastValidTouch, forcedScale) { var chart = this.chart, xy = horiz ? 'x' : 'y', XY = horiz ? 'X' : 'Y', sChartXY = ('chart' + XY), wh = horiz ? 'width' : 'height', plotLeftTop = chart['plot' + (horiz ? 'Left' : 'Top')], selectionWH, selectionXY, clipXY, scale = forcedScale || 1, inverted = chart.inverted, bounds = chart.bounds[horiz ? 'h' : 'v'], singleTouch = pinchDown.length === 1, touch0Start = pinchDown[0][sChartXY], touch0Now = touches[0][sChartXY], touch1Start = !singleTouch && pinchDown[1][sChartXY], touch1Now = !singleTouch && touches[1][sChartXY], outOfBounds, transformScale, scaleKey, setScale = function () { // Don't zoom if fingers are too close on this axis if (typeof touch1Now === 'number' && Math.abs(touch0Start - touch1Start) > 20) { scale = forcedScale || Math.abs(touch0Now - touch1Now) / Math.abs(touch0Start - touch1Start); } clipXY = ((plotLeftTop - touch0Now) / scale) + touch0Start; selectionWH = chart['plot' + (horiz ? 'Width' : 'Height')] / scale; }; // Set the scale, first pass setScale(); // The clip position (x or y) is altered if out of bounds, the selection // position is not selectionXY = clipXY; // Out of bounds if (selectionXY < bounds.min) { selectionXY = bounds.min; outOfBounds = true; } else if (selectionXY + selectionWH > bounds.max) { selectionXY = bounds.max - selectionWH; outOfBounds = true; } // Is the chart dragged off its bounds, determined by dataMin and // dataMax? if (outOfBounds) { // Modify the touchNow position in order to create an elastic drag // movement. This indicates to the user that the chart is responsive // but can't be dragged further. touch0Now -= 0.8 * (touch0Now - lastValidTouch[xy][0]); if (typeof touch1Now === 'number') { touch1Now -= 0.8 * (touch1Now - lastValidTouch[xy][1]); } // Set the scale, second pass to adapt to the modified touchNow // positions setScale(); } else { lastValidTouch[xy] = [touch0Now, touch1Now]; } // Set geometry for clipping, selection and transformation if (!inverted) { clip[xy] = clipXY - plotLeftTop; clip[wh] = selectionWH; } scaleKey = inverted ? (horiz ? 'scaleY' : 'scaleX') : 'scale' + XY; transformScale = inverted ? 1 / scale : scale; selectionMarker[wh] = selectionWH; selectionMarker[xy] = selectionXY; transform[scaleKey] = scale; transform['translate' + XY] = (transformScale * plotLeftTop) + (touch0Now - (transformScale * touch0Start)); }; /** * Reset the tracking by hiding the tooltip, the hover series state and the * hover point * * @function Highcharts.Pointer#reset * * @param {boolean} [allowMove] * Instead of destroying the tooltip altogether, allow moving it if * possible. * * @param {number} [delay] * * @return {void} */ Pointer.prototype.reset = function (allowMove, delay) { var pointer = this, chart = pointer.chart, hoverSeries = chart.hoverSeries, hoverPoint = chart.hoverPoint, hoverPoints = chart.hoverPoints, tooltip = chart.tooltip, tooltipPoints = tooltip && tooltip.shared ? hoverPoints : hoverPoint; // Check if the points have moved outside the plot area (#1003, #4736, // #5101) if (allowMove && tooltipPoints) { splat(tooltipPoints).forEach(function (point) { if (point.series.isCartesian && typeof point.plotX === 'undefined') { allowMove = false; } }); } // Just move the tooltip, #349 if (allowMove) { if (tooltip && tooltipPoints && splat(tooltipPoints).length) { tooltip.refresh(tooltipPoints); if (tooltip.shared && hoverPoints) { // #8284 hoverPoints.forEach(function (point) { point.setState(point.state, true); if (point.series.isCartesian) { if (point.series.xAxis.crosshair) { point.series.xAxis .drawCrosshair(null, point); } if (point.series.yAxis.crosshair) { point.series.yAxis .drawCrosshair(null, point); } } }); } else if (hoverPoint) { // #2500 hoverPoint.setState(hoverPoint.state, true); chart.axes.forEach(function (axis) { if (axis.crosshair && hoverPoint.series[axis.coll] === axis) { axis.drawCrosshair(null, hoverPoint); } }); } } // Full reset } else { if (hoverPoint) { hoverPoint.onMouseOut(); } if (hoverPoints) { hoverPoints.forEach(function (point) { point.setState(); }); } if (hoverSeries) { hoverSeries.onMouseOut(); } if (tooltip) { tooltip.hide(delay); } if (pointer.unDocMouseMove) { pointer.unDocMouseMove = pointer.unDocMouseMove(); } // Remove crosshairs chart.axes.forEach(function (axis) { axis.hideCrosshair(); }); pointer.hoverX = chart.hoverPoints = chart.hoverPoint = null; } }; /** * With line type charts with a single tracker, get the point closest to the * mouse. Run Point.onMouseOver and display tooltip for the point or points. * * @private * @function Highcharts.Pointer#runPointActions * * @param {global.Event} e * * @param {Highcharts.PointerEventObject} [p] * * @return {void} * * @fires Highcharts.Point#event:mouseOut * @fires Highcharts.Point#event:mouseOver */ Pointer.prototype.runPointActions = function (e, p) { var pointer = this, chart = pointer.chart, series = chart.series, tooltip = (chart.tooltip && chart.tooltip.options.enabled ? chart.tooltip : void 0), shared = (tooltip ? tooltip.shared : false), hoverPoint = p || chart.hoverPoint, hoverSeries = hoverPoint && hoverPoint.series || chart.hoverSeries, // onMouseOver or already hovering a series with directTouch isDirectTouch = (!e || e.type !== 'touchmove') && (!!p || ((hoverSeries && hoverSeries.directTouch) && pointer.isDirectTouch)), hoverData = this.getHoverData(hoverPoint, hoverSeries, series, isDirectTouch, shared, e), useSharedTooltip, followPointer, anchor, points; // Update variables from hoverData. hoverPoint = hoverData.hoverPoint; points = hoverData.hoverPoints; hoverSeries = hoverData.hoverSeries; followPointer = hoverSeries && hoverSeries.tooltipOptions.followPointer; useSharedTooltip = (shared && hoverSeries && !hoverSeries.noSharedTooltip); // Refresh tooltip for kdpoint if new hover point or tooltip was hidden // #3926, #4200 if (hoverPoint && // !(hoverSeries && hoverSeries.directTouch) && (hoverPoint !== chart.hoverPoint || (tooltip && tooltip.isHidden))) { (chart.hoverPoints || []).forEach(function (p) { if (points.indexOf(p) === -1) { p.setState(); } }); // Set normal state to previous series if (chart.hoverSeries !== hoverSeries) { hoverSeries.onMouseOver(); } pointer.applyInactiveState(points); // Do mouseover on all points (#3919, #3985, #4410, #5622) (points || []).forEach(function (p) { p.setState('hover'); }); // If tracking is on series in stead of on each point, // fire mouseOver on hover point. // #4448 if (chart.hoverPoint) { chart.hoverPoint.firePointEvent('mouseOut'); } // Hover point may have been destroyed in the event handlers (#7127) if (!hoverPoint.series) { return; } hoverPoint.firePointEvent('mouseOver'); /** * Contains all hovered points. * * @name Highcharts.Chart#hoverPoints * @type {Array|null} */ chart.hoverPoints = points; /** * Contains the original hovered point. * * @name Highcharts.Chart#hoverPoint * @type {Highcharts.Point|null} */ chart.hoverPoint = hoverPoint; // Draw tooltip if necessary if (tooltip) { tooltip.refresh(useSharedTooltip ? points : hoverPoint, e); } // Update positions (regardless of kdpoint or hoverPoint) } else if (followPointer && tooltip && !tooltip.isHidden) { anchor = tooltip.getAnchor([{}], e); tooltip.updatePosition({ plotX: anchor[0], plotY: anchor[1] }); } // Start the event listener to pick up the tooltip and crosshairs if (!pointer.unDocMouseMove) { pointer.unDocMouseMove = addEvent(chart.container.ownerDocument, 'mousemove', function (e) { var chart = charts[H.hoverChartIndex]; if (chart) { chart.pointer.onDocumentMouseMove(e); } }); } // Issues related to crosshair #4927, #5269 #5066, #5658 chart.axes.forEach(function drawAxisCrosshair(axis) { var snap = pick((axis.crosshair || {}).snap, true); var point; if (snap) { point = chart.hoverPoint; // #13002 if (!point || point.series[axis.coll] !== axis) { point = find(points, function (p) { return p.series[axis.coll] === axis; }); } } // Axis has snapping crosshairs, and one of the hover points belongs // to axis. Always call drawCrosshair when it is not snap. if (point || !snap) { axis.drawCrosshair(e, point); // Axis has snapping crosshairs, but no hover point belongs to axis } else { axis.hideCrosshair(); } }); }; /** * Scale series groups to a certain scale and translation. * * @private * @function Highcharts.Pointer#scaleGroups * * @param {Highcharts.SeriesPlotBoxObject} [attribs] * * @param {boolean} [clip] * * @return {void} */ Pointer.prototype.scaleGroups = function (attribs, clip) { var chart = this.chart, seriesAttribs; // Scale each series chart.series.forEach(function (series) { seriesAttribs = attribs || series.getPlotBox(); // #1701 if (series.xAxis && series.xAxis.zoomEnabled && series.group) { series.group.attr(seriesAttribs); if (series.markerGroup) { series.markerGroup.attr(seriesAttribs); series.markerGroup.clip(clip ? chart.clipRect : null); } if (series.dataLabelsGroup) { series.dataLabelsGroup.attr(seriesAttribs); } } }); // Clip chart.clipRect.attr(clip || chart.clipBox); }; /** * Set the JS DOM events on the container and document. This method should * contain a one-to-one assignment between methods and their handlers. Any * advanced logic should be moved to the handler reflecting the event's * name. * * @private * @function Highcharts.Pointer#setDOMEvents * * @return {void} */ Pointer.prototype.setDOMEvents = function () { var container = this.chart.container, ownerDoc = container.ownerDocument; container.onmousedown = this.onContainerMouseDown.bind(this); container.onmousemove = this.onContainerMouseMove.bind(this); container.onclick = this.onContainerClick.bind(this); this.unbindContainerMouseLeave = addEvent(container, 'mouseleave', this.onContainerMouseLeave.bind(this)); if (!H.unbindDocumentMouseUp) { H.unbindDocumentMouseUp = addEvent(ownerDoc, 'mouseup', this.onDocumentMouseUp.bind(this)); } if (H.hasTouch) { addEvent(container, 'touchstart', this.onContainerTouchStart.bind(this)); addEvent(container, 'touchmove', this.onContainerTouchMove.bind(this)); if (!H.unbindDocumentTouchEnd) { H.unbindDocumentTouchEnd = addEvent(ownerDoc, 'touchend', this.onDocumentTouchEnd.bind(this)); } } }; /** * Sets the index of the hovered chart and leaves the previous hovered * chart, to reset states like tooltip. * * @private * @function Highcharts.Pointer#setHoverChartIndex */ Pointer.prototype.setHoverChartIndex = function () { var chart = this.chart; var hoverChart = H.charts[pick(H.hoverChartIndex, -1)]; if (hoverChart && hoverChart !== chart) { hoverChart.pointer.onContainerMouseLeave({ relatedTarget: true }); } if (!hoverChart || !hoverChart.mouseIsDown) { H.hoverChartIndex = chart.index; } }; /** * General touch handler shared by touchstart and touchmove. * * @private * @function Highcharts.Pointer#touch * * @param {Highcharts.PointerEventObject} e * * @param {boolean} [start] * * @return {void} */ Pointer.prototype.touch = function (e, start) { var chart = this.chart, hasMoved, pinchDown, isInside; this.setHoverChartIndex(); if (e.touches.length === 1) { e = this.normalize(e); isInside = chart.isInsidePlot(e.chartX - chart.plotLeft, e.chartY - chart.plotTop); if (isInside && !chart.openMenu) { // Run mouse events and display tooltip etc if (start) { this.runPointActions(e); } // Android fires touchmove events after the touchstart even if // the finger hasn't moved, or moved only a pixel or two. In iOS // however, the touchmove doesn't fire unless the finger moves // more than ~4px. So we emulate this behaviour in Android by // checking how much it moved, and cancelling on small // distances. #3450. if (e.type === 'touchmove') { pinchDown = this.pinchDown; hasMoved = pinchDown[0] ? Math.sqrt(// #5266 Math.pow(pinchDown[0].chartX - e.chartX, 2) + Math.pow(pinchDown[0].chartY - e.chartY, 2)) >= 4 : false; } if (pick(hasMoved, true)) { this.pinch(e); } } else if (start) { // Hide the tooltip on touching outside the plot area (#1203) this.reset(); } } else if (e.touches.length === 2) { this.pinch(e); } }; /** * Resolve the zoomType option, this is reset on all touch start and mouse * down events. * * @private * @function Highcharts.Pointer#zoomOption * * @param {global.Event} e * Event object. * * @param {void} */ Pointer.prototype.zoomOption = function (e) { var chart = this.chart, options = chart.options.chart, zoomType = options.zoomType || '', inverted = chart.inverted, zoomX, zoomY; // Look for the pinchType option if (/touch/.test(e.type)) { zoomType = pick(options.pinchType, zoomType); } this.zoomX = zoomX = /x/.test(zoomType); this.zoomY = zoomY = /y/.test(zoomType); this.zoomHor = (zoomX && !inverted) || (zoomY && inverted); this.zoomVert = (zoomY && !inverted) || (zoomX && inverted); this.hasZoom = zoomX || zoomY; }; return Pointer; }()); H.Pointer = Pointer; export default H.Pointer;