API Overview

The Map SDK provides a range of functions for embedding, controlling, querying and monitoring Studio maps embedded in web pages or Jupyter Notebooks.

The Studio Map SDK API is summarized here. Note that each function is documented on a dedicated page that provides detailed information, including JavaScript and Python syntax, as well as sample code snippets.


Annotation Functions

Functions related to annotations, which are labeled callouts applied to custom positions on your map, and can optionally feature a pointer/line. For a brief description and easy-to-follow examples, please visit the Annotation Functions page.

API FunctionDescription
addAnnotationAdds a new annotation to the map.
getAnnotationsGets all the annotations currently available in the map.
getAnnotationByIdRetrieves an annotation by its identifier.
removeAnnotationRemoves an annotation from the map.
updateAnnotationUpdates an existing annotation with given values.

Dataset Functions

Functions related to managing datasets associated with your maps. For a brief description and easy-to-follow examples, please visit the Data Functions page.

API FunctionDescription
addDatasetAdds a new dataset to the map.
addTileDatasetAdds a new tiled dataset to the map.
getDatasetByIdRetrieves a dataset by its identifier.
getDatasetWithDataRetrieves a dataset record with its data for a given dataset.
getDatasetsGets all datasets available on the map.
removeDatasetRemoves a dataset from the map.
replaceDatasetReplaces a given dataset with a new one.
updateDatasetUpdates an existing dataset with given values.

Filter Functions

Functions for data filters applied to your map, including timeline filters for temporal, animated maps. For a brief description and easy-to-follow examples, please visit the Filter Functions page.

API FunctionDescription
addFilterAdds a filter to the map.
getFilterByIdRetrieves a filter by its identifier.
getFiltersGets all the filters currently applied to the map.
removeFilterRemoves a filter from the map.
updateFilterUpdates an existing filter with given values.
updateTimelineUpdates a time range filter timeline with given values.

Layer Functions

Functions for managing visual layers and layer groups. For a brief description and easy-to-follow examples, please visit the Layer Functions page.

API FunctionDescription
addLayerAdds a new layer to the map.
addLayerFromConfigCreates a new layer from a layer config.
addLayerGroupAdds a new layer group to the map.
getLayerByIdRetrieves a layer by its identifier.
getLayerGroupByIdRetrieves a layer group by its identifier.
getLayerGroupsGets all the layer groups currently available in the map.
getLayersGets all the layers currently available in the map.
getLayerTimelineGets the current layer timeline configuration.
removeLayerRemoves a layer from the map.
removeLayerGroupRemoves a layer group from the map.
updateLayerUpdates an existing layer with given values.
updateLayerGroupUpdates an existing layer group with given values.
updateLayerTimelineUpdates the current layer timeline configuration.

Map Functions

Functions for managing the map's state, including view modes, limits, themes, as well as visual effects. For a brief description and easy-to-follow examples, please visit the Map Functions page.

API FunctionDescription
addToDOMAdds a map into a container element provided as an argument. (Normally called in constructor.)
addEffectAdds a visual post-processing effect to the map.
createMapCreate a new map instance.
getEffectsGet all visual effects applied to the map.
getEffectByIdGet a visual effect by its ID.
getMapConfigGets the configuration representing the current map state.
getMapControlVisibilityGets the map control visibility settings.
getMapStylesGets the currently available map styles.
getSplitModeGets the split mode of the map.
getViewGets the current view state of the map.
getViewLimitsGets the current view limits of the map.
getViewModeGets the current view mode of the map. View mode can be one of "2d", "3d", or "globe".
remove_event_handlersPython-exclusive. Remove an event handler from the map.
set_event_handlersPython-exclusive. Add an event handler to the map.
setMapConfigLoads the given configuration into the current map.
setMapControlVisibilitySets the map control visibility settings.
setSplitModeSets the split mode of the map.
setThemeSets the theme of the map.
setViewSets the view state of the map.
setViewLimitsSets the view limits of the map.
setViewModeSets the view mode of the map to either "2d", "3d", or "globe".
removeEffectRemove a visual effect from the map.
updateEffectUpdate a visual effect on the map.

Types

Types are supplied as arguments in many SDK functions. These types are documented on a separate page.

Event Handlers

Applications can add interactivity by listening to events from Studio's maps and implementing custom event handling functions.


Sign In