basemaps module

Module for basemaps.

get_basemap_list(free_only=True)

Returns a list of xyz services.

Parameters:

Name	Type	Description	Default
free_only	bool	Whether to return only free xyz tile services that do not require an access token. Defaults to True.	True

Returns:

Name	Type	Description
list		A list of xyz services.

Source code in mapwidget/basemaps.py

def get_basemap_list(free_only=True):
    """Returns a list of xyz services.

    Args:
        free_only (bool, optional): Whether to return only free xyz tile services that do not require an access token. Defaults to True.

    Returns:
        list: A list of xyz services.
    """

    return list(get_xyz_dict(free_only).keys())

get_xyz_dict(free_only=True)

Returns a dictionary of xyz services.

Parameters:

Name	Type	Description	Default
free_only	bool	Whether to return only free xyz tile services that do not require an access token. Defaults to True.	True

Returns:

Name	Type	Description
dict		A dictionary of xyz services.

Source code in mapwidget/basemaps.py

def get_xyz_dict(free_only=True):
    """Returns a dictionary of xyz services.

    Args:
        free_only (bool, optional): Whether to return only free xyz tile services that do not require an access token. Defaults to True.

    Returns:
        dict: A dictionary of xyz services.
    """

    xyz_dict = {}
    for item in xyz.values():
        try:
            name = item["name"]
            tile = _unpack_sub_parameters(xyz, name)
            if _unpack_sub_parameters(xyz, name).requires_token():
                if free_only:
                    pass
                else:
                    xyz_dict[name] = tile
            else:
                xyz_dict[name] = tile

        except Exception:
            for sub_item in item:
                name = item[sub_item]["name"]
                tile = _unpack_sub_parameters(xyz, name)
                if _unpack_sub_parameters(xyz, name).requires_token():
                    if free_only:
                        pass
                    else:
                        xyz_dict[name] = tile
                else:
                    xyz_dict[name] = tile

    xyz_dict = collections.OrderedDict(sorted(xyz_dict.items()))

    tiles = xyz_tiles

    for item in xyz_dict:
        name = xyz_dict[item].name
        url = xyz_dict[item].build_url()
        attribution = xyz_dict[item].attribution
        if "max_zoom" in xyz_dict[item].keys():
            max_zoom = xyz_dict[item]["max_zoom"]
        else:
            max_zoom = 24

        tiles[item] = {
            "name": name,
            "url": url,
            "attribution": attribution,
            "max_zoom": max_zoom,
        }

    return tiles