Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

add 'tickformatstops' #1965

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Oct 16, 2017
Merged

add 'tickformatstops' #1965

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
1baa14a
add 'tickformatstops'
yauhen-kavaliou Aug 17, 2017
f958c3b
change tickformatstops definition and code review fixes
yauhen-kavaliou Aug 23, 2017
a155bd9
change valType
yauhen-kavaliou Aug 24, 2017
be11c03
remove axis attribute duplication
apalchys Aug 24, 2017
a13c29e
fix: add missed semicolon
apalchys Aug 25, 2017
304d96b
add tests for tickformatstops
apalchys Aug 28, 2017
0c9fb2b
add tickformatstop image for test
apalchys Aug 28, 2017
db526d9
Merge branch 'master' into tickformatstops
alexcjohnson Oct 9, 2017
7f1fd41
editTypes for tickformatstops
alexcjohnson Oct 9, 2017
86777f7
make sure the tickformatstops tests actually run as expected
alexcjohnson Oct 9, 2017
531aea8
flatten tickformatstops tests
alexcjohnson Oct 9, 2017
0b48a33
robustify tickformatstops supplydefaults
alexcjohnson Oct 9, 2017
6420044
take the first matching tickformatstop
apalchys Oct 10, 2017
92f7c13
replace Array.prototype.find with for loop and update tests
apalchys Oct 10, 2017
df72531
lint
alexcjohnson Oct 10, 2017
7665b4c
updated tickformatstops baseline
alexcjohnson Oct 10, 2017
0e6747f
merge tickformatstops_test into axes_test
alexcjohnson Oct 12, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
change tickformatstops definition and code review fixes
  • Loading branch information
