Move and resize line shapes #2594
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -108,77 +108,143 @@ function drawOne(gd, index) { | |
| .call(Color.fill, options.fillcolor) | ||
| .call(Drawing.dashLine, options.line.dash, options.line.width); | ||
|
|
||
| setClipPath(path, gd, options); | ||
|
|
||
| if(gd._context.edits.shapePosition) setupDragElement(gd, path, options, index, shapeLayer); | ||
| } | ||
| } | ||
|
|
||
| function setClipPath(shapePath, gd, shapeOptions) { | ||
| // note that for layer="below" the clipAxes can be different from the | ||
| // subplot we're drawing this in. This could cause problems if the shape | ||
| // spans two subplots. See https://github.com/plotly/plotly.js/issues/1452 | ||
| var clipAxes = (shapeOptions.xref + shapeOptions.yref).replace(/paper/g, ''); | ||
|
|
||
| shapePath.call(Drawing.setClipUrl, clipAxes ? | ||
| ('clip' + gd._fullLayout._uid + clipAxes) : | ||
| null | ||
| ); | ||
| } | ||
|
|
||
| function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer) { | ||
| var MINWIDTH = 10, | ||
| MINHEIGHT = 10; | ||
|
|
||
| var xPixelSized = shapeOptions.xsizemode === 'pixel', | ||
| yPixelSized = shapeOptions.ysizemode === 'pixel', | ||
| isLine = shapeOptions.type === 'line', | ||
| isPath = shapeOptions.type === 'path'; | ||
|
|
||
| var update; | ||
| var x0, y0, x1, y1, xAnchor, yAnchor, astrX0, astrY0, astrX1, astrY1, astrXAnchor, astrYAnchor; | ||
| var n0, s0, w0, e0, astrN, astrS, astrW, astrE, optN, optS, optW, optE; | ||
| var pathIn, astrPath; | ||
|
|
||
| // setup conversion functions | ||
| var xa = Axes.getFromId(gd, shapeOptions.xref), | ||
| ya = Axes.getFromId(gd, shapeOptions.yref), | ||
| x2p = helpers.getDataToPixel(gd, xa), | ||
| y2p = helpers.getDataToPixel(gd, ya, true), | ||
| p2x = helpers.getPixelToData(gd, xa), | ||
| p2y = helpers.getPixelToData(gd, ya, true); | ||
|
|
||
| var sensoryElement = obtainSensoryElement(); | ||
| var dragOptions = { | ||
| element: sensoryElement.node(), | ||
| gd: gd, | ||
| prepFn: startDrag, | ||
| doneFn: endDrag, | ||
| clickFn: abortDrag | ||
| }, | ||
| dragMode; | ||
|
|
||
| dragElement.init(dragOptions); | ||
|
|
||
| sensoryElement.node().onmousemove = updateDragMode; | ||
|
|
||
| function obtainSensoryElement() { | ||
| return isLine ? createLineDragHandles() : shapePath; | ||
| } | ||
|
|
||
| function createLineDragHandles() { | ||
| var minSensoryWidth = 10, | ||
|
There was a problem hiding this comment. Might want to move this into https://github.com/plotly/plotly.js/blob/master/src/constants/interactions.js? This behavior for annotations is even more ugly and hard-coded plotly.js/src/components/annotations/draw.js Lines 536 to 540 in 2b1713d It wouldn't need to be changed now, but if we were to move this to a constants file and reuse it in annotations, I like the Math.max logic you have here better than the width + 6 currently in annotations (though the little-bit-extra around the head should be preserved).
|
||
| sensoryWidth = Math.max(shapeOptions.line.width, minSensoryWidth); | ||
|
|
||
| // Helper shapes group | ||
| // Note that by setting the `data-index` attr, it is ensured that | ||
| // the helper group is purged in this modules `draw` function | ||
| var g = shapeLayer.append('g') | ||
| .attr('data-index', index); | ||
|
|
||
| // Helper path for moving | ||
| g.append('path') | ||
| .attr('d', shapePath.attr('d')) | ||
| .style({ | ||
| 'cursor': 'move', | ||
| 'stroke-width': sensoryWidth, | ||
| 'stroke-opacity': '0' // ensure not visible | ||
| }); | ||
|
|
||
| // Helper circles for resizing | ||
| var circleStyle = { | ||
| 'fill-opacity': '0' // ensure not visible | ||
| }; | ||
| var circleRadius = sensoryWidth / 2 > minSensoryWidth ? sensoryWidth / 2 : minSensoryWidth; | ||
|
|
||
| g.append('circle') | ||
| .attr({ | ||
| 'data-line-point': 'start-point', | ||
| 'cx': xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x0 : x2p(shapeOptions.x0), | ||
| 'cy': yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y0 : y2p(shapeOptions.y0), | ||
| 'r': circleRadius | ||
| }) | ||
| .style(circleStyle) | ||
| .classed('cursor-grab', true); | ||
|
|
||
| g.append('circle') | ||
| .attr({ | ||
| 'data-line-point': 'end-point', | ||
| 'cx': xPixelSized ? x2p(shapeOptions.xanchor) + shapeOptions.x1 : x2p(shapeOptions.x1), | ||
| 'cy': yPixelSized ? y2p(shapeOptions.yanchor) - shapeOptions.y1 : y2p(shapeOptions.y1), | ||
| 'r': circleRadius | ||
| }) | ||
| .style(circleStyle) | ||
| .classed('cursor-grab', true); | ||
|
|
||
| return g; | ||
| } | ||
|
|
||
| function updateDragMode(evt) { | ||
| if(isLine) { | ||
| if(evt.target.tagName === 'path') { | ||
| dragMode = 'move'; | ||
| } else { | ||
| dragMode = evt.target.attributes['data-line-point'].value === 'start-point' ? | ||
| 'resize-over-start-point' : 'resize-over-end-point'; | ||
| } | ||
| } else { | ||
| // element might not be on screen at time of setup, | ||
| // so obtain bounding box here | ||
| var dragBBox = dragOptions.element.getBoundingClientRect(); | ||
|
|
||
| // choose 'move' or 'resize' | ||
| // based on initial position of cursor within the drag element | ||
| var w = dragBBox.right - dragBBox.left, | ||
| h = dragBBox.bottom - dragBBox.top, | ||
| x = evt.clientX - dragBBox.left, | ||
| y = evt.clientY - dragBBox.top, | ||
| cursor = (!isPath && w > MINWIDTH && h > MINHEIGHT && !evt.shiftKey) ? | ||
|
There was a problem hiding this comment. nice catch - and thanks for updating the comment below! |
||
| dragElement.getCursor(x / w, 1 - y / h) : | ||
| 'move'; | ||
|
|
||
| setCursor(shapePath, cursor); | ||
|
|
||
| // possible values 'move', 'sw', 'w', 'se', 'e', 'ne', 'n', 'nw' and 'w' | ||
| dragMode = cursor.split('-')[0]; | ||
| } | ||
| } | ||
|
|
||
| function startDrag(evt) { | ||
| // setup update strings and initial values | ||
| var astr = 'shapes[' + index + ']'; | ||
|
|
||
|
|
@@ -231,14 +297,24 @@ function setupDragElement(gd, shapePath, shapeOptions, index) { | |
|
|
||
| // setup dragMode and the corresponding handler | ||
| updateDragMode(evt); | ||
| renderVisualCues(shapeLayer, shapeOptions); | ||
| deactivateClipPathTemporarily(shapePath, shapeOptions, gd); | ||
| dragOptions.moveFn = (dragMode === 'move') ? moveShape : resizeShape; | ||
| } | ||
|
|
||
| function endDrag() { | ||
| setCursor(shapePath); | ||
| removeVisualCues(shapeLayer); | ||
|
|
||
| // Don't rely on clipPath being activated during re-layout | ||
| setClipPath(shapePath, gd, shapeOptions); | ||
| Registry.call('relayout', gd, update); | ||
| } | ||
|
|
||
| function abortDrag() { | ||
| removeVisualCues(shapeLayer); | ||
| } | ||
|
|
||
| function moveShape(dx, dy) { | ||
| if(shapeOptions.type === 'path') { | ||
| var noOp = function(coord) { return coord; }, | ||
|
|
@@ -279,11 +355,12 @@ function setupDragElement(gd, shapePath, shapeOptions, index) { | |
| } | ||
|
|
||
| shapePath.attr('d', getPathString(gd, shapeOptions)); | ||
| renderVisualCues(shapeLayer, shapeOptions); | ||
| } | ||
|
|
||
| function resizeShape(dx, dy) { | ||
| if(isPath) { | ||
| // TODO: implement path resize, don't forget to update dragMode code | ||
| var noOp = function(coord) { return coord; }, | ||
| moveX = noOp, | ||
| moveY = noOp; | ||
|
|
@@ -305,6 +382,19 @@ function setupDragElement(gd, shapePath, shapeOptions, index) { | |
| shapeOptions.path = movePath(pathIn, moveX, moveY); | ||
| update[astrPath] = shapeOptions.path; | ||
| } | ||
| else if(isLine) { | ||
| if(dragMode === 'resize-over-start-point') { | ||
| var newX0 = x0 + dx; | ||
| var newY0 = yPixelSized ? y0 - dy : y0 + dy; | ||
| update[astrX0] = shapeOptions.x0 = xPixelSized ? newX0 : p2x(newX0); | ||
| update[astrY0] = shapeOptions.y0 = yPixelSized ? newY0 : p2y(newY0); | ||
| } else if(dragMode === 'resize-over-end-point') { | ||
| var newX1 = x1 + dx; | ||
| var newY1 = yPixelSized ? y1 - dy : y1 + dy; | ||
| update[astrX1] = shapeOptions.x1 = xPixelSized ? newX1 : p2x(newX1); | ||
| update[astrY1] = shapeOptions.y1 = yPixelSized ? newY1 : p2y(newY1); | ||
| } | ||
| } | ||
| else { | ||
| var newN = (~dragMode.indexOf('n')) ? n0 + dy : n0, | ||
| newS = (~dragMode.indexOf('s')) ? s0 + dy : s0, | ||
|
|
@@ -330,6 +420,68 @@ function setupDragElement(gd, shapePath, shapeOptions, index) { | |
| } | ||
|
|
||
| shapePath.attr('d', getPathString(gd, shapeOptions)); | ||
| renderVisualCues(shapeLayer, shapeOptions); | ||
| } | ||
|
|
||
| function renderVisualCues(shapeLayer, shapeOptions) { | ||
| if(xPixelSized || yPixelSized) { | ||
| renderAnchor(); | ||
| } | ||
|
|
||
| function renderAnchor() { | ||
| var isNotPath = shapeOptions.type !== 'path'; | ||
|
|
||
| // d3 join with dummy data to satisfy d3 data-binding | ||
| var visualCues = shapeLayer.selectAll('.visual-cue').data([0]); | ||
|
|
||
| // Enter | ||
| visualCues.enter() | ||
| .append('path') | ||
| .attr({ | ||
| 'fill': '#fff', | ||
| 'fill-rule': 'evenodd', | ||
| 'stroke': '#000', | ||
| 'stroke-width': 1 | ||
| }) | ||
| .classed('visual-cue', true); | ||
|
|
||
| // Update | ||
| var anchorX = x2p(xPixelSized ? | ||
| shapeOptions.xanchor : | ||
| isNotPath ? | ||
| shapeOptions.x0 : | ||
| helpers.extractPathCoords(shapeOptions.path, constants.paramIsX)[0]); | ||
| var anchorY = y2p(yPixelSized ? | ||
| shapeOptions.yanchor : | ||
| isNotPath ? | ||
| shapeOptions.y0 : | ||
| helpers.extractPathCoords(shapeOptions.path, constants.paramIsY)[0]); | ||
|
|
||
| var crossHairPath = 'M' + (anchorX - 1) + ',' + (anchorY - 1) + | ||
| 'l-8,0 l0,-2 l8,0 l0,-8 l2,0 l0,8 l8,0 l0,2 l-8,0 l0,8 l-2,0 Z'; | ||
|
|
||
| visualCues.attr('d', crossHairPath); | ||
| } | ||
| } | ||
|
|
||
| function removeVisualCues(shapeLayer) { | ||
| shapeLayer.selectAll('.visual-cue').remove(); | ||
| } | ||
|
|
||
| function deactivateClipPathTemporarily(shapePath, shapeOptions, gd) { | ||
| var xref = shapeOptions.xref, | ||
| yref = shapeOptions.yref, | ||
| xa = Axes.getFromId(gd, xref), | ||
| ya = Axes.getFromId(gd, yref); | ||
|
|
||
| var clipAxes = ''; | ||
| if(xref !== 'paper' && !xa.autorange) clipAxes += xref; | ||
| if(yref !== 'paper' && !ya.autorange) clipAxes += yref; | ||
|
|
||
| shapePath.call(Drawing.setClipUrl, clipAxes ? | ||
| 'clip' + gd._fullLayout._uid + clipAxes : | ||
| null | ||
| ); | ||
| } | ||
| } | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That issue is closed - is there still a case where this currently breaks? I see #1452 (comment) about layering and inset plots, is that what you're referring to?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh sorry, you just copied this comment on refactor. NVM!