Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/components/annotations/annotation_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');


module.exports = function handleAnnotationDefaults(annIn, fullLayout) {
var annOut = {};
module.exports = function handleAnnotationDefaults(annIn, annOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(annIn, annOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return annOut;

Expand Down
14 changes: 6 additions & 8 deletions src/components/annotations/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleAnnotationDefaults = require('./annotation_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.annotations || [],
containerOut = layoutOut.annotations = [];
var opts = {
name: 'annotations',
handleItemDefaults: handleAnnotationDefaults

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

🌴

};

for(var i = 0; i < containerIn.length; i++) {
var annIn = containerIn[i] || {},
annOut = handleAnnotationDefaults(annIn, layoutOut);

containerOut.push(annOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/annotations/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -242,7 +242,8 @@ function drawOne(gd, index, opt, value) {
optionsIn[axLetter] = position;
}

var options = handleAnnotationDefaults(optionsIn, fullLayout);
var options = {};
handleAnnotationDefaults(optionsIn, options, fullLayout);
fullLayout.annotations[index] = options;

var xa = Axes.getFromId(gd, options.xref),
Expand Down
20 changes: 8 additions & 12 deletions src/components/images/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,24 +8,20 @@

'use strict';

var Axes = require('../../plots/cartesian/axes');
var Lib = require('../../lib');
var attributes = require('./attributes');
var Axes = require('../../plots/cartesian/axes');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var name = 'images';

module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: imageDefaults
};

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i] || {},
itemOut = {};

imageDefaults(itemIn, itemOut, layoutOut);

contOut.push(itemOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};


Expand Down
14 changes: 6 additions & 8 deletions src/components/shapes/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleShapeDefaults = require('./shape_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.shapes || [],
containerOut = layoutOut.shapes = [];
var opts = {
name: 'shapes',
handleItemDefaults: handleShapeDefaults
};

for(var i = 0; i < containerIn.length; i++) {
var shapeIn = containerIn[i] || {},
shapeOut = handleShapeDefaults(shapeIn, layoutOut);

containerOut.push(shapeOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/shapes/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -232,7 +232,8 @@ function updateShape(gd, index, opt, value) {
optionsIn[posAttr] = position;
}

var options = handleShapeDefaults(optionsIn, gd._fullLayout);
var options = {};
handleShapeDefaults(optionsIn, options, gd._fullLayout);
gd._fullLayout.shapes[index] = options;

var clipAxes;
Expand Down
8 changes: 5 additions & 3 deletions src/components/shapes/shape_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,16 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');
var helpers = require('./helpers');

module.exports = function handleShapeDefaults(shapeIn, fullLayout) {
var shapeOut = {};

module.exports = function handleShapeDefaults(shapeIn, shapeOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(shapeIn, shapeOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return shapeOut;

Expand Down
22 changes: 6 additions & 16 deletions src/components/sliders/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var stepAttrs = attributes.steps;


module.exports = function slidersDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: sliderDefaults
};

for(var i = 0; i < contIn.length; i++) {
var sliderIn = contIn[i] || {},
sliderOut = {};

sliderDefaults(sliderIn, sliderOut, layoutOut);

// used on button click to update the 'active' field
sliderOut._input = sliderIn;

// used to determine object constancy
sliderOut._index = i;

contOut.push(sliderOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function sliderDefaults(sliderIn, sliderOut, layoutOut) {
Expand Down
22 changes: 6 additions & 16 deletions src/components/updatemenus/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var buttonAttrs = attributes.buttons;


module.exports = function updateMenusDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: menuDefaults
};

for(var i = 0; i < contIn.length; i++) {
var menuIn = contIn[i] || {},
menuOut = {};

menuDefaults(menuIn, menuOut, layoutOut);

// used on button click to update the 'active' field
menuOut._input = menuIn;

// used to determine object constancy
menuOut._index = i;

contOut.push(menuOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function menuDefaults(menuIn, menuOut, layoutOut) {
Expand Down
19 changes: 9 additions & 10 deletions src/plot_api/helpers.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,13 +102,12 @@ exports.cleanLayout = function(layout) {
}
}

if(layout.annotations !== undefined && !Array.isArray(layout.annotations)) {
Lib.warn('Annotations must be an array.');
delete layout.annotations;
}
var annotationsLen = (layout.annotations || []).length;
var annotationsLen = Array.isArray(layout.annotations) ? layout.annotations.length : 0;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this commit was enough to fix bug discovered in http://codepen.io/etpinard/pen/xRGgwW

for(i = 0; i < annotationsLen; i++) {
var ann = layout.annotations[i];

if(!Lib.isPlainObject(ann)) continue;

if(ann.ref) {
if(ann.ref === 'paper') {
ann.xref = 'paper';
Expand All@@ -120,17 +119,17 @@ exports.cleanLayout = function(layout) {
}
delete ann.ref;
}

cleanAxRef(ann, 'xref');
cleanAxRef(ann, 'yref');
}

if(layout.shapes !== undefined && !Array.isArray(layout.shapes)) {
Lib.warn('Shapes must be an array.');
delete layout.shapes;
}
var shapesLen = (layout.shapes || []).length;
var shapesLen = Array.isArray(layout.shapes) ? layout.shapes.length : 0;
for(i = 0; i < shapesLen; i++) {
var shape = layout.shapes[i];

if(!Lib.isPlainObject(shape)) continue;

cleanAxRef(shape, 'xref');
cleanAxRef(shape, 'yref');
}
Expand Down
67 changes: 67 additions & 0 deletions src/plots/array_container_defaults.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
/**
* Copyright 2012-2016, Plotly, Inc.
* All rights reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

'use strict';

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


/** Convenience wrapper for making array container logic DRY and consistent
*
* @param {object} parentObjIn
* user input object where the container in question is linked
* (i.e. either a user trace object or the user layout object)
*
* @param {object} parentObjOut
* full object where the coerced container will be linked
* (i.e. either a full trace object or the full layout object)
*
* @param {object} opts
* options object:
* - name {string}
* name of the key linking the container in question
* - handleItemDefaults {function}
* defaults method to be called on each item in the array container in question
*
* Its arguments are:
* - itemIn {object} item in user layout
* - itemOut {object} item in full layout
* - parentObj {object} (as in closure)
* - opts {object} (as in closure)
* - itemOpts {object}
* - itemIsNotPlainObject {boolean}
* N.B.
*
* - opts is passed to handleItemDefaults so it can also store
* links to supplementary data (e.g. fullData for layout components)
*
*/
module.exports = function handleArrayContainerDefaults(parentObjIn, parentObjOut, opts) {

@etpinardetpinardNov 10, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

similar to plots/subplot_defaults.

The logic below is pretty trivial, but might as well 🔒 down the behavior for all array containers.

var name = opts.name;

var contIn = Array.isArray(parentObjIn[name]) ? parentObjIn[name] : [],
contOut = parentObjOut[name] = [];

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i],
itemOut = {},
itemOpts = {};

if(!Lib.isPlainObject(itemIn)) {
itemOpts.itemIsNotPlainObject = true;
itemIn = {};
}

opts.handleItemDefaults(itemIn, itemOut, parentObjOut, opts, itemOpts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sure, that's fine. I still don't quite see where the handler will use the original opts but I guess it doesn't hurt to leave it in.


itemOut._input = itemIn;
itemOut._index = i;

contOut.push(itemOut);
}
};
19 changes: 15 additions & 4 deletions src/plots/plots.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -1569,8 +1569,14 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
for(i = 0; i < containerPaths.length; i++) {
containerProp = Lib.nestedProperty(expandedObj, containerPaths[i]);
containerVal = containerProp.get();
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);

if(containerVal === undefined) {
Lib.nestedProperty(containerObj, containerPaths[i]).set(null);
}
else {
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);
}
}
}

Expand All@@ -1584,15 +1590,20 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
if(!srcContainer) continue;

destProp = Lib.nestedProperty(dest, containerPaths[i]);

destContainer = destProp.get();

if(!Array.isArray(destContainer)) {
destContainer = [];
destProp.set(destContainer);
}

for(j = 0; j < srcContainer.length; j++) {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcContainer[j]);
var srcObj = srcContainer[j];

if(srcObj === null) destContainer[j] = null;
else {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcObj);
}
}

destProp.set(destContainer);
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" + '
Make frame with nulls clear items & array containers by etpinard · Pull Request #1118 · plotly/plotly.js · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/components/annotations/annotation_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');


module.exports = function handleAnnotationDefaults(annIn, fullLayout) {
var annOut = {};
module.exports = function handleAnnotationDefaults(annIn, annOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(annIn, annOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return annOut;

Expand Down
14 changes: 6 additions & 8 deletions src/components/annotations/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleAnnotationDefaults = require('./annotation_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.annotations || [],
containerOut = layoutOut.annotations = [];
var opts = {
name: 'annotations',
handleItemDefaults: handleAnnotationDefaults

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

🌴

};

for(var i = 0; i < containerIn.length; i++) {
var annIn = containerIn[i] || {},
annOut = handleAnnotationDefaults(annIn, layoutOut);

containerOut.push(annOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/annotations/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -242,7 +242,8 @@ function drawOne(gd, index, opt, value) {
optionsIn[axLetter] = position;
}

var options = handleAnnotationDefaults(optionsIn, fullLayout);
var options = {};
handleAnnotationDefaults(optionsIn, options, fullLayout);
fullLayout.annotations[index] = options;

var xa = Axes.getFromId(gd, options.xref),
Expand Down
20 changes: 8 additions & 12 deletions src/components/images/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,24 +8,20 @@

'use strict';

var Axes = require('../../plots/cartesian/axes');
var Lib = require('../../lib');
var attributes = require('./attributes');
var Axes = require('../../plots/cartesian/axes');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var name = 'images';

module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: imageDefaults
};

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i] || {},
itemOut = {};

imageDefaults(itemIn, itemOut, layoutOut);

contOut.push(itemOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};


Expand Down
14 changes: 6 additions & 8 deletions src/components/shapes/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleShapeDefaults = require('./shape_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.shapes || [],
containerOut = layoutOut.shapes = [];
var opts = {
name: 'shapes',
handleItemDefaults: handleShapeDefaults
};

for(var i = 0; i < containerIn.length; i++) {
var shapeIn = containerIn[i] || {},
shapeOut = handleShapeDefaults(shapeIn, layoutOut);

containerOut.push(shapeOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/shapes/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -232,7 +232,8 @@ function updateShape(gd, index, opt, value) {
optionsIn[posAttr] = position;
}

var options = handleShapeDefaults(optionsIn, gd._fullLayout);
var options = {};
handleShapeDefaults(optionsIn, options, gd._fullLayout);
gd._fullLayout.shapes[index] = options;

var clipAxes;
Expand Down
8 changes: 5 additions & 3 deletions src/components/shapes/shape_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,16 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');
var helpers = require('./helpers');

module.exports = function handleShapeDefaults(shapeIn, fullLayout) {
var shapeOut = {};

module.exports = function handleShapeDefaults(shapeIn, shapeOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(shapeIn, shapeOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return shapeOut;

Expand Down
22 changes: 6 additions & 16 deletions src/components/sliders/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var stepAttrs = attributes.steps;


module.exports = function slidersDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: sliderDefaults
};

for(var i = 0; i < contIn.length; i++) {
var sliderIn = contIn[i] || {},
sliderOut = {};

sliderDefaults(sliderIn, sliderOut, layoutOut);

// used on button click to update the 'active' field
sliderOut._input = sliderIn;

// used to determine object constancy
sliderOut._index = i;

contOut.push(sliderOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function sliderDefaults(sliderIn, sliderOut, layoutOut) {
Expand Down
22 changes: 6 additions & 16 deletions src/components/updatemenus/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var buttonAttrs = attributes.buttons;


module.exports = function updateMenusDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: menuDefaults
};

for(var i = 0; i < contIn.length; i++) {
var menuIn = contIn[i] || {},
menuOut = {};

menuDefaults(menuIn, menuOut, layoutOut);

// used on button click to update the 'active' field
menuOut._input = menuIn;

// used to determine object constancy
menuOut._index = i;

contOut.push(menuOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function menuDefaults(menuIn, menuOut, layoutOut) {
Expand Down
19 changes: 9 additions & 10 deletions src/plot_api/helpers.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,13 +102,12 @@ exports.cleanLayout = function(layout) {
}
}

if(layout.annotations !== undefined && !Array.isArray(layout.annotations)) {
Lib.warn('Annotations must be an array.');
delete layout.annotations;
}
var annotationsLen = (layout.annotations || []).length;
var annotationsLen = Array.isArray(layout.annotations) ? layout.annotations.length : 0;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this commit was enough to fix bug discovered in http://codepen.io/etpinard/pen/xRGgwW

for(i = 0; i < annotationsLen; i++) {
var ann = layout.annotations[i];

if(!Lib.isPlainObject(ann)) continue;

if(ann.ref) {
if(ann.ref === 'paper') {
ann.xref = 'paper';
Expand All@@ -120,17 +119,17 @@ exports.cleanLayout = function(layout) {
}
delete ann.ref;
}

cleanAxRef(ann, 'xref');
cleanAxRef(ann, 'yref');
}

if(layout.shapes !== undefined && !Array.isArray(layout.shapes)) {
Lib.warn('Shapes must be an array.');
delete layout.shapes;
}
var shapesLen = (layout.shapes || []).length;
var shapesLen = Array.isArray(layout.shapes) ? layout.shapes.length : 0;
for(i = 0; i < shapesLen; i++) {
var shape = layout.shapes[i];

if(!Lib.isPlainObject(shape)) continue;

cleanAxRef(shape, 'xref');
cleanAxRef(shape, 'yref');
}
Expand Down
67 changes: 67 additions & 0 deletions src/plots/array_container_defaults.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
/**
* Copyright 2012-2016, Plotly, Inc.
* All rights reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

'use strict';

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


/** Convenience wrapper for making array container logic DRY and consistent
*
* @param {object} parentObjIn
* user input object where the container in question is linked
* (i.e. either a user trace object or the user layout object)
*
* @param {object} parentObjOut
* full object where the coerced container will be linked
* (i.e. either a full trace object or the full layout object)
*
* @param {object} opts
* options object:
* - name {string}
* name of the key linking the container in question
* - handleItemDefaults {function}
* defaults method to be called on each item in the array container in question
*
* Its arguments are:
* - itemIn {object} item in user layout
* - itemOut {object} item in full layout
* - parentObj {object} (as in closure)
* - opts {object} (as in closure)
* - itemOpts {object}
* - itemIsNotPlainObject {boolean}
* N.B.
*
* - opts is passed to handleItemDefaults so it can also store
* links to supplementary data (e.g. fullData for layout components)
*
*/
module.exports = function handleArrayContainerDefaults(parentObjIn, parentObjOut, opts) {

@etpinardetpinardNov 10, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

similar to plots/subplot_defaults.

The logic below is pretty trivial, but might as well 🔒 down the behavior for all array containers.

var name = opts.name;

var contIn = Array.isArray(parentObjIn[name]) ? parentObjIn[name] : [],
contOut = parentObjOut[name] = [];

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i],
itemOut = {},
itemOpts = {};

if(!Lib.isPlainObject(itemIn)) {
itemOpts.itemIsNotPlainObject = true;
itemIn = {};
}

opts.handleItemDefaults(itemIn, itemOut, parentObjOut, opts, itemOpts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sure, that's fine. I still don't quite see where the handler will use the original opts but I guess it doesn't hurt to leave it in.


itemOut._input = itemIn;
itemOut._index = i;

contOut.push(itemOut);
}
};
19 changes: 15 additions & 4 deletions src/plots/plots.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -1569,8 +1569,14 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
for(i = 0; i < containerPaths.length; i++) {
containerProp = Lib.nestedProperty(expandedObj, containerPaths[i]);
containerVal = containerProp.get();
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);

if(containerVal === undefined) {
Lib.nestedProperty(containerObj, containerPaths[i]).set(null);
}
else {
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);
}
}
}

Expand All@@ -1584,15 +1590,20 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
if(!srcContainer) continue;

destProp = Lib.nestedProperty(dest, containerPaths[i]);

destContainer = destProp.get();

if(!Array.isArray(destContainer)) {
destContainer = [];
destProp.set(destContainer);
}

for(j = 0; j < srcContainer.length; j++) {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcContainer[j]);
var srcObj = srcContainer[j];

if(srcObj === null) destContainer[j] = null;
else {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcObj);
}
}

destProp.set(destContainer);
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('^' + ".*" + ' Make frame with nulls clear items & array containers by etpinard · Pull Request #1118 · plotly/plotly.js · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/components/annotations/annotation_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');


module.exports = function handleAnnotationDefaults(annIn, fullLayout) {
var annOut = {};
module.exports = function handleAnnotationDefaults(annIn, annOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(annIn, annOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return annOut;

Expand Down
14 changes: 6 additions & 8 deletions src/components/annotations/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleAnnotationDefaults = require('./annotation_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.annotations || [],
containerOut = layoutOut.annotations = [];
var opts = {
name: 'annotations',
handleItemDefaults: handleAnnotationDefaults

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

🌴

};

for(var i = 0; i < containerIn.length; i++) {
var annIn = containerIn[i] || {},
annOut = handleAnnotationDefaults(annIn, layoutOut);

containerOut.push(annOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/annotations/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -242,7 +242,8 @@ function drawOne(gd, index, opt, value) {
optionsIn[axLetter] = position;
}

var options = handleAnnotationDefaults(optionsIn, fullLayout);
var options = {};
handleAnnotationDefaults(optionsIn, options, fullLayout);
fullLayout.annotations[index] = options;

var xa = Axes.getFromId(gd, options.xref),
Expand Down
20 changes: 8 additions & 12 deletions src/components/images/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,24 +8,20 @@

'use strict';

var Axes = require('../../plots/cartesian/axes');
var Lib = require('../../lib');
var attributes = require('./attributes');
var Axes = require('../../plots/cartesian/axes');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var name = 'images';

module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: imageDefaults
};

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i] || {},
itemOut = {};

imageDefaults(itemIn, itemOut, layoutOut);

contOut.push(itemOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};


Expand Down
14 changes: 6 additions & 8 deletions src/components/shapes/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleShapeDefaults = require('./shape_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.shapes || [],
containerOut = layoutOut.shapes = [];
var opts = {
name: 'shapes',
handleItemDefaults: handleShapeDefaults
};

for(var i = 0; i < containerIn.length; i++) {
var shapeIn = containerIn[i] || {},
shapeOut = handleShapeDefaults(shapeIn, layoutOut);

containerOut.push(shapeOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/shapes/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -232,7 +232,8 @@ function updateShape(gd, index, opt, value) {
optionsIn[posAttr] = position;
}

var options = handleShapeDefaults(optionsIn, gd._fullLayout);
var options = {};
handleShapeDefaults(optionsIn, options, gd._fullLayout);
gd._fullLayout.shapes[index] = options;

var clipAxes;
Expand Down
8 changes: 5 additions & 3 deletions src/components/shapes/shape_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,16 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');
var helpers = require('./helpers');

module.exports = function handleShapeDefaults(shapeIn, fullLayout) {
var shapeOut = {};

module.exports = function handleShapeDefaults(shapeIn, shapeOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(shapeIn, shapeOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return shapeOut;

Expand Down
22 changes: 6 additions & 16 deletions src/components/sliders/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var stepAttrs = attributes.steps;


module.exports = function slidersDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: sliderDefaults
};

for(var i = 0; i < contIn.length; i++) {
var sliderIn = contIn[i] || {},
sliderOut = {};

sliderDefaults(sliderIn, sliderOut, layoutOut);

// used on button click to update the 'active' field
sliderOut._input = sliderIn;

// used to determine object constancy
sliderOut._index = i;

contOut.push(sliderOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function sliderDefaults(sliderIn, sliderOut, layoutOut) {
Expand Down
22 changes: 6 additions & 16 deletions src/components/updatemenus/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var buttonAttrs = attributes.buttons;


module.exports = function updateMenusDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: menuDefaults
};

for(var i = 0; i < contIn.length; i++) {
var menuIn = contIn[i] || {},
menuOut = {};

menuDefaults(menuIn, menuOut, layoutOut);

// used on button click to update the 'active' field
menuOut._input = menuIn;

// used to determine object constancy
menuOut._index = i;

contOut.push(menuOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function menuDefaults(menuIn, menuOut, layoutOut) {
Expand Down
19 changes: 9 additions & 10 deletions src/plot_api/helpers.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,13 +102,12 @@ exports.cleanLayout = function(layout) {
}
}

if(layout.annotations !== undefined && !Array.isArray(layout.annotations)) {
Lib.warn('Annotations must be an array.');
delete layout.annotations;
}
var annotationsLen = (layout.annotations || []).length;
var annotationsLen = Array.isArray(layout.annotations) ? layout.annotations.length : 0;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this commit was enough to fix bug discovered in http://codepen.io/etpinard/pen/xRGgwW

for(i = 0; i < annotationsLen; i++) {
var ann = layout.annotations[i];

if(!Lib.isPlainObject(ann)) continue;

if(ann.ref) {
if(ann.ref === 'paper') {
ann.xref = 'paper';
Expand All@@ -120,17 +119,17 @@ exports.cleanLayout = function(layout) {
}
delete ann.ref;
}

cleanAxRef(ann, 'xref');
cleanAxRef(ann, 'yref');
}

if(layout.shapes !== undefined && !Array.isArray(layout.shapes)) {
Lib.warn('Shapes must be an array.');
delete layout.shapes;
}
var shapesLen = (layout.shapes || []).length;
var shapesLen = Array.isArray(layout.shapes) ? layout.shapes.length : 0;
for(i = 0; i < shapesLen; i++) {
var shape = layout.shapes[i];

if(!Lib.isPlainObject(shape)) continue;

cleanAxRef(shape, 'xref');
cleanAxRef(shape, 'yref');
}
Expand Down
67 changes: 67 additions & 0 deletions src/plots/array_container_defaults.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
/**
* Copyright 2012-2016, Plotly, Inc.
* All rights reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

'use strict';

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


/** Convenience wrapper for making array container logic DRY and consistent
*
* @param {object} parentObjIn
* user input object where the container in question is linked
* (i.e. either a user trace object or the user layout object)
*
* @param {object} parentObjOut
* full object where the coerced container will be linked
* (i.e. either a full trace object or the full layout object)
*
* @param {object} opts
* options object:
* - name {string}
* name of the key linking the container in question
* - handleItemDefaults {function}
* defaults method to be called on each item in the array container in question
*
* Its arguments are:
* - itemIn {object} item in user layout
* - itemOut {object} item in full layout
* - parentObj {object} (as in closure)
* - opts {object} (as in closure)
* - itemOpts {object}
* - itemIsNotPlainObject {boolean}
* N.B.
*
* - opts is passed to handleItemDefaults so it can also store
* links to supplementary data (e.g. fullData for layout components)
*
*/
module.exports = function handleArrayContainerDefaults(parentObjIn, parentObjOut, opts) {

@etpinardetpinardNov 10, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

similar to plots/subplot_defaults.

The logic below is pretty trivial, but might as well 🔒 down the behavior for all array containers.

var name = opts.name;

var contIn = Array.isArray(parentObjIn[name]) ? parentObjIn[name] : [],
contOut = parentObjOut[name] = [];

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i],
itemOut = {},
itemOpts = {};

if(!Lib.isPlainObject(itemIn)) {
itemOpts.itemIsNotPlainObject = true;
itemIn = {};
}

opts.handleItemDefaults(itemIn, itemOut, parentObjOut, opts, itemOpts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sure, that's fine. I still don't quite see where the handler will use the original opts but I guess it doesn't hurt to leave it in.


itemOut._input = itemIn;
itemOut._index = i;

contOut.push(itemOut);
}
};
19 changes: 15 additions & 4 deletions src/plots/plots.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -1569,8 +1569,14 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
for(i = 0; i < containerPaths.length; i++) {
containerProp = Lib.nestedProperty(expandedObj, containerPaths[i]);
containerVal = containerProp.get();
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);

if(containerVal === undefined) {
Lib.nestedProperty(containerObj, containerPaths[i]).set(null);
}
else {
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);
}
}
}

Expand All@@ -1584,15 +1590,20 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
if(!srcContainer) continue;

destProp = Lib.nestedProperty(dest, containerPaths[i]);

destContainer = destProp.get();

if(!Array.isArray(destContainer)) {
destContainer = [];
destProp.set(destContainer);
}

for(j = 0; j < srcContainer.length; j++) {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcContainer[j]);
var srcObj = srcContainer[j];

if(srcObj === null) destContainer[j] = null;
else {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcObj);
}
}

destProp.set(destContainer);
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('^' + ".*" + ' Make frame with nulls clear items & array containers by etpinard · Pull Request #1118 · plotly/plotly.js · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/components/annotations/annotation_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');


module.exports = function handleAnnotationDefaults(annIn, fullLayout) {
var annOut = {};
module.exports = function handleAnnotationDefaults(annIn, annOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(annIn, annOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return annOut;

Expand Down
14 changes: 6 additions & 8 deletions src/components/annotations/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleAnnotationDefaults = require('./annotation_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.annotations || [],
containerOut = layoutOut.annotations = [];
var opts = {
name: 'annotations',
handleItemDefaults: handleAnnotationDefaults

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

🌴

};

for(var i = 0; i < containerIn.length; i++) {
var annIn = containerIn[i] || {},
annOut = handleAnnotationDefaults(annIn, layoutOut);

containerOut.push(annOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/annotations/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -242,7 +242,8 @@ function drawOne(gd, index, opt, value) {
optionsIn[axLetter] = position;
}

var options = handleAnnotationDefaults(optionsIn, fullLayout);
var options = {};
handleAnnotationDefaults(optionsIn, options, fullLayout);
fullLayout.annotations[index] = options;

var xa = Axes.getFromId(gd, options.xref),
Expand Down
20 changes: 8 additions & 12 deletions src/components/images/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,24 +8,20 @@

'use strict';

var Axes = require('../../plots/cartesian/axes');
var Lib = require('../../lib');
var attributes = require('./attributes');
var Axes = require('../../plots/cartesian/axes');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var name = 'images';

module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: imageDefaults
};

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i] || {},
itemOut = {};

imageDefaults(itemIn, itemOut, layoutOut);

contOut.push(itemOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};


Expand Down
14 changes: 6 additions & 8 deletions src/components/shapes/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleShapeDefaults = require('./shape_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.shapes || [],
containerOut = layoutOut.shapes = [];
var opts = {
name: 'shapes',
handleItemDefaults: handleShapeDefaults
};

for(var i = 0; i < containerIn.length; i++) {
var shapeIn = containerIn[i] || {},
shapeOut = handleShapeDefaults(shapeIn, layoutOut);

containerOut.push(shapeOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/shapes/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -232,7 +232,8 @@ function updateShape(gd, index, opt, value) {
optionsIn[posAttr] = position;
}

var options = handleShapeDefaults(optionsIn, gd._fullLayout);
var options = {};
handleShapeDefaults(optionsIn, options, gd._fullLayout);
gd._fullLayout.shapes[index] = options;

var clipAxes;
Expand Down
8 changes: 5 additions & 3 deletions src/components/shapes/shape_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,16 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');
var helpers = require('./helpers');

module.exports = function handleShapeDefaults(shapeIn, fullLayout) {
var shapeOut = {};

module.exports = function handleShapeDefaults(shapeIn, shapeOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(shapeIn, shapeOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return shapeOut;

Expand Down
22 changes: 6 additions & 16 deletions src/components/sliders/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var stepAttrs = attributes.steps;


module.exports = function slidersDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: sliderDefaults
};

for(var i = 0; i < contIn.length; i++) {
var sliderIn = contIn[i] || {},
sliderOut = {};

sliderDefaults(sliderIn, sliderOut, layoutOut);

// used on button click to update the 'active' field
sliderOut._input = sliderIn;

// used to determine object constancy
sliderOut._index = i;

contOut.push(sliderOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function sliderDefaults(sliderIn, sliderOut, layoutOut) {
Expand Down
22 changes: 6 additions & 16 deletions src/components/updatemenus/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var buttonAttrs = attributes.buttons;


module.exports = function updateMenusDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: menuDefaults
};

for(var i = 0; i < contIn.length; i++) {
var menuIn = contIn[i] || {},
menuOut = {};

menuDefaults(menuIn, menuOut, layoutOut);

// used on button click to update the 'active' field
menuOut._input = menuIn;

// used to determine object constancy
menuOut._index = i;

contOut.push(menuOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function menuDefaults(menuIn, menuOut, layoutOut) {
Expand Down
19 changes: 9 additions & 10 deletions src/plot_api/helpers.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,13 +102,12 @@ exports.cleanLayout = function(layout) {
}
}

if(layout.annotations !== undefined && !Array.isArray(layout.annotations)) {
Lib.warn('Annotations must be an array.');
delete layout.annotations;
}
var annotationsLen = (layout.annotations || []).length;
var annotationsLen = Array.isArray(layout.annotations) ? layout.annotations.length : 0;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this commit was enough to fix bug discovered in http://codepen.io/etpinard/pen/xRGgwW

for(i = 0; i < annotationsLen; i++) {
var ann = layout.annotations[i];

if(!Lib.isPlainObject(ann)) continue;

if(ann.ref) {
if(ann.ref === 'paper') {
ann.xref = 'paper';
Expand All@@ -120,17 +119,17 @@ exports.cleanLayout = function(layout) {
}
delete ann.ref;
}

cleanAxRef(ann, 'xref');
cleanAxRef(ann, 'yref');
}

if(layout.shapes !== undefined && !Array.isArray(layout.shapes)) {
Lib.warn('Shapes must be an array.');
delete layout.shapes;
}
var shapesLen = (layout.shapes || []).length;
var shapesLen = Array.isArray(layout.shapes) ? layout.shapes.length : 0;
for(i = 0; i < shapesLen; i++) {
var shape = layout.shapes[i];

if(!Lib.isPlainObject(shape)) continue;

cleanAxRef(shape, 'xref');
cleanAxRef(shape, 'yref');
}
Expand Down
67 changes: 67 additions & 0 deletions src/plots/array_container_defaults.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
/**
* Copyright 2012-2016, Plotly, Inc.
* All rights reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

'use strict';

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


/** Convenience wrapper for making array container logic DRY and consistent
*
* @param {object} parentObjIn
* user input object where the container in question is linked
* (i.e. either a user trace object or the user layout object)
*
* @param {object} parentObjOut
* full object where the coerced container will be linked
* (i.e. either a full trace object or the full layout object)
*
* @param {object} opts
* options object:
* - name {string}
* name of the key linking the container in question
* - handleItemDefaults {function}
* defaults method to be called on each item in the array container in question
*
* Its arguments are:
* - itemIn {object} item in user layout
* - itemOut {object} item in full layout
* - parentObj {object} (as in closure)
* - opts {object} (as in closure)
* - itemOpts {object}
* - itemIsNotPlainObject {boolean}
* N.B.
*
* - opts is passed to handleItemDefaults so it can also store
* links to supplementary data (e.g. fullData for layout components)
*
*/
module.exports = function handleArrayContainerDefaults(parentObjIn, parentObjOut, opts) {

@etpinardetpinardNov 10, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

similar to plots/subplot_defaults.

The logic below is pretty trivial, but might as well 🔒 down the behavior for all array containers.

var name = opts.name;

var contIn = Array.isArray(parentObjIn[name]) ? parentObjIn[name] : [],
contOut = parentObjOut[name] = [];

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i],
itemOut = {},
itemOpts = {};

if(!Lib.isPlainObject(itemIn)) {
itemOpts.itemIsNotPlainObject = true;
itemIn = {};
}

opts.handleItemDefaults(itemIn, itemOut, parentObjOut, opts, itemOpts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sure, that's fine. I still don't quite see where the handler will use the original opts but I guess it doesn't hurt to leave it in.


itemOut._input = itemIn;
itemOut._index = i;

contOut.push(itemOut);
}
};
19 changes: 15 additions & 4 deletions src/plots/plots.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -1569,8 +1569,14 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
for(i = 0; i < containerPaths.length; i++) {
containerProp = Lib.nestedProperty(expandedObj, containerPaths[i]);
containerVal = containerProp.get();
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);

if(containerVal === undefined) {
Lib.nestedProperty(containerObj, containerPaths[i]).set(null);
}
else {
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);
}
}
}

Expand All@@ -1584,15 +1590,20 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
if(!srcContainer) continue;

destProp = Lib.nestedProperty(dest, containerPaths[i]);

destContainer = destProp.get();

if(!Array.isArray(destContainer)) {
destContainer = [];
destProp.set(destContainer);
}

for(j = 0; j < srcContainer.length; j++) {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcContainer[j]);
var srcObj = srcContainer[j];

if(srcObj === null) destContainer[j] = null;
else {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcObj);
}
}

destProp.set(destContainer);
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" + ' Make frame with nulls clear items & array containers by etpinard · Pull Request #1118 · plotly/plotly.js · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/components/annotations/annotation_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');


module.exports = function handleAnnotationDefaults(annIn, fullLayout) {
var annOut = {};
module.exports = function handleAnnotationDefaults(annIn, annOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(annIn, annOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return annOut;

Expand Down
14 changes: 6 additions & 8 deletions src/components/annotations/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleAnnotationDefaults = require('./annotation_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.annotations || [],
containerOut = layoutOut.annotations = [];
var opts = {
name: 'annotations',
handleItemDefaults: handleAnnotationDefaults

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

🌴

};

for(var i = 0; i < containerIn.length; i++) {
var annIn = containerIn[i] || {},
annOut = handleAnnotationDefaults(annIn, layoutOut);

containerOut.push(annOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/annotations/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -242,7 +242,8 @@ function drawOne(gd, index, opt, value) {
optionsIn[axLetter] = position;
}

var options = handleAnnotationDefaults(optionsIn, fullLayout);
var options = {};
handleAnnotationDefaults(optionsIn, options, fullLayout);
fullLayout.annotations[index] = options;

var xa = Axes.getFromId(gd, options.xref),
Expand Down
20 changes: 8 additions & 12 deletions src/components/images/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,24 +8,20 @@

'use strict';

var Axes = require('../../plots/cartesian/axes');
var Lib = require('../../lib');
var attributes = require('./attributes');
var Axes = require('../../plots/cartesian/axes');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var name = 'images';

module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: imageDefaults
};

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i] || {},
itemOut = {};

imageDefaults(itemIn, itemOut, layoutOut);

contOut.push(itemOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};


Expand Down
14 changes: 6 additions & 8 deletions src/components/shapes/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleShapeDefaults = require('./shape_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.shapes || [],
containerOut = layoutOut.shapes = [];
var opts = {
name: 'shapes',
handleItemDefaults: handleShapeDefaults
};

for(var i = 0; i < containerIn.length; i++) {
var shapeIn = containerIn[i] || {},
shapeOut = handleShapeDefaults(shapeIn, layoutOut);

containerOut.push(shapeOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/shapes/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -232,7 +232,8 @@ function updateShape(gd, index, opt, value) {
optionsIn[posAttr] = position;
}

var options = handleShapeDefaults(optionsIn, gd._fullLayout);
var options = {};
handleShapeDefaults(optionsIn, options, gd._fullLayout);
gd._fullLayout.shapes[index] = options;

var clipAxes;
Expand Down
8 changes: 5 additions & 3 deletions src/components/shapes/shape_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,16 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');
var helpers = require('./helpers');

module.exports = function handleShapeDefaults(shapeIn, fullLayout) {
var shapeOut = {};

module.exports = function handleShapeDefaults(shapeIn, shapeOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(shapeIn, shapeOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return shapeOut;

Expand Down
22 changes: 6 additions & 16 deletions src/components/sliders/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var stepAttrs = attributes.steps;


module.exports = function slidersDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: sliderDefaults
};

for(var i = 0; i < contIn.length; i++) {
var sliderIn = contIn[i] || {},
sliderOut = {};

sliderDefaults(sliderIn, sliderOut, layoutOut);

// used on button click to update the 'active' field
sliderOut._input = sliderIn;

// used to determine object constancy
sliderOut._index = i;

contOut.push(sliderOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function sliderDefaults(sliderIn, sliderOut, layoutOut) {
Expand Down
22 changes: 6 additions & 16 deletions src/components/updatemenus/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var buttonAttrs = attributes.buttons;


module.exports = function updateMenusDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: menuDefaults
};

for(var i = 0; i < contIn.length; i++) {
var menuIn = contIn[i] || {},
menuOut = {};

menuDefaults(menuIn, menuOut, layoutOut);

// used on button click to update the 'active' field
menuOut._input = menuIn;

// used to determine object constancy
menuOut._index = i;

contOut.push(menuOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function menuDefaults(menuIn, menuOut, layoutOut) {
Expand Down
19 changes: 9 additions & 10 deletions src/plot_api/helpers.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,13 +102,12 @@ exports.cleanLayout = function(layout) {
}
}

if(layout.annotations !== undefined && !Array.isArray(layout.annotations)) {
Lib.warn('Annotations must be an array.');
delete layout.annotations;
}
var annotationsLen = (layout.annotations || []).length;
var annotationsLen = Array.isArray(layout.annotations) ? layout.annotations.length : 0;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this commit was enough to fix bug discovered in http://codepen.io/etpinard/pen/xRGgwW

for(i = 0; i < annotationsLen; i++) {
var ann = layout.annotations[i];

if(!Lib.isPlainObject(ann)) continue;

if(ann.ref) {
if(ann.ref === 'paper') {
ann.xref = 'paper';
Expand All@@ -120,17 +119,17 @@ exports.cleanLayout = function(layout) {
}
delete ann.ref;
}

cleanAxRef(ann, 'xref');
cleanAxRef(ann, 'yref');
}

if(layout.shapes !== undefined && !Array.isArray(layout.shapes)) {
Lib.warn('Shapes must be an array.');
delete layout.shapes;
}
var shapesLen = (layout.shapes || []).length;
var shapesLen = Array.isArray(layout.shapes) ? layout.shapes.length : 0;
for(i = 0; i < shapesLen; i++) {
var shape = layout.shapes[i];

if(!Lib.isPlainObject(shape)) continue;

cleanAxRef(shape, 'xref');
cleanAxRef(shape, 'yref');
}
Expand Down
67 changes: 67 additions & 0 deletions src/plots/array_container_defaults.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
/**
* Copyright 2012-2016, Plotly, Inc.
* All rights reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

'use strict';

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


/** Convenience wrapper for making array container logic DRY and consistent
*
* @param {object} parentObjIn
* user input object where the container in question is linked
* (i.e. either a user trace object or the user layout object)
*
* @param {object} parentObjOut
* full object where the coerced container will be linked
* (i.e. either a full trace object or the full layout object)
*
* @param {object} opts
* options object:
* - name {string}
* name of the key linking the container in question
* - handleItemDefaults {function}
* defaults method to be called on each item in the array container in question
*
* Its arguments are:
* - itemIn {object} item in user layout
* - itemOut {object} item in full layout
* - parentObj {object} (as in closure)
* - opts {object} (as in closure)
* - itemOpts {object}
* - itemIsNotPlainObject {boolean}
* N.B.
*
* - opts is passed to handleItemDefaults so it can also store
* links to supplementary data (e.g. fullData for layout components)
*
*/
module.exports = function handleArrayContainerDefaults(parentObjIn, parentObjOut, opts) {

@etpinardetpinardNov 10, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

similar to plots/subplot_defaults.

The logic below is pretty trivial, but might as well 🔒 down the behavior for all array containers.

var name = opts.name;

var contIn = Array.isArray(parentObjIn[name]) ? parentObjIn[name] : [],
contOut = parentObjOut[name] = [];

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i],
itemOut = {},
itemOpts = {};

if(!Lib.isPlainObject(itemIn)) {
itemOpts.itemIsNotPlainObject = true;
itemIn = {};
}

opts.handleItemDefaults(itemIn, itemOut, parentObjOut, opts, itemOpts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sure, that's fine. I still don't quite see where the handler will use the original opts but I guess it doesn't hurt to leave it in.


itemOut._input = itemIn;
itemOut._index = i;

contOut.push(itemOut);
}
};
19 changes: 15 additions & 4 deletions src/plots/plots.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -1569,8 +1569,14 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
for(i = 0; i < containerPaths.length; i++) {
containerProp = Lib.nestedProperty(expandedObj, containerPaths[i]);
containerVal = containerProp.get();
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);

if(containerVal === undefined) {
Lib.nestedProperty(containerObj, containerPaths[i]).set(null);
}
else {
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);
}
}
}

Expand All@@ -1584,15 +1590,20 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
if(!srcContainer) continue;

destProp = Lib.nestedProperty(dest, containerPaths[i]);

destContainer = destProp.get();

if(!Array.isArray(destContainer)) {
destContainer = [];
destProp.set(destContainer);
}

for(j = 0; j < srcContainer.length; j++) {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcContainer[j]);
var srcObj = srcContainer[j];

if(srcObj === null) destContainer[j] = null;
else {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcObj);
}
}

destProp.set(destContainer);
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('^' + ".*" + ' Make frame with nulls clear items & array containers by etpinard · Pull Request #1118 · plotly/plotly.js · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/components/annotations/annotation_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');


module.exports = function handleAnnotationDefaults(annIn, fullLayout) {
var annOut = {};
module.exports = function handleAnnotationDefaults(annIn, annOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(annIn, annOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return annOut;

Expand Down
14 changes: 6 additions & 8 deletions src/components/annotations/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleAnnotationDefaults = require('./annotation_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.annotations || [],
containerOut = layoutOut.annotations = [];
var opts = {
name: 'annotations',
handleItemDefaults: handleAnnotationDefaults

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

🌴

};

for(var i = 0; i < containerIn.length; i++) {
var annIn = containerIn[i] || {},
annOut = handleAnnotationDefaults(annIn, layoutOut);

containerOut.push(annOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/annotations/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -242,7 +242,8 @@ function drawOne(gd, index, opt, value) {
optionsIn[axLetter] = position;
}

var options = handleAnnotationDefaults(optionsIn, fullLayout);
var options = {};
handleAnnotationDefaults(optionsIn, options, fullLayout);
fullLayout.annotations[index] = options;

var xa = Axes.getFromId(gd, options.xref),
Expand Down
20 changes: 8 additions & 12 deletions src/components/images/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,24 +8,20 @@

'use strict';

var Axes = require('../../plots/cartesian/axes');
var Lib = require('../../lib');
var attributes = require('./attributes');
var Axes = require('../../plots/cartesian/axes');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var name = 'images';

module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: imageDefaults
};

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i] || {},
itemOut = {};

imageDefaults(itemIn, itemOut, layoutOut);

contOut.push(itemOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};


Expand Down
14 changes: 6 additions & 8 deletions src/components/shapes/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleShapeDefaults = require('./shape_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.shapes || [],
containerOut = layoutOut.shapes = [];
var opts = {
name: 'shapes',
handleItemDefaults: handleShapeDefaults
};

for(var i = 0; i < containerIn.length; i++) {
var shapeIn = containerIn[i] || {},
shapeOut = handleShapeDefaults(shapeIn, layoutOut);

containerOut.push(shapeOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/shapes/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -232,7 +232,8 @@ function updateShape(gd, index, opt, value) {
optionsIn[posAttr] = position;
}

var options = handleShapeDefaults(optionsIn, gd._fullLayout);
var options = {};
handleShapeDefaults(optionsIn, options, gd._fullLayout);
gd._fullLayout.shapes[index] = options;

var clipAxes;
Expand Down
8 changes: 5 additions & 3 deletions src/components/shapes/shape_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,16 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');
var helpers = require('./helpers');

module.exports = function handleShapeDefaults(shapeIn, fullLayout) {
var shapeOut = {};

module.exports = function handleShapeDefaults(shapeIn, shapeOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(shapeIn, shapeOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return shapeOut;

Expand Down
22 changes: 6 additions & 16 deletions src/components/sliders/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var stepAttrs = attributes.steps;


module.exports = function slidersDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: sliderDefaults
};

for(var i = 0; i < contIn.length; i++) {
var sliderIn = contIn[i] || {},
sliderOut = {};

sliderDefaults(sliderIn, sliderOut, layoutOut);

// used on button click to update the 'active' field
sliderOut._input = sliderIn;

// used to determine object constancy
sliderOut._index = i;

contOut.push(sliderOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function sliderDefaults(sliderIn, sliderOut, layoutOut) {
Expand Down
22 changes: 6 additions & 16 deletions src/components/updatemenus/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var buttonAttrs = attributes.buttons;


module.exports = function updateMenusDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: menuDefaults
};

for(var i = 0; i < contIn.length; i++) {
var menuIn = contIn[i] || {},
menuOut = {};

menuDefaults(menuIn, menuOut, layoutOut);

// used on button click to update the 'active' field
menuOut._input = menuIn;

// used to determine object constancy
menuOut._index = i;

contOut.push(menuOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function menuDefaults(menuIn, menuOut, layoutOut) {
Expand Down
19 changes: 9 additions & 10 deletions src/plot_api/helpers.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,13 +102,12 @@ exports.cleanLayout = function(layout) {
}
}

if(layout.annotations !== undefined && !Array.isArray(layout.annotations)) {
Lib.warn('Annotations must be an array.');
delete layout.annotations;
}
var annotationsLen = (layout.annotations || []).length;
var annotationsLen = Array.isArray(layout.annotations) ? layout.annotations.length : 0;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this commit was enough to fix bug discovered in http://codepen.io/etpinard/pen/xRGgwW

for(i = 0; i < annotationsLen; i++) {
var ann = layout.annotations[i];

if(!Lib.isPlainObject(ann)) continue;

if(ann.ref) {
if(ann.ref === 'paper') {
ann.xref = 'paper';
Expand All@@ -120,17 +119,17 @@ exports.cleanLayout = function(layout) {
}
delete ann.ref;
}

cleanAxRef(ann, 'xref');
cleanAxRef(ann, 'yref');
}

if(layout.shapes !== undefined && !Array.isArray(layout.shapes)) {
Lib.warn('Shapes must be an array.');
delete layout.shapes;
}
var shapesLen = (layout.shapes || []).length;
var shapesLen = Array.isArray(layout.shapes) ? layout.shapes.length : 0;
for(i = 0; i < shapesLen; i++) {
var shape = layout.shapes[i];

if(!Lib.isPlainObject(shape)) continue;

cleanAxRef(shape, 'xref');
cleanAxRef(shape, 'yref');
}
Expand Down
67 changes: 67 additions & 0 deletions src/plots/array_container_defaults.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
/**
* Copyright 2012-2016, Plotly, Inc.
* All rights reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

'use strict';

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


/** Convenience wrapper for making array container logic DRY and consistent
*
* @param {object} parentObjIn
* user input object where the container in question is linked
* (i.e. either a user trace object or the user layout object)
*
* @param {object} parentObjOut
* full object where the coerced container will be linked
* (i.e. either a full trace object or the full layout object)
*
* @param {object} opts
* options object:
* - name {string}
* name of the key linking the container in question
* - handleItemDefaults {function}
* defaults method to be called on each item in the array container in question
*
* Its arguments are:
* - itemIn {object} item in user layout
* - itemOut {object} item in full layout
* - parentObj {object} (as in closure)
* - opts {object} (as in closure)
* - itemOpts {object}
* - itemIsNotPlainObject {boolean}
* N.B.
*
* - opts is passed to handleItemDefaults so it can also store
* links to supplementary data (e.g. fullData for layout components)
*
*/
module.exports = function handleArrayContainerDefaults(parentObjIn, parentObjOut, opts) {

@etpinardetpinardNov 10, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

similar to plots/subplot_defaults.

The logic below is pretty trivial, but might as well 🔒 down the behavior for all array containers.

var name = opts.name;

var contIn = Array.isArray(parentObjIn[name]) ? parentObjIn[name] : [],
contOut = parentObjOut[name] = [];

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i],
itemOut = {},
itemOpts = {};

if(!Lib.isPlainObject(itemIn)) {
itemOpts.itemIsNotPlainObject = true;
itemIn = {};
}

opts.handleItemDefaults(itemIn, itemOut, parentObjOut, opts, itemOpts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sure, that's fine. I still don't quite see where the handler will use the original opts but I guess it doesn't hurt to leave it in.


itemOut._input = itemIn;
itemOut._index = i;

contOut.push(itemOut);
}
};
19 changes: 15 additions & 4 deletions src/plots/plots.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -1569,8 +1569,14 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
for(i = 0; i < containerPaths.length; i++) {
containerProp = Lib.nestedProperty(expandedObj, containerPaths[i]);
containerVal = containerProp.get();
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);

if(containerVal === undefined) {
Lib.nestedProperty(containerObj, containerPaths[i]).set(null);
}
else {
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);
}
}
}

Expand All@@ -1584,15 +1590,20 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
if(!srcContainer) continue;

destProp = Lib.nestedProperty(dest, containerPaths[i]);

destContainer = destProp.get();

if(!Array.isArray(destContainer)) {
destContainer = [];
destProp.set(destContainer);
}

for(j = 0; j < srcContainer.length; j++) {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcContainer[j]);
var srcObj = srcContainer[j];

if(srcObj === null) destContainer[j] = null;
else {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcObj);
}
}

destProp.set(destContainer);
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('^' + ".*" + ' Make frame with nulls clear items & array containers by etpinard · Pull Request #1118 · plotly/plotly.js · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/components/annotations/annotation_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');


module.exports = function handleAnnotationDefaults(annIn, fullLayout) {
var annOut = {};
module.exports = function handleAnnotationDefaults(annIn, annOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(annIn, annOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return annOut;

Expand Down
14 changes: 6 additions & 8 deletions src/components/annotations/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleAnnotationDefaults = require('./annotation_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.annotations || [],
containerOut = layoutOut.annotations = [];
var opts = {
name: 'annotations',
handleItemDefaults: handleAnnotationDefaults

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

🌴

};

for(var i = 0; i < containerIn.length; i++) {
var annIn = containerIn[i] || {},
annOut = handleAnnotationDefaults(annIn, layoutOut);

containerOut.push(annOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/annotations/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -242,7 +242,8 @@ function drawOne(gd, index, opt, value) {
optionsIn[axLetter] = position;
}

var options = handleAnnotationDefaults(optionsIn, fullLayout);
var options = {};
handleAnnotationDefaults(optionsIn, options, fullLayout);
fullLayout.annotations[index] = options;

var xa = Axes.getFromId(gd, options.xref),
Expand Down
20 changes: 8 additions & 12 deletions src/components/images/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,24 +8,20 @@

'use strict';

var Axes = require('../../plots/cartesian/axes');
var Lib = require('../../lib');
var attributes = require('./attributes');
var Axes = require('../../plots/cartesian/axes');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var name = 'images';

module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: imageDefaults
};

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i] || {},
itemOut = {};

imageDefaults(itemIn, itemOut, layoutOut);

contOut.push(itemOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};


Expand Down
14 changes: 6 additions & 8 deletions src/components/shapes/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleShapeDefaults = require('./shape_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.shapes || [],
containerOut = layoutOut.shapes = [];
var opts = {
name: 'shapes',
handleItemDefaults: handleShapeDefaults
};

for(var i = 0; i < containerIn.length; i++) {
var shapeIn = containerIn[i] || {},
shapeOut = handleShapeDefaults(shapeIn, layoutOut);

containerOut.push(shapeOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/shapes/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -232,7 +232,8 @@ function updateShape(gd, index, opt, value) {
optionsIn[posAttr] = position;
}

var options = handleShapeDefaults(optionsIn, gd._fullLayout);
var options = {};
handleShapeDefaults(optionsIn, options, gd._fullLayout);
gd._fullLayout.shapes[index] = options;

var clipAxes;
Expand Down
8 changes: 5 additions & 3 deletions src/components/shapes/shape_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,16 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');
var helpers = require('./helpers');

module.exports = function handleShapeDefaults(shapeIn, fullLayout) {
var shapeOut = {};

module.exports = function handleShapeDefaults(shapeIn, shapeOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(shapeIn, shapeOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return shapeOut;

Expand Down
22 changes: 6 additions & 16 deletions src/components/sliders/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var stepAttrs = attributes.steps;


module.exports = function slidersDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: sliderDefaults
};

for(var i = 0; i < contIn.length; i++) {
var sliderIn = contIn[i] || {},
sliderOut = {};

sliderDefaults(sliderIn, sliderOut, layoutOut);

// used on button click to update the 'active' field
sliderOut._input = sliderIn;

// used to determine object constancy
sliderOut._index = i;

contOut.push(sliderOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function sliderDefaults(sliderIn, sliderOut, layoutOut) {
Expand Down
22 changes: 6 additions & 16 deletions src/components/updatemenus/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var buttonAttrs = attributes.buttons;


module.exports = function updateMenusDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: menuDefaults
};

for(var i = 0; i < contIn.length; i++) {
var menuIn = contIn[i] || {},
menuOut = {};

menuDefaults(menuIn, menuOut, layoutOut);

// used on button click to update the 'active' field
menuOut._input = menuIn;

// used to determine object constancy
menuOut._index = i;

contOut.push(menuOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function menuDefaults(menuIn, menuOut, layoutOut) {
Expand Down
19 changes: 9 additions & 10 deletions src/plot_api/helpers.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,13 +102,12 @@ exports.cleanLayout = function(layout) {
}
}

if(layout.annotations !== undefined && !Array.isArray(layout.annotations)) {
Lib.warn('Annotations must be an array.');
delete layout.annotations;
}
var annotationsLen = (layout.annotations || []).length;
var annotationsLen = Array.isArray(layout.annotations) ? layout.annotations.length : 0;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this commit was enough to fix bug discovered in http://codepen.io/etpinard/pen/xRGgwW

for(i = 0; i < annotationsLen; i++) {
var ann = layout.annotations[i];

if(!Lib.isPlainObject(ann)) continue;

if(ann.ref) {
if(ann.ref === 'paper') {
ann.xref = 'paper';
Expand All@@ -120,17 +119,17 @@ exports.cleanLayout = function(layout) {
}
delete ann.ref;
}

cleanAxRef(ann, 'xref');
cleanAxRef(ann, 'yref');
}

if(layout.shapes !== undefined && !Array.isArray(layout.shapes)) {
Lib.warn('Shapes must be an array.');
delete layout.shapes;
}
var shapesLen = (layout.shapes || []).length;
var shapesLen = Array.isArray(layout.shapes) ? layout.shapes.length : 0;
for(i = 0; i < shapesLen; i++) {
var shape = layout.shapes[i];

if(!Lib.isPlainObject(shape)) continue;

cleanAxRef(shape, 'xref');
cleanAxRef(shape, 'yref');
}
Expand Down
67 changes: 67 additions & 0 deletions src/plots/array_container_defaults.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
/**
* Copyright 2012-2016, Plotly, Inc.
* All rights reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

'use strict';

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


/** Convenience wrapper for making array container logic DRY and consistent
*
* @param {object} parentObjIn
* user input object where the container in question is linked
* (i.e. either a user trace object or the user layout object)
*
* @param {object} parentObjOut
* full object where the coerced container will be linked
* (i.e. either a full trace object or the full layout object)
*
* @param {object} opts
* options object:
* - name {string}
* name of the key linking the container in question
* - handleItemDefaults {function}
* defaults method to be called on each item in the array container in question
*
* Its arguments are:
* - itemIn {object} item in user layout
* - itemOut {object} item in full layout
* - parentObj {object} (as in closure)
* - opts {object} (as in closure)
* - itemOpts {object}
* - itemIsNotPlainObject {boolean}
* N.B.
*
* - opts is passed to handleItemDefaults so it can also store
* links to supplementary data (e.g. fullData for layout components)
*
*/
module.exports = function handleArrayContainerDefaults(parentObjIn, parentObjOut, opts) {

@etpinardetpinardNov 10, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

similar to plots/subplot_defaults.

The logic below is pretty trivial, but might as well 🔒 down the behavior for all array containers.

var name = opts.name;

var contIn = Array.isArray(parentObjIn[name]) ? parentObjIn[name] : [],
contOut = parentObjOut[name] = [];

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i],
itemOut = {},
itemOpts = {};

if(!Lib.isPlainObject(itemIn)) {
itemOpts.itemIsNotPlainObject = true;
itemIn = {};
}

opts.handleItemDefaults(itemIn, itemOut, parentObjOut, opts, itemOpts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sure, that's fine. I still don't quite see where the handler will use the original opts but I guess it doesn't hurt to leave it in.


itemOut._input = itemIn;
itemOut._index = i;

contOut.push(itemOut);
}
};
19 changes: 15 additions & 4 deletions src/plots/plots.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -1569,8 +1569,14 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
for(i = 0; i < containerPaths.length; i++) {
containerProp = Lib.nestedProperty(expandedObj, containerPaths[i]);
containerVal = containerProp.get();
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);

if(containerVal === undefined) {
Lib.nestedProperty(containerObj, containerPaths[i]).set(null);
}
else {
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);
}
}
}

Expand All@@ -1584,15 +1590,20 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
if(!srcContainer) continue;

destProp = Lib.nestedProperty(dest, containerPaths[i]);

destContainer = destProp.get();

if(!Array.isArray(destContainer)) {
destContainer = [];
destProp.set(destContainer);
}

for(j = 0; j < srcContainer.length; j++) {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcContainer[j]);
var srcObj = srcContainer[j];

if(srcObj === null) destContainer[j] = null;
else {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcObj);
}
}

destProp.set(destContainer);
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); } })(); })(); Make frame with nulls clear items & array containers by etpinard · Pull Request #1118 · plotly/plotly.js · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/components/annotations/annotation_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,14 +16,15 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');


module.exports = function handleAnnotationDefaults(annIn, fullLayout) {
var annOut = {};
module.exports = function handleAnnotationDefaults(annIn, annOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(annIn, annOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return annOut;

Expand Down
14 changes: 6 additions & 8 deletions src/components/annotations/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleAnnotationDefaults = require('./annotation_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.annotations || [],
containerOut = layoutOut.annotations = [];
var opts = {
name: 'annotations',
handleItemDefaults: handleAnnotationDefaults

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

🌴

};

for(var i = 0; i < containerIn.length; i++) {
var annIn = containerIn[i] || {},
annOut = handleAnnotationDefaults(annIn, layoutOut);

containerOut.push(annOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/annotations/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -242,7 +242,8 @@ function drawOne(gd, index, opt, value) {
optionsIn[axLetter] = position;
}

var options = handleAnnotationDefaults(optionsIn, fullLayout);
var options = {};
handleAnnotationDefaults(optionsIn, options, fullLayout);
fullLayout.annotations[index] = options;

var xa = Axes.getFromId(gd, options.xref),
Expand Down
20 changes: 8 additions & 12 deletions src/components/images/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,24 +8,20 @@

'use strict';

var Axes = require('../../plots/cartesian/axes');
var Lib = require('../../lib');
var attributes = require('./attributes');
var Axes = require('../../plots/cartesian/axes');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var name = 'images';

module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: imageDefaults
};

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i] || {},
itemOut = {};

imageDefaults(itemIn, itemOut, layoutOut);

contOut.push(itemOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};


Expand Down
14 changes: 6 additions & 8 deletions src/components/shapes/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,17 +9,15 @@

'use strict';

var handleArrayContainerDefaults = require('../../plots/array_container_defaults');
var handleShapeDefaults = require('./shape_defaults');


module.exports = function supplyLayoutDefaults(layoutIn, layoutOut) {
var containerIn = layoutIn.shapes || [],
containerOut = layoutOut.shapes = [];
var opts = {
name: 'shapes',
handleItemDefaults: handleShapeDefaults
};

for(var i = 0; i < containerIn.length; i++) {
var shapeIn = containerIn[i] || {},
shapeOut = handleShapeDefaults(shapeIn, layoutOut);

containerOut.push(shapeOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};
3 changes: 2 additions & 1 deletion src/components/shapes/draw.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -232,7 +232,8 @@ function updateShape(gd, index, opt, value) {
optionsIn[posAttr] = position;
}

var options = handleShapeDefaults(optionsIn, gd._fullLayout);
var options = {};
handleShapeDefaults(optionsIn, options, gd._fullLayout);
gd._fullLayout.shapes[index] = options;

var clipAxes;
Expand Down
8 changes: 5 additions & 3 deletions src/components/shapes/shape_defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,14 +15,16 @@ var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');
var helpers = require('./helpers');

module.exports = function handleShapeDefaults(shapeIn, fullLayout) {
var shapeOut = {};

module.exports = function handleShapeDefaults(shapeIn, shapeOut, fullLayout, opts, itemOpts) {
opts = opts || {};
itemOpts = itemOpts || {};

function coerce(attr, dflt) {
return Lib.coerce(shapeIn, shapeOut, attributes, attr, dflt);
}

var visible = coerce('visible');
var visible = coerce('visible', !itemOpts.itemIsNotPlainObject);

if(!visible) return shapeOut;

Expand Down
22 changes: 6 additions & 16 deletions src/components/sliders/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var stepAttrs = attributes.steps;


module.exports = function slidersDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: sliderDefaults
};

for(var i = 0; i < contIn.length; i++) {
var sliderIn = contIn[i] || {},
sliderOut = {};

sliderDefaults(sliderIn, sliderOut, layoutOut);

// used on button click to update the 'active' field
sliderOut._input = sliderIn;

// used to determine object constancy
sliderOut._index = i;

contOut.push(sliderOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function sliderDefaults(sliderIn, sliderOut, layoutOut) {
Expand Down
22 changes: 6 additions & 16 deletions src/components/updatemenus/defaults.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@
'use strict';

var Lib = require('../../lib');
var handleArrayContainerDefaults = require('../../plots/array_container_defaults');

var attributes = require('./attributes');
var constants = require('./constants');
Expand All@@ -18,23 +19,12 @@ var buttonAttrs = attributes.buttons;


module.exports = function updateMenusDefaults(layoutIn, layoutOut) {
var contIn = Array.isArray(layoutIn[name]) ? layoutIn[name] : [],
contOut = layoutOut[name] = [];
var opts = {
name: name,
handleItemDefaults: menuDefaults
};

for(var i = 0; i < contIn.length; i++) {
var menuIn = contIn[i] || {},
menuOut = {};

menuDefaults(menuIn, menuOut, layoutOut);

// used on button click to update the 'active' field
menuOut._input = menuIn;

// used to determine object constancy
menuOut._index = i;

contOut.push(menuOut);
}
handleArrayContainerDefaults(layoutIn, layoutOut, opts);
};

function menuDefaults(menuIn, menuOut, layoutOut) {
Expand Down
19 changes: 9 additions & 10 deletions src/plot_api/helpers.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,13 +102,12 @@ exports.cleanLayout = function(layout) {
}
}

if(layout.annotations !== undefined && !Array.isArray(layout.annotations)) {
Lib.warn('Annotations must be an array.');
delete layout.annotations;
}
var annotationsLen = (layout.annotations || []).length;
var annotationsLen = Array.isArray(layout.annotations) ? layout.annotations.length : 0;

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this commit was enough to fix bug discovered in http://codepen.io/etpinard/pen/xRGgwW

for(i = 0; i < annotationsLen; i++) {
var ann = layout.annotations[i];

if(!Lib.isPlainObject(ann)) continue;

if(ann.ref) {
if(ann.ref === 'paper') {
ann.xref = 'paper';
Expand All@@ -120,17 +119,17 @@ exports.cleanLayout = function(layout) {
}
delete ann.ref;
}

cleanAxRef(ann, 'xref');
cleanAxRef(ann, 'yref');
}

if(layout.shapes !== undefined && !Array.isArray(layout.shapes)) {
Lib.warn('Shapes must be an array.');
delete layout.shapes;
}
var shapesLen = (layout.shapes || []).length;
var shapesLen = Array.isArray(layout.shapes) ? layout.shapes.length : 0;
for(i = 0; i < shapesLen; i++) {
var shape = layout.shapes[i];

if(!Lib.isPlainObject(shape)) continue;

cleanAxRef(shape, 'xref');
cleanAxRef(shape, 'yref');
}
Expand Down
67 changes: 67 additions & 0 deletions src/plots/array_container_defaults.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
/**
* Copyright 2012-2016, Plotly, Inc.
* All rights reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

'use strict';

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


/** Convenience wrapper for making array container logic DRY and consistent
*
* @param {object} parentObjIn
* user input object where the container in question is linked
* (i.e. either a user trace object or the user layout object)
*
* @param {object} parentObjOut
* full object where the coerced container will be linked
* (i.e. either a full trace object or the full layout object)
*
* @param {object} opts
* options object:
* - name {string}
* name of the key linking the container in question
* - handleItemDefaults {function}
* defaults method to be called on each item in the array container in question
*
* Its arguments are:
* - itemIn {object} item in user layout
* - itemOut {object} item in full layout
* - parentObj {object} (as in closure)
* - opts {object} (as in closure)
* - itemOpts {object}
* - itemIsNotPlainObject {boolean}
* N.B.
*
* - opts is passed to handleItemDefaults so it can also store
* links to supplementary data (e.g. fullData for layout components)
*
*/
module.exports = function handleArrayContainerDefaults(parentObjIn, parentObjOut, opts) {

@etpinardetpinardNov 10, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

similar to plots/subplot_defaults.

The logic below is pretty trivial, but might as well 🔒 down the behavior for all array containers.

var name = opts.name;

var contIn = Array.isArray(parentObjIn[name]) ? parentObjIn[name] : [],
contOut = parentObjOut[name] = [];

for(var i = 0; i < contIn.length; i++) {
var itemIn = contIn[i],
itemOut = {},
itemOpts = {};

if(!Lib.isPlainObject(itemIn)) {
itemOpts.itemIsNotPlainObject = true;
itemIn = {};
}

opts.handleItemDefaults(itemIn, itemOut, parentObjOut, opts, itemOpts);

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sure, that's fine. I still don't quite see where the handler will use the original opts but I guess it doesn't hurt to leave it in.


itemOut._input = itemIn;
itemOut._index = i;

contOut.push(itemOut);
}
};
19 changes: 15 additions & 4 deletions src/plots/plots.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -1569,8 +1569,14 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
for(i = 0; i < containerPaths.length; i++) {
containerProp = Lib.nestedProperty(expandedObj, containerPaths[i]);
containerVal = containerProp.get();
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);

if(containerVal === undefined) {
Lib.nestedProperty(containerObj, containerPaths[i]).set(null);
}
else {
containerProp.set(null);
Lib.nestedProperty(containerObj, containerPaths[i]).set(containerVal);
}
}
}

Expand All@@ -1584,15 +1590,20 @@ plots.extendObjectWithContainers = function(dest, src, containerPaths) {
if(!srcContainer) continue;

destProp = Lib.nestedProperty(dest, containerPaths[i]);

destContainer = destProp.get();

if(!Array.isArray(destContainer)) {
destContainer = [];
destProp.set(destContainer);
}

for(j = 0; j < srcContainer.length; j++) {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcContainer[j]);
var srcObj = srcContainer[j];

if(srcObj === null) destContainer[j] = null;
else {
destContainer[j] = plots.extendObjectWithContainers(destContainer[j], srcObj);
}
}

destProp.set(destContainer);
Expand Down
Loading