Update scatter plot to align with the Plotly API #21
Conversation
…th the Plotly API and the line plot from vuecore
… other scripts, and also addx_title and y_title fields on he Pydantic model
| into the arguments for `plotly.express.scatter`. | ||
| Plotly Express implementation. It translates the validated `ScattereConfig` | ||
| into the arguments for `plotly.express.scatter` and also forwards any | ||
| additional, unvalidated keyword arguments from plotly. The resulting figure |
There was a problem hiding this comment.
So you will add all plotly arguments per default?
There was a problem hiding this comment.
No, I added the most important ones, but also enabled passing extra arguments from plotly express. Do you think that would be better to just add all of them?
src/vuecore/plots/basic/scatter.py
Outdated
| * **Jupyter Notebook:** `docs/api_examples/scatter_plot.ipynb` - | ||
| https://vuecore.readthedocs.io/en/latest/api_examples/scatter_plot.html | ||
| * **Python Script:** `docs/api_examples/scatter_plot.py` |
There was a problem hiding this comment.
Do you want to have the link to GitHub?
There was a problem hiding this comment.
Sure, I will add the link for the Python Script on GitHub.
| a scatter plot, from data mapping to styling and layout. It ensures that | ||
| user-provided configurations are type-safe and adhere to the expected structure. | ||
| This model serves as a curated API for the most relevant parameters | ||
| for scatter plots, closely aligned with the `plotly.express.scatter` API |
There was a problem hiding this comment.
If it is a one-to-one mapping we could check is in a script with the default function parameters of the plotly function. the inspect module can do that, but there are probably other ways as well to list the parameter.
import inspect
import plotly.express as px
signature = inspect.signature(px.scatter)
This returns a signature object which has the name as keys (signature.parameters)
2 participants
No description provided.