Skip to content

Commit 26315dc

Browse files
committed
improve ticklabelstandoff description and note that inside ticks could move outside and outside ticks could move inside
1 parent 6715564 commit 26315dc

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

src/plots/cartesian/layout_attributes.js

+7-4
Original file line numberDiff line numberDiff line change
@@ -712,10 +712,13 @@ module.exports = {
712712
dflt: 0,
713713
editType: 'ticks',
714714
description: [
715-
'Shifts the tick labels by the specified number of pixels orthogonally to the axis.',
716-
'A positive `ticklabelstandoff` will move the labels farther away from the plot area',
717-
'if `ticklabelposition` is "outside", and deeper into the plotarea if',
718-
'`ticklabelposition` is "inside".'
715+
'Sets the standoff distance (in px) between the axis tick labels and their default position.',
716+
'A positive `ticklabelstandoff` moves the labels farther away from the plot area',
717+
'if `ticklabelposition` is *outside*, and deeper into the plot area if',
718+
'`ticklabelposition` is *inside*. A negative `ticklabelstandoff` works in the opposite',
719+
'direction, moving outside ticks towards the plot area and inside ticks towards',
720+
'the outside. If the negative value is large enough, inside ticks can even end up',
721+
'outside and vice versa.'
719722
].join(' ')
720723
},
721724
mirror: {

test/plot-schema.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -15161,7 +15161,7 @@
1516115161
"valType": "integer"
1516215162
},
1516315163
"ticklabelstandoff": {
15164-
"description": "Shifts the tick labels by the specified number of pixels orthogonally to the axis. A positive `ticklabelstandoff` will move the labels farther away from the plot area if `ticklabelposition` is \"outside\", and deeper into the plotarea if `ticklabelposition` is \"inside\".",
15164+
"description": "Sets the standoff distance (in px) between the axis tick labels and their default position. A positive `ticklabelstandoff` moves the labels farther away from the plot area if `ticklabelposition` is *outside*, and deeper into the plot area if `ticklabelposition` is *inside*. A negative `ticklabelstandoff` works in the opposite direction, moving outside ticks towards the plot area and inside ticks towards the outside. If the negative value is large enough, inside ticks can even end up outside and vice versa.",
1516515165
"dflt": 0,
1516615166
"editType": "ticks",
1516715167
"valType": "integer"
@@ -16482,7 +16482,7 @@
1648216482
"valType": "integer"
1648316483
},
1648416484
"ticklabelstandoff": {
16485-
"description": "Shifts the tick labels by the specified number of pixels orthogonally to the axis. A positive `ticklabelstandoff` will move the labels farther away from the plot area if `ticklabelposition` is \"outside\", and deeper into the plotarea if `ticklabelposition` is \"inside\".",
16485+
"description": "Sets the standoff distance (in px) between the axis tick labels and their default position. A positive `ticklabelstandoff` moves the labels farther away from the plot area if `ticklabelposition` is *outside*, and deeper into the plot area if `ticklabelposition` is *inside*. A negative `ticklabelstandoff` works in the opposite direction, moving outside ticks towards the plot area and inside ticks towards the outside. If the negative value is large enough, inside ticks can even end up outside and vice versa.",
1648616486
"dflt": 0,
1648716487
"editType": "ticks",
1648816488
"valType": "integer"

0 commit comments

Comments
 (0)