produce_map_set#
- caf.viz.web.mapping.produce_map_set(output_path, datasets, split, split_name_column, filter_zone_gpd=None)[source]#
Produce HTML maps for datasets, split into regions.
- A set of maps will be produced, one for each geometry in the split GeoDataFrame, filtered
to the filter_zone_gpd if provided.
- The initial overview map will include links to the split maps, which will be stored in a
separate folder.
A textbox is included with instructions on how to use the map.
- Parameters:
output_path (pathlib.Path) –
Output path to write the HTML map. If a directory is provided, the overview map will be written to a file called
”Overview Map.html” in that directory.
datasets (dict[str, MapData]) –
Datasets must be provided as a dictionary of name to MapData. MapData includes the GeoDataFrame, an optional color column to plot, and extra options
for plotting (ExploreOptions).
split (gpd.GeoDataFrame) – GeoDataFrame containing the geometries to split the map into.
split_name_column (str) – Name of the column containing the names of the split geometries.
filter_zone_gpd (gpd.GeoDataFrame | None, optional) – GeoDataFrame or GeoSeries containing the geometry to filter the split geometries.
- Return type:
None