@yauhen-kavaliou @apalchys
yauhen-kavaliou authored and apalchys committed Aug 23, 2017
commit f958c3b0463f37db80411fe674e7fb7e9a3b79d0
38 changes: 34 additions & 4 deletions 38 src/plots/cartesian/axes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1297,7 +1297,8 @@ function formatDate(ax, out, hover, extraPrecision) {

function formatLog(ax, out, hover, extraPrecision, hideexp) {
var dtick = ax.dtick,
x = out.x;
x = out.x,
tickformat = ax.tickformat;

if(hideexp === 'never') {
// If this is a hover label, then we must *never* hide the exponent
Expand All @@ -1311,7 +1312,7 @@ function formatLog(ax, out, hover, extraPrecision, hideexp) {

if(extraPrecision && ((typeof dtick !== 'string') || dtick.charAt(0) !== 'L')) dtick = 'L3';

if(ax.tickformat || (typeof dtick === 'string' && dtick.charAt(0) === 'L')) {
if(tickformat || (typeof dtick === 'string' && dtick.charAt(0) === 'L')) {
out.text = numFormat(Math.pow(10, x), ax, hideexp, extraPrecision);
}
else if(isNumeric(dtick) || ((dtick.charAt(0) === 'D') && (Lib.mod(x + 0.01, 1) < 0.1))) {
Expand Down Expand Up @@ -1515,15 +1516,33 @@ axes.getTickFormat = function(ax) {
var convertFn = convert || function(x) { return x;};
var leftDtick = range[0];
var rightDtick = range[1];
return (!leftDtick || convertFn(leftDtick) <= convertFn(dtick)) &&
(!rightDtick || convertFn(rightDtick) >= convertFn(dtick));
return (leftDtick === null || convertFn(leftDtick) <= convertFn(dtick)) &&
(rightDtick === null || convertFn(rightDtick) >= convertFn(dtick));
}
function getRangeWidth(range, convert) {
var convertFn = convert || function(x) { return x;};
var left = range[0] || 0;
var right = range[1] || 0;
return Math.abs(convertFn(right) - convertFn(left));
}
function compareLogTicks(left, right) {
var priority = ['L', 'D'];
if(typeof left === typeof right) {
if(typeof left === 'number') {
return left - right;
} else {
var leftPriority = priority.indexOf(left.charAt(0));
var rightPriority = priority.indexOf(right.charAt(0));
if(leftPriority === rightPriority) {
return Number(left.replace(/(L|D)/g, '')) - Number(right.replace(/(L|D)/g, ''));
} else {
return leftPriority - rightPriority;
}
}
} else {
return typeof left === 'number' ? 1 : -1;
}
}

var tickstop;
if(ax.tickformatstops && ax.tickformatstops.length > 0) {
Expand Down Expand Up @@ -1554,6 +1573,17 @@ axes.getTickFormat = function(ax) {
}, null);
break;
}
case 'log': {
tickstop = ax.tickformatstops.filter(function(stop) {
var left = stop.dtickrange[0], right = stop.dtickrange[1];
var isLeftDtickNull = left === null;
var isRightDtickNull = right === null;
var isDtickInRangeLeft = compareLogTicks(ax.dtick, left) >= 0;
var isDtickInRangeRight = compareLogTicks(ax.dtick, right) <= 0;
return (isLeftDtickNull || isDtickInRangeLeft) && (isRightDtickNull || isDtickInRangeRight);
})[0];
break;
}
default:
}
}
Expand Down
28 changes: 18 additions & 10 deletions 28 src/plots/cartesian/layout_attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -449,16 +449,24 @@ module.exports = {
].join(' ')
},
tickformatstops: {
valType: 'any',
arrayOk: true,
role: 'style',
description: [
'Set rules for customizing tickformat on different zoom levels for *date* and',
'*linear axis types. You can specify these rules in following way',
'[{dtickrange: [*min*, *max*], value: *format*}]. Where *min*, *max* - dtick values',
'which describe some zoom level, it is possible to omit *min* or *max* value by passing',
'*null*. *format* - string, exactly as *tickformat*'
].join(' ')
_isLinkedToArray: 'tickformatstop',

dtickrange: {
valType: 'data_array',
Copy link
Contributor

Choose a reason for hiding this comment

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

info_array please.

Copy link
Contributor

Choose a reason for hiding this comment

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

... just like range

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed, thanks.

description: [
'range [*min*, *max*], where *min*, *max* - dtick values',
'which describe some zoom level, it is possible to omit *min*',
'or *max* value by passing *null*'
].join(' ')
},
value: {
valType: 'string',
dflt: '',
Copy link
Contributor

Choose a reason for hiding this comment

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

Is axis.tickformat: '' a valid format? More precisely, could

tickformatstop: [{
  dtickrange: [/* */],
  value: ''
}]

be used to hide tick labels for some dtick range?

Copy link
Collaborator

Choose a reason for hiding this comment

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

no, tickformat: '' gives our default formatting. I suppose we could imagine making our own "hide" tickformat (for date axes you can already hack this with tickformat: ' ' but that doesn't work for numbers) but it seems a bit of a kludgy way to handle a very esoteric edge case.

role: 'style',
description: [
'string - dtickformat for described zoom level, the same as *tickformat*'
].join(' ')
}
},
hoverformat: {
valType: 'string',
Expand Down
27 changes: 25 additions & 2 deletions 27 src/plots/cartesian/tick_label_defaults.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
'use strict';

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

var layoutAttributes = require('./layout_attributes');

/**
* options: inherits font, outerTicks, noHover from axes.handleAxisDefaults
Expand Down Expand Up @@ -40,7 +40,7 @@ module.exports = function handleTickLabelDefaults(containerIn, containerOut, coe

if(axType !== 'category') {
var tickFormat = coerce('tickformat');
coerce('tickformatstops');
tickformatstopsDefaults(containerIn, containerOut);
if(!tickFormat && axType !== 'date') {
coerce('showexponent', showAttrDflt);
coerce('exponentformat');
Expand Down Expand Up @@ -81,3 +81,26 @@ function getShowAttrDflt(containerIn) {
return containerIn[showAttrs[0]];
}
}

function tickformatstopsDefaults(tickformatIn, tickformatOut) {
var valuesIn = tickformatIn.tickformatstops || [],
valuesOut = tickformatOut.tickformatstops = [];

var valueIn, valueOut;

function coerce(attr, dflt) {
return Lib.coerce(valueIn, valueOut, layoutAttributes.tickformatstops, attr, dflt);
}

for(var i = 0; i < valuesIn.length; i++) {
valueIn = valuesIn[i];
valueOut = {};

coerce('dtickrange');
coerce('value');

valuesOut.push(valueOut);
Copy link
Contributor

Choose a reason for hiding this comment

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

Nicely done. Thanks!

🎉

}

return valuesOut;
}
28 changes: 18 additions & 10 deletions 28 src/traces/carpet/axis_attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,16 +266,24 @@ module.exports = {
].join(' ')
},
tickformatstops: {
Copy link
Contributor

Choose a reason for hiding this comment

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

Would you mind DRYing this up by adding

var axesAttrs = require('../../plots/cartesian/layout_attributes')

// ....

     tickformatstops: axesAtttrs.tickformatstops, 

// ...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed, thanks.

valType: 'any',
arrayOk: true,
role: 'style',
description: [
'Set rules for customizing tickformat on different zoom levels for *date* and',
'*linear axis types. You can specify these rules in following way',
'[{dtickrange: [*min*, *max*], value: *format*}]. Where *min*, *max* - dtick values',
'which describe some zoom level, it is possible to omit *min* or *max* value by passing',
'*null*. *format* - string, exactly as *tickformat*'
].join(' ')
_isLinkedToArray: 'tickformatstop',

dtickrange: {
valType: 'data_array',
description: [
'range [*min*, *max*], where *min*, *max* - dtick values',
'which describe some zoom level, it is possible to omit *min*',
'or *max* value by passing *null*'
].join(' ')
},
value: {
valType: 'string',
dflt: '',
role: 'style',
description: [
'string - dtickformat for described zoom level, the same as *tickformat*'
].join(' ')
}
},
categoryorder: {
valType: 'enumerated',
Expand Down
4 changes: 2 additions & 2 deletions 4 tasks/util/strict_d3.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ var pathToStrictD3Module = path.join(
constants.pathToImageTest,
'strict-d3.js'
);

var normalizedpathToStrictD3Module = pathToStrictD3Module.replace(/\\/g, '/'); // fix npm-sripts for windows users
/**
* Transform `require('d3')` expressions to `require(/path/to/strict-d3.js)`
*/
Expand All @@ -18,7 +18,7 @@ module.exports = transformTools.makeRequireTransform('requireTransform',
var pathOut;

if(pathIn === 'd3' && opts.file !== pathToStrictD3Module) {
pathOut = 'require(\'' + pathToStrictD3Module.replace(/\\/g, '/') + '\')';
pathOut = 'require(\'' + normalizedpathToStrictD3Module + '\')';
}

if(pathOut) return cb(null, pathOut);
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.