Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
42c9601
add button placeholder which shows chart JSON
emilykl Apr 14, 2026
8ce5512
add icon
emilykl May 11, 2026
ad9ddfc
use existing sendChartToCloud function
emilykl May 14, 2026
100da7b
update plot-schema
emilykl May 14, 2026
82f5437
Update approach to use postMessage and wait for ready signal before s…
marthacryan May 28, 2026
fddd50e
Merge branch 'master' of github.com:plotly/plotly.js into upload-to-c…
marthacryan May 28, 2026
ba91b11
Create a confirmation dialog
marthacryan May 28, 2026
717fc26
Add default URL for plotlyServerURL
marthacryan May 28, 2026
8774b9c
Update string to indicate success
marthacryan Jun 9, 2026
13b8f12
Update src/plot_api/plot_config.js
marthacryan Jun 11, 2026
a44f6ef
Add localization
marthacryan Jun 11, 2026
836d24c
Address review
marthacryan Jun 11, 2026
1f47ebd
Update default cloud URL
marthacryan Jun 11, 2026
83deac2
Update src/components/modebar/cloud_confirm.js
marthacryan Jun 11, 2026
852dc1f
Set default to false for showSendToCloud
marthacryan Jun 11, 2026
4a71e43
Merge changes
marthacryan Jun 11, 2026
ff34976
Update plot-schema in dist
marthacryan Jun 11, 2026
e5933bd
Revert "Update plot-schema in dist"
emilykl Jun 15, 2026
c1b7122
update test/plot-schema.json
emilykl Jun 15, 2026
c28c434
Update default URL for upload to empty string until plotly cloud endp…
marthacryan Jun 16, 2026
da868be
Merge branch 'upload-to-cloud-proto' of github.com:plotly/plotly.js i…
marthacryan Jun 16, 2026
bf8971a
Update src/components/modebar/cloud_confirm.js
marthacryan Jun 16, 2026
ada548c
Update src/components/modebar/buttons.js
marthacryan Jun 16, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions build/plotcss.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,17 @@ var rules = {
"X [data-title]:after": "content:attr(data-title);background:#69738a;color:#fff;padding:8px 10px;font-size:12px;line-height:12px;white-space:nowrap;margin-right:-18px;border-radius:2px;",
"X .vertical [data-title]:before,X .vertical [data-title]:after": "top:0%;right:200%;",
"X .vertical [data-title]:before": "border:6px solid rgba(0,0,0,0);border-left-color:#69738a;margin-top:8px;margin-right:-30px;",
"X .plotly-cloud-dialog": "font-family:\"Open Sans\",verdana,arial,sans-serif;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,.4);",
"X .plotly-cloud-dialog .plotly-cloud-dialog-box": "box-sizing:border-box;min-width:300px;max-width:420px;padding:20px 24px;background-color:#fff;border:1px solid #e0e2e5;border-radius:4px;box-shadow:0 4px 16px rgba(0,0,0,.25);font-size:13px;color:#2a3f5f;",
"X .plotly-cloud-dialog .plotly-cloud-dialog-title": "font-size:16px;font-weight:bold;margin-bottom:12px;",
"X .plotly-cloud-dialog .plotly-cloud-dialog-message": "line-height:1.5;overflow-wrap:break-word;word-wrap:break-word;",
"X .plotly-cloud-dialog .plotly-cloud-dialog-buttons": "display:flex;justify-content:flex-end;margin-top:20px;",
"X .plotly-cloud-dialog .plotly-cloud-dialog-btn": "font-family:inherit;font-size:13px;padding:7px 16px;margin-left:8px;border-radius:3px;border:1px solid rgba(0,0,0,0);cursor:pointer;",
"X .plotly-cloud-dialog .plotly-cloud-dialog-btn:focus-visible": "outline:2px solid #447adb;outline-offset:1px;",
"X .plotly-cloud-dialog .plotly-cloud-dialog-btn--cancel": "background-color:#fff;border-color:#e0e2e5;color:#777;",
"X .plotly-cloud-dialog .plotly-cloud-dialog-btn--cancel:hover": "background-color:#f3f3f3;",
"X .plotly-cloud-dialog .plotly-cloud-dialog-btn--confirm": "background-color:#447adb;color:#fff;",
"X .plotly-cloud-dialog .plotly-cloud-dialog-btn--confirm:hover": "background-color:#1d3b84;",
Y: "font-family:\"Open Sans\",verdana,arial,sans-serif;position:fixed;top:50px;right:20px;z-index:10000;font-size:10pt;max-width:180px;",
"Y p": "margin:0;",
"Y .notifier-note": "min-width:180px;max-width:250px;border:1px solid #fff;z-index:3000;margin:0;background-color:#8c97af;background-color:rgba(140,151,175,.9);color:#fff;padding:10px;overflow-wrap:break-word;word-wrap:break-word;-ms-hyphens:auto;-webkit-hyphens:auto;hyphens:auto;",
Expand Down
25 changes: 12 additions & 13 deletions src/components/modebar/buttons.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ var Plots = require('../../plots/plots');
var axisIds = require('../../plots/cartesian/axis_ids');
var Icons = require('../../fonts/ploticon');
var eraseActiveShape = require('../shapes/draw').eraseActiveShape;
var confirmCloudDialog = require('./cloud_confirm');
var Lib = require('../../lib');
var _ = Lib._;

Expand Down Expand Up @@ -67,23 +68,21 @@ modeBarButtons.toImage = {
}
};

