Property ticklabelindex for custom tick label display
#7036
Conversation
…ck n positions away from a major tick - has no effect for category/multicategory/log axes - has no effect if tickformat frequency incompatible with minor tick frequency
archmoj
added
feature
|
I thought based on the attribute name that this would be about labeling ALL the minor ticks, but it’s just about shifting the label away from the major tick. Is there a use case other than period ticks, where the label is already shifted but now you want to shift it the other way? If that’s the only purpose I’d suggest making this specific to period ticks, something like |
|
@alexcjohnson: One use case for more options than
In this example it would be desirable to display the "Q2 24" label, but to have the major ticks follow the Gregorian calendar (ticks on 1st of January).
|
|
I see, that’s reasonable. And in this case moving all the tick labels to Q2 is the desired behavior, not just a side effect? Ie would you ideally prefer Q1 to be labeled on all the earlier years (and possibly also 2024) and just label Q2 on 2024, or is what you’ve drawn with every Q2 labeled in fact the goal? |
|
For us this would be the desired behaviour. The rationale is, that you typically want to compare the Q2 value of this year with the Q2 values of previous years. I don't see a use case for drawing different minor tick labels for different years. I also think something like this would make the interface relatively complex. Therefore I would propose to stay with the level of control My-Tien proposed. What do you think? |
|
Ok great, just wanted to confirm that this is truly the intent. So yes, let’s keep the behavior as implemented. I’d still like to discuss the name, as to me What about |
|
Great! I don't have a strong opinion on the name, but How about |
|
Thanks for the feedback! Yes, finding a name is one of the more difficult problems of this PR and any help is welcome! If we stick to period axes only, how about The only reason why I came up with the original rather generic name is that the feature worked out of the box for linear axes as well and in case someone has a use case for that in the future, the name would still be fitting (But I currently can't think of any use case). |
…g drawminorticklabel" This reverts commit 11fd3f1. I thought label overlap with minor ticks was something I introduced with drawminorticklabel, but this was also possible before and is sometimes desired (check e.g. baseline image 24.png)
|
What would be an example of this incompatibility? "has no effect if tickformat frequency incompatible with minor tick frequency"? |
for enhanced clarity of function `periodCompatibleWithTickformat`
Check for period compatibility did not take reversed axis into account. Also added reversed axis to mock.
src/plots/cartesian/axes.js
Outdated
| @@ -1166,38 +1223,44 @@ axes.calcTicks = function calcTicks(ax, opts) { | |||
|
|
|||
| tickVals = tickVals.concat(minorTickVals); | |||
|
|
|||
| var t, p; | |||
| function setTickLabel(ax, tickVal) { | |||
| var t = axes.tickText( | |||
There was a problem hiding this comment.
Please rename t variable inside this function as there is another t declared in the upper scope.
|
@my-tien Just a few comments to address and we should be good to merge this PR. 🌟 |
- improve performance of ticklabelindex initialization - rename labelTickVals → allTicklabelVals
- use pushUnique - don't shadow variable name from outer scope
This PR introduces the property
drawminorticklabelticklabelindexfor drawing the label for each minor tick n positions away from a major tickOne use case for this feature are period axes where we want to configure which period is labeled.
Current behavior
With
"ticklabelindex": -1Disclaimer
I am required to add that…the software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. in no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.