Skip to content

Make it more obvious how to add text #2092

Open
@elliot-100

Description

@elliot-100

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationDocumentation about a certain topic should be added

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions