From 761620f1c47382b732787e1d954a3a4400c18b91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Senanur=20=C3=87etin?= Date: Sun, 18 Oct 2026 15:41:38 +0300 Subject: [PATCH] docs: clarify WMS transparency and assert rendered options --- docs/user_guide/raster_layers/wms_tile_layer.md | 5 +++++ tests/test_raster_layers.py | 3 +++ 2 files changed, 8 insertions(+) diff --git a/docs/user_guide/raster_layers/wms_tile_layer.md b/docs/user_guide/raster_layers/wms_tile_layer.md index 25b547eb91..b694ed3977 100644 --- a/docs/user_guide/raster_layers/wms_tile_layer.md +++ b/docs/user_guide/raster_layers/wms_tile_layer.md @@ -7,6 +7,11 @@ import folium # WmsTileLayer +`transparent=True` requests a transparent background from the WMS server. +It does not make black (or other colored) pixels in the returned imagery transparent. +Use an image format that supports transparency, such as `image/png`, and check +that the server supports transparency for the requested layer. + ```{code-cell} ipython3 m = folium.Map(location=[41, -70], zoom_start=5, tiles="cartodb positron") diff --git a/tests/test_raster_layers.py b/tests/test_raster_layers.py index 918568b3cb..e9c0622fb7 100644 --- a/tests/test_raster_layers.py +++ b/tests/test_raster_layers.py @@ -66,6 +66,9 @@ def test_wms(): w.add_to(m) html = m.get_root().render() + assert '"transparent": true' in html + assert '"format": "image/png"' in html + # verify this special case wasn't converted to lowerCamelCase assert '"cql_filter": "something",' in html assert "cqlFilter" not in html