Document all graph properties that can be edited when `editable` is set to `True` in the graph config
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 18.8k
- Forks
- 2.8k
- Avg merge
- 16h 26m
- Merged PRs (30d)
- 21
Description
It would be great if the docs (both Plotly.js and Plotly.py) contained a list of all the graph properties which can be edited when editable is set to True in the graph config.
The JS docs mention editable mode but don't contain a list of properties.
I can't find a mention of editable mode at all in the Plotly.py docs.
This community post provides a partial list
Here is the list I've compiled, based on the above linked commuminty post and with help from @archmoj :
- Chart title (click to edit)
- Axis titles (click to edit)
- Axis ranges (min and max) (click endpoints to edit)
- Shape position (drag edges to resize, drag center to move)
- Shape polygon vertices (drag to move)
- (note: only editable when
editable: trueis set for the individual shape andeditable: falsefor the chart as a whole)
- (note: only editable when
- Shape addition and removal (use modebar buttons)
- Annotation text (click to edit)
- Annotation position (drag text or arrowhead to move)
- Legend trace names (click to edit)
- Legend position (drag to move)
- Colorbar title (click to edit)
- Colorbar position (drag to move)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Plotly.js editable mode documentation, the Plotly.py documentation, and the linked community post; compare them with the property list in this issue. Update both documentation sets with the complete editable-property list, including the noted shape configuration exception, and verify that both pages clearly describe the supported interactions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100