Skip to content

Conversation

@rzats
Copy link

@rzats rzats commented Oct 22, 2025

What type of PR is this? (Check all that apply)

  • 🛠 Refactor
  • ✨ Feature
  • 🐛 Bug Fix
  • ⚡ Optimization
  • 📝 Documentation Update

Description

In issue #2372, a user was confused about yaxis property usage in Taipy charts, confusing it for something like Matplotlib's plt.ylabel. In fact, their suggested "workaround" of using the layout property seems like the intended way to go about things :) This PR clarifies the documentation for xaxis and yaxis properties accordingly.

Related Tickets & Documents

How to reproduce the issue

N/A - just a documentation update.

Backporting

This change should be backported to:

  • 3.0
  • 3.1
  • 4.0
  • develop

Checklist

We encourage keeping the code coverage percentage at 80% or above.

  • ✅ This solution meets the acceptance criteria of the related issue.
  • 📝 The related issue checklist is completed.
  • 🧪 This PR includes unit tests for the developed code.
    If not, explain why: documentation only
  • 🔄 End-to-End tests have been added or updated.
    If not, explain why: documentation only
  • 📚 The documentation has been updated, or a dedicated issue has been created.
    If not, explain why:
  • 📌 The release notes have been updated.
    If not, explain why: handled by maintainers?

@arcanaxion
Copy link
Contributor

Thanks for this PR. The descriptions for xaxis/yaxis is definitely ambiguous especially to someone not familiar with plotly internal workings (like myself), so I appreciate your added clarification.

The docs for Taipy chart already make many references to the Plotly JS docs, so I wonder if adding a reference to this https://plotly.com/javascript/reference/scatter/#scatter-xaxis (as opposed to this) would be helpful or clutter.

@rzats
Copy link
Author

rzats commented Oct 23, 2025

I've added this link to the docs - it should render roughly like this:

Screenshot 2025-10-23 at 14 29 52

Copy link
Member

@FabienLelaquais FabienLelaquais left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that change is fair, and neat.
Now @rzats, @arcanaxion don't you think that we should add a little example of using this in the chart doc as well (viselements/charts/advanced)?
And if yes, can you think of a usecase that would demonstrate that? I suspect that you do have that example in your hands right now...

@arcanaxion
Copy link
Contributor

don't you think that we should add a little example of using this in the chart doc as well (viselements/charts/advanced)?

This appears to address that: https://docs.taipy.io/en/develop/refmans/gui/viselements/generic/charts/basics/#adding-a-y-axis

I think we're good to merge this

@github-actions
Copy link
Contributor

github-actions bot commented Nov 7, 2025

This PR has been labelled as "🥶Waiting for contributor" because it has been inactive for more than 14 days. If you would like to continue working on this PR, then please add new commit or another comment, otherwise this PR will be closed in 14 days. For more information please refer to the contributing guidelines.

@github-actions github-actions bot added the 🥶Waiting for contributor Issues or PRs waiting for a long time label Nov 7, 2025
@arcanaxion arcanaxion removed the 🥶Waiting for contributor Issues or PRs waiting for a long time label Nov 7, 2025
@github-actions
Copy link
Contributor

This PR has been labelled as "🥶Waiting for contributor" because it has been inactive for more than 14 days. If you would like to continue working on this PR, then please add new commit or another comment, otherwise this PR will be closed in 14 days. For more information please refer to the contributing guidelines.

@github-actions github-actions bot added the 🥶Waiting for contributor Issues or PRs waiting for a long time label Nov 22, 2025
@FredLL-Avaiga
Copy link
Member

@rzats can you update your branch ?

@github-actions github-actions bot removed the 🥶Waiting for contributor Issues or PRs waiting for a long time label Nov 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[🐛 BUG] How to use the yaxis property of chart

4 participants