xyzspaces.iml package¶
This module defines IML
class to interact with Interactive Map Layer.
- class xyzspaces.iml.IML[source]¶
Bases:
object
A single interface to interact with Interactive Map Layer.
- classmethod from_catalog_hrn_and_layer_id(catalog_hrn, layer_id, credentials=None)[source]¶
Instantiate a IML object for an existing catalog and interactive map layer.
- Parameters
catalog_hrn (str) – HRN of the catalog.
layer_id (str) – a string with the layer ID of this layer.
credentials (Optional[xyzspaces.iml.credentials.Credentials]) – object of
Credentials
.
- Returns
Object of IML
- Return type
- classmethod new(catalog_id, catalog_name, catalog_summary, catalog_description, layer_details, credentials=None, billing_tag=None, proxies=None)[source]¶
Create a new catalog and interactive map layer.
- Parameters
catalog_id (str) – ID of the catalog.
catalog_name (str) – name of the catalog.
catalog_summary (str) – catalog summary.
catalog_description (str) – catalog description.
layer_details (Dict) – A dict to represent interactive map layer details.
credentials (Optional[xyzspaces.iml.credentials.Credentials]) – A Credentials instance.
billing_tag (Optional[str]) – A string to represent billing tag.
proxies (Optional[Dict]) – A dict to represnt proxies.
- Returns
Object of IML.
- Return type
- add_interactive_map_layer(catalog_hrn, layer_details, credentials=None, billing_tag=None, proxies=None)[source]¶
Add a new interactive map layer to existing catalog.
- Parameters
catalog_hrn (str) – HRN of the catalog.
layer_details (Dict) – A dict to represent interactive map layer details.
credentials (Optional[xyzspaces.iml.credentials.Credentials]) – A Credentials instance.
billing_tag (Optional[str]) – A string to represent billing tag.
proxies (Optional[Dict]) – A dict to represnt proxies.
- Return type
None
- delete_catalog(catalog_hrn, credentials=None, billing_tag=None, proxies=None)[source]¶
Delete a catalog along with the layers it contains.
- Parameters
catalog_hrn (str) – The HERE Resource Name of the catalog
credentials (Optional[xyzspaces.iml.credentials.Credentials]) – The credentials object.
billing_tag (Optional[str]) – A string to represent billing tag.
proxies (Optional[Dict]) – A dict to represnt proxies.
- Return type
None