polartoolkit.interactive_map

Contents

polartoolkit.interactive_map#

interactive_map(hemisphere=None, epsg=None, center_yx=None, zoom=None, display_xy=True, points=None, basemap_type=None, **kwargs)[source]#

Plot an interactive map with various basemaps. Clicking gives the cursor location in a the supplied projection [x,y]. Requires ipyleaflet

Parameters:

  • hemisphere (str | None) – set whether to plot in “north” hemisphere (EPSG:3413) or “south” hemisphere (EPSG:3031), can be set manually, or will read from the environment variable: “POLARTOOLKIT_HEMISPHERE”

  • epsg (str | None) – set which EPSG projection to use for plotting, can be set manually, or will read from the environment variable: “POLARTOOLKIT_EPSG”, by default None

  • center_yx (tuple[float] | None) – choose center coordinates in projected units [y,x], by default None

  • zoom (float | None) – choose zoom level, by default None

  • display_xy (bool) – choose if you want clicks to show the xy location, by default True

  • show (bool, optional) – choose whether to display the map, by default True

  • points (DataFrame | None) – choose to plot points supplied as columns ‘x’, ‘y’, or ‘easting’, ‘northing’, in the supplied projection in a dataframe

  • basemap_type (str | None) – choose what basemap to plot, options are ‘BlueMarble’, ‘Imagery’, ‘Basemap’, and “IceVelocity”, by default ‘BlueMarble’ for northern hemisphere and ‘Imagery’ for southern hemisphere.

  • kwargs (Any)

Returns:

interactive map

Return type:

Any

Contents