Map SDK
Under construction
This documentation refers to the Unfolded Map SDK v0.x. The newest version of the Map SDK is a complete reconstruction, and documentation is currently being developed for this domain. Documentation for the Map SDK v1.0 can be found on docs.unfolded.ai.
Installation
To get started with the Map SDK, visit the appropriate setup guide for your environment:
- Install the JavaScript package, allowing you to utilize the Map SDK in standard HTML + JavaScript.
- Install the Python package, allowing you to utilize the Map SDK in notebook environments.
API Overview
The sections below contain an overview of Unfolded Map SDK organized by function.
Map Functions
The Map SDK provides functionality for configuring the visualization of maps, as well as embedding them int your web page.
API Function | Description |
|---|---|
Embeds a map into your web page or Jupyter Notebook. | |
Creates a static version of Unfolded Studio (for use in Databricks notebooks). | |
Builds the full URL string from a Studio map id. | |
Gets map configuration. | |
Sets map configuration. | |
Sets the map view on a certain location. | |
Sets the map Split Mode between dual, swipe, or single mode. | |
Sets the theme of Studio to dark or light. | |
Set the visibility for the specified map controls (legend etc). |
Data Functions
The Map SDK provides a variety of data functions, allowing you to add, remove, and filter data from datasets.
API Function | Description |
|---|---|
Adds a dataset to the map. | |
Removes a dataset from the map. | |
Reloads the data displayed on the map (used with live data). | |
Set a filter value. |
Layer Functions
The Map SDK provides a variety of layer functions, allowing you to add, remove, and configure the visibility of layers on your map.
API Function | Description |
|---|---|
Adds a new layer to the specified map. | |
Returns a list of objects describing each layer in the specified map. | |
Shows or hides a layer for the specified map. | |
Removes a layer from the specified map. |
Timeline Functions
Animation is a core feature of Unfolded maps, and the Map SDK's timeline endpoints provide a full complement of functions to let applications control this feature.
API Function | Description |
|---|---|
Sets time filter timeline configuration. | |
Sets layer timeline configuration. | |
Gets information object for the timeline filter. | |
Gets information object for the layer timeline control. |
Event Operations
Applications can add interactivity by listening to events from Unfolded maps and implementing custom event handling functions.
API Function | Description |
|---|---|
Sets event handlers for a map. |
The following event handlers are provided by the Unfolded Map SDK:
Event | Event Handler | Description |
|---|---|---|
| Fires when the map loads. | |
| Fires when the user clicks on the map. | |
| Fires when the cursor is being hovered over the map. | |
| Fires when the user draws a polygon or rectangle. | |
| Fires when a map filter changes. | |
| Fires when the timeline interval changes. | |
| Fires when the "current" time change events in the layer timeline. |
API Reference
Visit the Map SDK's API Reference to view all functions, methods, and parameter specification
Updated about 1 month ago