odc.geo.geobox.GeoBox.explore

GeoBox.explore(map=None, grid_lines=True, tiles='OpenStreetMap', attr=None, map_kwds=None, **kwargs)

Plot a visual representation of the GeoBox’s extent on an interactive folium leaflet map.

Parameters:
  • map (Optional[Any]) – An optional existing folium map object to plot into. By default, a new map object will be created.

  • tiles (Any) – Map tileset to use for the map basemap. Supports any option supported by folium, including “OpenStreetMap”, “CartoDB positron”, “CartoDB dark_matter” or a custom XYZ URL.

  • attr (Optional[str]) – Map tile attribution; only required if passing custom tile URL.

  • map_kwds (Optional[Dict[str, Any]]) – Additional keyword arguments to pass to folium.Map.

  • kwargs (Any) – Additional keyword arguments to pass to folium.GeoJson.

Param:

grid_lines: Whether to plot pixel edge aligned grid lines over the GeoBox extent.

Return type:

Any

Returns:

A folium map containing the plotted GeoBox.