plotly / plotly/plotly.py

Document all graph properties that can be edited when `editable` is set to `True` in the graph config

Offen
#4,635 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

documentation feature P2
Vorherrschende Sprache
Python
Sterne
18.8k
Forks
2.8k
Ø Merge
16 Std. 26 Min.
Gemergte PRs (30 T.)
21

Beschreibung

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: true is set for the individual shape and editable: false for the chart as a whole)
  • 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)

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit der Dokumentation zum bearbeitbaren Modus von Plotly.js, der Dokumentation von Plotly.py und dem verlinkten Community-Beitrag; vergleichen Sie diese mit der Eigenschaftsliste in diesem Issue. Aktualisieren Sie beide Dokumentationssätze mit der vollständigen Liste der bearbeitbaren Eigenschaften, einschließlich der angegebenen Ausnahme bei der shape-Konfiguration, und stellen Sie sicher, dass beide Seiten die unterstützten Interaktionen klar beschreiben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.