2.1.1.2. cpforager.GPS.folium_map

GPS.folium_map(fig_dir, file_id, plot_params)

Produce the html map of the GPS data with the possibility to choose a color gradient.

Parameters:

• self (cpforager.GPS) – a GPS object

• fig_dir (str) – figure saving directory.

• file_id (str) – name of the saved figure.

• plot_params (dict) – plot parameters dictionary.

Returns:

the folium map.

Return type:

folium.Map

The figure is saved at the html format.

Warning

Producing the figure may take some time and the resulting html may be heavy.