python-visualization / python-visualization/folium

Make it more obvious how to add text

Đang mở Phù hợp với người mới
#2,092 5 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

documentation
Ngôn ngữ chính
Python
Star
7.4k
Fork
2.3k
Merge trung bình
17 giờ 22 phút
Pull request đã merge (30 ngày)
11

Mô tả

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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách đọc hướng dẫn người dùng, hướng dẫn nâng cao và tài liệu tham chiếu API DivIcon được liên kết trong issue để tìm các phần tài liệu liên quan. Được xem là hoàn tất khi hướng dẫn người dùng có một phần «Text» mô tả các cách được khuyến nghị để thêm văn bản hiển thị, và các phần API liên quan có cách diễn đạt giúp có thể tìm kiếm các ví dụ liên quan đến văn bản.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
68/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.