Skip to content

Commit 98a90ce

Browse files
committed
mention extra date formatting options in (x|y)hoverformat too
1 parent defaf8e commit 98a90ce

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

src/plots/cartesian/axis_format.js

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,9 @@ function axisHoverFormat(x, noDates) {
99
valType: 'string',
1010
dflt: '',
1111
editType: 'none',
12-
description: [
13-
'Sets the hover text formatting rule for `' + x + '`',
14-
' using d3 formatting mini-languages which are very similar to those in Python.',
15-
'See: ' + FORMAT_LINK + (
16-
noDates ?
17-
'' :
18-
' And for dates see: ' + DATE_FORMAT_LINK
19-
),
12+
description: (
13+
noDates ? descriptionOnlyNumbers : descriptionWithDates
14+
)('hover text', x) + [
2015
'By default the values are formatted using ' + (
2116
noDates ?
2217
'generic number format' :
@@ -26,15 +21,16 @@ function axisHoverFormat(x, noDates) {
2621
};
2722
}
2823

29-
function descriptionOnlyNumbers(label) {
24+
function descriptionOnlyNumbers(label, x) {
3025
return [
31-
'Sets the ' + label + ' formatting rule using d3 formatting mini-languages',
26+
'Sets the ' + label + ' formatting rule' + (x ? 'for `' + x + '` ' : ''),
27+
'using d3 formatting mini-languages',
3228
'which are very similar to those in Python. For numbers, see: ' + FORMAT_LINK
3329
].join(' ');
3430
}
3531

36-
function descriptionWithDates(label) {
37-
return descriptionOnlyNumbers(label) + [
32+
function descriptionWithDates(label, x) {
33+
return descriptionOnlyNumbers(label, x) + [
3834
' And for dates see: ' + DATE_FORMAT_LINK,
3935
'We add two items to d3\'s date formatter:',
4036
'*%h* for half of the year as a decimal number as well as',

0 commit comments

Comments
 (0)