Share chart button #7802
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| 'use strict'; | ||
|
|
||
| var d3 = require('@plotly/d3'); | ||
|
|
||
| /** | ||
| * Show a styled confirmation dialog before sharing a chart with Plotly Cloud. | ||
| * | ||
| * The dialog is appended to the plot's positioning container (.svg-container) | ||
| * so it is centered over the plot rather than the whole viewport. It can be | ||
| * dismissed by clicking Cancel, clicking the backdrop, or pressing Escape. | ||
| * | ||
| * @param {DOM node} gd - the graph div, used to scope the dialog to the plot | ||
| * @param {string} serverUrl - destination shown in the dialog message | ||
| * @param {function} onConfirm - called when the user confirms the upload | ||
| */ | ||
| module.exports = function confirmCloudDialog(gd, serverUrl, onConfirm) { | ||
| var container = d3.select(gd._fullLayout._paperdiv.node()); | ||
|
|
||
| // Never stack dialogs - drop any that is already open. | ||
| container.selectAll('.plotly-cloud-dialog').remove(); | ||
|
|
||
| var overlay = container | ||
| .append('div') | ||
| .classed('plotly-cloud-dialog', true); | ||
|
|
||
| var dialog = overlay.append('div') | ||
| .classed('plotly-cloud-dialog-box', true); | ||
|
|
||
| dialog.append('div') | ||
| .classed('plotly-cloud-dialog-title', true) | ||
| .text('Share with Plotly Cloud'); | ||
|
|
||
| dialog.append('div') | ||
| .classed('plotly-cloud-dialog-message', true) | ||
| .text('Your chart data will be sent to ' + serverUrl + '.'); | ||
|
|
||
| var buttons = dialog.append('div') | ||
| .classed('plotly-cloud-dialog-buttons', true); | ||
|
|
||
| function close() { | ||
| overlay.remove(); | ||
| document.removeEventListener('keydown', onKeydown); | ||
| } | ||
|
|
||
| function onKeydown(e) { | ||
| if(e.key === 'Escape' || e.keyCode === 27) close(); | ||
| } | ||
| document.addEventListener('keydown', onKeydown); | ||
|
|
||
| // Clicking the backdrop (but not the dialog box) cancels. | ||
| overlay.on('click', function() { | ||
| if(d3.event.target === overlay.node()) close(); | ||
| }); | ||
|
|
||
| buttons.append('button') | ||
| .classed('plotly-cloud-dialog-btn', true) | ||
| .classed('plotly-cloud-dialog-btn--cancel', true) | ||
| .text('Cancel') | ||
| .on('click', close); | ||
|
|
||
| buttons.append('button') | ||
| .classed('plotly-cloud-dialog-btn', true) | ||
| .classed('plotly-cloud-dialog-btn--confirm', true) | ||
| .text('Share') | ||
| .on('click', function() { | ||
| close(); | ||
| onConfirm(); | ||
| }); | ||
| }; | ||
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 |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| .plotly-cloud-dialog { | ||
| font-family: 'Open Sans', verdana, arial, sans-serif; // Because not all contexts have this specified. | ||
| position: absolute; | ||
| top: 0; | ||
| left: 0; | ||
| width: 100%; | ||
| height: 100%; | ||
| z-index: 1001; | ||
|
|
||
| display: flex; | ||
| align-items: center; | ||
| justify-content: center; | ||
|
|
||
| background-color: rgba(0, 0, 0, 0.4); | ||
|
|
||
| .plotly-cloud-dialog-box { | ||
| box-sizing: border-box; | ||
| min-width: 300px; | ||
| max-width: 420px; | ||
| padding: 20px 24px; | ||
|
|
||
| background-color: $color-bg-light; | ||
| border: 1px solid $color-bg-darker; | ||
| border-radius: 4px; | ||
| box-shadow: 0 4px 16px rgba(0, 0, 0, 0.25); | ||
|
|
||
| font-size: 13px; | ||
| color: #2a3f5f; | ||
| } | ||
|
|
||
| .plotly-cloud-dialog-title { | ||
| font-size: 16px; | ||
| font-weight: bold; | ||
| margin-bottom: 12px; | ||
| } | ||
|
|
||
| .plotly-cloud-dialog-message { | ||
| line-height: 1.5; | ||
| overflow-wrap: break-word; | ||
| word-wrap: break-word; | ||
| } | ||
|
|
||
| .plotly-cloud-dialog-buttons { | ||
| display: flex; | ||
| justify-content: flex-end; | ||
| margin-top: 20px; | ||
| } | ||
|
|
||
| .plotly-cloud-dialog-btn { | ||
| font-family: inherit; | ||
| font-size: 13px; | ||
| padding: 7px 16px; | ||
| margin-left: 8px; | ||
|
|
||
| border-radius: 3px; | ||
| border: 1px solid transparent; | ||
| cursor: pointer; | ||
|
|
||
| &:focus-visible { | ||
| outline: 2px solid $color-brand-primary; | ||
| outline-offset: 1px; | ||
| } | ||
| } | ||
|
|
||
| .plotly-cloud-dialog-btn--cancel { | ||
| background-color: $color-bg-light; | ||
| border-color: $color-bg-darker; | ||
| color: $color-muted-text; | ||
|
|
||
| &:hover { | ||
| background-color: $color-bg-base; | ||
| } | ||
| } | ||
|
|
||
| .plotly-cloud-dialog-btn--confirm { | ||
| background-color: $color-brand-primary; | ||
| color: $color-bg-light; | ||
|
|
||
| &:hover { | ||
| background-color: $color-brand-accent; | ||
| } | ||
| } | ||
| } |
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -6,6 +6,7 @@ var formatLocale = require('d3-format').formatLocale; | |||||
| var isNumeric = require('fast-isnumeric'); | ||||||
| var b64encode = require('base64-arraybuffer'); | ||||||
|
|
||||||
| var version = require('../version').version; | ||||||
| var Registry = require('../registry'); | ||||||
| var PlotSchema = require('../plot_api/plot_schema'); | ||||||
| var Template = require('../plot_api/plot_template'); | ||||||
|
|
@@ -202,35 +203,55 @@ function positionPlayWithData(gd, container) { | |||||
|
|
||||||
| plots.sendDataToCloud = function(gd) { | ||||||
| var baseUrl = (window.PLOTLYENV || {}).BASE_URL || gd._context.plotlyServerURL; | ||||||
| if(!baseUrl) { | ||||||
| console.error('No destination URL provided (plotlyServerURL is not set)'); | ||||||
| return; | ||||||
| } | ||||||
|
|
||||||
| // Plotly Cloud origin, used to validate incoming messages and to target outgoing ones. | ||||||
| // `baseUrl` (plotlyServerURL) is the upload page that handles login and signals | ||||||
| // back when authentication succeeds. | ||||||
| var cloudOrigin; | ||||||
| try { | ||||||
| cloudOrigin = new URL(baseUrl).origin; | ||||||
| } catch(e) { | ||||||
| console.error('Invalid plotlyServerURL: ' + baseUrl); | ||||||
| return; | ||||||
| } | ||||||
|
|
||||||
| gd.emit('plotly_beforeexport'); | ||||||
|
|
||||||
| // Build the request body: the chart JSON plus the plotly.js version used to | ||||||
| // generate it, so Cloud can host the chart with a compatible plotly.js version. | ||||||
| var chart = JSON.parse(plots.graphJson(gd, false, 'keepdata')); | ||||||
|
Contributor
Author
There was a problem hiding this comment. Can avoid serializing and de-serializing by doing this I think
Suggested change
|
||||||
| chart.version = version; | ||||||
|
|
||||||
| // Open the Cloud login page in a new tab. We keep a reference so we can post | ||||||
| // the chart back to it once Cloud reports that authentication succeeded. | ||||||
| var cloudWindow = window.open(baseUrl, '_blank'); | ||||||
| if(!cloudWindow) { | ||||||
| console.error('Unable to open Plotly Cloud (the popup may have been blocked)'); | ||||||
| gd.emit('plotly_afterexport'); | ||||||
|
Contributor
Author
There was a problem hiding this comment. May not want to emit |
||||||
| return; | ||||||
| } | ||||||
|
|
||||||
| var handleMessage = function(event) { | ||||||
| // Only trust messages coming from the Cloud origin. | ||||||
| if(event.origin !== cloudOrigin) return; | ||||||
|
|
||||||
| if(event.data && event.data.type === 'authenticated') { | ||||||
| cloudWindow.postMessage({ | ||||||
| type: 'chart', | ||||||
| chart: chart | ||||||
| }, cloudOrigin); | ||||||
|
|
||||||
| window.removeEventListener('message', handleMessage); | ||||||
| gd.emit('plotly_afterexport'); | ||||||
| } | ||||||
| }; | ||||||
|
|
||||||
| window.addEventListener('message', handleMessage); | ||||||
|
|
||||||
| return false; | ||||||
| }; | ||||||
|
|
||||||
|
|
||||||
Oops, something went wrong.
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.
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.
All of these strings should (eventually) be wrapped in the localization function (search for
Lib._(or_(to find where this is done elsewhere in the codebase)