Skip to content

Commit d9210da

Browse files
committed
Clarify the direction of movement for ticklabelstandoff and ticklabelrunoff
1 parent e8f88ba commit d9210da

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/plots/cartesian/layout_attributes.js

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -703,15 +703,19 @@ module.exports = {
703703
dflt: 0,
704704
editType: 'ticks',
705705
description: [
706-
'Shifts the tick labels by the specified number of pixels in parallel to the axis.'
706+
'Shifts the tick labels by the specified number of pixels in parallel to the axis.',
707+
'Positive values move the labels in the positive direction of the axis.'
707708
].join(' ')
708709
},
709710
ticklabelstandoff: {
710711
valType: 'integer',
711712
dflt: 0,
712713
editType: 'ticks',
713714
description: [
714-
'Shifts the tick labels by the specified number of pixels orthogonally to the axis.'
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".'
715719
].join(' ')
716720
},
717721
mirror: {

0 commit comments

Comments
 (0)