modeBarButtons.sendDataToCloud = {
name: 'sendDataToCloud',
title: function(gd) { return _(gd, 'Edit in Chart Studio'); },
icon: Icons.disk,
modeBarButtons.sendChartToCloud = {
name: 'sendChartToCloud',
title: function(gd) { return _(gd, 'Share with Plotly Cloud'); },
icon: Icons.cloudupload,
click: function(gd) {
Plots.sendDataToCloud(gd);
var serverUrl = (window.PLOTLYENV || {}).BASE_URL || gd._context.plotlyServerURL;

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO the URL validation steps (truthiness check and try { new URL(baseUrl).origin;}) should happen inside a validateURL function here, rather than inside Plots.sendDataToCloud(gd);, so that we don't even show the dialog at all if the URL is invalid.

confirmCloudDialog(gd, serverUrl, function() {
Plots.sendDataToCloud(gd);
});
}
};
Comment thread
marthacryan marked this conversation as resolved.

modeBarButtons.editInChartStudio = {
name: 'editInChartStudio',
title: function(gd) { return _(gd, 'Edit in Chart Studio'); },
icon: Icons.pencil,
click: function(gd) {
Plots.sendDataToCloud(gd);
}
};
// Alias to keep existing button name functional
// TODO: Remove for 4.0
modeBarButtons.sendDataToCloud = modeBarButtons.sendChartToCloud;

modeBarButtons.zoom2d = {
name: 'zoom2d',
Expand Down
71 changes: 71 additions & 0 deletions src/components/modebar/cloud_confirm.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
'use strict';

var d3 = require('@plotly/d3');

var _ = require('../../lib')._;

/**
* 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(_(gd, 'Share with Plotly Cloud'));

dialog.append('div')
.classed('plotly-cloud-dialog-message', true)
.text(_(gd, 'This chart and its 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(_(gd, 'Cancel'))
.on('click', close);

buttons.append('button')
.classed('plotly-cloud-dialog-btn', true)
.classed('plotly-cloud-dialog-btn--confirm', true)
.text(_(gd, 'Share'))
.on('click', function() {
close();
onConfirm();
});
};
3 changes: 1 addition & 2 deletions src/components/modebar/manage.js
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,7 @@ function getButtonGroups(gd) {

// buttons common to all plot types
var commonGroup = ['toImage'];
if(context.showEditInChartStudio) commonGroup.push('editInChartStudio');
else if(context.showSendToCloud) commonGroup.push('sendDataToCloud');
if(context.showSendToCloud) commonGroup.push('sendChartToCloud');
addGroup(commonGroup);

var zoomGroup = [];
Expand Down
83 changes: 83 additions & 0 deletions src/css/_cloud_dialog.scss
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;
}
}
}
1 change: 1 addition & 0 deletions src/css/style.scss
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@
@import "cursor.scss";
@import "modebar.scss";
@import "tooltip.scss";
@import "cloud_dialog.scss";
}
@import "notifier.scss";
6 changes: 6 additions & 0 deletions src/fonts/ploticon.js
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,12 @@ module.exports = {
path: 'm214-7h429v214h-429v-214z m500 0h72v500q0 8-6 21t-11 20l-157 156q-5 6-19 12t-22 5v-232q0-22-15-38t-38-16h-322q-22 0-37 16t-16 38v232h-72v-714h72v232q0 22 16 38t37 16h465q22 0 38-16t15-38v-232z m-214 518v178q0 8-5 13t-13 5h-107q-7 0-13-5t-5-13v-178q0-8 5-13t13-5h107q7 0 13 5t5 13z m357-18v-518q0-22-15-38t-38-16h-750q-23 0-38 16t-16 38v750q0 22 16 38t38 16h517q23 0 50-12t42-26l156-157q16-15 27-42t11-49z',
transform: 'matrix(1 0 0 -1 0 850)'
},
cloudupload: {
width: 640,
height: 640,
path: 'M176 544C96.5 544 32 479.5 32 400C32 336.6 73 282.8 129.9 263.5C128.6 255.8 128 248 128 240C128 160.5 192.5 96 272 96C327.4 96 375.5 127.3 399.6 173.1C413.8 164.8 430.4 160 448 160C501 160 544 203 544 256C544 271.7 540.2 286.6 533.5 299.7C577.5 320 608 364.4 608 416C608 486.7 550.7 544 480 544L176 544zM337 255C327.6 245.6 312.4 245.6 303.1 255L231.1 327C221.7 336.4 221.7 351.6 231.1 360.9C240.5 370.2 255.7 370.3 265 360.9L296 329.9L296 432C296 445.3 306.7 456 320 456C333.3 456 344 445.3 344 432L344 329.9L375 360.9C384.4 370.3 399.6 370.3 408.9 360.9C418.2 351.5 418.3 336.3 408.9 327L336.9 255z',
transform: 'matrix(1 0 0 1 -15 -15)'
},
drawopenpath: {
width: 70,
height: 70,
Expand Down
28 changes: 6 additions & 22 deletions src/plot_api/plot_config.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,8 @@ var configAttributes = {
valType: 'string',
dflt: '',
description: [
'When set it determines base URL for',
'the \'Edit in Chart Studio\' `showEditInChartStudio`/`showSendToCloud` mode bar button',
'and the showLink/sendData on-graph link.',
'To enable sending your data to Chart Studio Cloud, you need to',
'set both `plotlyServerURL` to \'https://chart-studio.plotly.com\' and',
'also set `showSendToCloud` to true.'
'Sets the URL for the `sendChartToCloud` modebar button.',
'When clicked, the button will send the chart data to this URL.',
].join(' ')
},

Expand Down Expand Up @@ -277,22 +273,10 @@ var configAttributes = {
valType: 'boolean',
dflt: false,
description: [
'Should we include a ModeBar button, labeled "Edit in Chart Studio",',
'that sends this chart to chart-studio.plotly.com (formerly plot.ly) or another plotly server',
'as specified by `plotlyServerURL` for editing, export, etc? Prior to version 1.43.0',
'this button was included by default, now it is opt-in using this flag.',
'Note that this button can (depending on `plotlyServerURL` being set) send your data',
'to an external server. However that server does not persist your data',
'until you arrive at the Chart Studio and explicitly click "Save".'
].join(' ')
},
showEditInChartStudio: {
valType: 'boolean',
dflt: false,
description: [
'Same as `showSendToCloud`, but use a pencil icon instead of a floppy-disk.',
'Note that if both `showSendToCloud` and `showEditInChartStudio` are turned,',
'only `showEditInChartStudio` will be honored.'
'Should we include a modebar button that sends this chart to a URL',
'specified by `plotlyServerURL`, for sharing the chart with others?',
'Note that this button will (after a confirmation step)',
'send chart data to an external server.'
].join(' ')
},
modeBarButtonsToRemove: {
Expand Down
65 changes: 43 additions & 22 deletions src/plots/plots.js
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Expand Down Expand Up @@ -202,35 +203,55 @@ function positionPlayWithData(gd, container) {

plots.sendDataToCloud = function(gd) {
var baseUrl = (window.PLOTLYENV || {}).BASE_URL || gd._context.plotlyServerURL;
Comment on lines 204 to 205

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably better to pass in baseUrl / serverUrl as an argument, so that we don't have to duplicate this (window.PLOTLYENV || {}).BASE_URL || gd._context.plotlyServerURL logic

if(!baseUrl) return;
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');

var hiddenformDiv = d3.select(gd)
.append('div')
.attr('id', 'hiddenform')
.style('display', 'none');
// 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 = plots.graphJson(gd, false, 'keepdata', 'object');
Comment thread
marthacryan marked this conversation as resolved.
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_exportfail');
return;
}

var handleMessage = function(event) {
// Only trust messages coming from the Cloud origin.
if(event.origin !== cloudOrigin) return;

var hiddenform = hiddenformDiv
.append('form')
.attr({
action: baseUrl + '/external',
method: 'post',
target: '_blank'
});
if(event.data && event.data.type === 'CHART_AUTH_SUCCESS') {
cloudWindow.postMessage({
type: 'chart',
chart: chart
}, cloudOrigin);

var hiddenformInput = hiddenform
.append('input')
.attr({
type: 'text',
name: 'data'
});
window.removeEventListener('message', handleMessage);
gd.emit('plotly_afterexport');
}
};

hiddenformInput.node().value = plots.graphJson(gd, false, 'keepdata');
hiddenform.node().submit();
hiddenformDiv.remove();
window.addEventListener('message', handleMessage);

gd.emit('plotly_afterexport');
return false;
};

Expand Down
Loading
Loading