var imageOutputBinding = new OutputBinding(); $.extend(imageOutputBinding, { find: function(scope) { return $(scope).find('.shiny-image-output, .shiny-plot-output'); }, renderValue: function(el, data) { // The overall strategy: // * Clear out existing image and event handlers. // * Create new image. // * Create various event handlers. // * Bind those event handlers to events. // * Insert the new image. var $el = $(el); // Load the image before emptying, to minimize flicker var img = null; // Remove event handlers that were added in previous renderValue() $el.off('.image_output'); // Trigger custom 'remove' event for any existing images in the div $el.find('img').trigger('remove'); if (!data) { $el.empty(); return; } var opts = { clickId: $el.data('click-id'), clickClip: strToBool($el.data('click-clip')) || true, dblclickId: $el.data('dblclick-id'), dblclickClip: strToBool($el.data('dblclick-clip')) || true, dblclickDelay: $el.data('dblclick-delay') || 400, hoverId: $el.data('hover-id'), hoverClip: $el.data('hover-clip') || true, hoverDelayType: $el.data('hover-delay-type') || 'debounce', hoverDelay: $el.data('hover-delay') || 300, brushId: $el.data('brush-id'), brushClip: strToBool($el.data('brush-clip')) || true, brushDelayType: $el.data('brush-delay-type') || 'debounce', brushDelay: $el.data('brush-delay') || 300, brushFill: $el.data('brush-fill') || '#666', brushStroke: $el.data('brush-stroke') || '#000', brushOpacity: $el.data('brush-opacity') || 0.3, brushDirection: $el.data('brush-direction') || 'xy', brushResetOnNew: strToBool($el.data('brush-reset-on-new')) || false, coordmap: data.coordmap }; img = document.createElement('img'); // Copy items from data to img. This should include 'src' $.each(data, function(key, value) { if (value !== null) img[key] = value; }); var $img = $(img); if (!opts.coordmap) opts.coordmap = []; imageutils.initCoordmap($el, opts.coordmap); // This object listens for mousedowns, and triggers mousedown2 and dblclick2 // events as appropriate. var clickInfo = imageutils.createClickInfo($el, opts.dblclickId, opts.dblclickDelay); $el.on('mousedown.image_output', clickInfo.mousedown); if (browser.isIE && browser.IEVersion === 8) { $el.on('dblclick.image_output', clickInfo.dblclickIE8); } // ---------------------------------------------------------- // Register the various event handlers // ---------------------------------------------------------- if (opts.clickId) { var clickHandler = imageutils.createClickHandler(opts.clickId, opts.clickClip, opts.coordmap); $el.on('mousedown2.image_output', clickHandler.mousedown); // When img is removed, do housekeeping: clear $el's mouse listener and // call the handler's onRemoveImg callback. $img.on('remove', clickHandler.onRemoveImg); } if (opts.dblclickId) { // We'll use the clickHandler's mousedown function, but register it to // our custom 'dblclick2' event. var dblclickHandler = imageutils.createClickHandler(opts.dblclickId, opts.clickClip, opts.coordmap); $el.on('dblclick2.image_output', dblclickHandler.mousedown); $img.on('remove', dblclickHandler.onRemoveImg); } if (opts.hoverId) { var hoverHandler = imageutils.createHoverHandler(opts.hoverId, opts.hoverDelay, opts.hoverDelayType, opts.hoverClip, opts.coordmap); $el.on('mousemove.image_output', hoverHandler.mousemove); $img.on('remove', hoverHandler.onRemoveImg); } if (opts.brushId) { // Make image non-draggable (Chrome, Safari) $img.css('-webkit-user-drag', 'none'); // Firefox, IE<=10 $img.on('dragstart', function() { return false; }); // Disable selection of image and text when dragging in IE<=10 $el.on('selectstart.image_output', function() { return false; }); var brushHandler = imageutils.createBrushHandler(opts.brushId, $el, opts, opts.coordmap); $el.on('mousedown.image_output', brushHandler.mousedown); $el.on('mousemove.image_output', brushHandler.mousemove); $img.on('remove', brushHandler.onRemoveImg); } if (opts.clickId || opts.dblclickId || opts.hoverId || opts.brushId) { $el.addClass('crosshair'); } // Remove all elements except brush, usually image plus error messages. // These extra contortions are needed to select the bare text of error // message. $el.contents().filter(function() { return this.id !== el.id + '_brush'; }).remove(); if (img) $el.append(img); } }); outputBindings.register(imageOutputBinding, 'shiny.imageOutput'); var imageutils = {}; // Modifies the panel objects in a coordmap, adding scale_x, scale_y, // scaleinv_x, scaleinv_y functions to each one. imageutils.initPanelScales = function(coordmap) { // Map a value x from a domain to a range. If clip is true, clip it to the // range. function mapLinear(x, domainMin, domainMax, rangeMin, rangeMax, clip) { // By default, clip to range clip = clip || true; var factor = (rangeMax - rangeMin) / (domainMax - domainMin); var val = x - domainMin; var newval = (val * factor) + rangeMin; if (clip) { var max = Math.max(rangeMax, rangeMin); var min = Math.min(rangeMax, rangeMin); if (newval > max) newval = max; else if (newval < min) newval = min; } return newval; } // Create scale and inverse-scale functions for a single direction (x or y). function scaler1D(domainMin, domainMax, rangeMin, rangeMax, logbase) { return { scale: function(val, clip) { if (logbase) val = Math.log(val) / Math.log(logbase); return mapLinear(val, domainMin, domainMax, rangeMin, rangeMax, clip); }, scaleInv: function(val, clip) { var res = mapLinear(val, rangeMin, rangeMax, domainMin, domainMax, clip); if (logbase) res = Math.pow(logbase, res); return res; } }; } // Modify panel, adding scale and inverse-scale functions that take objects // like {x:1, y:3}, and also add clip function. function addScaleFuns(panel) { var d = panel.domain; var r = panel.range; var xlog = (panel.log && panel.log.x) ? panel.log.x : null; var ylog = (panel.log && panel.log.y) ? panel.log.y : null; var xscaler = scaler1D(d.left, d.right, r.left, r.right, xlog); var yscaler = scaler1D(d.bottom, d.top, r.bottom, r.top, ylog); panel.scale = function(val, clip) { return { x: xscaler.scale(val.x, clip), y: yscaler.scale(val.y, clip) }; }; panel.scaleInv = function(val, clip) { return { x: xscaler.scaleInv(val.x, clip), y: yscaler.scaleInv(val.y, clip) }; }; // Given a scaled offset (in pixels), clip it to the nearest panel region. panel.clip = function(offset) { var newOffset = { x: offset.x, y: offset.y }; var bounds = panel.range; if (offset.x > bounds.right) newOffset.x = bounds.right; else if (offset.x < bounds.left) newOffset.x = bounds.left; if (offset.y > bounds.bottom) newOffset.y = bounds.bottom; else if (offset.y < bounds.top) newOffset.y = bounds.top; return newOffset; }; } // Add the functions to each panel object. for (var i=0; i max) { shiftAmount = max - maxval; } else if (minval < min) { shiftAmount = min - minval; } var newvals = []; for (var i=0; i= b.left - expand && y <= b.bottom + expand && y >= b.top - expand) { matches.push(coordmap[i]); // Find distance from edges for x and y var xdist = 0; var ydist = 0; if (x > b.right && x <= b.right + expand) { xdist = x - b.right; } else if (x < b.left && x >= b.left - expand) { xdist = x - b.left; } if (y > b.bottom && y <= b.bottom + expand) { ydist = y - b.bottom; } else if (y < b.top && y >= b.top - expand) { ydist = y - b.top; } // Cartesian distance dists.push(Math.sqrt( Math.pow(xdist, 2) + Math.pow(ydist, 2) )); } } if (matches.length) { // Find shortest distance var min_dist = Math.min.apply(null, dists); for (i=0; i 2 || Math.abs(pending_e.offsetY - e.offsetY) > 2) { triggerPendingMousedown2(); scheduleMousedown2(e); } else { // The second click was close to the first one. If it happened // within specified delay, trigger our custom 'dblclick2' event. pending_e = null; triggerEvent('dblclick2', e); } } } // IE8 needs a special hack because when you do a double-click it doesn't // trigger the click event twice - it directly triggers dblclick. function dblclickIE8(e) { e.which = 1; // In IE8, e.which is 0 instead of 1. ??? triggerEvent('dblclick2', e); } return { mousedown: mousedown, dblclickIE8: dblclickIE8 }; }; // ---------------------------------------------------------- // Handler creators for click, hover, brush. // Each of these returns an object with a few public members. These public // members are callbacks that are meant to be bound to events on $el with // the same name (like 'mousedown'). // ---------------------------------------------------------- imageutils.createClickHandler = function(inputId, clip, coordmap) { var clickInfoSender = coordmap.mouseCoordinateSender(inputId, clip); return { mousedown: function(e) { // Listen for left mouse button only if (e.which !== 1) return; clickInfoSender(e); }, onRemoveImg: function() { clickInfoSender(null); } }; }; imageutils.createHoverHandler = function(inputId, delay, delayType, clip, coordmap) { var sendHoverInfo = coordmap.mouseCoordinateSender(inputId, clip); var hoverInfoSender; if (delayType === 'throttle') hoverInfoSender = new Throttler(null, sendHoverInfo, delay); else hoverInfoSender = new Debouncer(null, sendHoverInfo, delay); return { mousemove: function(e) { hoverInfoSender.normalCall(e); }, onRemoveImg: function() { hoverInfoSender.immediateCall(null); } }; }; // Returns a brush handler object. This has three public functions: // mousedown, mousemove, and onRemoveImg. imageutils.createBrushHandler = function(inputId, $el, opts, coordmap) { // Parameter: expand the area in which a brush can be started, by this // many pixels in all directions. (This should probably be a brush option) var expandPixels = 20; // Represents the state of the brush var brush = imageutils.createBrush($el, opts, coordmap, expandPixels); // Set cursor to one of 3 styles. We need to set the cursor on the whole // el instead of the brush div, because the brush div has // 'pointer-events:none' so that it won't intercept pointer events. // If `style` is null, don't add a cursor style. function setCursorStyle(style) { $el.removeClass('crosshair'); $el.removeClass('grabbable'); $el.removeClass('grabbing'); if (style) $el.addClass(style); } function sendBrushInfo() { var bounds = brush.boundsPx(); // We're in a new or reset state if (isNaN(bounds.xmin)) { exports.onInputChange(inputId, null); return; } // Transform coordinates of brush to data space // TODO: remove this - use brush API var panel = coordmap.getPanel({ x: bounds.xmin, y: bounds.ymin }, expandPixels); var min = panel.scaleInv({ x: bounds.xmin, y: bounds.ymin }, opts.brushClip); var max = panel.scaleInv({ x: bounds.xmax, y: bounds.ymax }, opts.brushClip); // Because the x and y directions of the pixel space may differ from // the x and y directions of the data space, we need to recalculate // the min and max. var coords = { xmin: Math.min(min.x, max.x), xmax: Math.max(min.x, max.x), ymin: Math.min(min.y, max.y), ymax: Math.max(min.y, max.y) }; // Add the panel (facet) variables, if present if (panel.vars) { var v; for (var i=0; i= bounds.xmin && offset.y <= bounds.ymax && offset.y >= bounds.ymin; } // Sets the bounds of the brush, given a box and optional panel. This // will fit the box bounds into the panel, so we don't brush outside of it. // This knows whether we're brushing in the x, y, or xy directions, and sets // bounds accordingly. // If no box is passed in, return current bounds. function boundsPx(box) { if (box === undefined) return state.boundsPx; var min = { x: box.xmin, y: box.ymin }; var max = { x: box.xmax, y: box.ymax }; var panel = state.panel; var panelBounds = panel.range; if (opts.brushClip) { min = panel.clip(min); max = panel.clip(max); } if (opts.brushDirection === 'xy') { // No change } else if (opts.brushDirection === 'x') { // Extend top and bottom of plotting area min.y = panelBounds.top; max.y = panelBounds.bottom; } else if (opts.brushDirection === 'y') { min.x = panelBounds.left; max.x = panelBounds.right; } state.boundsPx = { xmin: min.x, xmax: max.x, ymin: min.y, ymax: max.y }; // Positions in data space var minData = state.panel.scaleInv(min); var maxData = state.panel.scaleInv(max); state.boundsData = { xmin: minData.x, xmax: maxData.x, ymin: minData.y, ymax: maxData.y }; // We also need to attach the data bounds and panel as data attributes, so // that if the image is re-sent, we can grab the data bounds to create a new // brush. This should be fast because it doesn't actually modify the DOM. $div.data('bounds-data', state.boundsData); $div.data('panel', state.panel); } // Get or set the bounds of the brush using coordinates in the data space. function boundsData(box) { if (box === undefined) { coordmap.scaleInvBox(boundsPx()); } var min = { x: box.xmin, y: box.ymin }; var max = { x: box.xmax, y: box.ymax }; var minPx = state.panel.scale(min); var maxPx = state.panel.scale(max); boundsPx({ xmin: minPx.x, xmax: maxPx.x, ymin: minPx.y, ymax: maxPx.y }); } // Add a new div representing the brush. function addDiv() { if ($div) $div.remove(); $div = $(document.createElement('div')) .attr('id', el.id + '_brush') .css({ 'background-color': opts.brushFill, 'opacity': opts.brushOpacity, 'pointer-events': 'none', 'position': 'absolute' }); var borderStyle = '1px solid ' + opts.brushStroke; if (opts.brushDirection === 'xy') { $div.css({ 'border': borderStyle }); } else if (opts.brushDirection === 'x') { $div.css({ 'border-left': borderStyle, 'border-right': borderStyle }); } else if (opts.brushDirection === 'y') { $div.css({ 'border-top': borderStyle, 'border-bottom': borderStyle }); } $el.append($div); $div.offset({x:0, y:0}).width(0).outerHeight(0).show(); } // Update the brush div to reflect the current brush bounds. function updateDiv() { // Need parent offset relative to page to calculate mouse offset // relative to page. var imgOffset = $el.offset(); var b = state.boundsPx; $div.offset({ top: imgOffset.top + b.ymin, left: imgOffset.left + b.xmin }) .outerWidth(b.xmax - b.xmin) .outerHeight(b.ymax - b.ymin) .show(); } function down(offset) { if (offset === undefined) return state.down; state.down = offset; } function up(offset) { if (offset === undefined) return state.up; state.up = offset; } function isBrushing() { return state.brushing; } function startBrushing() { state.brushing = true; addDiv(); state.panel = coordmap.getPanel(state.down, expandPixels); boundsPx(coordmap.findBox(state.down, state.down)); updateDiv(); } function brushTo(offset) { boundsPx(coordmap.findBox(state.down, offset)); updateDiv(); } function stopBrushing() { state.brushing = false; // Save the final bounding box of the brush boundsPx(coordmap.findBox(state.down, state.up)); } function isDragging() { return state.dragging; } function startDragging() { state.dragging = true; state.dragStartBounds = $.extend({}, state.boundsPx); } function dragTo(offset) { // How far the brush was dragged var dx = offset.x - state.down.x; var dy = offset.y - state.down.y; // Calculate what new start/end positions would be, before clipping. var start = state.dragStartBounds; var newBounds = { xmin: start.xmin + dx, xmax: start.xmax + dx, ymin: start.ymin + dy, ymax: start.ymax + dy }; // Clip to the plotting area if (opts.brushClip) { // Get the panel that we started dragging in var panelBounds = coordmap.getPanel(state.down, expandPixels).range; // Convert to format for shiftToRange var xvals = [ newBounds.xmin, newBounds.xmax ]; var yvals = [ newBounds.ymin, newBounds.ymax ]; xvals = coordmap.shiftToRange(xvals, panelBounds.left, panelBounds.right); yvals = coordmap.shiftToRange(yvals, panelBounds.top, panelBounds.bottom); // Convert back to bounds format newBounds = { xmin: xvals[0], xmax: xvals[1], ymin: yvals[0], ymax: yvals[1] }; } boundsPx(newBounds); updateDiv(); } function stopDragging() { state.dragging = false; } return { reset: reset, importOldBrush: importOldBrush, isInsideBrush: isInsideBrush, boundsPx: boundsPx, down: down, up: up, isBrushing: isBrushing, startBrushing: startBrushing, brushTo: brushTo, stopBrushing: stopBrushing, isDragging: isDragging, startDragging: startDragging, dragTo: dragTo, stopDragging: stopDragging }; };