Skip to content

Commit a00c3c3

Browse files
achieveordieachieveordie
authored
docs: rework Plugins page into a tabular format (#1889)
* separate markdown usages of textpath and antpath plugins * remodel plugins page into a table
1 parent 0950a52 commit a00c3c3

3 files changed

Lines changed: 113 additions & 19 deletions

File tree

‎docs/user_guide/plugins.rst‎

Lines changed: 72 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@ Plugins
22
-------
33

44
.. toctree::
5-
:maxdepth: 1
5+
:hidden:
66

7+
plugins/antpath
78
plugins/boat_marker
89
plugins/beautify_icon
910
plugins/draw
@@ -22,7 +23,7 @@ Plugins
2223
plugins/mouse_position
2324
plugins/pattern
2425
plugins/polyline_offset
25-
plugins/polyline_textpath_and_antpath
26+
plugins/polyline_textpath
2627
plugins/realtime
2728
plugins/scroll_zoom_toggler
2829
plugins/search
@@ -34,3 +35,72 @@ Plugins
3435
plugins/timestamped_geojson
3536
plugins/vector_tiles
3637
plugins/WmsTimeDimension
38+
39+
.. list-table::
40+
:widths: 25 75
41+
:header-rows: 1
42+
43+
* - Plugin
44+
- Description
45+
* - :doc:`Ant Path <plugins/antpath>`
46+
- A flux animation (like walking of ants) along a polyline.
47+
* - :doc:`Boat Marker <plugins/boat_marker>`
48+
- A boat marker using HTML canvas for displaying yachts and sailboats with heading and optional wind information.
49+
* - :doc:`Beautify Icon <plugins/beautify_icon>`
50+
- Lightweight plugin that adds colorful iconic markers without image and gives full control of style to end user (i.e. Unlimited colors and CSS styling).
51+
* - :doc:`Draw <plugins/draw>`
52+
- Enables drawing features like polylines, polygons, rectangles, circles and markers through a very nice user-friendly interface with icons and hints.
53+
* - :doc:`Dual Map <plugins/dual_map>`
54+
- Synchronized view of two maps in the same window.
55+
* - :doc:`FeatureGroup Subgroup <plugins/featuregroup_subgroup>`
56+
- Create Feature Groups that add their child layers into a parent group.
57+
* - :doc:`Float Image <plugins/float_image>`
58+
- Add a floating image in the HTML canvas on top of the map.
59+
* - :doc:`Fullscreen <plugins/fullscreen>`
60+
- A fullscreen button control for modern browsers, using HTML Fullscreen API.
61+
* - :doc:`Geocoder <plugins/geocoder>`
62+
- A clean and extensible control for both geocoding and reverse geocoding using different geocoding providers.
63+
* - :doc:`Grouped Layer Control <plugins/grouped_layer_control>`
64+
- Create layer control with support for grouping overlays together.
65+
* - :doc:`Heatmap <plugins/heatmap>`
66+
- A tiny, simple and fast heatmap plugin.
67+
* - :doc:`Heatmap with Time <plugins/heatmap_with_time>`
68+
- Create a time-aware heatmap.
69+
* - :doc:`Locate Control <plugins/locate_control>`
70+
- Geolocate a user over an encrypted connection.
71+
* - :doc:`Marker Cluster <plugins/marker_cluster>`
72+
- Beautiful, sophisticated, high performance marker clustering solution with smooth animations.
73+
* - :doc:`Measure Control <plugins/measure_control>`
74+
- Coordinate, linear, and area measure control.
75+
* - :doc:`Mini Map <plugins/mini_map>`
76+
- A small minimap showing the map at a different scale to aid navigation.
77+
* - :doc:`Mouse Position <plugins/mouse_position>`
78+
- A control that displays geographic coordinates of the mouse pointer, as it is moved over the map.
79+
* - :doc:`Pattern <plugins/pattern>`
80+
- Add support for pattern fills on Paths.
81+
* - :doc:`Polyline Offset <plugins/polyline_offset>`
82+
- Shift relative pixel offset, without actually changing the actual latitude longitude values.
83+
* - :doc:`Polyline Textpath <plugins/polyline_textpath>`
84+
- Write text along polylines.
85+
* - :doc:`Realtime <plugins/realtime>`
86+
- Put realtime data (like live tracking, GPS information) on a map.
87+
* - :doc:`Scroll Zoom Toggler <plugins/scroll_zoom_toggler>`
88+
- Enable/Disable zooming via a button.
89+
* - :doc:`Search <plugins/search>`
90+
- A control for search Markers/Features location by custom property in LayerGroup/GeoJSON.
91+
* - :doc:`Semi Circle <plugins/semi_circle>`
92+
- Add a marker in the shape of a semicircle, similar to the Circle class.
93+
* - :doc:`Side by Side Layers <plugins/side_by_side_layers>`
94+
- A control to add a split screen to compare two map overlays.
95+
* - :doc:`Tag Filter Button <plugins/tag_filter_button>`
96+
- Creates a Tag Filter Button to filter elements based on different criteria.
97+
* - :doc:`Terminator <plugins/terminator>`
98+
- Overlay day and night regions on a map.
99+
* - :doc:`Timeslider Choropleth <plugins/timeslider_choropleth>`
100+
- Create a choropleth with a timeslider for timestamped data.
101+
* - :doc:`Timestamped GeoJSON <plugins/timestamped_geojson>`
102+
- Add time-aware GeoJSON into the map.
103+
* - :doc:`Vector Tiles using VectorGridProtobuf <plugins/vector_tiles>`
104+
- Display gridded vector data (GeoJSON or TopoJSON sliced with geojson-vt, or protobuf vector tiles).
105+
* - :doc:`WMS Time Dimension <plugins/WmsTimeDimension>`
106+
- Create a time-aware WmsTileLayer.

‎docs/user_guide/plugins/antpath.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
```{code-cell} ipython3
2+
---
3+
nbsphinx: hidden
4+
---
5+
import folium
6+
import folium.plugins
7+
```
8+
9+
10+
## Antpath
11+
12+
```{code-cell} ipython3
13+
m = folium.Map()
14+
15+
wind_locations = [
16+
[59.35560, -31.992190],
17+
[55.178870, -42.89062],
18+
[47.754100, -43.94531],
19+
[38.272690, -37.96875],
20+
[27.059130, -41.13281],
21+
[16.299050, -36.56250],
22+
[8.4071700, -30.23437],
23+
[1.0546300, -22.50000],
24+
[-8.754790, -18.28125],
25+
[-21.61658, -20.03906],
26+
[-31.35364, -24.25781],
27+
[-39.90974, -30.93750],
28+
[-43.83453, -41.13281],
29+
[-47.75410, -49.92187],
30+
[-50.95843, -54.14062],
31+
[-55.97380, -56.60156],
32+
]
33+
34+
folium.plugins.AntPath(
35+
locations=wind_locations, reverse="True", dash_array=[20, 30]
36+
).add_to(m)
37+
38+
m.fit_bounds(m.get_bounds())
39+
40+
m
41+
```

docs/user_guide/plugins/polyline_textpath_and_antpath.md renamed to docs/user_guide/plugins/polyline_textpath.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ import folium
66
import folium.plugins
77
```
88

9-
# PolylineTextPath and AntPath
10-
11-
129
## PolyLineTextPath
1310

1411
```{code-cell} ipython3
@@ -92,17 +89,3 @@ folium.plugins.PolyLineTextPath(line_to_hanoi, "To Hanoi", offset=-5).add_to(m)
9289
9390
m
9491
```
95-
96-
## Antpath
97-
98-
```{code-cell} ipython3
99-
m = folium.Map()
100-
101-
folium.plugins.AntPath(
102-
locations=wind_locations, reverse="True", dash_array=[20, 30]
103-
).add_to(m)
104-
105-
m.fit_bounds(m.get_bounds())
106-
107-
m
108-
```

0 commit comments

Comments
 (0)