Skip to content

Granular options for on-chart editing#1895

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
alexcjohnson merged 4 commits into from
Jul 19, 2017
Merged

Granular options for on-chart editing #1895

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5500120
forEach -> for
alexcjohnson Jul 18, 2017
9d4b191
DRY-up computeLegendDimensions
alexcjohnson Jul 18, 2017
b4e26ae
optionally split up editable into granular parts
alexcjohnson Jul 18, 2017
04d49dd
extendDeep for defaultConfig so we clone edits and don't modify it
alexcjohnson Jul 18, 2017
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
13 changes: 9 additions & 4 deletions src/components/annotations/draw.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,8 @@ function drawOne(gd, index) {
function drawRaw(gd, options, index, subplotId, xa, ya) {
var fullLayout = gd._fullLayout;
var gs = gd._fullLayout._size;
var edits = gd._context.edits;

var className;
var annbase;

Expand DownExpand Up@@ -128,8 +130,11 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
var annTextGroup = annGroup.append('g')
.classed('annotation-text-g', true);

var editTextPosition = edits[options.showarrow ? 'annotationTail' : 'annotationPosition'];
var textEvents = options.captureevents || edits.annotationText || editTextPosition;

@etpinardetpinardJul 19, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No need to address this now, but this seems like the right place to reference #1750


var annTextGroupInner = annTextGroup.append('g')
.style('pointer-events', options.captureevents ? 'all' : null)
.style('pointer-events', textEvents ? 'all' : null)
.call(setCursor, 'default')
.on('click', function() {
gd._dragging = false;
Expand DownExpand Up@@ -519,7 +524,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {

// the arrow dragger is a small square right at the head, then a line to the tail,
// all expanded by a stroke width of 6px plus the arrow line width
if(gd._context.editable && arrow.node().parentNode && !subplotId) {
if(edits.annotationPosition && arrow.node().parentNode && !subplotId) {
var arrowDragHeadX = headX;
var arrowDragHeadY = headY;
if(options.standoff) {
Expand DownExpand Up@@ -601,7 +606,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
if(options.showarrow) drawArrow(0, 0);

// user dragging the annotation (text, not arrow)
if(gd._context.editable) {
if(editTextPosition) {
var update,
baseTextTransform;

Expand DownExpand Up@@ -679,7 +684,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
}
}

if(gd._context.editable) {
if(edits.annotationText) {
annText.call(svgTextUtils.makeEditable, {delegate: annTextGroupInner, gd: gd})
.call(textLayout)
.on('edit', function(_text) {
Expand Down
2 changes: 1 addition & 1 deletion src/components/colorbar/draw.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -550,7 +550,7 @@ module.exports = function draw(gd, id) {
if(cbDone && cbDone.then) (gd._promises || []).push(cbDone);

// dragging...
if(gd._context.editable) {
if(gd._context.edits.colorbarPosition) {
var t0,
xf,
yf;
Expand Down
86 changes: 27 additions & 59 deletions src/components/legend/draw.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -312,7 +312,7 @@ module.exports = function draw(gd) {
});
}

if(gd._context.editable) {
if(gd._context.edits.legendPosition) {
var xf, yf, x0, y0;

legend.classed('cursor-move', true);
Expand DownExpand Up@@ -385,7 +385,7 @@ function drawTexts(g, gd) {
});
}

if(gd._context.editable && !isPie) {
if(gd._context.edits.legendText && !isPie) {
text.call(svgTextUtils.makeEditable, {gd: gd})
.call(textLayout)
.on('edit', function(text) {
Expand DownExpand Up@@ -597,10 +597,15 @@ function computeTextDimensions(g, gd) {
}

function computeLegendDimensions(gd, groups, traces) {
var fullLayout = gd._fullLayout,
opts = fullLayout.legend,
borderwidth = opts.borderwidth,
isGrouped = helpers.isGrouped(opts);
var fullLayout = gd._fullLayout;
var opts = fullLayout.legend;
var borderwidth = opts.borderwidth;
var isGrouped = helpers.isGrouped(opts);

var extraWidth = 0;

opts.width = 0;
opts.height = 0;

if(helpers.isVertical(opts)) {
if(isGrouped) {
Expand All@@ -609,9 +614,6 @@ function computeLegendDimensions(gd, groups, traces) {
});
}

opts.width = 0;
opts.height = 0;

traces.each(function(d) {
var legendItem = d[0],
textHeight = legendItem.height,
Expand All@@ -632,26 +634,9 @@ function computeLegendDimensions(gd, groups, traces) {
opts.height += (opts._lgroupsLength - 1) * opts.tracegroupgap;
}

// make sure we're only getting full pixels
opts.width = Math.ceil(opts.width);
opts.height = Math.ceil(opts.height);

traces.each(function(d) {
var legendItem = d[0],
bg = d3.select(this).select('.legendtoggle');

bg.call(Drawing.setRect,
0,
-legendItem.height / 2,
(gd._context.editable ? 0 : opts.width) + 40,
legendItem.height
);
});
extraWidth = 40;
}
else if(isGrouped) {
opts.width = 0;
opts.height = 0;

var groupXOffsets = [opts.width],
groupData = groups.data();

Expand DownExpand Up@@ -692,26 +677,8 @@ function computeLegendDimensions(gd, groups, traces) {

opts.height += 10 + borderwidth * 2;
opts.width += borderwidth * 2;

// make sure we're only getting full pixels
opts.width = Math.ceil(opts.width);
opts.height = Math.ceil(opts.height);

traces.each(function(d) {
var legendItem = d[0],
bg = d3.select(this).select('.legendtoggle');

bg.call(Drawing.setRect,
0,
-legendItem.height / 2,
(gd._context.editable ? 0 : opts.width),
legendItem.height
);
});
}
else {
opts.width = 0;
opts.height = 0;
var rowHeight = 0,
maxTraceHeight = 0,
maxTraceWidth = 0,
Expand DownExpand Up@@ -750,22 +717,23 @@ function computeLegendDimensions(gd, groups, traces) {
opts.width += borderwidth * 2;
opts.height += 10 + borderwidth * 2;

// make sure we're only getting full pixels
opts.width = Math.ceil(opts.width);
opts.height = Math.ceil(opts.height);
}

traces.each(function(d) {
var legendItem = d[0],
bg = d3.select(this).select('.legendtoggle');
// make sure we're only getting full pixels
opts.width = Math.ceil(opts.width);
opts.height = Math.ceil(opts.height);

bg.call(Drawing.setRect,
0,
-legendItem.height / 2,
(gd._context.editable ? 0 : opts.width),
legendItem.height
);
});
}
traces.each(function(d) {
var legendItem = d[0],
bg = d3.select(this).select('.legendtoggle');

bg.call(Drawing.setRect,

@etpinardetpinardJul 19, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lovely commit 🎉

0,
-legendItem.height / 2,
(gd._context.edits.legendText ? 0 : opts.width) + extraWidth,
legendItem.height
);
});
}

function expandMargin(gd) {
Expand Down
2 changes: 1 addition & 1 deletion src/components/shapes/draw.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function drawOne(gd, index) {
null
);

if(gd._context.editable) setupDragElement(gd, path, options, index);
if(gd._context.edits.shapePosition) setupDragElement(gd, path, options, index);
}
}

Expand Down
9 changes: 8 additions & 1 deletion src/components/titles/index.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,14 @@ Titles.draw = function(gd, titleClass, options) {
var opacity = 1;
var isplaceholder = false;
var txt = cont.title.trim();
var editable = gd._context.editable;

// only make this title editable if we positively identify its property
// as one that has editing enabled.
var editAttr;
if(prop === 'title') editAttr = 'titleText';
else if(prop.indexOf('axis') !== -1) editAttr = 'axisTitleText';
else if(prop.indexOf('colorbar' !== -1)) editAttr = 'colorbarTitleText';
var editable = gd._context.edits[editAttr];

if(txt === '') opacity = 0;
if(txt.match(PLACEHOLDER_RE)) {
Expand Down
37 changes: 33 additions & 4 deletions src/plot_api/plot_api.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -397,28 +397,57 @@ function opaqueSetBackground(gd, bgColor) {
}

function setPlotContext(gd, config) {
if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
if(!gd._context) gd._context = Lib.extendDeep({}, Plotly.defaultConfig);

@etpinardetpinardJul 19, 2017

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice. Maybe config isn't as poorly tested than I thought.

var context = gd._context;

var i, keys, key;

if(config) {
Object.keys(config).forEach(function(key) {
keys = Object.keys(config);
for(i = 0; i < keys.length; i++) {
key = keys[i];
if(key === 'editable' || key === 'edits') continue;
if(key in context) {
if(key === 'setBackground' && config[key] === 'opaque') {
context[key] = opaqueSetBackground;
}
else context[key] = config[key];
}
});
}

// map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
context.plotGlPixelRatio = context.plot3dPixelRatio;
}

// now deal with editable and edits - first editable overrides
// everything, then edits refines
var editable = config.editable;
if(editable !== undefined) {
// we're not going to *use* context.editable, we're only going to
// use context.edits... but keep it for the record
context.editable = editable;

keys = Object.keys(context.edits);
for(i = 0; i < keys.length; i++) {
context.edits[keys[i]] = editable;
}
}
if(config.edits) {
keys = Object.keys(config.edits);
for(i = 0; i < keys.length; i++) {
key = keys[i];
if(key in context.edits) {
context.edits[key] = config.edits[key];
}
}
}
}

// staticPlot forces a bunch of others:
if(context.staticPlot) {
context.editable = false;
context.edits = {};
context.autosizable = false;
context.scrollZoom = false;
context.doubleClick = false;
Expand DownExpand Up@@ -487,7 +516,7 @@ function plotPolar(gd, data, layout) {
var title = polarPlotSVG.select('.title-group text')
.call(titleLayout);

if(gd._context.editable) {
if(gd._context.edits.titleText) {
if(!txt || txt === placeholderText) {
opacity = 0.2;
// placeholder is not going through convertToTspans
Expand Down
21 changes: 20 additions & 1 deletion src/plot_api/plot_config.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,27 @@ module.exports = {
// no interactivity, for export or image generation
staticPlot: false,

// we can edit titles, move annotations, etc
// we can edit titles, move annotations, etc - sets all pieces of `edits`
// unless a separate `edits` config item overrides individual parts
editable: false,
edits: {
// annotationPosition: the main anchor of the annotation, which is the
// text (if no arrow) or the arrow (which drags the whole thing leaving
// the arrow length & direction unchanged)
annotationPosition: false,
// just for annotations with arrows, change the length and direction of the arrow
annotationTail: false,
annotationText: false,
axisTitleText: false,
colorbarPosition: false,
colorbarTitleText: false,
legendPosition: false,
// edit the trace name fields from the legend
legendText: false,
shapePosition: false,
// the global `layout.title`
titleText: false
},

// DO autosize once regardless of layout.autosize
// (use default width or height values otherwise)
Expand Down
Loading
, '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" + '
Granular options for on-chart editing by alexcjohnson · Pull Request #1895 · plotly/plotly.js · GitHub
Skip to content
Granular options for on-chart editing#1895

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

alexcjohnson
merged 4 commits into

from

Jul 19, 2017
 Merged


Granular options for on-chart editing
#1895
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5500120

forEach -> for


alexcjohnson Jul 18, 2017
9d4b191

DRY-up computeLegendDimensions


alexcjohnson Jul 18, 2017
b4e26ae

optionally split up editable into granular parts


alexcjohnson Jul 18, 2017
04d49dd

extendDeep for defaultConfig so we clone edits and don't modify it


alexcjohnson Jul 18, 2017

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


13 changes: 9 additions & 4 deletions
src/components/annotations/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,8 @@ function drawOne(gd, index) {
function drawRaw(gd, options, index, subplotId, xa, ya) {
 var fullLayout = gd._fullLayout;
 var gs = gd._fullLayout._size;
 var edits = gd._context.edits;

 var className;
 var annbase;

Expand DownExpand Up@@ -128,8 +130,11 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 var annTextGroup = annGroup.append('g')
 .classed('annotation-text-g', true);

 var editTextPosition = edits[options.showarrow ? 'annotationTail' : 'annotationPosition'];
 var textEvents = options.captureevents || edits.annotationText || editTextPosition;
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

No need to address this now, but this seems like the right place to reference #1750

 var annTextGroupInner = annTextGroup.append('g')
 .style('pointer-events', options.captureevents ? 'all' : null)
 .style('pointer-events', textEvents ? 'all' : null)
 .call(setCursor, 'default')
 .on('click', function() {
 gd._dragging = false;
Expand DownExpand Up@@ -519,7 +524,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {

 // the arrow dragger is a small square right at the head, then a line to the tail,
 // all expanded by a stroke width of 6px plus the arrow line width
 if(gd._context.editable && arrow.node().parentNode && !subplotId) {
 if(edits.annotationPosition && arrow.node().parentNode && !subplotId) {
 var arrowDragHeadX = headX;
 var arrowDragHeadY = headY;
 if(options.standoff) {
Expand DownExpand Up@@ -601,7 +606,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 if(options.showarrow) drawArrow(0, 0);

 // user dragging the annotation (text, not arrow)
 if(gd._context.editable) {
 if(editTextPosition) {
 var update,
 baseTextTransform;

Expand DownExpand Up@@ -679,7 +684,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 }
 }

 if(gd._context.editable) {
 if(edits.annotationText) {
 annText.call(svgTextUtils.makeEditable, {delegate: annTextGroupInner, gd: gd})
 .call(textLayout)
 .on('edit', function(_text) {
Expand Down

2 changes: 1 addition & 1 deletion
src/components/colorbar/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -550,7 +550,7 @@ module.exports = function draw(gd, id) {
 if(cbDone && cbDone.then) (gd._promises || []).push(cbDone);

 // dragging...
 if(gd._context.editable) {
 if(gd._context.edits.colorbarPosition) {
 var t0,
 xf,
 yf;
Expand Down

86 changes: 27 additions & 59 deletions
src/components/legend/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -312,7 +312,7 @@ module.exports = function draw(gd) {
 });
 }

 if(gd._context.editable) {
 if(gd._context.edits.legendPosition) {
 var xf, yf, x0, y0;

 legend.classed('cursor-move', true);
Expand DownExpand Up@@ -385,7 +385,7 @@ function drawTexts(g, gd) {
 });
 }

 if(gd._context.editable && !isPie) {
 if(gd._context.edits.legendText && !isPie) {
 text.call(svgTextUtils.makeEditable, {gd: gd})
 .call(textLayout)
 .on('edit', function(text) {
Expand DownExpand Up@@ -597,10 +597,15 @@ function computeTextDimensions(g, gd) {
}

function computeLegendDimensions(gd, groups, traces) {
 var fullLayout = gd._fullLayout,
 opts = fullLayout.legend,
 borderwidth = opts.borderwidth,
 isGrouped = helpers.isGrouped(opts);
 var fullLayout = gd._fullLayout;
 var opts = fullLayout.legend;
 var borderwidth = opts.borderwidth;
 var isGrouped = helpers.isGrouped(opts);

 var extraWidth = 0;

 opts.width = 0;
 opts.height = 0;

 if(helpers.isVertical(opts)) {
 if(isGrouped) {
Expand All@@ -609,9 +614,6 @@ function computeLegendDimensions(gd, groups, traces) {
 });
 }

 opts.width = 0;
 opts.height = 0;

 traces.each(function(d) {
 var legendItem = d[0],
 textHeight = legendItem.height,
Expand All@@ -632,26 +634,9 @@ function computeLegendDimensions(gd, groups, traces) {
 opts.height += (opts._lgroupsLength - 1) * opts.tracegroupgap;
 }

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width) + 40,
 legendItem.height
 );
 });
 extraWidth = 40;
 }
 else if(isGrouped) {
 opts.width = 0;
 opts.height = 0;

 var groupXOffsets = [opts.width],
 groupData = groups.data();

Expand DownExpand Up@@ -692,26 +677,8 @@ function computeLegendDimensions(gd, groups, traces) {

 opts.height += 10 + borderwidth * 2;
 opts.width += borderwidth * 2;

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width),
 legendItem.height
 );
 });
 }
 else {
 opts.width = 0;
 opts.height = 0;
 var rowHeight = 0,
 maxTraceHeight = 0,
 maxTraceWidth = 0,
Expand DownExpand Up@@ -750,22 +717,23 @@ function computeLegendDimensions(gd, groups, traces) {
 opts.width += borderwidth * 2;
 opts.height += 10 + borderwidth * 2;

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);
 }

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');
// make sure we're only getting full pixels
opts.width = Math.ceil(opts.width);
opts.height = Math.ceil(opts.height);

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width),
 legendItem.height
 );
 });
 }
 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

lovely commit 🎉
 0,
 -legendItem.height / 2,
 (gd._context.edits.legendText ? 0 : opts.width) + extraWidth,
 legendItem.height
 );
 });
}

function expandMargin(gd) {
Expand Down

2 changes: 1 addition & 1 deletion
src/components/shapes/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function drawOne(gd, index) {
 null
 );

 if(gd._context.editable) setupDragElement(gd, path, options, index);
 if(gd._context.edits.shapePosition) setupDragElement(gd, path, options, index);
 }
}

Expand Down

9 changes: 8 additions & 1 deletion
src/components/titles/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,14 @@ Titles.draw = function(gd, titleClass, options) {
 var opacity = 1;
 var isplaceholder = false;
 var txt = cont.title.trim();
 var editable = gd._context.editable;

 // only make this title editable if we positively identify its property
 // as one that has editing enabled.
 var editAttr;
 if(prop === 'title') editAttr = 'titleText';
 else if(prop.indexOf('axis') !== -1) editAttr = 'axisTitleText';
 else if(prop.indexOf('colorbar' !== -1)) editAttr = 'colorbarTitleText';
 var editable = gd._context.edits[editAttr];

 if(txt === '') opacity = 0;
 if(txt.match(PLACEHOLDER_RE)) {
Expand Down

37 changes: 33 additions & 4 deletions
src/plot_api/plot_api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -397,28 +397,57 @@ function opaqueSetBackground(gd, bgColor) {
}

function setPlotContext(gd, config) {
 if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
 if(!gd._context) gd._context = Lib.extendDeep({}, Plotly.defaultConfig);
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Nice. Maybe config isn't as poorly tested than I thought.
 var context = gd._context;

 var i, keys, key;

 if(config) {
 Object.keys(config).forEach(function(key) {
 keys = Object.keys(config);
 for(i = 0; i < keys.length; i++) {
 key = keys[i];
 if(key === 'editable' || key === 'edits') continue;
 if(key in context) {
 if(key === 'setBackground' && config[key] === 'opaque') {
 context[key] = opaqueSetBackground;
 }
 else context[key] = config[key];
 }
 });
 }

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
 }

 // now deal with editable and edits - first editable overrides
 // everything, then edits refines
 var editable = config.editable;
 if(editable !== undefined) {
 // we're not going to *use* context.editable, we're only going to
 // use context.edits... but keep it for the record
 context.editable = editable;

 keys = Object.keys(context.edits);
 for(i = 0; i < keys.length; i++) {
 context.edits[keys[i]] = editable;
 }
 }
 if(config.edits) {
 keys = Object.keys(config.edits);
 for(i = 0; i < keys.length; i++) {
 key = keys[i];
 if(key in context.edits) {
 context.edits[key] = config.edits[key];
 }
 }
 }
 }

 // staticPlot forces a bunch of others:
 if(context.staticPlot) {
 context.editable = false;
 context.edits = {};
 context.autosizable = false;
 context.scrollZoom = false;
 context.doubleClick = false;
Expand DownExpand Up@@ -487,7 +516,7 @@ function plotPolar(gd, data, layout) {
 var title = polarPlotSVG.select('.title-group text')
 .call(titleLayout);

 if(gd._context.editable) {
 if(gd._context.edits.titleText) {
 if(!txt || txt === placeholderText) {
 opacity = 0.2;
 // placeholder is not going through convertToTspans
Expand Down

21 changes: 20 additions & 1 deletion
src/plot_api/plot_config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,27 @@ module.exports = {
 // no interactivity, for export or image generation
 staticPlot: false,

 // we can edit titles, move annotations, etc
 // we can edit titles, move annotations, etc - sets all pieces of `edits`
 // unless a separate `edits` config item overrides individual parts
 editable: false,
 edits: {
 // annotationPosition: the main anchor of the annotation, which is the
 // text (if no arrow) or the arrow (which drags the whole thing leaving
 // the arrow length & direction unchanged)
 annotationPosition: false,
 // just for annotations with arrows, change the length and direction of the arrow
 annotationTail: false,
 annotationText: false,
 axisTitleText: false,
 colorbarPosition: false,
 colorbarTitleText: false,
 legendPosition: false,
 // edit the trace name fields from the legend
 legendText: false,
 shapePosition: false,
 // the global `layout.title`
 titleText: false
 },

 // DO autosize once regardless of layout.autosize
 // (use default width or height values otherwise)
Expand Down
Loading

, '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('^' + ".*" + '
Granular options for on-chart editing by alexcjohnson · Pull Request #1895 · plotly/plotly.js · GitHub
Skip to content
Granular options for on-chart editing#1895

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

alexcjohnson
merged 4 commits into

from

Jul 19, 2017
 Merged


Granular options for on-chart editing
#1895
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5500120

forEach -> for


alexcjohnson Jul 18, 2017
9d4b191

DRY-up computeLegendDimensions


alexcjohnson Jul 18, 2017
b4e26ae

optionally split up editable into granular parts


alexcjohnson Jul 18, 2017
04d49dd

extendDeep for defaultConfig so we clone edits and don't modify it


alexcjohnson Jul 18, 2017

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


13 changes: 9 additions & 4 deletions
src/components/annotations/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,8 @@ function drawOne(gd, index) {
function drawRaw(gd, options, index, subplotId, xa, ya) {
 var fullLayout = gd._fullLayout;
 var gs = gd._fullLayout._size;
 var edits = gd._context.edits;

 var className;
 var annbase;

Expand DownExpand Up@@ -128,8 +130,11 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 var annTextGroup = annGroup.append('g')
 .classed('annotation-text-g', true);

 var editTextPosition = edits[options.showarrow ? 'annotationTail' : 'annotationPosition'];
 var textEvents = options.captureevents || edits.annotationText || editTextPosition;
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

No need to address this now, but this seems like the right place to reference #1750

 var annTextGroupInner = annTextGroup.append('g')
 .style('pointer-events', options.captureevents ? 'all' : null)
 .style('pointer-events', textEvents ? 'all' : null)
 .call(setCursor, 'default')
 .on('click', function() {
 gd._dragging = false;
Expand DownExpand Up@@ -519,7 +524,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {

 // the arrow dragger is a small square right at the head, then a line to the tail,
 // all expanded by a stroke width of 6px plus the arrow line width
 if(gd._context.editable && arrow.node().parentNode && !subplotId) {
 if(edits.annotationPosition && arrow.node().parentNode && !subplotId) {
 var arrowDragHeadX = headX;
 var arrowDragHeadY = headY;
 if(options.standoff) {
Expand DownExpand Up@@ -601,7 +606,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 if(options.showarrow) drawArrow(0, 0);

 // user dragging the annotation (text, not arrow)
 if(gd._context.editable) {
 if(editTextPosition) {
 var update,
 baseTextTransform;

Expand DownExpand Up@@ -679,7 +684,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 }
 }

 if(gd._context.editable) {
 if(edits.annotationText) {
 annText.call(svgTextUtils.makeEditable, {delegate: annTextGroupInner, gd: gd})
 .call(textLayout)
 .on('edit', function(_text) {
Expand Down

2 changes: 1 addition & 1 deletion
src/components/colorbar/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -550,7 +550,7 @@ module.exports = function draw(gd, id) {
 if(cbDone && cbDone.then) (gd._promises || []).push(cbDone);

 // dragging...
 if(gd._context.editable) {
 if(gd._context.edits.colorbarPosition) {
 var t0,
 xf,
 yf;
Expand Down

86 changes: 27 additions & 59 deletions
src/components/legend/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -312,7 +312,7 @@ module.exports = function draw(gd) {
 });
 }

 if(gd._context.editable) {
 if(gd._context.edits.legendPosition) {
 var xf, yf, x0, y0;

 legend.classed('cursor-move', true);
Expand DownExpand Up@@ -385,7 +385,7 @@ function drawTexts(g, gd) {
 });
 }

 if(gd._context.editable && !isPie) {
 if(gd._context.edits.legendText && !isPie) {
 text.call(svgTextUtils.makeEditable, {gd: gd})
 .call(textLayout)
 .on('edit', function(text) {
Expand DownExpand Up@@ -597,10 +597,15 @@ function computeTextDimensions(g, gd) {
}

function computeLegendDimensions(gd, groups, traces) {
 var fullLayout = gd._fullLayout,
 opts = fullLayout.legend,
 borderwidth = opts.borderwidth,
 isGrouped = helpers.isGrouped(opts);
 var fullLayout = gd._fullLayout;
 var opts = fullLayout.legend;
 var borderwidth = opts.borderwidth;
 var isGrouped = helpers.isGrouped(opts);

 var extraWidth = 0;

 opts.width = 0;
 opts.height = 0;

 if(helpers.isVertical(opts)) {
 if(isGrouped) {
Expand All@@ -609,9 +614,6 @@ function computeLegendDimensions(gd, groups, traces) {
 });
 }

 opts.width = 0;
 opts.height = 0;

 traces.each(function(d) {
 var legendItem = d[0],
 textHeight = legendItem.height,
Expand All@@ -632,26 +634,9 @@ function computeLegendDimensions(gd, groups, traces) {
 opts.height += (opts._lgroupsLength - 1) * opts.tracegroupgap;
 }

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width) + 40,
 legendItem.height
 );
 });
 extraWidth = 40;
 }
 else if(isGrouped) {
 opts.width = 0;
 opts.height = 0;

 var groupXOffsets = [opts.width],
 groupData = groups.data();

Expand DownExpand Up@@ -692,26 +677,8 @@ function computeLegendDimensions(gd, groups, traces) {

 opts.height += 10 + borderwidth * 2;
 opts.width += borderwidth * 2;

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width),
 legendItem.height
 );
 });
 }
 else {
 opts.width = 0;
 opts.height = 0;
 var rowHeight = 0,
 maxTraceHeight = 0,
 maxTraceWidth = 0,
Expand DownExpand Up@@ -750,22 +717,23 @@ function computeLegendDimensions(gd, groups, traces) {
 opts.width += borderwidth * 2;
 opts.height += 10 + borderwidth * 2;

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);
 }

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');
// make sure we're only getting full pixels
opts.width = Math.ceil(opts.width);
opts.height = Math.ceil(opts.height);

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width),
 legendItem.height
 );
 });
 }
 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

lovely commit 🎉
 0,
 -legendItem.height / 2,
 (gd._context.edits.legendText ? 0 : opts.width) + extraWidth,
 legendItem.height
 );
 });
}

function expandMargin(gd) {
Expand Down

2 changes: 1 addition & 1 deletion
src/components/shapes/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function drawOne(gd, index) {
 null
 );

 if(gd._context.editable) setupDragElement(gd, path, options, index);
 if(gd._context.edits.shapePosition) setupDragElement(gd, path, options, index);
 }
}

Expand Down

9 changes: 8 additions & 1 deletion
src/components/titles/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,14 @@ Titles.draw = function(gd, titleClass, options) {
 var opacity = 1;
 var isplaceholder = false;
 var txt = cont.title.trim();
 var editable = gd._context.editable;

 // only make this title editable if we positively identify its property
 // as one that has editing enabled.
 var editAttr;
 if(prop === 'title') editAttr = 'titleText';
 else if(prop.indexOf('axis') !== -1) editAttr = 'axisTitleText';
 else if(prop.indexOf('colorbar' !== -1)) editAttr = 'colorbarTitleText';
 var editable = gd._context.edits[editAttr];

 if(txt === '') opacity = 0;
 if(txt.match(PLACEHOLDER_RE)) {
Expand Down

37 changes: 33 additions & 4 deletions
src/plot_api/plot_api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -397,28 +397,57 @@ function opaqueSetBackground(gd, bgColor) {
}

function setPlotContext(gd, config) {
 if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
 if(!gd._context) gd._context = Lib.extendDeep({}, Plotly.defaultConfig);
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Nice. Maybe config isn't as poorly tested than I thought.
 var context = gd._context;

 var i, keys, key;

 if(config) {
 Object.keys(config).forEach(function(key) {
 keys = Object.keys(config);
 for(i = 0; i < keys.length; i++) {
 key = keys[i];
 if(key === 'editable' || key === 'edits') continue;
 if(key in context) {
 if(key === 'setBackground' && config[key] === 'opaque') {
 context[key] = opaqueSetBackground;
 }
 else context[key] = config[key];
 }
 });
 }

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
 }

 // now deal with editable and edits - first editable overrides
 // everything, then edits refines
 var editable = config.editable;
 if(editable !== undefined) {
 // we're not going to *use* context.editable, we're only going to
 // use context.edits... but keep it for the record
 context.editable = editable;

 keys = Object.keys(context.edits);
 for(i = 0; i < keys.length; i++) {
 context.edits[keys[i]] = editable;
 }
 }
 if(config.edits) {
 keys = Object.keys(config.edits);
 for(i = 0; i < keys.length; i++) {
 key = keys[i];
 if(key in context.edits) {
 context.edits[key] = config.edits[key];
 }
 }
 }
 }

 // staticPlot forces a bunch of others:
 if(context.staticPlot) {
 context.editable = false;
 context.edits = {};
 context.autosizable = false;
 context.scrollZoom = false;
 context.doubleClick = false;
Expand DownExpand Up@@ -487,7 +516,7 @@ function plotPolar(gd, data, layout) {
 var title = polarPlotSVG.select('.title-group text')
 .call(titleLayout);

 if(gd._context.editable) {
 if(gd._context.edits.titleText) {
 if(!txt || txt === placeholderText) {
 opacity = 0.2;
 // placeholder is not going through convertToTspans
Expand Down

21 changes: 20 additions & 1 deletion
src/plot_api/plot_config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,27 @@ module.exports = {
 // no interactivity, for export or image generation
 staticPlot: false,

 // we can edit titles, move annotations, etc
 // we can edit titles, move annotations, etc - sets all pieces of `edits`
 // unless a separate `edits` config item overrides individual parts
 editable: false,
 edits: {
 // annotationPosition: the main anchor of the annotation, which is the
 // text (if no arrow) or the arrow (which drags the whole thing leaving
 // the arrow length & direction unchanged)
 annotationPosition: false,
 // just for annotations with arrows, change the length and direction of the arrow
 annotationTail: false,
 annotationText: false,
 axisTitleText: false,
 colorbarPosition: false,
 colorbarTitleText: false,
 legendPosition: false,
 // edit the trace name fields from the legend
 legendText: false,
 shapePosition: false,
 // the global `layout.title`
 titleText: false
 },

 // DO autosize once regardless of layout.autosize
 // (use default width or height values otherwise)
Expand Down
Loading

, '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('^' + ".*" + '
Granular options for on-chart editing by alexcjohnson · Pull Request #1895 · plotly/plotly.js · GitHub
Skip to content
Granular options for on-chart editing#1895

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

alexcjohnson
merged 4 commits into

from

Jul 19, 2017
 Merged


Granular options for on-chart editing
#1895
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5500120

forEach -> for


alexcjohnson Jul 18, 2017
9d4b191

DRY-up computeLegendDimensions


alexcjohnson Jul 18, 2017
b4e26ae

optionally split up editable into granular parts


alexcjohnson Jul 18, 2017
04d49dd

extendDeep for defaultConfig so we clone edits and don't modify it


alexcjohnson Jul 18, 2017

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


13 changes: 9 additions & 4 deletions
src/components/annotations/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,8 @@ function drawOne(gd, index) {
function drawRaw(gd, options, index, subplotId, xa, ya) {
 var fullLayout = gd._fullLayout;
 var gs = gd._fullLayout._size;
 var edits = gd._context.edits;

 var className;
 var annbase;

Expand DownExpand Up@@ -128,8 +130,11 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 var annTextGroup = annGroup.append('g')
 .classed('annotation-text-g', true);

 var editTextPosition = edits[options.showarrow ? 'annotationTail' : 'annotationPosition'];
 var textEvents = options.captureevents || edits.annotationText || editTextPosition;
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

No need to address this now, but this seems like the right place to reference #1750

 var annTextGroupInner = annTextGroup.append('g')
 .style('pointer-events', options.captureevents ? 'all' : null)
 .style('pointer-events', textEvents ? 'all' : null)
 .call(setCursor, 'default')
 .on('click', function() {
 gd._dragging = false;
Expand DownExpand Up@@ -519,7 +524,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {

 // the arrow dragger is a small square right at the head, then a line to the tail,
 // all expanded by a stroke width of 6px plus the arrow line width
 if(gd._context.editable && arrow.node().parentNode && !subplotId) {
 if(edits.annotationPosition && arrow.node().parentNode && !subplotId) {
 var arrowDragHeadX = headX;
 var arrowDragHeadY = headY;
 if(options.standoff) {
Expand DownExpand Up@@ -601,7 +606,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 if(options.showarrow) drawArrow(0, 0);

 // user dragging the annotation (text, not arrow)
 if(gd._context.editable) {
 if(editTextPosition) {
 var update,
 baseTextTransform;

Expand DownExpand Up@@ -679,7 +684,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 }
 }

 if(gd._context.editable) {
 if(edits.annotationText) {
 annText.call(svgTextUtils.makeEditable, {delegate: annTextGroupInner, gd: gd})
 .call(textLayout)
 .on('edit', function(_text) {
Expand Down

2 changes: 1 addition & 1 deletion
src/components/colorbar/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -550,7 +550,7 @@ module.exports = function draw(gd, id) {
 if(cbDone && cbDone.then) (gd._promises || []).push(cbDone);

 // dragging...
 if(gd._context.editable) {
 if(gd._context.edits.colorbarPosition) {
 var t0,
 xf,
 yf;
Expand Down

86 changes: 27 additions & 59 deletions
src/components/legend/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -312,7 +312,7 @@ module.exports = function draw(gd) {
 });
 }

 if(gd._context.editable) {
 if(gd._context.edits.legendPosition) {
 var xf, yf, x0, y0;

 legend.classed('cursor-move', true);
Expand DownExpand Up@@ -385,7 +385,7 @@ function drawTexts(g, gd) {
 });
 }

 if(gd._context.editable && !isPie) {
 if(gd._context.edits.legendText && !isPie) {
 text.call(svgTextUtils.makeEditable, {gd: gd})
 .call(textLayout)
 .on('edit', function(text) {
Expand DownExpand Up@@ -597,10 +597,15 @@ function computeTextDimensions(g, gd) {
}

function computeLegendDimensions(gd, groups, traces) {
 var fullLayout = gd._fullLayout,
 opts = fullLayout.legend,
 borderwidth = opts.borderwidth,
 isGrouped = helpers.isGrouped(opts);
 var fullLayout = gd._fullLayout;
 var opts = fullLayout.legend;
 var borderwidth = opts.borderwidth;
 var isGrouped = helpers.isGrouped(opts);

 var extraWidth = 0;

 opts.width = 0;
 opts.height = 0;

 if(helpers.isVertical(opts)) {
 if(isGrouped) {
Expand All@@ -609,9 +614,6 @@ function computeLegendDimensions(gd, groups, traces) {
 });
 }

 opts.width = 0;
 opts.height = 0;

 traces.each(function(d) {
 var legendItem = d[0],
 textHeight = legendItem.height,
Expand All@@ -632,26 +634,9 @@ function computeLegendDimensions(gd, groups, traces) {
 opts.height += (opts._lgroupsLength - 1) * opts.tracegroupgap;
 }

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width) + 40,
 legendItem.height
 );
 });
 extraWidth = 40;
 }
 else if(isGrouped) {
 opts.width = 0;
 opts.height = 0;

 var groupXOffsets = [opts.width],
 groupData = groups.data();

Expand DownExpand Up@@ -692,26 +677,8 @@ function computeLegendDimensions(gd, groups, traces) {

 opts.height += 10 + borderwidth * 2;
 opts.width += borderwidth * 2;

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width),
 legendItem.height
 );
 });
 }
 else {
 opts.width = 0;
 opts.height = 0;
 var rowHeight = 0,
 maxTraceHeight = 0,
 maxTraceWidth = 0,
Expand DownExpand Up@@ -750,22 +717,23 @@ function computeLegendDimensions(gd, groups, traces) {
 opts.width += borderwidth * 2;
 opts.height += 10 + borderwidth * 2;

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);
 }

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');
// make sure we're only getting full pixels
opts.width = Math.ceil(opts.width);
opts.height = Math.ceil(opts.height);

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width),
 legendItem.height
 );
 });
 }
 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

lovely commit 🎉
 0,
 -legendItem.height / 2,
 (gd._context.edits.legendText ? 0 : opts.width) + extraWidth,
 legendItem.height
 );
 });
}

function expandMargin(gd) {
Expand Down

2 changes: 1 addition & 1 deletion
src/components/shapes/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function drawOne(gd, index) {
 null
 );

 if(gd._context.editable) setupDragElement(gd, path, options, index);
 if(gd._context.edits.shapePosition) setupDragElement(gd, path, options, index);
 }
}

Expand Down

9 changes: 8 additions & 1 deletion
src/components/titles/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,14 @@ Titles.draw = function(gd, titleClass, options) {
 var opacity = 1;
 var isplaceholder = false;
 var txt = cont.title.trim();
 var editable = gd._context.editable;

 // only make this title editable if we positively identify its property
 // as one that has editing enabled.
 var editAttr;
 if(prop === 'title') editAttr = 'titleText';
 else if(prop.indexOf('axis') !== -1) editAttr = 'axisTitleText';
 else if(prop.indexOf('colorbar' !== -1)) editAttr = 'colorbarTitleText';
 var editable = gd._context.edits[editAttr];

 if(txt === '') opacity = 0;
 if(txt.match(PLACEHOLDER_RE)) {
Expand Down

37 changes: 33 additions & 4 deletions
src/plot_api/plot_api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -397,28 +397,57 @@ function opaqueSetBackground(gd, bgColor) {
}

function setPlotContext(gd, config) {
 if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
 if(!gd._context) gd._context = Lib.extendDeep({}, Plotly.defaultConfig);
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Nice. Maybe config isn't as poorly tested than I thought.
 var context = gd._context;

 var i, keys, key;

 if(config) {
 Object.keys(config).forEach(function(key) {
 keys = Object.keys(config);
 for(i = 0; i < keys.length; i++) {
 key = keys[i];
 if(key === 'editable' || key === 'edits') continue;
 if(key in context) {
 if(key === 'setBackground' && config[key] === 'opaque') {
 context[key] = opaqueSetBackground;
 }
 else context[key] = config[key];
 }
 });
 }

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
 }

 // now deal with editable and edits - first editable overrides
 // everything, then edits refines
 var editable = config.editable;
 if(editable !== undefined) {
 // we're not going to *use* context.editable, we're only going to
 // use context.edits... but keep it for the record
 context.editable = editable;

 keys = Object.keys(context.edits);
 for(i = 0; i < keys.length; i++) {
 context.edits[keys[i]] = editable;
 }
 }
 if(config.edits) {
 keys = Object.keys(config.edits);
 for(i = 0; i < keys.length; i++) {
 key = keys[i];
 if(key in context.edits) {
 context.edits[key] = config.edits[key];
 }
 }
 }
 }

 // staticPlot forces a bunch of others:
 if(context.staticPlot) {
 context.editable = false;
 context.edits = {};
 context.autosizable = false;
 context.scrollZoom = false;
 context.doubleClick = false;
Expand DownExpand Up@@ -487,7 +516,7 @@ function plotPolar(gd, data, layout) {
 var title = polarPlotSVG.select('.title-group text')
 .call(titleLayout);

 if(gd._context.editable) {
 if(gd._context.edits.titleText) {
 if(!txt || txt === placeholderText) {
 opacity = 0.2;
 // placeholder is not going through convertToTspans
Expand Down

21 changes: 20 additions & 1 deletion
src/plot_api/plot_config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,27 @@ module.exports = {
 // no interactivity, for export or image generation
 staticPlot: false,

 // we can edit titles, move annotations, etc
 // we can edit titles, move annotations, etc - sets all pieces of `edits`
 // unless a separate `edits` config item overrides individual parts
 editable: false,
 edits: {
 // annotationPosition: the main anchor of the annotation, which is the
 // text (if no arrow) or the arrow (which drags the whole thing leaving
 // the arrow length & direction unchanged)
 annotationPosition: false,
 // just for annotations with arrows, change the length and direction of the arrow
 annotationTail: false,
 annotationText: false,
 axisTitleText: false,
 colorbarPosition: false,
 colorbarTitleText: false,
 legendPosition: false,
 // edit the trace name fields from the legend
 legendText: false,
 shapePosition: false,
 // the global `layout.title`
 titleText: false
 },

 // DO autosize once regardless of layout.autosize
 // (use default width or height values otherwise)
Expand Down
Loading

, '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" + '
Granular options for on-chart editing by alexcjohnson · Pull Request #1895 · plotly/plotly.js · GitHub
Skip to content
Granular options for on-chart editing#1895

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

alexcjohnson
merged 4 commits into

from

Jul 19, 2017
 Merged


Granular options for on-chart editing
#1895
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5500120

forEach -> for


alexcjohnson Jul 18, 2017
9d4b191

DRY-up computeLegendDimensions


alexcjohnson Jul 18, 2017
b4e26ae

optionally split up editable into granular parts


alexcjohnson Jul 18, 2017
04d49dd

extendDeep for defaultConfig so we clone edits and don't modify it


alexcjohnson Jul 18, 2017

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


13 changes: 9 additions & 4 deletions
src/components/annotations/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,8 @@ function drawOne(gd, index) {
function drawRaw(gd, options, index, subplotId, xa, ya) {
 var fullLayout = gd._fullLayout;
 var gs = gd._fullLayout._size;
 var edits = gd._context.edits;

 var className;
 var annbase;

Expand DownExpand Up@@ -128,8 +130,11 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 var annTextGroup = annGroup.append('g')
 .classed('annotation-text-g', true);

 var editTextPosition = edits[options.showarrow ? 'annotationTail' : 'annotationPosition'];
 var textEvents = options.captureevents || edits.annotationText || editTextPosition;
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

No need to address this now, but this seems like the right place to reference #1750

 var annTextGroupInner = annTextGroup.append('g')
 .style('pointer-events', options.captureevents ? 'all' : null)
 .style('pointer-events', textEvents ? 'all' : null)
 .call(setCursor, 'default')
 .on('click', function() {
 gd._dragging = false;
Expand DownExpand Up@@ -519,7 +524,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {

 // the arrow dragger is a small square right at the head, then a line to the tail,
 // all expanded by a stroke width of 6px plus the arrow line width
 if(gd._context.editable && arrow.node().parentNode && !subplotId) {
 if(edits.annotationPosition && arrow.node().parentNode && !subplotId) {
 var arrowDragHeadX = headX;
 var arrowDragHeadY = headY;
 if(options.standoff) {
Expand DownExpand Up@@ -601,7 +606,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 if(options.showarrow) drawArrow(0, 0);

 // user dragging the annotation (text, not arrow)
 if(gd._context.editable) {
 if(editTextPosition) {
 var update,
 baseTextTransform;

Expand DownExpand Up@@ -679,7 +684,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 }
 }

 if(gd._context.editable) {
 if(edits.annotationText) {
 annText.call(svgTextUtils.makeEditable, {delegate: annTextGroupInner, gd: gd})
 .call(textLayout)
 .on('edit', function(_text) {
Expand Down

2 changes: 1 addition & 1 deletion
src/components/colorbar/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -550,7 +550,7 @@ module.exports = function draw(gd, id) {
 if(cbDone && cbDone.then) (gd._promises || []).push(cbDone);

 // dragging...
 if(gd._context.editable) {
 if(gd._context.edits.colorbarPosition) {
 var t0,
 xf,
 yf;
Expand Down

86 changes: 27 additions & 59 deletions
src/components/legend/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -312,7 +312,7 @@ module.exports = function draw(gd) {
 });
 }

 if(gd._context.editable) {
 if(gd._context.edits.legendPosition) {
 var xf, yf, x0, y0;

 legend.classed('cursor-move', true);
Expand DownExpand Up@@ -385,7 +385,7 @@ function drawTexts(g, gd) {
 });
 }

 if(gd._context.editable && !isPie) {
 if(gd._context.edits.legendText && !isPie) {
 text.call(svgTextUtils.makeEditable, {gd: gd})
 .call(textLayout)
 .on('edit', function(text) {
Expand DownExpand Up@@ -597,10 +597,15 @@ function computeTextDimensions(g, gd) {
}

function computeLegendDimensions(gd, groups, traces) {
 var fullLayout = gd._fullLayout,
 opts = fullLayout.legend,
 borderwidth = opts.borderwidth,
 isGrouped = helpers.isGrouped(opts);
 var fullLayout = gd._fullLayout;
 var opts = fullLayout.legend;
 var borderwidth = opts.borderwidth;
 var isGrouped = helpers.isGrouped(opts);

 var extraWidth = 0;

 opts.width = 0;
 opts.height = 0;

 if(helpers.isVertical(opts)) {
 if(isGrouped) {
Expand All@@ -609,9 +614,6 @@ function computeLegendDimensions(gd, groups, traces) {
 });
 }

 opts.width = 0;
 opts.height = 0;

 traces.each(function(d) {
 var legendItem = d[0],
 textHeight = legendItem.height,
Expand All@@ -632,26 +634,9 @@ function computeLegendDimensions(gd, groups, traces) {
 opts.height += (opts._lgroupsLength - 1) * opts.tracegroupgap;
 }

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width) + 40,
 legendItem.height
 );
 });
 extraWidth = 40;
 }
 else if(isGrouped) {
 opts.width = 0;
 opts.height = 0;

 var groupXOffsets = [opts.width],
 groupData = groups.data();

Expand DownExpand Up@@ -692,26 +677,8 @@ function computeLegendDimensions(gd, groups, traces) {

 opts.height += 10 + borderwidth * 2;
 opts.width += borderwidth * 2;

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width),
 legendItem.height
 );
 });
 }
 else {
 opts.width = 0;
 opts.height = 0;
 var rowHeight = 0,
 maxTraceHeight = 0,
 maxTraceWidth = 0,
Expand DownExpand Up@@ -750,22 +717,23 @@ function computeLegendDimensions(gd, groups, traces) {
 opts.width += borderwidth * 2;
 opts.height += 10 + borderwidth * 2;

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);
 }

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');
// make sure we're only getting full pixels
opts.width = Math.ceil(opts.width);
opts.height = Math.ceil(opts.height);

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width),
 legendItem.height
 );
 });
 }
 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

lovely commit 🎉
 0,
 -legendItem.height / 2,
 (gd._context.edits.legendText ? 0 : opts.width) + extraWidth,
 legendItem.height
 );
 });
}

function expandMargin(gd) {
Expand Down

2 changes: 1 addition & 1 deletion
src/components/shapes/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function drawOne(gd, index) {
 null
 );

 if(gd._context.editable) setupDragElement(gd, path, options, index);
 if(gd._context.edits.shapePosition) setupDragElement(gd, path, options, index);
 }
}

Expand Down

9 changes: 8 additions & 1 deletion
src/components/titles/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,14 @@ Titles.draw = function(gd, titleClass, options) {
 var opacity = 1;
 var isplaceholder = false;
 var txt = cont.title.trim();
 var editable = gd._context.editable;

 // only make this title editable if we positively identify its property
 // as one that has editing enabled.
 var editAttr;
 if(prop === 'title') editAttr = 'titleText';
 else if(prop.indexOf('axis') !== -1) editAttr = 'axisTitleText';
 else if(prop.indexOf('colorbar' !== -1)) editAttr = 'colorbarTitleText';
 var editable = gd._context.edits[editAttr];

 if(txt === '') opacity = 0;
 if(txt.match(PLACEHOLDER_RE)) {
Expand Down

37 changes: 33 additions & 4 deletions
src/plot_api/plot_api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -397,28 +397,57 @@ function opaqueSetBackground(gd, bgColor) {
}

function setPlotContext(gd, config) {
 if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
 if(!gd._context) gd._context = Lib.extendDeep({}, Plotly.defaultConfig);
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Nice. Maybe config isn't as poorly tested than I thought.
 var context = gd._context;

 var i, keys, key;

 if(config) {
 Object.keys(config).forEach(function(key) {
 keys = Object.keys(config);
 for(i = 0; i < keys.length; i++) {
 key = keys[i];
 if(key === 'editable' || key === 'edits') continue;
 if(key in context) {
 if(key === 'setBackground' && config[key] === 'opaque') {
 context[key] = opaqueSetBackground;
 }
 else context[key] = config[key];
 }
 });
 }

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
 }

 // now deal with editable and edits - first editable overrides
 // everything, then edits refines
 var editable = config.editable;
 if(editable !== undefined) {
 // we're not going to *use* context.editable, we're only going to
 // use context.edits... but keep it for the record
 context.editable = editable;

 keys = Object.keys(context.edits);
 for(i = 0; i < keys.length; i++) {
 context.edits[keys[i]] = editable;
 }
 }
 if(config.edits) {
 keys = Object.keys(config.edits);
 for(i = 0; i < keys.length; i++) {
 key = keys[i];
 if(key in context.edits) {
 context.edits[key] = config.edits[key];
 }
 }
 }
 }

 // staticPlot forces a bunch of others:
 if(context.staticPlot) {
 context.editable = false;
 context.edits = {};
 context.autosizable = false;
 context.scrollZoom = false;
 context.doubleClick = false;
Expand DownExpand Up@@ -487,7 +516,7 @@ function plotPolar(gd, data, layout) {
 var title = polarPlotSVG.select('.title-group text')
 .call(titleLayout);

 if(gd._context.editable) {
 if(gd._context.edits.titleText) {
 if(!txt || txt === placeholderText) {
 opacity = 0.2;
 // placeholder is not going through convertToTspans
Expand Down

21 changes: 20 additions & 1 deletion
src/plot_api/plot_config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,27 @@ module.exports = {
 // no interactivity, for export or image generation
 staticPlot: false,

 // we can edit titles, move annotations, etc
 // we can edit titles, move annotations, etc - sets all pieces of `edits`
 // unless a separate `edits` config item overrides individual parts
 editable: false,
 edits: {
 // annotationPosition: the main anchor of the annotation, which is the
 // text (if no arrow) or the arrow (which drags the whole thing leaving
 // the arrow length & direction unchanged)
 annotationPosition: false,
 // just for annotations with arrows, change the length and direction of the arrow
 annotationTail: false,
 annotationText: false,
 axisTitleText: false,
 colorbarPosition: false,
 colorbarTitleText: false,
 legendPosition: false,
 // edit the trace name fields from the legend
 legendText: false,
 shapePosition: false,
 // the global `layout.title`
 titleText: false
 },

 // DO autosize once regardless of layout.autosize
 // (use default width or height values otherwise)
Expand Down
Loading

, '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('^' + ".*" + '
Granular options for on-chart editing by alexcjohnson · Pull Request #1895 · plotly/plotly.js · GitHub
Skip to content
Granular options for on-chart editing#1895

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

alexcjohnson
merged 4 commits into

from

Jul 19, 2017
 Merged


Granular options for on-chart editing
#1895
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5500120

forEach -> for


alexcjohnson Jul 18, 2017
9d4b191

DRY-up computeLegendDimensions


alexcjohnson Jul 18, 2017
b4e26ae

optionally split up editable into granular parts


alexcjohnson Jul 18, 2017
04d49dd

extendDeep for defaultConfig so we clone edits and don't modify it


alexcjohnson Jul 18, 2017

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


13 changes: 9 additions & 4 deletions
src/components/annotations/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,8 @@ function drawOne(gd, index) {
function drawRaw(gd, options, index, subplotId, xa, ya) {
 var fullLayout = gd._fullLayout;
 var gs = gd._fullLayout._size;
 var edits = gd._context.edits;

 var className;
 var annbase;

Expand DownExpand Up@@ -128,8 +130,11 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 var annTextGroup = annGroup.append('g')
 .classed('annotation-text-g', true);

 var editTextPosition = edits[options.showarrow ? 'annotationTail' : 'annotationPosition'];
 var textEvents = options.captureevents || edits.annotationText || editTextPosition;
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

No need to address this now, but this seems like the right place to reference #1750

 var annTextGroupInner = annTextGroup.append('g')
 .style('pointer-events', options.captureevents ? 'all' : null)
 .style('pointer-events', textEvents ? 'all' : null)
 .call(setCursor, 'default')
 .on('click', function() {
 gd._dragging = false;
Expand DownExpand Up@@ -519,7 +524,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {

 // the arrow dragger is a small square right at the head, then a line to the tail,
 // all expanded by a stroke width of 6px plus the arrow line width
 if(gd._context.editable && arrow.node().parentNode && !subplotId) {
 if(edits.annotationPosition && arrow.node().parentNode && !subplotId) {
 var arrowDragHeadX = headX;
 var arrowDragHeadY = headY;
 if(options.standoff) {
Expand DownExpand Up@@ -601,7 +606,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 if(options.showarrow) drawArrow(0, 0);

 // user dragging the annotation (text, not arrow)
 if(gd._context.editable) {
 if(editTextPosition) {
 var update,
 baseTextTransform;

Expand DownExpand Up@@ -679,7 +684,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 }
 }

 if(gd._context.editable) {
 if(edits.annotationText) {
 annText.call(svgTextUtils.makeEditable, {delegate: annTextGroupInner, gd: gd})
 .call(textLayout)
 .on('edit', function(_text) {
Expand Down

2 changes: 1 addition & 1 deletion
src/components/colorbar/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -550,7 +550,7 @@ module.exports = function draw(gd, id) {
 if(cbDone && cbDone.then) (gd._promises || []).push(cbDone);

 // dragging...
 if(gd._context.editable) {
 if(gd._context.edits.colorbarPosition) {
 var t0,
 xf,
 yf;
Expand Down

86 changes: 27 additions & 59 deletions
src/components/legend/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -312,7 +312,7 @@ module.exports = function draw(gd) {
 });
 }

 if(gd._context.editable) {
 if(gd._context.edits.legendPosition) {
 var xf, yf, x0, y0;

 legend.classed('cursor-move', true);
Expand DownExpand Up@@ -385,7 +385,7 @@ function drawTexts(g, gd) {
 });
 }

 if(gd._context.editable && !isPie) {
 if(gd._context.edits.legendText && !isPie) {
 text.call(svgTextUtils.makeEditable, {gd: gd})
 .call(textLayout)
 .on('edit', function(text) {
Expand DownExpand Up@@ -597,10 +597,15 @@ function computeTextDimensions(g, gd) {
}

function computeLegendDimensions(gd, groups, traces) {
 var fullLayout = gd._fullLayout,
 opts = fullLayout.legend,
 borderwidth = opts.borderwidth,
 isGrouped = helpers.isGrouped(opts);
 var fullLayout = gd._fullLayout;
 var opts = fullLayout.legend;
 var borderwidth = opts.borderwidth;
 var isGrouped = helpers.isGrouped(opts);

 var extraWidth = 0;

 opts.width = 0;
 opts.height = 0;

 if(helpers.isVertical(opts)) {
 if(isGrouped) {
Expand All@@ -609,9 +614,6 @@ function computeLegendDimensions(gd, groups, traces) {
 });
 }

 opts.width = 0;
 opts.height = 0;

 traces.each(function(d) {
 var legendItem = d[0],
 textHeight = legendItem.height,
Expand All@@ -632,26 +634,9 @@ function computeLegendDimensions(gd, groups, traces) {
 opts.height += (opts._lgroupsLength - 1) * opts.tracegroupgap;
 }

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width) + 40,
 legendItem.height
 );
 });
 extraWidth = 40;
 }
 else if(isGrouped) {
 opts.width = 0;
 opts.height = 0;

 var groupXOffsets = [opts.width],
 groupData = groups.data();

Expand DownExpand Up@@ -692,26 +677,8 @@ function computeLegendDimensions(gd, groups, traces) {

 opts.height += 10 + borderwidth * 2;
 opts.width += borderwidth * 2;

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width),
 legendItem.height
 );
 });
 }
 else {
 opts.width = 0;
 opts.height = 0;
 var rowHeight = 0,
 maxTraceHeight = 0,
 maxTraceWidth = 0,
Expand DownExpand Up@@ -750,22 +717,23 @@ function computeLegendDimensions(gd, groups, traces) {
 opts.width += borderwidth * 2;
 opts.height += 10 + borderwidth * 2;

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);
 }

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');
// make sure we're only getting full pixels
opts.width = Math.ceil(opts.width);
opts.height = Math.ceil(opts.height);

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width),
 legendItem.height
 );
 });
 }
 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

lovely commit 🎉
 0,
 -legendItem.height / 2,
 (gd._context.edits.legendText ? 0 : opts.width) + extraWidth,
 legendItem.height
 );
 });
}

function expandMargin(gd) {
Expand Down

2 changes: 1 addition & 1 deletion
src/components/shapes/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function drawOne(gd, index) {
 null
 );

 if(gd._context.editable) setupDragElement(gd, path, options, index);
 if(gd._context.edits.shapePosition) setupDragElement(gd, path, options, index);
 }
}

Expand Down

9 changes: 8 additions & 1 deletion
src/components/titles/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,14 @@ Titles.draw = function(gd, titleClass, options) {
 var opacity = 1;
 var isplaceholder = false;
 var txt = cont.title.trim();
 var editable = gd._context.editable;

 // only make this title editable if we positively identify its property
 // as one that has editing enabled.
 var editAttr;
 if(prop === 'title') editAttr = 'titleText';
 else if(prop.indexOf('axis') !== -1) editAttr = 'axisTitleText';
 else if(prop.indexOf('colorbar' !== -1)) editAttr = 'colorbarTitleText';
 var editable = gd._context.edits[editAttr];

 if(txt === '') opacity = 0;
 if(txt.match(PLACEHOLDER_RE)) {
Expand Down

37 changes: 33 additions & 4 deletions
src/plot_api/plot_api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -397,28 +397,57 @@ function opaqueSetBackground(gd, bgColor) {
}

function setPlotContext(gd, config) {
 if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
 if(!gd._context) gd._context = Lib.extendDeep({}, Plotly.defaultConfig);
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Nice. Maybe config isn't as poorly tested than I thought.
 var context = gd._context;

 var i, keys, key;

 if(config) {
 Object.keys(config).forEach(function(key) {
 keys = Object.keys(config);
 for(i = 0; i < keys.length; i++) {
 key = keys[i];
 if(key === 'editable' || key === 'edits') continue;
 if(key in context) {
 if(key === 'setBackground' && config[key] === 'opaque') {
 context[key] = opaqueSetBackground;
 }
 else context[key] = config[key];
 }
 });
 }

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
 }

 // now deal with editable and edits - first editable overrides
 // everything, then edits refines
 var editable = config.editable;
 if(editable !== undefined) {
 // we're not going to *use* context.editable, we're only going to
 // use context.edits... but keep it for the record
 context.editable = editable;

 keys = Object.keys(context.edits);
 for(i = 0; i < keys.length; i++) {
 context.edits[keys[i]] = editable;
 }
 }
 if(config.edits) {
 keys = Object.keys(config.edits);
 for(i = 0; i < keys.length; i++) {
 key = keys[i];
 if(key in context.edits) {
 context.edits[key] = config.edits[key];
 }
 }
 }
 }

 // staticPlot forces a bunch of others:
 if(context.staticPlot) {
 context.editable = false;
 context.edits = {};
 context.autosizable = false;
 context.scrollZoom = false;
 context.doubleClick = false;
Expand DownExpand Up@@ -487,7 +516,7 @@ function plotPolar(gd, data, layout) {
 var title = polarPlotSVG.select('.title-group text')
 .call(titleLayout);

 if(gd._context.editable) {
 if(gd._context.edits.titleText) {
 if(!txt || txt === placeholderText) {
 opacity = 0.2;
 // placeholder is not going through convertToTspans
Expand Down

21 changes: 20 additions & 1 deletion
src/plot_api/plot_config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,27 @@ module.exports = {
 // no interactivity, for export or image generation
 staticPlot: false,

 // we can edit titles, move annotations, etc
 // we can edit titles, move annotations, etc - sets all pieces of `edits`
 // unless a separate `edits` config item overrides individual parts
 editable: false,
 edits: {
 // annotationPosition: the main anchor of the annotation, which is the
 // text (if no arrow) or the arrow (which drags the whole thing leaving
 // the arrow length & direction unchanged)
 annotationPosition: false,
 // just for annotations with arrows, change the length and direction of the arrow
 annotationTail: false,
 annotationText: false,
 axisTitleText: false,
 colorbarPosition: false,
 colorbarTitleText: false,
 legendPosition: false,
 // edit the trace name fields from the legend
 legendText: false,
 shapePosition: false,
 // the global `layout.title`
 titleText: false
 },

 // DO autosize once regardless of layout.autosize
 // (use default width or height values otherwise)
Expand Down
Loading

, '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('^' + ".*" + '
Granular options for on-chart editing by alexcjohnson · Pull Request #1895 · plotly/plotly.js · GitHub
Skip to content
Granular options for on-chart editing#1895

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

alexcjohnson
merged 4 commits into

from

Jul 19, 2017
 Merged


Granular options for on-chart editing
#1895
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5500120

forEach -> for


alexcjohnson Jul 18, 2017
9d4b191

DRY-up computeLegendDimensions


alexcjohnson Jul 18, 2017
b4e26ae

optionally split up editable into granular parts


alexcjohnson Jul 18, 2017
04d49dd

extendDeep for defaultConfig so we clone edits and don't modify it


alexcjohnson Jul 18, 2017

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


13 changes: 9 additions & 4 deletions
src/components/annotations/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,8 @@ function drawOne(gd, index) {
function drawRaw(gd, options, index, subplotId, xa, ya) {
 var fullLayout = gd._fullLayout;
 var gs = gd._fullLayout._size;
 var edits = gd._context.edits;

 var className;
 var annbase;

Expand DownExpand Up@@ -128,8 +130,11 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 var annTextGroup = annGroup.append('g')
 .classed('annotation-text-g', true);

 var editTextPosition = edits[options.showarrow ? 'annotationTail' : 'annotationPosition'];
 var textEvents = options.captureevents || edits.annotationText || editTextPosition;
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

No need to address this now, but this seems like the right place to reference #1750

 var annTextGroupInner = annTextGroup.append('g')
 .style('pointer-events', options.captureevents ? 'all' : null)
 .style('pointer-events', textEvents ? 'all' : null)
 .call(setCursor, 'default')
 .on('click', function() {
 gd._dragging = false;
Expand DownExpand Up@@ -519,7 +524,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {

 // the arrow dragger is a small square right at the head, then a line to the tail,
 // all expanded by a stroke width of 6px plus the arrow line width
 if(gd._context.editable && arrow.node().parentNode && !subplotId) {
 if(edits.annotationPosition && arrow.node().parentNode && !subplotId) {
 var arrowDragHeadX = headX;
 var arrowDragHeadY = headY;
 if(options.standoff) {
Expand DownExpand Up@@ -601,7 +606,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 if(options.showarrow) drawArrow(0, 0);

 // user dragging the annotation (text, not arrow)
 if(gd._context.editable) {
 if(editTextPosition) {
 var update,
 baseTextTransform;

Expand DownExpand Up@@ -679,7 +684,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 }
 }

 if(gd._context.editable) {
 if(edits.annotationText) {
 annText.call(svgTextUtils.makeEditable, {delegate: annTextGroupInner, gd: gd})
 .call(textLayout)
 .on('edit', function(_text) {
Expand Down

2 changes: 1 addition & 1 deletion
src/components/colorbar/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -550,7 +550,7 @@ module.exports = function draw(gd, id) {
 if(cbDone && cbDone.then) (gd._promises || []).push(cbDone);

 // dragging...
 if(gd._context.editable) {
 if(gd._context.edits.colorbarPosition) {
 var t0,
 xf,
 yf;
Expand Down

86 changes: 27 additions & 59 deletions
src/components/legend/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -312,7 +312,7 @@ module.exports = function draw(gd) {
 });
 }

 if(gd._context.editable) {
 if(gd._context.edits.legendPosition) {
 var xf, yf, x0, y0;

 legend.classed('cursor-move', true);
Expand DownExpand Up@@ -385,7 +385,7 @@ function drawTexts(g, gd) {
 });
 }

 if(gd._context.editable && !isPie) {
 if(gd._context.edits.legendText && !isPie) {
 text.call(svgTextUtils.makeEditable, {gd: gd})
 .call(textLayout)
 .on('edit', function(text) {
Expand DownExpand Up@@ -597,10 +597,15 @@ function computeTextDimensions(g, gd) {
}

function computeLegendDimensions(gd, groups, traces) {
 var fullLayout = gd._fullLayout,
 opts = fullLayout.legend,
 borderwidth = opts.borderwidth,
 isGrouped = helpers.isGrouped(opts);
 var fullLayout = gd._fullLayout;
 var opts = fullLayout.legend;
 var borderwidth = opts.borderwidth;
 var isGrouped = helpers.isGrouped(opts);

 var extraWidth = 0;

 opts.width = 0;
 opts.height = 0;

 if(helpers.isVertical(opts)) {
 if(isGrouped) {
Expand All@@ -609,9 +614,6 @@ function computeLegendDimensions(gd, groups, traces) {
 });
 }

 opts.width = 0;
 opts.height = 0;

 traces.each(function(d) {
 var legendItem = d[0],
 textHeight = legendItem.height,
Expand All@@ -632,26 +634,9 @@ function computeLegendDimensions(gd, groups, traces) {
 opts.height += (opts._lgroupsLength - 1) * opts.tracegroupgap;
 }

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width) + 40,
 legendItem.height
 );
 });
 extraWidth = 40;
 }
 else if(isGrouped) {
 opts.width = 0;
 opts.height = 0;

 var groupXOffsets = [opts.width],
 groupData = groups.data();

Expand DownExpand Up@@ -692,26 +677,8 @@ function computeLegendDimensions(gd, groups, traces) {

 opts.height += 10 + borderwidth * 2;
 opts.width += borderwidth * 2;

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width),
 legendItem.height
 );
 });
 }
 else {
 opts.width = 0;
 opts.height = 0;
 var rowHeight = 0,
 maxTraceHeight = 0,
 maxTraceWidth = 0,
Expand DownExpand Up@@ -750,22 +717,23 @@ function computeLegendDimensions(gd, groups, traces) {
 opts.width += borderwidth * 2;
 opts.height += 10 + borderwidth * 2;

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);
 }

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');
// make sure we're only getting full pixels
opts.width = Math.ceil(opts.width);
opts.height = Math.ceil(opts.height);

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width),
 legendItem.height
 );
 });
 }
 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

lovely commit 🎉
 0,
 -legendItem.height / 2,
 (gd._context.edits.legendText ? 0 : opts.width) + extraWidth,
 legendItem.height
 );
 });
}

function expandMargin(gd) {
Expand Down

2 changes: 1 addition & 1 deletion
src/components/shapes/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function drawOne(gd, index) {
 null
 );

 if(gd._context.editable) setupDragElement(gd, path, options, index);
 if(gd._context.edits.shapePosition) setupDragElement(gd, path, options, index);
 }
}

Expand Down

9 changes: 8 additions & 1 deletion
src/components/titles/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,14 @@ Titles.draw = function(gd, titleClass, options) {
 var opacity = 1;
 var isplaceholder = false;
 var txt = cont.title.trim();
 var editable = gd._context.editable;

 // only make this title editable if we positively identify its property
 // as one that has editing enabled.
 var editAttr;
 if(prop === 'title') editAttr = 'titleText';
 else if(prop.indexOf('axis') !== -1) editAttr = 'axisTitleText';
 else if(prop.indexOf('colorbar' !== -1)) editAttr = 'colorbarTitleText';
 var editable = gd._context.edits[editAttr];

 if(txt === '') opacity = 0;
 if(txt.match(PLACEHOLDER_RE)) {
Expand Down

37 changes: 33 additions & 4 deletions
src/plot_api/plot_api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -397,28 +397,57 @@ function opaqueSetBackground(gd, bgColor) {
}

function setPlotContext(gd, config) {
 if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
 if(!gd._context) gd._context = Lib.extendDeep({}, Plotly.defaultConfig);
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Nice. Maybe config isn't as poorly tested than I thought.
 var context = gd._context;

 var i, keys, key;

 if(config) {
 Object.keys(config).forEach(function(key) {
 keys = Object.keys(config);
 for(i = 0; i < keys.length; i++) {
 key = keys[i];
 if(key === 'editable' || key === 'edits') continue;
 if(key in context) {
 if(key === 'setBackground' && config[key] === 'opaque') {
 context[key] = opaqueSetBackground;
 }
 else context[key] = config[key];
 }
 });
 }

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
 }

 // now deal with editable and edits - first editable overrides
 // everything, then edits refines
 var editable = config.editable;
 if(editable !== undefined) {
 // we're not going to *use* context.editable, we're only going to
 // use context.edits... but keep it for the record
 context.editable = editable;

 keys = Object.keys(context.edits);
 for(i = 0; i < keys.length; i++) {
 context.edits[keys[i]] = editable;
 }
 }
 if(config.edits) {
 keys = Object.keys(config.edits);
 for(i = 0; i < keys.length; i++) {
 key = keys[i];
 if(key in context.edits) {
 context.edits[key] = config.edits[key];
 }
 }
 }
 }

 // staticPlot forces a bunch of others:
 if(context.staticPlot) {
 context.editable = false;
 context.edits = {};
 context.autosizable = false;
 context.scrollZoom = false;
 context.doubleClick = false;
Expand DownExpand Up@@ -487,7 +516,7 @@ function plotPolar(gd, data, layout) {
 var title = polarPlotSVG.select('.title-group text')
 .call(titleLayout);

 if(gd._context.editable) {
 if(gd._context.edits.titleText) {
 if(!txt || txt === placeholderText) {
 opacity = 0.2;
 // placeholder is not going through convertToTspans
Expand Down

21 changes: 20 additions & 1 deletion
src/plot_api/plot_config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,27 @@ module.exports = {
 // no interactivity, for export or image generation
 staticPlot: false,

 // we can edit titles, move annotations, etc
 // we can edit titles, move annotations, etc - sets all pieces of `edits`
 // unless a separate `edits` config item overrides individual parts
 editable: false,
 edits: {
 // annotationPosition: the main anchor of the annotation, which is the
 // text (if no arrow) or the arrow (which drags the whole thing leaving
 // the arrow length & direction unchanged)
 annotationPosition: false,
 // just for annotations with arrows, change the length and direction of the arrow
 annotationTail: false,
 annotationText: false,
 axisTitleText: false,
 colorbarPosition: false,
 colorbarTitleText: false,
 legendPosition: false,
 // edit the trace name fields from the legend
 legendText: false,
 shapePosition: false,
 // the global `layout.title`
 titleText: false
 },

 // DO autosize once regardless of layout.autosize
 // (use default width or height values otherwise)
Expand Down
Loading

, '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); }
})();
})();
Granular options for on-chart editing by alexcjohnson · Pull Request #1895 · plotly/plotly.js · GitHub
Skip to content
Granular options for on-chart editing#1895

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

alexcjohnson
merged 4 commits into

from

Jul 19, 2017
 Merged


Granular options for on-chart editing
#1895
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
5500120

forEach -> for


alexcjohnson Jul 18, 2017
9d4b191

DRY-up computeLegendDimensions


alexcjohnson Jul 18, 2017
b4e26ae

optionally split up editable into granular parts


alexcjohnson Jul 18, 2017
04d49dd

extendDeep for defaultConfig so we clone edits and don't modify it


alexcjohnson Jul 18, 2017

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


13 changes: 9 additions & 4 deletions
src/components/annotations/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,8 @@ function drawOne(gd, index) {
function drawRaw(gd, options, index, subplotId, xa, ya) {
 var fullLayout = gd._fullLayout;
 var gs = gd._fullLayout._size;
 var edits = gd._context.edits;

 var className;
 var annbase;

Expand DownExpand Up@@ -128,8 +130,11 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 var annTextGroup = annGroup.append('g')
 .classed('annotation-text-g', true);

 var editTextPosition = edits[options.showarrow ? 'annotationTail' : 'annotationPosition'];
 var textEvents = options.captureevents || edits.annotationText || editTextPosition;
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

No need to address this now, but this seems like the right place to reference #1750

 var annTextGroupInner = annTextGroup.append('g')
 .style('pointer-events', options.captureevents ? 'all' : null)
 .style('pointer-events', textEvents ? 'all' : null)
 .call(setCursor, 'default')
 .on('click', function() {
 gd._dragging = false;
Expand DownExpand Up@@ -519,7 +524,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {

 // the arrow dragger is a small square right at the head, then a line to the tail,
 // all expanded by a stroke width of 6px plus the arrow line width
 if(gd._context.editable && arrow.node().parentNode && !subplotId) {
 if(edits.annotationPosition && arrow.node().parentNode && !subplotId) {
 var arrowDragHeadX = headX;
 var arrowDragHeadY = headY;
 if(options.standoff) {
Expand DownExpand Up@@ -601,7 +606,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 if(options.showarrow) drawArrow(0, 0);

 // user dragging the annotation (text, not arrow)
 if(gd._context.editable) {
 if(editTextPosition) {
 var update,
 baseTextTransform;

Expand DownExpand Up@@ -679,7 +684,7 @@ function drawRaw(gd, options, index, subplotId, xa, ya) {
 }
 }

 if(gd._context.editable) {
 if(edits.annotationText) {
 annText.call(svgTextUtils.makeEditable, {delegate: annTextGroupInner, gd: gd})
 .call(textLayout)
 .on('edit', function(_text) {
Expand Down

2 changes: 1 addition & 1 deletion
src/components/colorbar/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -550,7 +550,7 @@ module.exports = function draw(gd, id) {
 if(cbDone && cbDone.then) (gd._promises || []).push(cbDone);

 // dragging...
 if(gd._context.editable) {
 if(gd._context.edits.colorbarPosition) {
 var t0,
 xf,
 yf;
Expand Down

86 changes: 27 additions & 59 deletions
src/components/legend/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -312,7 +312,7 @@ module.exports = function draw(gd) {
 });
 }

 if(gd._context.editable) {
 if(gd._context.edits.legendPosition) {
 var xf, yf, x0, y0;

 legend.classed('cursor-move', true);
Expand DownExpand Up@@ -385,7 +385,7 @@ function drawTexts(g, gd) {
 });
 }

 if(gd._context.editable && !isPie) {
 if(gd._context.edits.legendText && !isPie) {
 text.call(svgTextUtils.makeEditable, {gd: gd})
 .call(textLayout)
 .on('edit', function(text) {
Expand DownExpand Up@@ -597,10 +597,15 @@ function computeTextDimensions(g, gd) {
}

function computeLegendDimensions(gd, groups, traces) {
 var fullLayout = gd._fullLayout,
 opts = fullLayout.legend,
 borderwidth = opts.borderwidth,
 isGrouped = helpers.isGrouped(opts);
 var fullLayout = gd._fullLayout;
 var opts = fullLayout.legend;
 var borderwidth = opts.borderwidth;
 var isGrouped = helpers.isGrouped(opts);

 var extraWidth = 0;

 opts.width = 0;
 opts.height = 0;

 if(helpers.isVertical(opts)) {
 if(isGrouped) {
Expand All@@ -609,9 +614,6 @@ function computeLegendDimensions(gd, groups, traces) {
 });
 }

 opts.width = 0;
 opts.height = 0;

 traces.each(function(d) {
 var legendItem = d[0],
 textHeight = legendItem.height,
Expand All@@ -632,26 +634,9 @@ function computeLegendDimensions(gd, groups, traces) {
 opts.height += (opts._lgroupsLength - 1) * opts.tracegroupgap;
 }

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width) + 40,
 legendItem.height
 );
 });
 extraWidth = 40;
 }
 else if(isGrouped) {
 opts.width = 0;
 opts.height = 0;

 var groupXOffsets = [opts.width],
 groupData = groups.data();

Expand DownExpand Up@@ -692,26 +677,8 @@ function computeLegendDimensions(gd, groups, traces) {

 opts.height += 10 + borderwidth * 2;
 opts.width += borderwidth * 2;

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width),
 legendItem.height
 );
 });
 }
 else {
 opts.width = 0;
 opts.height = 0;
 var rowHeight = 0,
 maxTraceHeight = 0,
 maxTraceWidth = 0,
Expand DownExpand Up@@ -750,22 +717,23 @@ function computeLegendDimensions(gd, groups, traces) {
 opts.width += borderwidth * 2;
 opts.height += 10 + borderwidth * 2;

 // make sure we're only getting full pixels
 opts.width = Math.ceil(opts.width);
 opts.height = Math.ceil(opts.height);
 }

 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');
// make sure we're only getting full pixels
opts.width = Math.ceil(opts.width);
opts.height = Math.ceil(opts.height);

 bg.call(Drawing.setRect,
 0,
 -legendItem.height / 2,
 (gd._context.editable ? 0 : opts.width),
 legendItem.height
 );
 });
 }
 traces.each(function(d) {
 var legendItem = d[0],
 bg = d3.select(this).select('.legendtoggle');

 bg.call(Drawing.setRect,
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

lovely commit 🎉
 0,
 -legendItem.height / 2,
 (gd._context.edits.legendText ? 0 : opts.width) + extraWidth,
 legendItem.height
 );
 });
}

function expandMargin(gd) {
Expand Down

2 changes: 1 addition & 1 deletion
src/components/shapes/draw.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,7 +114,7 @@ function drawOne(gd, index) {
 null
 );

 if(gd._context.editable) setupDragElement(gd, path, options, index);
 if(gd._context.edits.shapePosition) setupDragElement(gd, path, options, index);
 }
}

Expand Down

9 changes: 8 additions & 1 deletion
src/components/titles/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -70,7 +70,14 @@ Titles.draw = function(gd, titleClass, options) {
 var opacity = 1;
 var isplaceholder = false;
 var txt = cont.title.trim();
 var editable = gd._context.editable;

 // only make this title editable if we positively identify its property
 // as one that has editing enabled.
 var editAttr;
 if(prop === 'title') editAttr = 'titleText';
 else if(prop.indexOf('axis') !== -1) editAttr = 'axisTitleText';
 else if(prop.indexOf('colorbar' !== -1)) editAttr = 'colorbarTitleText';
 var editable = gd._context.edits[editAttr];

 if(txt === '') opacity = 0;
 if(txt.match(PLACEHOLDER_RE)) {
Expand Down

37 changes: 33 additions & 4 deletions
src/plot_api/plot_api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -397,28 +397,57 @@ function opaqueSetBackground(gd, bgColor) {
}

function setPlotContext(gd, config) {
 if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
 if(!gd._context) gd._context = Lib.extendDeep({}, Plotly.defaultConfig);
@etpinardetpinardJul 19, 2017

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

Nice. Maybe config isn't as poorly tested than I thought.
 var context = gd._context;

 var i, keys, key;

 if(config) {
 Object.keys(config).forEach(function(key) {
 keys = Object.keys(config);
 for(i = 0; i < keys.length; i++) {
 key = keys[i];
 if(key === 'editable' || key === 'edits') continue;
 if(key in context) {
 if(key === 'setBackground' && config[key] === 'opaque') {
 context[key] = opaqueSetBackground;
 }
 else context[key] = config[key];
 }
 });
 }

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
 }

 // now deal with editable and edits - first editable overrides
 // everything, then edits refines
 var editable = config.editable;
 if(editable !== undefined) {
 // we're not going to *use* context.editable, we're only going to
 // use context.edits... but keep it for the record
 context.editable = editable;

 keys = Object.keys(context.edits);
 for(i = 0; i < keys.length; i++) {
 context.edits[keys[i]] = editable;
 }
 }
 if(config.edits) {
 keys = Object.keys(config.edits);
 for(i = 0; i < keys.length; i++) {
 key = keys[i];
 if(key in context.edits) {
 context.edits[key] = config.edits[key];
 }
 }
 }
 }

 // staticPlot forces a bunch of others:
 if(context.staticPlot) {
 context.editable = false;
 context.edits = {};
 context.autosizable = false;
 context.scrollZoom = false;
 context.doubleClick = false;
Expand DownExpand Up@@ -487,7 +516,7 @@ function plotPolar(gd, data, layout) {
 var title = polarPlotSVG.select('.title-group text')
 .call(titleLayout);

 if(gd._context.editable) {
 if(gd._context.edits.titleText) {
 if(!txt || txt === placeholderText) {
 opacity = 0.2;
 // placeholder is not going through convertToTspans
Expand Down

21 changes: 20 additions & 1 deletion
src/plot_api/plot_config.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,8 +23,27 @@ module.exports = {
 // no interactivity, for export or image generation
 staticPlot: false,

 // we can edit titles, move annotations, etc
 // we can edit titles, move annotations, etc - sets all pieces of `edits`
 // unless a separate `edits` config item overrides individual parts
 editable: false,
 edits: {
 // annotationPosition: the main anchor of the annotation, which is the
 // text (if no arrow) or the arrow (which drags the whole thing leaving
 // the arrow length & direction unchanged)
 annotationPosition: false,
 // just for annotations with arrows, change the length and direction of the arrow
 annotationTail: false,
 annotationText: false,
 axisTitleText: false,
 colorbarPosition: false,
 colorbarTitleText: false,
 legendPosition: false,
 // edit the trace name fields from the legend
 legendText: false,
 shapePosition: false,
 // the global `layout.title`
 titleText: false
 },

 // DO autosize once regardless of layout.autosize
 // (use default width or height values otherwise)
Expand Down
Loading