python-visualization / python-visualization/folium

Make it more obvious how to add text

Aperta Adatta ai principianti
#2,092 5 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

documentation
Lingua principale
Python
Stelle
7.4k
Fork
2.3k
Merge medio
17h 22m
PR unite (30g)
11

Descrizione

Is your feature request related to a problem? Please describe.

I've just started using Folium, and while it is very useful, I have been frustrated by the lack of documentation on how to add text elements - other than marker tooltips and popups, neither of which are initially visible to the user. As far as I can see there is nothing at all in the user guide or advanced guide.

A search for 'text' doesn't seem to point to anything relevant either, except PolyLineTextPath which is for a relatively specialist text case.

From StackOverflow etc. searches, the simplest solution for most cases seems to be to use a DivIcon for most cases. But that is very hidden in the documentation. I can see there are other methods via Leaflet or branca APIs.

Describe the solution you'd like

  • Add a Text section to the user guide with recommended ways to add text elements.
  • Add a bit of detail including the word 'text' to relevant API sections so they can be found more easily.

Describe alternatives you've considered
n/a

Additional context
n/a

Implementation
folium is maintained by volunteers. Can you help make a PR if we want to implement this feature?
Probably, depending on how complex it is to make docs changes.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo la guida utente, la guida avanzata e il riferimento API di DivIcon collegati nell’issue per trovare le sezioni pertinenti della documentazione. Il lavoro è completato quando la guida utente contiene una sezione «Text» che descrive i modi consigliati per aggiungere testo visibile e le sezioni API pertinenti includono una formulazione che renda ricercabili gli esempi relativi al testo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
68/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.