Skip to content

Commit 64e14d6

Browse files
committed
Add to ticklabelindex description how it can be useful for period axes
1 parent 96a26da commit 64e14d6

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

src/plots/cartesian/layout_attributes.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -729,7 +729,9 @@ module.exports = {
729729
'Only for axes with `type` *date* or *linear*.',
730730
'Instead of drawing the major tick label, draw the label for the minor tick',
731731
'that is n positions away from the major tick. E.g. to always draw the label for the',
732-
'minor tick before each major tick, choose `ticklabelindex` -1'
732+
'minor tick before each major tick, choose `ticklabelindex` -1. This is useful for date',
733+
'axes with `ticklabelmode` *period* if you want to label the period that ends with each',
734+
'major tick instead of the period that begins there.'
733735
].join(' ')
734736
},
735737
mirror: {

test/plot-schema.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15118,7 +15118,7 @@
1511815118
},
1511915119
"ticklabelindex": {
1512015120
"arrayOk": true,
15121-
"description": "Only for axes with `type` *date* or *linear*. Instead of drawing the major tick label, draw the label for the minor tick that is n positions away from the major tick. E.g. to always draw the label for the minor tick before each major tick, choose `ticklabelindex` -1",
15121+
"description": "Only for axes with `type` *date* or *linear*. Instead of drawing the major tick label, draw the label for the minor tick that is n positions away from the major tick. E.g. to always draw the label for the minor tick before each major tick, choose `ticklabelindex` -1. This is useful for date axes with `ticklabelmode` *period* if you want to label the period that ends with each major tick instead of the period that begins there.",
1512215122
"editType": "calc",
1512315123
"valType": "integer"
1512415124
},
@@ -16450,7 +16450,7 @@
1645016450
},
1645116451
"ticklabelindex": {
1645216452
"arrayOk": true,
16453-
"description": "Only for axes with `type` *date* or *linear*. Instead of drawing the major tick label, draw the label for the minor tick that is n positions away from the major tick. E.g. to always draw the label for the minor tick before each major tick, choose `ticklabelindex` -1",
16453+
"description": "Only for axes with `type` *date* or *linear*. Instead of drawing the major tick label, draw the label for the minor tick that is n positions away from the major tick. E.g. to always draw the label for the minor tick before each major tick, choose `ticklabelindex` -1. This is useful for date axes with `ticklabelmode` *period* if you want to label the period that ends with each major tick instead of the period that begins there.",
1645416454
"editType": "calc",
1645516455
"valType": "integer"
1645616456
},

0 commit comments

Comments
 (0)