Skip to content

Config options coerce / schema#1188

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
etpinard wants to merge 6 commits into from
Closed

Config options coerce / schema #1188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1417622
rewrite plot_config as valObjects
etpinard Nov 22, 2016
bea7eaf
rm (now useless) validation from frameMargins
etpinard Nov 22, 2016
8cd3ada
use gd._context instead of config file for queueLength
etpinard Nov 22, 2016
bdd7144
test: fixup frame test
etpinard Nov 22, 2016
35ade0f
test: fixup plot api test
etpinard Nov 22, 2016
e44d66f
schema: add config valObjects to PlotSchema.get() output
etpinard Nov 22, 2016
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/lib/loggers.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
/* eslint-disable no-console */

var config = require('../plot_api/plot_config');
var loggingDflt = config.dflt;

var loggers = module.exports = {};

Expand All@@ -21,7 +22,7 @@ var loggers = module.exports = {};
*/

loggers.log = function() {
if(config.logging > 1) {
if(loggingDflt > 1) {
var messages = ['LOG:'];

for(var i = 0; i < arguments.length; i++) {
Expand All@@ -37,7 +38,7 @@ loggers.log = function() {
};

loggers.warn = function() {
if(config.logging > 0) {
if(loggingDflt > 0) {
var messages = ['WARN:'];

for(var i = 0; i < arguments.length; i++) {
Expand All@@ -53,7 +54,7 @@ loggers.warn = function() {
};

loggers.error = function() {
if(config.logging > 0) {
if(loggingDflt > 0) {
var messages = ['ERROR:'];

for(var i = 0; i < arguments.length; i++) {
Expand Down
3 changes: 1 addition & 2 deletions src/lib/queue.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@
'use strict';

var Lib = require('../lib');
var config = require('../plot_api/plot_config');


/**
Expand DownExpand Up@@ -91,7 +90,7 @@ queue.add = function(gd, undoFunc, undoArgs, redoFunc, redoArgs) {
queueObj.redo.args.push(redoArgs);
}

if(gd.undoQueue.queue.length > config.queueLength) {
if(gd.undoQueue.queue.length > gd._context.queueLength) {
gd.undoQueue.queue.shift();
gd.undoQueue.index--;
}
Expand Down
51 changes: 35 additions & 16 deletions src/plot_api/plot_api.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ var ErrorBars = require('../components/errorbars');
var xmlnsNamespaces = require('../constants/xmlns_namespaces');
var svgTextUtils = require('../lib/svg_text_utils');

var defaultConfig = require('./plot_config');
var helpers = require('./helpers');
var subroutines = require('./subroutines');

Expand DownExpand Up@@ -80,6 +81,7 @@ Plotly.plot = function(gd, data, layout, config) {

// transfer configuration options to gd until we move over to
// a more OO like model

setPlotContext(gd, config);

if(!layout) layout = {};
Expand DownExpand Up@@ -363,32 +365,49 @@ Plotly.plot = function(gd, data, layout, config) {
});
};


function opaqueSetBackground(gd, bgColor) {
gd._fullLayout._paperdiv.style('background', 'white');
Plotly.defaultConfig.setBackground(gd, bgColor);
defaultConfig.setBackground.dflt(gd, bgColor);
}

function setPlotContext(gd, config) {
if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
var context = gd._context;
var keys, i;

if(config) {
Object.keys(config).forEach(function(key) {
if(key in context) {
if(key === 'setBackground' && config[key] === 'opaque') {
context[key] = opaqueSetBackground;
}
else context[key] = config[key];
}
});
if(!gd._context) {
gd._context = {};
keys = Object.keys(defaultConfig);

// map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
context.plotGlPixelRatio = context.plot3dPixelRatio;
// init context
for(i = 0; i < keys.length; i++) {
var k = keys[i];
gd._context[k] = defaultConfig[k].dflt;
}
}

var context = gd._context;

config = Lib.isPlainObject(config) ? config : {};
keys = Object.keys(config);

function coerce(key, dflt) {
return Lib.coerce(config, context, defaultConfig, key, dflt);
}

// extend context with config
for(i = 0; i < keys.length; i++) {
coerce(keys[i]);
}

// 'opaque' is special value for setBackground
if(config.setBackground === 'opaque') {
context.setBackground = opaqueSetBackground;
}

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

@alexcjohnsonalexcjohnsonDec 8, 2016

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.

shouldn't this happen to the input object before coercing, so it can be validated? Anyway if it stays here it would need to be context.plotGlPixelRatio = config.plot3dPixelRatio;

@etpinardetpinardDec 9, 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.

Thanks for the comment. I discovered some breaking behavior.

As this PR isn't important to anyone right now, I'll drop it from the 1.21.1 release.

}

// staticPlot forces a bunch of others:
if(context.staticPlot) {
context.editable = false;
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" + '
Config options coerce / schema by etpinard · Pull Request #1188 · plotly/plotly.js · GitHub
Skip to content
Config options coerce / schema#1188

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

etpinard
wants to merge
6
commits into

from

 Closed


Config options coerce / schema
#1188
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
1417622

rewrite plot_config as valObjects


etpinard Nov 22, 2016
bea7eaf

rm (now useless) validation from frameMargins


etpinard Nov 22, 2016
8cd3ada

use gd._context instead of config file for queueLength


etpinard Nov 22, 2016
bdd7144

test: fixup frame test


etpinard Nov 22, 2016
35ade0f

test: fixup plot api test


etpinard Nov 22, 2016
e44d66f

schema: add config valObjects to PlotSchema.get() output


etpinard Nov 22, 2016

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/lib/loggers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
/* eslint-disable no-console */

var config = require('../plot_api/plot_config');
var loggingDflt = config.dflt;

var loggers = module.exports = {};

Expand All@@ -21,7 +22,7 @@ var loggers = module.exports = {};
 */

loggers.log = function() {
 if(config.logging > 1) {
 if(loggingDflt > 1) {
 var messages = ['LOG:'];

 for(var i = 0; i < arguments.length; i++) {
Expand All@@ -37,7 +38,7 @@ loggers.log = function() {
};

loggers.warn = function() {
 if(config.logging > 0) {
 if(loggingDflt > 0) {
 var messages = ['WARN:'];

 for(var i = 0; i < arguments.length; i++) {
Expand All@@ -53,7 +54,7 @@ loggers.warn = function() {
};

loggers.error = function() {
 if(config.logging > 0) {
 if(loggingDflt > 0) {
 var messages = ['ERROR:'];

 for(var i = 0; i < arguments.length; i++) {
Expand Down

3 changes: 1 addition & 2 deletions
src/lib/queue.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@
'use strict';

var Lib = require('../lib');
var config = require('../plot_api/plot_config');


/**
Expand DownExpand Up@@ -91,7 +90,7 @@ queue.add = function(gd, undoFunc, undoArgs, redoFunc, redoArgs) {
 queueObj.redo.args.push(redoArgs);
 }

 if(gd.undoQueue.queue.length > config.queueLength) {
 if(gd.undoQueue.queue.length > gd._context.queueLength) {
 gd.undoQueue.queue.shift();
 gd.undoQueue.index--;
 }
Expand Down

51 changes: 35 additions & 16 deletions
src/plot_api/plot_api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ var ErrorBars = require('../components/errorbars');
var xmlnsNamespaces = require('../constants/xmlns_namespaces');
var svgTextUtils = require('../lib/svg_text_utils');

var defaultConfig = require('./plot_config');
var helpers = require('./helpers');
var subroutines = require('./subroutines');

Expand DownExpand Up@@ -80,6 +81,7 @@ Plotly.plot = function(gd, data, layout, config) {

 // transfer configuration options to gd until we move over to
 // a more OO like model

 setPlotContext(gd, config);

 if(!layout) layout = {};
Expand DownExpand Up@@ -363,32 +365,49 @@ Plotly.plot = function(gd, data, layout, config) {
 });
};


function opaqueSetBackground(gd, bgColor) {
 gd._fullLayout._paperdiv.style('background', 'white');
Plotly.defaultConfig.setBackground(gd, bgColor);
 defaultConfig.setBackground.dflt(gd, bgColor);
}

function setPlotContext(gd, config) {
 if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
 var context = gd._context;
 var keys, i;

 if(config) {
 Object.keys(config).forEach(function(key) {
 if(key in context) {
 if(key === 'setBackground' && config[key] === 'opaque') {
 context[key] = opaqueSetBackground;
 }
 else context[key] = config[key];
 }
 });
 if(!gd._context) {
 gd._context = {};
 keys = Object.keys(defaultConfig);

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
 // init context
 for(i = 0; i < keys.length; i++) {
 var k = keys[i];
 gd._context[k] = defaultConfig[k].dflt;
 }
 }

 var context = gd._context;

 config = Lib.isPlainObject(config) ? config : {};
 keys = Object.keys(config);

 function coerce(key, dflt) {
 return Lib.coerce(config, context, defaultConfig, key, dflt);
 }

 // extend context with config
 for(i = 0; i < keys.length; i++) {
 coerce(keys[i]);
 }

 // 'opaque' is special value for setBackground
 if(config.setBackground === 'opaque') {
 context.setBackground = opaqueSetBackground;
 }

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
@alexcjohnsonalexcjohnsonDec 8, 2016

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.

shouldn't this happen to the input object before coercing, so it can be validated? Anyway if it stays here it would need to be context.plotGlPixelRatio = config.plot3dPixelRatio;
@etpinardetpinardDec 9, 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.

Thanks for the comment. I discovered some breaking behavior.
As this PR isn't important to anyone right now, I'll drop it from the 1.21.1 release.
 }

 // staticPlot forces a bunch of others:
 if(context.staticPlot) {
 context.editable = false;
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('^' + ".*" + '
Config options coerce / schema by etpinard · Pull Request #1188 · plotly/plotly.js · GitHub
Skip to content
Config options coerce / schema#1188

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

etpinard
wants to merge
6
commits into

from

 Closed


Config options coerce / schema
#1188
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
1417622

rewrite plot_config as valObjects


etpinard Nov 22, 2016
bea7eaf

rm (now useless) validation from frameMargins


etpinard Nov 22, 2016
8cd3ada

use gd._context instead of config file for queueLength


etpinard Nov 22, 2016
bdd7144

test: fixup frame test


etpinard Nov 22, 2016
35ade0f

test: fixup plot api test


etpinard Nov 22, 2016
e44d66f

schema: add config valObjects to PlotSchema.get() output


etpinard Nov 22, 2016

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/lib/loggers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
/* eslint-disable no-console */

var config = require('../plot_api/plot_config');
var loggingDflt = config.dflt;

var loggers = module.exports = {};

Expand All@@ -21,7 +22,7 @@ var loggers = module.exports = {};
 */

loggers.log = function() {
 if(config.logging > 1) {
 if(loggingDflt > 1) {
 var messages = ['LOG:'];

 for(var i = 0; i < arguments.length; i++) {
Expand All@@ -37,7 +38,7 @@ loggers.log = function() {
};

loggers.warn = function() {
 if(config.logging > 0) {
 if(loggingDflt > 0) {
 var messages = ['WARN:'];

 for(var i = 0; i < arguments.length; i++) {
Expand All@@ -53,7 +54,7 @@ loggers.warn = function() {
};

loggers.error = function() {
 if(config.logging > 0) {
 if(loggingDflt > 0) {
 var messages = ['ERROR:'];

 for(var i = 0; i < arguments.length; i++) {
Expand Down

3 changes: 1 addition & 2 deletions
src/lib/queue.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@
'use strict';

var Lib = require('../lib');
var config = require('../plot_api/plot_config');


/**
Expand DownExpand Up@@ -91,7 +90,7 @@ queue.add = function(gd, undoFunc, undoArgs, redoFunc, redoArgs) {
 queueObj.redo.args.push(redoArgs);
 }

 if(gd.undoQueue.queue.length > config.queueLength) {
 if(gd.undoQueue.queue.length > gd._context.queueLength) {
 gd.undoQueue.queue.shift();
 gd.undoQueue.index--;
 }
Expand Down

51 changes: 35 additions & 16 deletions
src/plot_api/plot_api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ var ErrorBars = require('../components/errorbars');
var xmlnsNamespaces = require('../constants/xmlns_namespaces');
var svgTextUtils = require('../lib/svg_text_utils');

var defaultConfig = require('./plot_config');
var helpers = require('./helpers');
var subroutines = require('./subroutines');

Expand DownExpand Up@@ -80,6 +81,7 @@ Plotly.plot = function(gd, data, layout, config) {

 // transfer configuration options to gd until we move over to
 // a more OO like model

 setPlotContext(gd, config);

 if(!layout) layout = {};
Expand DownExpand Up@@ -363,32 +365,49 @@ Plotly.plot = function(gd, data, layout, config) {
 });
};


function opaqueSetBackground(gd, bgColor) {
 gd._fullLayout._paperdiv.style('background', 'white');
Plotly.defaultConfig.setBackground(gd, bgColor);
 defaultConfig.setBackground.dflt(gd, bgColor);
}

function setPlotContext(gd, config) {
 if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
 var context = gd._context;
 var keys, i;

 if(config) {
 Object.keys(config).forEach(function(key) {
 if(key in context) {
 if(key === 'setBackground' && config[key] === 'opaque') {
 context[key] = opaqueSetBackground;
 }
 else context[key] = config[key];
 }
 });
 if(!gd._context) {
 gd._context = {};
 keys = Object.keys(defaultConfig);

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
 // init context
 for(i = 0; i < keys.length; i++) {
 var k = keys[i];
 gd._context[k] = defaultConfig[k].dflt;
 }
 }

 var context = gd._context;

 config = Lib.isPlainObject(config) ? config : {};
 keys = Object.keys(config);

 function coerce(key, dflt) {
 return Lib.coerce(config, context, defaultConfig, key, dflt);
 }

 // extend context with config
 for(i = 0; i < keys.length; i++) {
 coerce(keys[i]);
 }

 // 'opaque' is special value for setBackground
 if(config.setBackground === 'opaque') {
 context.setBackground = opaqueSetBackground;
 }

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
@alexcjohnsonalexcjohnsonDec 8, 2016

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.

shouldn't this happen to the input object before coercing, so it can be validated? Anyway if it stays here it would need to be context.plotGlPixelRatio = config.plot3dPixelRatio;
@etpinardetpinardDec 9, 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.

Thanks for the comment. I discovered some breaking behavior.
As this PR isn't important to anyone right now, I'll drop it from the 1.21.1 release.
 }

 // staticPlot forces a bunch of others:
 if(context.staticPlot) {
 context.editable = false;
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('^' + ".*" + '
Config options coerce / schema by etpinard · Pull Request #1188 · plotly/plotly.js · GitHub
Skip to content
Config options coerce / schema#1188

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

etpinard
wants to merge
6
commits into

from

 Closed


Config options coerce / schema
#1188
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
1417622

rewrite plot_config as valObjects


etpinard Nov 22, 2016
bea7eaf

rm (now useless) validation from frameMargins


etpinard Nov 22, 2016
8cd3ada

use gd._context instead of config file for queueLength


etpinard Nov 22, 2016
bdd7144

test: fixup frame test


etpinard Nov 22, 2016
35ade0f

test: fixup plot api test


etpinard Nov 22, 2016
e44d66f

schema: add config valObjects to PlotSchema.get() output


etpinard Nov 22, 2016

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/lib/loggers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
/* eslint-disable no-console */

var config = require('../plot_api/plot_config');
var loggingDflt = config.dflt;

var loggers = module.exports = {};

Expand All@@ -21,7 +22,7 @@ var loggers = module.exports = {};
 */

loggers.log = function() {
 if(config.logging > 1) {
 if(loggingDflt > 1) {
 var messages = ['LOG:'];

 for(var i = 0; i < arguments.length; i++) {
Expand All@@ -37,7 +38,7 @@ loggers.log = function() {
};

loggers.warn = function() {
 if(config.logging > 0) {
 if(loggingDflt > 0) {
 var messages = ['WARN:'];

 for(var i = 0; i < arguments.length; i++) {
Expand All@@ -53,7 +54,7 @@ loggers.warn = function() {
};

loggers.error = function() {
 if(config.logging > 0) {
 if(loggingDflt > 0) {
 var messages = ['ERROR:'];

 for(var i = 0; i < arguments.length; i++) {
Expand Down

3 changes: 1 addition & 2 deletions
src/lib/queue.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@
'use strict';

var Lib = require('../lib');
var config = require('../plot_api/plot_config');


/**
Expand DownExpand Up@@ -91,7 +90,7 @@ queue.add = function(gd, undoFunc, undoArgs, redoFunc, redoArgs) {
 queueObj.redo.args.push(redoArgs);
 }

 if(gd.undoQueue.queue.length > config.queueLength) {
 if(gd.undoQueue.queue.length > gd._context.queueLength) {
 gd.undoQueue.queue.shift();
 gd.undoQueue.index--;
 }
Expand Down

51 changes: 35 additions & 16 deletions
src/plot_api/plot_api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ var ErrorBars = require('../components/errorbars');
var xmlnsNamespaces = require('../constants/xmlns_namespaces');
var svgTextUtils = require('../lib/svg_text_utils');

var defaultConfig = require('./plot_config');
var helpers = require('./helpers');
var subroutines = require('./subroutines');

Expand DownExpand Up@@ -80,6 +81,7 @@ Plotly.plot = function(gd, data, layout, config) {

 // transfer configuration options to gd until we move over to
 // a more OO like model

 setPlotContext(gd, config);

 if(!layout) layout = {};
Expand DownExpand Up@@ -363,32 +365,49 @@ Plotly.plot = function(gd, data, layout, config) {
 });
};


function opaqueSetBackground(gd, bgColor) {
 gd._fullLayout._paperdiv.style('background', 'white');
Plotly.defaultConfig.setBackground(gd, bgColor);
 defaultConfig.setBackground.dflt(gd, bgColor);
}

function setPlotContext(gd, config) {
 if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
 var context = gd._context;
 var keys, i;

 if(config) {
 Object.keys(config).forEach(function(key) {
 if(key in context) {
 if(key === 'setBackground' && config[key] === 'opaque') {
 context[key] = opaqueSetBackground;
 }
 else context[key] = config[key];
 }
 });
 if(!gd._context) {
 gd._context = {};
 keys = Object.keys(defaultConfig);

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
 // init context
 for(i = 0; i < keys.length; i++) {
 var k = keys[i];
 gd._context[k] = defaultConfig[k].dflt;
 }
 }

 var context = gd._context;

 config = Lib.isPlainObject(config) ? config : {};
 keys = Object.keys(config);

 function coerce(key, dflt) {
 return Lib.coerce(config, context, defaultConfig, key, dflt);
 }

 // extend context with config
 for(i = 0; i < keys.length; i++) {
 coerce(keys[i]);
 }

 // 'opaque' is special value for setBackground
 if(config.setBackground === 'opaque') {
 context.setBackground = opaqueSetBackground;
 }

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
@alexcjohnsonalexcjohnsonDec 8, 2016

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.

shouldn't this happen to the input object before coercing, so it can be validated? Anyway if it stays here it would need to be context.plotGlPixelRatio = config.plot3dPixelRatio;
@etpinardetpinardDec 9, 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.

Thanks for the comment. I discovered some breaking behavior.
As this PR isn't important to anyone right now, I'll drop it from the 1.21.1 release.
 }

 // staticPlot forces a bunch of others:
 if(context.staticPlot) {
 context.editable = false;
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" + '
Config options coerce / schema by etpinard · Pull Request #1188 · plotly/plotly.js · GitHub
Skip to content
Config options coerce / schema#1188

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

etpinard
wants to merge
6
commits into

from

 Closed


Config options coerce / schema
#1188
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
1417622

rewrite plot_config as valObjects


etpinard Nov 22, 2016
bea7eaf

rm (now useless) validation from frameMargins


etpinard Nov 22, 2016
8cd3ada

use gd._context instead of config file for queueLength


etpinard Nov 22, 2016
bdd7144

test: fixup frame test


etpinard Nov 22, 2016
35ade0f

test: fixup plot api test


etpinard Nov 22, 2016
e44d66f

schema: add config valObjects to PlotSchema.get() output


etpinard Nov 22, 2016

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/lib/loggers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
/* eslint-disable no-console */

var config = require('../plot_api/plot_config');
var loggingDflt = config.dflt;

var loggers = module.exports = {};

Expand All@@ -21,7 +22,7 @@ var loggers = module.exports = {};
 */

loggers.log = function() {
 if(config.logging > 1) {
 if(loggingDflt > 1) {
 var messages = ['LOG:'];

 for(var i = 0; i < arguments.length; i++) {
Expand All@@ -37,7 +38,7 @@ loggers.log = function() {
};

loggers.warn = function() {
 if(config.logging > 0) {
 if(loggingDflt > 0) {
 var messages = ['WARN:'];

 for(var i = 0; i < arguments.length; i++) {
Expand All@@ -53,7 +54,7 @@ loggers.warn = function() {
};

loggers.error = function() {
 if(config.logging > 0) {
 if(loggingDflt > 0) {
 var messages = ['ERROR:'];

 for(var i = 0; i < arguments.length; i++) {
Expand Down

3 changes: 1 addition & 2 deletions
src/lib/queue.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@
'use strict';

var Lib = require('../lib');
var config = require('../plot_api/plot_config');


/**
Expand DownExpand Up@@ -91,7 +90,7 @@ queue.add = function(gd, undoFunc, undoArgs, redoFunc, redoArgs) {
 queueObj.redo.args.push(redoArgs);
 }

 if(gd.undoQueue.queue.length > config.queueLength) {
 if(gd.undoQueue.queue.length > gd._context.queueLength) {
 gd.undoQueue.queue.shift();
 gd.undoQueue.index--;
 }
Expand Down

51 changes: 35 additions & 16 deletions
src/plot_api/plot_api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ var ErrorBars = require('../components/errorbars');
var xmlnsNamespaces = require('../constants/xmlns_namespaces');
var svgTextUtils = require('../lib/svg_text_utils');

var defaultConfig = require('./plot_config');
var helpers = require('./helpers');
var subroutines = require('./subroutines');

Expand DownExpand Up@@ -80,6 +81,7 @@ Plotly.plot = function(gd, data, layout, config) {

 // transfer configuration options to gd until we move over to
 // a more OO like model

 setPlotContext(gd, config);

 if(!layout) layout = {};
Expand DownExpand Up@@ -363,32 +365,49 @@ Plotly.plot = function(gd, data, layout, config) {
 });
};


function opaqueSetBackground(gd, bgColor) {
 gd._fullLayout._paperdiv.style('background', 'white');
Plotly.defaultConfig.setBackground(gd, bgColor);
 defaultConfig.setBackground.dflt(gd, bgColor);
}

function setPlotContext(gd, config) {
 if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
 var context = gd._context;
 var keys, i;

 if(config) {
 Object.keys(config).forEach(function(key) {
 if(key in context) {
 if(key === 'setBackground' && config[key] === 'opaque') {
 context[key] = opaqueSetBackground;
 }
 else context[key] = config[key];
 }
 });
 if(!gd._context) {
 gd._context = {};
 keys = Object.keys(defaultConfig);

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
 // init context
 for(i = 0; i < keys.length; i++) {
 var k = keys[i];
 gd._context[k] = defaultConfig[k].dflt;
 }
 }

 var context = gd._context;

 config = Lib.isPlainObject(config) ? config : {};
 keys = Object.keys(config);

 function coerce(key, dflt) {
 return Lib.coerce(config, context, defaultConfig, key, dflt);
 }

 // extend context with config
 for(i = 0; i < keys.length; i++) {
 coerce(keys[i]);
 }

 // 'opaque' is special value for setBackground
 if(config.setBackground === 'opaque') {
 context.setBackground = opaqueSetBackground;
 }

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
@alexcjohnsonalexcjohnsonDec 8, 2016

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.

shouldn't this happen to the input object before coercing, so it can be validated? Anyway if it stays here it would need to be context.plotGlPixelRatio = config.plot3dPixelRatio;
@etpinardetpinardDec 9, 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.

Thanks for the comment. I discovered some breaking behavior.
As this PR isn't important to anyone right now, I'll drop it from the 1.21.1 release.
 }

 // staticPlot forces a bunch of others:
 if(context.staticPlot) {
 context.editable = false;
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('^' + ".*" + '
Config options coerce / schema by etpinard · Pull Request #1188 · plotly/plotly.js · GitHub
Skip to content
Config options coerce / schema#1188

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

etpinard
wants to merge
6
commits into

from

 Closed


Config options coerce / schema
#1188
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
1417622

rewrite plot_config as valObjects


etpinard Nov 22, 2016
bea7eaf

rm (now useless) validation from frameMargins


etpinard Nov 22, 2016
8cd3ada

use gd._context instead of config file for queueLength


etpinard Nov 22, 2016
bdd7144

test: fixup frame test


etpinard Nov 22, 2016
35ade0f

test: fixup plot api test


etpinard Nov 22, 2016
e44d66f

schema: add config valObjects to PlotSchema.get() output


etpinard Nov 22, 2016

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/lib/loggers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
/* eslint-disable no-console */

var config = require('../plot_api/plot_config');
var loggingDflt = config.dflt;

var loggers = module.exports = {};

Expand All@@ -21,7 +22,7 @@ var loggers = module.exports = {};
 */

loggers.log = function() {
 if(config.logging > 1) {
 if(loggingDflt > 1) {
 var messages = ['LOG:'];

 for(var i = 0; i < arguments.length; i++) {
Expand All@@ -37,7 +38,7 @@ loggers.log = function() {
};

loggers.warn = function() {
 if(config.logging > 0) {
 if(loggingDflt > 0) {
 var messages = ['WARN:'];

 for(var i = 0; i < arguments.length; i++) {
Expand All@@ -53,7 +54,7 @@ loggers.warn = function() {
};

loggers.error = function() {
 if(config.logging > 0) {
 if(loggingDflt > 0) {
 var messages = ['ERROR:'];

 for(var i = 0; i < arguments.length; i++) {
Expand Down

3 changes: 1 addition & 2 deletions
src/lib/queue.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@
'use strict';

var Lib = require('../lib');
var config = require('../plot_api/plot_config');


/**
Expand DownExpand Up@@ -91,7 +90,7 @@ queue.add = function(gd, undoFunc, undoArgs, redoFunc, redoArgs) {
 queueObj.redo.args.push(redoArgs);
 }

 if(gd.undoQueue.queue.length > config.queueLength) {
 if(gd.undoQueue.queue.length > gd._context.queueLength) {
 gd.undoQueue.queue.shift();
 gd.undoQueue.index--;
 }
Expand Down

51 changes: 35 additions & 16 deletions
src/plot_api/plot_api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ var ErrorBars = require('../components/errorbars');
var xmlnsNamespaces = require('../constants/xmlns_namespaces');
var svgTextUtils = require('../lib/svg_text_utils');

var defaultConfig = require('./plot_config');
var helpers = require('./helpers');
var subroutines = require('./subroutines');

Expand DownExpand Up@@ -80,6 +81,7 @@ Plotly.plot = function(gd, data, layout, config) {

 // transfer configuration options to gd until we move over to
 // a more OO like model

 setPlotContext(gd, config);

 if(!layout) layout = {};
Expand DownExpand Up@@ -363,32 +365,49 @@ Plotly.plot = function(gd, data, layout, config) {
 });
};


function opaqueSetBackground(gd, bgColor) {
 gd._fullLayout._paperdiv.style('background', 'white');
Plotly.defaultConfig.setBackground(gd, bgColor);
 defaultConfig.setBackground.dflt(gd, bgColor);
}

function setPlotContext(gd, config) {
 if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
 var context = gd._context;
 var keys, i;

 if(config) {
 Object.keys(config).forEach(function(key) {
 if(key in context) {
 if(key === 'setBackground' && config[key] === 'opaque') {
 context[key] = opaqueSetBackground;
 }
 else context[key] = config[key];
 }
 });
 if(!gd._context) {
 gd._context = {};
 keys = Object.keys(defaultConfig);

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
 // init context
 for(i = 0; i < keys.length; i++) {
 var k = keys[i];
 gd._context[k] = defaultConfig[k].dflt;
 }
 }

 var context = gd._context;

 config = Lib.isPlainObject(config) ? config : {};
 keys = Object.keys(config);

 function coerce(key, dflt) {
 return Lib.coerce(config, context, defaultConfig, key, dflt);
 }

 // extend context with config
 for(i = 0; i < keys.length; i++) {
 coerce(keys[i]);
 }

 // 'opaque' is special value for setBackground
 if(config.setBackground === 'opaque') {
 context.setBackground = opaqueSetBackground;
 }

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
@alexcjohnsonalexcjohnsonDec 8, 2016

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.

shouldn't this happen to the input object before coercing, so it can be validated? Anyway if it stays here it would need to be context.plotGlPixelRatio = config.plot3dPixelRatio;
@etpinardetpinardDec 9, 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.

Thanks for the comment. I discovered some breaking behavior.
As this PR isn't important to anyone right now, I'll drop it from the 1.21.1 release.
 }

 // staticPlot forces a bunch of others:
 if(context.staticPlot) {
 context.editable = false;
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('^' + ".*" + '
Config options coerce / schema by etpinard · Pull Request #1188 · plotly/plotly.js · GitHub
Skip to content
Config options coerce / schema#1188

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

etpinard
wants to merge
6
commits into

from

 Closed


Config options coerce / schema
#1188
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
1417622

rewrite plot_config as valObjects


etpinard Nov 22, 2016
bea7eaf

rm (now useless) validation from frameMargins


etpinard Nov 22, 2016
8cd3ada

use gd._context instead of config file for queueLength


etpinard Nov 22, 2016
bdd7144

test: fixup frame test


etpinard Nov 22, 2016
35ade0f

test: fixup plot api test


etpinard Nov 22, 2016
e44d66f

schema: add config valObjects to PlotSchema.get() output


etpinard Nov 22, 2016

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/lib/loggers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
/* eslint-disable no-console */

var config = require('../plot_api/plot_config');
var loggingDflt = config.dflt;

var loggers = module.exports = {};

Expand All@@ -21,7 +22,7 @@ var loggers = module.exports = {};
 */

loggers.log = function() {
 if(config.logging > 1) {
 if(loggingDflt > 1) {
 var messages = ['LOG:'];

 for(var i = 0; i < arguments.length; i++) {
Expand All@@ -37,7 +38,7 @@ loggers.log = function() {
};

loggers.warn = function() {
 if(config.logging > 0) {
 if(loggingDflt > 0) {
 var messages = ['WARN:'];

 for(var i = 0; i < arguments.length; i++) {
Expand All@@ -53,7 +54,7 @@ loggers.warn = function() {
};

loggers.error = function() {
 if(config.logging > 0) {
 if(loggingDflt > 0) {
 var messages = ['ERROR:'];

 for(var i = 0; i < arguments.length; i++) {
Expand Down

3 changes: 1 addition & 2 deletions
src/lib/queue.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@
'use strict';

var Lib = require('../lib');
var config = require('../plot_api/plot_config');


/**
Expand DownExpand Up@@ -91,7 +90,7 @@ queue.add = function(gd, undoFunc, undoArgs, redoFunc, redoArgs) {
 queueObj.redo.args.push(redoArgs);
 }

 if(gd.undoQueue.queue.length > config.queueLength) {
 if(gd.undoQueue.queue.length > gd._context.queueLength) {
 gd.undoQueue.queue.shift();
 gd.undoQueue.index--;
 }
Expand Down

51 changes: 35 additions & 16 deletions
src/plot_api/plot_api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ var ErrorBars = require('../components/errorbars');
var xmlnsNamespaces = require('../constants/xmlns_namespaces');
var svgTextUtils = require('../lib/svg_text_utils');

var defaultConfig = require('./plot_config');
var helpers = require('./helpers');
var subroutines = require('./subroutines');

Expand DownExpand Up@@ -80,6 +81,7 @@ Plotly.plot = function(gd, data, layout, config) {

 // transfer configuration options to gd until we move over to
 // a more OO like model

 setPlotContext(gd, config);

 if(!layout) layout = {};
Expand DownExpand Up@@ -363,32 +365,49 @@ Plotly.plot = function(gd, data, layout, config) {
 });
};


function opaqueSetBackground(gd, bgColor) {
 gd._fullLayout._paperdiv.style('background', 'white');
Plotly.defaultConfig.setBackground(gd, bgColor);
 defaultConfig.setBackground.dflt(gd, bgColor);
}

function setPlotContext(gd, config) {
 if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
 var context = gd._context;
 var keys, i;

 if(config) {
 Object.keys(config).forEach(function(key) {
 if(key in context) {
 if(key === 'setBackground' && config[key] === 'opaque') {
 context[key] = opaqueSetBackground;
 }
 else context[key] = config[key];
 }
 });
 if(!gd._context) {
 gd._context = {};
 keys = Object.keys(defaultConfig);

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
 // init context
 for(i = 0; i < keys.length; i++) {
 var k = keys[i];
 gd._context[k] = defaultConfig[k].dflt;
 }
 }

 var context = gd._context;

 config = Lib.isPlainObject(config) ? config : {};
 keys = Object.keys(config);

 function coerce(key, dflt) {
 return Lib.coerce(config, context, defaultConfig, key, dflt);
 }

 // extend context with config
 for(i = 0; i < keys.length; i++) {
 coerce(keys[i]);
 }

 // 'opaque' is special value for setBackground
 if(config.setBackground === 'opaque') {
 context.setBackground = opaqueSetBackground;
 }

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
@alexcjohnsonalexcjohnsonDec 8, 2016

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.

shouldn't this happen to the input object before coercing, so it can be validated? Anyway if it stays here it would need to be context.plotGlPixelRatio = config.plot3dPixelRatio;
@etpinardetpinardDec 9, 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.

Thanks for the comment. I discovered some breaking behavior.
As this PR isn't important to anyone right now, I'll drop it from the 1.21.1 release.
 }

 // staticPlot forces a bunch of others:
 if(context.staticPlot) {
 context.editable = false;
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); }
})();
})();
Config options coerce / schema by etpinard · Pull Request #1188 · plotly/plotly.js · GitHub
Skip to content
Config options coerce / schema#1188

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

etpinard
wants to merge
6
commits into

from

 Closed


Config options coerce / schema
#1188
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
1417622

rewrite plot_config as valObjects


etpinard Nov 22, 2016
bea7eaf

rm (now useless) validation from frameMargins


etpinard Nov 22, 2016
8cd3ada

use gd._context instead of config file for queueLength


etpinard Nov 22, 2016
bdd7144

test: fixup frame test


etpinard Nov 22, 2016
35ade0f

test: fixup plot api test


etpinard Nov 22, 2016
e44d66f

schema: add config valObjects to PlotSchema.get() output


etpinard Nov 22, 2016

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/lib/loggers.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
/* eslint-disable no-console */

var config = require('../plot_api/plot_config');
var loggingDflt = config.dflt;

var loggers = module.exports = {};

Expand All@@ -21,7 +22,7 @@ var loggers = module.exports = {};
 */

loggers.log = function() {
 if(config.logging > 1) {
 if(loggingDflt > 1) {
 var messages = ['LOG:'];

 for(var i = 0; i < arguments.length; i++) {
Expand All@@ -37,7 +38,7 @@ loggers.log = function() {
};

loggers.warn = function() {
 if(config.logging > 0) {
 if(loggingDflt > 0) {
 var messages = ['WARN:'];

 for(var i = 0; i < arguments.length; i++) {
Expand All@@ -53,7 +54,7 @@ loggers.warn = function() {
};

loggers.error = function() {
 if(config.logging > 0) {
 if(loggingDflt > 0) {
 var messages = ['ERROR:'];

 for(var i = 0; i < arguments.length; i++) {
Expand Down

3 changes: 1 addition & 2 deletions
src/lib/queue.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,6 @@
'use strict';

var Lib = require('../lib');
var config = require('../plot_api/plot_config');


/**
Expand DownExpand Up@@ -91,7 +90,7 @@ queue.add = function(gd, undoFunc, undoArgs, redoFunc, redoArgs) {
 queueObj.redo.args.push(redoArgs);
 }

 if(gd.undoQueue.queue.length > config.queueLength) {
 if(gd.undoQueue.queue.length > gd._context.queueLength) {
 gd.undoQueue.queue.shift();
 gd.undoQueue.index--;
 }
Expand Down

51 changes: 35 additions & 16 deletions
src/plot_api/plot_api.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@ var ErrorBars = require('../components/errorbars');
var xmlnsNamespaces = require('../constants/xmlns_namespaces');
var svgTextUtils = require('../lib/svg_text_utils');

var defaultConfig = require('./plot_config');
var helpers = require('./helpers');
var subroutines = require('./subroutines');

Expand DownExpand Up@@ -80,6 +81,7 @@ Plotly.plot = function(gd, data, layout, config) {

 // transfer configuration options to gd until we move over to
 // a more OO like model

 setPlotContext(gd, config);

 if(!layout) layout = {};
Expand DownExpand Up@@ -363,32 +365,49 @@ Plotly.plot = function(gd, data, layout, config) {
 });
};


function opaqueSetBackground(gd, bgColor) {
 gd._fullLayout._paperdiv.style('background', 'white');
Plotly.defaultConfig.setBackground(gd, bgColor);
 defaultConfig.setBackground.dflt(gd, bgColor);
}

function setPlotContext(gd, config) {
 if(!gd._context) gd._context = Lib.extendFlat({}, Plotly.defaultConfig);
 var context = gd._context;
 var keys, i;

 if(config) {
 Object.keys(config).forEach(function(key) {
 if(key in context) {
 if(key === 'setBackground' && config[key] === 'opaque') {
 context[key] = opaqueSetBackground;
 }
 else context[key] = config[key];
 }
 });
 if(!gd._context) {
 gd._context = {};
 keys = Object.keys(defaultConfig);

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
 // init context
 for(i = 0; i < keys.length; i++) {
 var k = keys[i];
 gd._context[k] = defaultConfig[k].dflt;
 }
 }

 var context = gd._context;

 config = Lib.isPlainObject(config) ? config : {};
 keys = Object.keys(config);

 function coerce(key, dflt) {
 return Lib.coerce(config, context, defaultConfig, key, dflt);
 }

 // extend context with config
 for(i = 0; i < keys.length; i++) {
 coerce(keys[i]);
 }

 // 'opaque' is special value for setBackground
 if(config.setBackground === 'opaque') {
 context.setBackground = opaqueSetBackground;
 }

 // map plot3dPixelRatio to plotGlPixelRatio for backward compatibility
 if(config.plot3dPixelRatio && !context.plotGlPixelRatio) {
 context.plotGlPixelRatio = context.plot3dPixelRatio;
@alexcjohnsonalexcjohnsonDec 8, 2016

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.

shouldn't this happen to the input object before coercing, so it can be validated? Anyway if it stays here it would need to be context.plotGlPixelRatio = config.plot3dPixelRatio;
@etpinardetpinardDec 9, 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.

Thanks for the comment. I discovered some breaking behavior.
As this PR isn't important to anyone right now, I'll drop it from the 1.21.1 release.
 }

 // staticPlot forces a bunch of others:
 if(context.staticPlot) {
 context.editable = false;
Expand Down
Loading