introduce layout attribute uid to provide deterministic identifiers

antoinerg · antoinerg · commit bda00d352638 · 2020-02-20T15:59:08.000-05:00
diff --git a/src/plot_api/plot_api.js b/src/plot_api/plot_api.js
@@ -3735,7 +3735,7 @@ function makePlotFramework(gd) {
         d3.selectAll('defs').each(function() {
             if(this.id) otherUids[this.id.split('-')[1]] = 1;
         });
-        fullLayout._uid = Lib.randstr(otherUids);
+        fullLayout._uid = fullLayout.uid || Lib.randstr(otherUids);
     }
 
     fullLayout._paperdiv.selectAll('.main-svg')
diff --git a/src/plots/layout_attributes.js b/src/plots/layout_attributes.js
@@ -460,7 +460,15 @@ module.exports = {
             '%{meta[key]}.'
         ].join(' ')
     },
-
+    uid: {
+        valType: 'string',
+        role: 'info',
+        editType: 'plot',
+        description: [
+            'Assign an id to this layout,',
+            'Use this to provide deterministic identifiers within that figure.'
+        ].join(' ')
+    },
     transition: extendFlat({}, animationAttrs.transition, {
         description: [
             'Sets transition options used during Plotly.react updates.'
diff --git a/src/plots/plots.js b/src/plots/plots.js
@@ -1524,6 +1524,7 @@ plots.supplyLayoutGlobalDefaults = function(layoutIn, layoutOut, formatObj) {
     coerce('modebar.uirevision', uirevision);
 
     coerce('meta');
+    coerce('uid');
 
     // do not include defaults in fullLayout when users do not set transition
     if(Lib.isPlainObject(layoutIn.transition)) {

Original file line number	Diff line number	Diff line change
`@@ -3735,7 +3735,7 @@ function makePlotFramework(gd) {`
`3735`	`3735`	`d3.selectAll('defs').each(function() {`
`3736`	`3736`	`if(this.id) otherUids[this.id.split('-')[1]] = 1;`
`3737`	`3737`	`});`
`3738`		`- fullLayout._uid = Lib.randstr(otherUids);`
	`3738`	`+ fullLayout._uid = fullLayout.uid \|\| Lib.randstr(otherUids);`
`3739`	`3739`	`}`
`3740`	`3740`
`3741`	`3741`	`fullLayout._paperdiv.selectAll('.main-svg')`