Skip to content

remove "Edit in Chart Studio" button by default #3307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 6, 2018
Merged

remove "Edit in Chart Studio" button by default #3307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 6 additions & 3 deletions src/components/modebar/manage.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ module.exports = function manageModeBar(gd) {
buttonGroups = getButtonGroups(
gd,
context.modeBarButtonsToRemove,
context.modeBarButtonsToAdd
context.modeBarButtonsToAdd,
context.showSendToCloud
);
}

Expand All @@ -73,7 +74,7 @@ module.exports = function manageModeBar(gd) {
};

// logic behind which buttons are displayed by default
function getButtonGroups(gd, buttonsToRemove, buttonsToAdd) {
function getButtonGroups(gd, buttonsToRemove, buttonsToAdd, showSendToCloud) {
var fullLayout = gd._fullLayout;
var fullData = gd._fullData;

Expand Down Expand Up @@ -104,7 +105,9 @@ function getButtonGroups(gd, buttonsToRemove, buttonsToAdd) {
}

// buttons common to all plot types
addGroup(['toImage', 'sendDataToCloud']);
var commonGroup = ['toImage'];
if(showSendToCloud) commonGroup.push('sendDataToCloud');
addGroup(commonGroup);

var zoomGroup = [];
var hoverGroup = [];
Expand Down
26 changes: 24 additions & 2 deletions src/plot_api/plot_config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,12 +90,34 @@ module.exports = {
*/
showAxisRangeEntryBoxes: true,

// link to open this plot in plotly
/*
* Add a text link to open this plot in plotly?
* This link shows up in the bottom right corner of the plot, and works
* identically to the newer ModeBar button controlled by `showSendToCloud`
* unless `sendData: false` is used.
*/
showLink: false,

// if we show a link, does it contain data or just link to a plotly file?
/*
* If we show a text link (`showLink: true`), does it contain data or just
* a reference to a plotly cloud file? This option should only be used on
* plot.ly or another plotly server, and is not supported by the newer
* ModeBar button `showSendToCloud`.
*/
sendData: true,

/*
* Should we include a ModeBar button, labeled "Edit in Chart Studio",
* that sends this chart to 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`) send your data
* to an external server. However that server doesn't persist your data
* until you arrive at the Chart Studio and explicitly click "Save".
*/
showSendToCloud: false,

// text appearing in the sendData link
linkText: 'Edit chart',

Expand Down
74 changes: 47 additions & 27 deletions test/jasmine/tests/modebar_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ describe('ModeBar', function() {
_fullData: [],
_context: {
displaylogo: true,
showSendToCloud: false,
displayModeBar: true,
modeBarButtonsToRemove: [],
modeBarButtonsToAdd: [],
Expand All @@ -55,15 +56,15 @@ describe('ModeBar', function() {
}

function countGroups(modeBar) {
return d3.select(modeBar.element).selectAll('div.modebar-group')[0].length;
return d3.select(modeBar.element).selectAll('div.modebar-group').size();
}

function countButtons(modeBar) {
return d3.select(modeBar.element).selectAll('a.modebar-btn')[0].length;
return d3.select(modeBar.element).selectAll('a.modebar-btn').size();
}

function countLogo(modeBar) {
return d3.select(modeBar.element).selectAll('a.plotlyjsicon')[0].length;
return d3.select(modeBar.element).selectAll('a.plotlyjsicon').size();
}

function checkBtnAttr(modeBar, index, attr) {
Expand Down Expand Up @@ -334,7 +335,7 @@ describe('ModeBar', function() {

it('creates mode bar (unselectable cartesian version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['zoom2d', 'pan2d'],
['zoomIn2d', 'zoomOut2d', 'autoScale2d', 'resetScale2d'],
['toggleSpikelines', 'hoverClosestCartesian', 'hoverCompareCartesian']
Expand All @@ -352,7 +353,7 @@ describe('ModeBar', function() {

it('creates mode bar (selectable scatter version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['zoom2d', 'pan2d', 'select2d', 'lasso2d'],
['zoomIn2d', 'zoomOut2d', 'autoScale2d', 'resetScale2d'],
['toggleSpikelines', 'hoverClosestCartesian', 'hoverCompareCartesian']
Expand All @@ -376,7 +377,7 @@ describe('ModeBar', function() {

it('creates mode bar (selectable box version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['zoom2d', 'pan2d', 'select2d', 'lasso2d'],
['zoomIn2d', 'zoomOut2d', 'autoScale2d', 'resetScale2d'],
['toggleSpikelines', 'hoverClosestCartesian', 'hoverCompareCartesian']
Expand All @@ -400,7 +401,7 @@ describe('ModeBar', function() {

it('creates mode bar (cartesian fixed-axes version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['toggleSpikelines', 'hoverClosestCartesian', 'hoverCompareCartesian']
]);

Expand All @@ -415,7 +416,7 @@ describe('ModeBar', function() {

it('creates mode bar (gl3d version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['zoom3d', 'pan3d', 'orbitRotation', 'tableRotation'],
['resetCameraDefault3d', 'resetCameraLastSave3d'],
['hoverClosest3d']
Expand All @@ -432,7 +433,7 @@ describe('ModeBar', function() {

it('creates mode bar (geo version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['pan2d'],
['zoomInGeo', 'zoomOutGeo', 'resetGeo'],
['hoverClosestGeo']
Expand All @@ -449,7 +450,7 @@ describe('ModeBar', function() {

it('creates mode bar (geo + selected version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['pan2d', 'select2d', 'lasso2d'],
['zoomInGeo', 'zoomOutGeo', 'resetGeo'],
['hoverClosestGeo']
Expand All @@ -472,7 +473,7 @@ describe('ModeBar', function() {

it('creates mode bar (mapbox version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['pan2d'],
['resetViewMapbox'],
['toggleHover']
Expand All @@ -489,7 +490,7 @@ describe('ModeBar', function() {

it('creates mode bar (mapbox + selected version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['pan2d', 'select2d', 'lasso2d'],
['resetViewMapbox'],
['toggleHover']
Expand All @@ -512,7 +513,7 @@ describe('ModeBar', function() {

it('creates mode bar (gl2d version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['zoom2d', 'pan2d'],
['zoomIn2d', 'zoomOut2d', 'autoScale2d', 'resetScale2d'],
['hoverClosestGl2d']
Expand All @@ -530,7 +531,7 @@ describe('ModeBar', function() {

it('creates mode bar (pie version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['hoverClosestPie']
]);

Expand All @@ -545,7 +546,7 @@ describe('ModeBar', function() {

it('creates mode bar (cartesian + gl3d version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['zoom3d', 'pan3d', 'orbitRotation', 'tableRotation'],
['resetViews'],
['toggleSpikelines', 'hoverClosestCartesian', 'hoverCompareCartesian']
Expand All @@ -562,7 +563,7 @@ describe('ModeBar', function() {

it('creates mode bar (cartesian + geo unselectable version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['zoom2d', 'pan2d'],
['zoomIn2d', 'zoomOut2d', 'autoScale2d', 'resetViews'],
['toggleSpikelines', 'hoverClosestCartesian', 'hoverCompareCartesian']
Expand All @@ -580,7 +581,7 @@ describe('ModeBar', function() {

it('creates mode bar (cartesian + geo selectable version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['zoom2d', 'pan2d', 'select2d', 'lasso2d'],
['zoomIn2d', 'zoomOut2d', 'autoScale2d', 'resetViews'],
['toggleSpikelines', 'hoverClosestCartesian', 'hoverCompareCartesian']
Expand All @@ -604,7 +605,7 @@ describe('ModeBar', function() {

it('creates mode bar (cartesian + pie version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['zoom2d', 'pan2d', 'select2d', 'lasso2d'],
['zoomIn2d', 'zoomOut2d', 'autoScale2d', 'resetScale2d'],
['toggleSpikelines', 'hoverClosestCartesian', 'hoverCompareCartesian']
Expand All @@ -628,7 +629,7 @@ describe('ModeBar', function() {

it('creates mode bar (gl3d + geo version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['zoom3d', 'pan3d', 'orbitRotation', 'tableRotation'],
['resetViews'],
['toggleHover']
Expand All @@ -645,7 +646,7 @@ describe('ModeBar', function() {

it('creates mode bar (un-selectable ternary version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['zoom2d', 'pan2d'],
['toggleHover']
]);
Expand All @@ -661,7 +662,7 @@ describe('ModeBar', function() {

it('creates mode bar (selectable ternary version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['zoom2d', 'pan2d', 'select2d', 'lasso2d'],
['toggleHover']
]);
Expand All @@ -683,7 +684,7 @@ describe('ModeBar', function() {

it('creates mode bar (ternary + cartesian version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['zoom2d', 'pan2d'],
['toggleSpikelines', 'hoverClosestCartesian', 'hoverCompareCartesian']
]);
Expand All @@ -699,7 +700,7 @@ describe('ModeBar', function() {

it('creates mode bar (ternary + gl3d version)', function() {
var buttons = getButtons([
['toImage', 'sendDataToCloud'],
['toImage'],
['zoom3d', 'pan3d', 'orbitRotation', 'tableRotation'],
['resetViews'],
['toggleHover']
Expand Down Expand Up @@ -756,6 +757,23 @@ describe('ModeBar', function() {
expect(countLogo(gd._fullLayout._modeBar)).toEqual(0);
});

it('displays/hides cloud link according to showSendToCloud config arg', function() {
var gd = getMockGraphInfo();
gd._fullLayout._basePlotModules = [{ name: 'pie' }];
manageModeBar(gd);
checkButtons(gd._fullLayout._modeBar, getButtons([
['toImage'],
['hoverClosestPie']
]), 1);

gd._context.showSendToCloud = true;
manageModeBar(gd);
checkButtons(gd._fullLayout._modeBar, getButtons([
['toImage', 'sendDataToCloud'],
['hoverClosestPie']
]), 1);
});

it('always displays the logo if watermark config arg is true', function() {
var gd = getMockGraphInfo();
gd._context.displaylogo = false;
Expand All @@ -778,18 +796,20 @@ describe('ModeBar', function() {
var gd = setupGraphInfo();
manageModeBar(gd);

expect(countButtons(gd._fullLayout._modeBar)).toEqual(11);

gd._fullLayout._basePlotModules = [{ name: 'gl3d' }];
manageModeBar(gd);

expect(countButtons(gd._fullLayout._modeBar)).toEqual(10);
expect(countButtons(gd._fullLayout._modeBar)).toEqual(9);
});

it('updates mode bar buttons if modeBarButtonsToRemove changes', function() {
var gd = setupGraphInfo();
manageModeBar(gd);
var initialButtonCount = countButtons(gd._fullLayout._modeBar);

gd._context.modeBarButtonsToRemove = ['toImage', 'sendDataToCloud'];
gd._context.modeBarButtonsToRemove = ['toImage', 'zoom2d'];
manageModeBar(gd);

expect(countButtons(gd._fullLayout._modeBar))
Expand Down Expand Up @@ -829,7 +849,7 @@ describe('ModeBar', function() {

var modeBar = gd._fullLayout._modeBar;
expect(countGroups(modeBar)).toEqual(6);
expect(countButtons(modeBar)).toEqual(11);
expect(countButtons(modeBar)).toEqual(10);
});

it('sets up buttons with modeBarButtonsToAdd and modeBarButtonToRemove (2)', function() {
Expand All @@ -849,7 +869,7 @@ describe('ModeBar', function() {

var modeBar = gd._fullLayout._modeBar;
expect(countGroups(modeBar)).toEqual(7);
expect(countButtons(modeBar)).toEqual(13);
expect(countButtons(modeBar)).toEqual(12);
});

it('sets up buttons with fully custom modeBarButtons', function() {
Expand Down