Skip to content

Revisit template Lib.coerce2 to set various attributes via template #5018

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.

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
wants to merge 2 commits into from
Closed
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
69 changes: 46 additions & 23 deletions src/lib/coerce.js
Original file line number Diff line number Diff line change
Expand Up @@ -361,58 +361,81 @@ exports.valObjectMeta = {
* as a convenience, returns the value it finally set
*/
exports.coerce = function(containerIn, containerOut, attributes, attribute, dflt) {
var opts = nestedProperty(attributes, attribute).get();
return _coerce(containerIn, containerOut, attributes, attribute, dflt).val;
};

function _coerce(containerIn, containerOut, attributes, attribute, dflt, opts) {
var shouldValidate = (opts || {}).shouldValidate;

var attr = nestedProperty(attributes, attribute).get();
if(dflt === undefined) dflt = attr.dflt;
var src = false;

var propIn = nestedProperty(containerIn, attribute);
var propOut = nestedProperty(containerOut, attribute);
var v = propIn.get();
var valIn = propIn.get();

var template = containerOut._template;
if(v === undefined && template) {
v = nestedProperty(template, attribute).get();
if(valIn === undefined && template) {
valIn = nestedProperty(template, attribute).get();
src = (valIn !== undefined);

// already used the template value, so short-circuit the second check
template = 0;
}

if(dflt === undefined) dflt = opts.dflt;

/**
* arrayOk: value MAY be an array, then we do no value checking
* at this point, because it can be more complicated than the
* individual form (eg. some array vals can be numbers, even if the
* single values must be color strings)
*/
if(opts.arrayOk && isArrayOrTypedArray(v)) {
propOut.set(v);
return v;
if(attr.arrayOk && isArrayOrTypedArray(valIn)) {
propOut.set(valIn);
return {
inp: valIn,
val: valIn,
src: true
};
}

var coerceFunction = exports.valObjectMeta[opts.valType].coerceFunction;
coerceFunction(v, propOut, dflt, opts);
var coerceFunction = exports.valObjectMeta[attr.valType].coerceFunction;
coerceFunction(valIn, propOut, dflt, attr);

var valOut = propOut.get();
src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);

var out = propOut.get();
// in case v was provided but invalid, try the template again so it still
// overrides the regular default
if(template && out === dflt && !validate(v, opts)) {
v = nestedProperty(template, attribute).get();
coerceFunction(v, propOut, dflt, opts);
out = propOut.get();
if(template && valOut === dflt && !validate(valIn, attr)) {
valIn = nestedProperty(template, attribute).get();
coerceFunction(valIn, propOut, dflt, attr);
valOut = propOut.get();

src = (valOut !== undefined) && shouldValidate && validate(valIn, attr);
}
return out;
};

return {
inp: valIn,
val: valOut,
src: src
};
}

/**
* Variation on coerce
* useful when setting an attribute to a valid value
* can change the default for another attribute.
*
* Uses coerce to get attribute value if user input is valid,
* returns attribute default if user input it not valid or
* returns false if there is no user input.
*/
exports.coerce2 = function(containerIn, containerOut, attributes, attribute, dflt) {
var propIn = nestedProperty(containerIn, attribute);
var propOut = exports.coerce(containerIn, containerOut, attributes, attribute, dflt);
var valIn = propIn.get();

return (valIn !== undefined && valIn !== null) ? propOut : false;
var out = _coerce(containerIn, containerOut, attributes, attribute, dflt, {
shouldValidate: true
});
return (out.src && out.inp !== undefined) ? out.val : false;
};

/*
Expand Down
1 change: 1 addition & 0 deletions src/plots/cartesian/axis_defaults.js
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,
dfltColor: dfltColor,
bgColor: options.bgColor,
showGrid: options.showGrid,
hideGrid: options.hideGrid,
attributes: layoutAttributes
});

Expand Down
2 changes: 2 additions & 0 deletions src/plots/cartesian/layout_defaults.js
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
letter: axLetter,
font: layoutOut.font,
outerTicks: outerTicks[axName],
hideGrid: noGrids[axName],
showGrid: !noGrids[axName],
data: ax2traces[axName] || [],
bgColor: bgColor,
Expand Down Expand Up @@ -303,6 +304,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
letter: axLetter,
font: layoutOut.font,
outerTicks: outerTicks[axName],
hideGrid: noGrids[axName],
showGrid: !noGrids[axName],
data: [],
bgColor: bgColor,
Expand Down
20 changes: 16 additions & 4 deletions src/plots/cartesian/line_grid_defaults.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,18 @@ module.exports = function handleLineGridDefaults(containerIn, containerOut, coer
return Lib.coerce2(containerIn, containerOut, opts.attributes, attr, dflt);
}

function _coerce(attr, dflt) {
var val = coerce2(attr, dflt);

if(
val && opts.hideGrid &&
containerOut[attr] !== containerIn[attr] &&
containerOut[attr] === containerOut._template[attr]
) return false;

return val;
}

var lineColor = coerce2('linecolor', dfltColor);
var lineWidth = coerce2('linewidth');
var showLine = coerce('showline', opts.showLine || !!lineColor || !!lineWidth);
Expand All @@ -41,8 +53,8 @@ module.exports = function handleLineGridDefaults(containerIn, containerOut, coer
}

var gridColorDflt = colorMix(dfltColor, opts.bgColor, opts.blend || lightFraction).toRgbString();
var gridColor = coerce2('gridcolor', gridColorDflt);
var gridWidth = coerce2('gridwidth');
var gridColor = _coerce('gridcolor', gridColorDflt);
var gridWidth = _coerce('gridwidth');
var showGridLines = coerce('showgrid', opts.showGrid || !!gridColor || !!gridWidth);

if(!showGridLines) {
Expand All @@ -51,8 +63,8 @@ module.exports = function handleLineGridDefaults(containerIn, containerOut, coer
}

if(!opts.noZeroLine) {
var zeroLineColor = coerce2('zerolinecolor', dfltColor);
var zeroLineWidth = coerce2('zerolinewidth');
var zeroLineColor = _coerce('zerolinecolor', dfltColor);
var zeroLineWidth = _coerce('zerolinewidth');
var showZeroLine = coerce('zeroline', opts.showGrid || !!zeroLineColor || !!zeroLineWidth);

if(!showZeroLine) {
Expand Down
Binary file modified test/image/baselines/axes_breaks-round-weekdays.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
80 changes: 42 additions & 38 deletions test/image/mocks/axes_custom-ticks_log-date.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,44 +15,48 @@
"layout": {
"width": 500,
"height": 300,
"title": {
"text": "custom ticks on date & log axes"
},
"paper_bgcolor": "lightblue",
"plot_bgcolor": "#ddd",
"yaxis": {
"type": "log",
"tickmode": "array",
"tickvals": [
1,
10,
100
],
"ticktext": [
"one",
"ten",
"one<br>hundred"
],
"gridwidth": 2,
"tickwidth": 15,
"tickcolor": "green",
"gridcolor": "green"
},
"xaxis": {
"type": "date",
"tickmode": "array",
"tickvals": [
"2010-01-16",
"2010-02-14"
],
"ticktext": [
"Jan 16",
"Feb 14"
],
"gridwidth": 10,
"tickwidth": 50,
"tickcolor": "rgba(255,0,0,0.75)",
"gridcolor": "rgba(255,0,0,0.25)"
"template": {
"layout": {
"title": {
"text": "custom ticks on date & log axes"
},
"paper_bgcolor": "lightblue",
"plot_bgcolor": "#ddd",
"yaxis": {
"type": "log",
"tickmode": "array",
"tickvals": [
1,
10,
100
],
"ticktext": [
"one",
"ten",
"one<br>hundred"
],
"gridwidth": 2,
"tickwidth": 15,
"tickcolor": "green",
"gridcolor": "green"
},
"xaxis": {
"type": "date",
"tickmode": "array",
"tickvals": [
"2010-01-16",
"2010-02-14"
],
"ticktext": [
"Jan 16",
"Feb 14"
],
"gridwidth": 10,
"tickwidth": 50,
"tickcolor": "rgba(255,0,0,0.75)",
"gridcolor": "rgba(255,0,0,0.25)"
}
}
}
}
}
70 changes: 70 additions & 0 deletions test/image/mocks/hide_gridline-template_color.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{
"data": [
{
"type": "scatter",
"marker": { "color": "blue" },
"x": [-1, 1],
"y": [-1, 1]
},
{
"type": "bar",
"marker": { "color": "rgba(127,127,127,0.5)" },
"y": [-1, 1],
"xaxis": "x2",
"yaxis": "y2"
},
{
"type": "bar",
"marker": { "color": "rgba(127,127,127,0.5)" },
"x": [-1, 1],
"xaxis": "x3",
"yaxis": "y3"
},
{
"type": "bar",
"marker": { "color": "rgba(127,127,127,0.5)" },
"y": [-1, 1],
"xaxis": "x4",
"yaxis": "y4"
},
{
"type": "scatter",
"marker": { "color": "blue" },
"x": [-1, 1],
"y": [-1, 1],
"xaxis": "x4",
"yaxis": "y4"
}
],
"layout": {
"title": {
"text": "hide grid lines for oriented traces"
},
"showlegend": false,
"width": 600,
"height": 600,
"grid": {
"rows": 2,
"columns": 2,
"xgap": 0.2,
"ygap": 0.2,
"pattern": "independent"
},
"template": {
"layout": {
"xaxis": {
"gridcolor": "red",
"gridwidth": 2,
"zerolinecolor": "orange",
"zerolinewidth": 5
},
"yaxis": {
"gridcolor": "red",
"gridwidth": 2,
"zerolinecolor": "orange",
"zerolinewidth": 5
}
}
}
}
}
8 changes: 4 additions & 4 deletions test/jasmine/tests/axes_test.js
Original file line number Diff line number Diff line change
Expand Up @@ -1803,10 +1803,10 @@ describe('Test axes', function() {
Plotly.plot(gd, data, layout);

var yaxis = gd._fullLayout.yaxis;
expect(yaxis.ticklen).toBe(5);
expect(yaxis.tickwidth).toBe(1);
expect(yaxis.tickcolor).toBe('#444');
expect(yaxis.ticks).toBe('outside');
expect(yaxis.ticklen).toBe(undefined);
expect(yaxis.tickwidth).toBe(undefined);
expect(yaxis.tickcolor).toBe(undefined);
expect(yaxis.ticks).toBe('');
expect(yaxis.showticklabels).toBe(true);
expect(yaxis.tickfont).toEqual({ family: '"Open Sans", verdana, arial, sans-serif', size: 12, color: '#444' });
expect(yaxis.tickangle).toBe('auto');
Expand Down
Loading