Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
remove "Edit in Chart Studio" button by default by alexcjohnson · Pull Request #3307 · plotly/plotly.js · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' remove "Edit in Chart Studio" button by default by alexcjohnson · Pull Request #3307 · plotly/plotly.js · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' remove "Edit in Chart Studio" button by default by alexcjohnson · Pull Request #3307 · plotly/plotly.js · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' remove "Edit in Chart Studio" button by default by alexcjohnson · Pull Request #3307 · plotly/plotly.js · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' remove "Edit in Chart Studio" button by default by alexcjohnson · Pull Request #3307 · plotly/plotly.js · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' remove "Edit in Chart Studio" button by default by alexcjohnson · Pull Request #3307 · plotly/plotly.js · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); remove "Edit in Chart Studio" button by default by alexcjohnson · Pull Request #3307 · plotly/plotly.js · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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