Using the Map SDK, you can configure the visualization configuration of maps, then embed them into a webpage or notebook.

For a full description of a function and its parameters, please follow the link to the full Map SDK reference.

Create Map

Creates a new map. If creating a map from scratch, you likely do not need to pass any parameters.

However, you can pass a MapCreationProps object (or keyword arguments in Python), allowing you to customize the style, event handlers, basemaps, raster support, and various UI configuration settings. Many of these advanced options are only available for on-prem versions of the Map SDK.

const map = createMap();

map = create_map()

Arguments

Note: Python Arguments require Python syntax and camel_case parameter names.

Argument	Type	Description
map	MapCreationProps	An object containing map creation parameters.
map.container	HTMLElement	DOM element to embed map into.
map.style	CSSProperties	Map container CSS style customization.
map.eventHandlers	MapEventHandlers	Event handlers to attach to the map.
map.showPlaceholder	bool	Visibility of loading screen placeholder. Default: true
map.basemaps	object	Basemap customization settings.
map.basemaps.customMapStyles	MapStyleCreationProps[]	Custom map styles to make available for usage.
map.basemaps.mapboxAccessToken	string	Mapbox token to be used when loading the provided custom map styles.
map.basemaps.initialMapStyleId	string	Identifier for the map style to be used initially.
map.transformRequest	function	Function to transform basemap resource requests.
map.raster	object	Customization related to raster datasets and tiles.
map.raster.serverUrls	string[]	URLs to custom servers to target when serving raster tiles.
map.raster.stacSearchUrls	string	URL to pass to the backend for searching a STAC Collection.
map.raster.onTileLoadUpdate	RasterTileLoadEvent	Called whenever a raster layer tile loading status updates.
map.uiConfig	object	UI configuration object.
map.uiConfig.mapName	string	Name of the map to show in the title. Default = Studio
map.uiConfig.sidePanel	object	A UI component displaying options for data, layer, and map manipulation.
map.uiConfig.sidePanel.view	string	View state of the side panel. Options include 'hidden','collapsed', or 'visible'.
map.uiConfig.sidePanel.isAddLayerVisible	bool	When enabled, display the "Add Layer" button.
map.uiConfig.sidePanel.addDataButton	object	Custom settings for the Add Data button.
map.uiConfig.sidePanel.addDatabutton.onClick		Custom event handler for the Add Data button.
map.uiConfig.sideNav	object	A UI element containing company logo and relevant links.
map.uiConfig.sideNav.isVisible	bool	When enabled, display the sidenav sidePanel.
map.urls.staticAssetUrlBase	string	Custom URL base for static assets.
map.urls.applicationUrlBase	string	Custom URL base for workers and other script resources loaded by the SDK.

For more information, including full Python documentation, see createMap() in the full API reference.

Get Map Configuration

Gets the configuration representing the current map state.

For more information, see the JSON reference for the map configuration file.

mapConfig = map.getMapConfig();

map_config = map.get_map_config()

For more information, including full Python documentation, see getMapConfig() in the full API reference.

Get Map Control Visibility

Gets the current map control visibility settings. This object contains flags that control the visibility of the legend, toggle_3d, split_map, and map_draw buttons.

mapVisibilitySettings = map.getMapControlVisibility();

map_visibility_settings = map.get_map_control_visibility()

For more information, including full Python documentation, see getMapControlVisibility() in the full API reference.

Get Split Mode

Gets the current split mode of the map along with its associated layers.

splitMode = map.getSplitMode();

split_mode = map.get_split_mode();

For more information, including full Python documentation, see getSplitMode() in the full API reference.

Get View

Gets the current view state of the map. The view state object contains the viewport's latitude, longitude, zoom, pitch, and bearing.

view = map.getView();

view = map.get_view()

For more information, including full Python documentation, see getView() in the full API reference.

Get View Limits

Gets the current view limits of the map. This includes the minZoom, maxZoom, and maxBounds, all of which limit the user's viewport.

viewLimits = map.getViewLimits();

view_limits = map.get_view_limits()

For more information, including full Python documentation, see getViewLimits() in the full API reference.

Remove Event Handlers

Removes event handlers from the map, layers, or filters.

Note: This function only exists for Python. While using Javascript, event handlers can be accessed, added, and modified through the map object.

map.remove_event_handlers(["on_view_update"])

Arguments

For more information, see remove_event_handlers() in the full API reference.

Set Event Handlers

Applies the specified event handlers to the map, layers, or filters.

Note: This function only exists for Python. While using Javascript, event handlers can be accessed, added, and modified through the map object.

map.set_event_handlers(on_view_update = do_something)

Arguments

For more information, see set_event_handlers() in the full API reference.

Set Map Control Visibility

Sets the visibility of map controls, including the legend, toggle-3d, split-map, and map-draw buttons.

map.setMapControlVisibility({
  legend: false,
  map-draw: false,
  split-map: true,
  toggle-3d: false,
  chart: false
});

map.set_map_control_visibility(
  legend = False,
  toggle_3d = True
)

Arguments

Note: Python Arguments require Python syntax and camel_case parameter names.

For more information, including full Python documentation, see setMapControlVisibility() in the full API reference.

Set Split Mode

Set the split mode of the map. Takes SplitMode and an options object.

map.setSplitMode('swipe', {
  layers: [['left_layer'], ['right_layer']],
  isViewSynced: true,
  isZoomSynced: true
});

map.set_split_mode("swipe",     
  layers = [['left_layer'], ['right_layer']],
  is_view_synced = True,
  is_zoom_synced = True,
)

Arguments

Note: Python Arguments require Python syntax and camel_case parameter names.

For more information, including full Python documentation, see setSplitMode() in the full API reference.

Set Theme

Sets the UI theme of the map. A theme contains a preset (either light or dark), as well as an optional background_color.

map.setTheme({
  preset: 'light',
  options: {
    backgroundColor: 'lightseagreen'
  }
});

map.set_theme(
    preset = 'light',
    background_color = 'lightseagreen'
)

Arguments

Note: Python Arguments require Python syntax and camel_case parameter names.

For more information, including full Python documentation, see setTheme() in the full API reference.

Set View

Sets the view state of the map. The view state object should contain the viewport's latitude, longitude, zoom, pitch, and bearing.

map.setView({
  longitude: -118.8189,
  latitude: 34.01207,
  zoom: 10,
  pitch: 0,
  bearing: 0
});

map.set_view(
  longitude = -118.8189,
  latitude = 34.01207,
  zoom = 10,
  pitch = 0,
  bearing = 0
)

Arguments

Note: Python Arguments require Python syntax and camel_case parameter names.

For more information, including full Python documentation, see setView() in the full API reference.

Set View Limits

Set the view limits of the map. This includes the minZoom, maxZoom, and maxBounds, all of which limit the user's viewport.

map.setViewLimits({
  minZoom: 0,
  maxZoom: 22,
  maxBounds: {
    minLongitude: -122.4845632122524,
    maxLongitude: -121.7461580455235,
    minLatitude: 37.49028773126059,
    maxLatitude: 37.94131376494916
  }
});

map.set_view_limits({
  "min_zoom": 0,
  "max_zoom": 22,
  "max_bounds": {
    "min_longitude": -122.4845632122524,
    "max_longitude": -121.7461580455235,
    "min_latitude": 37.49028773126059,
    "max_latitude": 37.94131376494916
  }
})

Arguments

Note: Python Arguments require Python syntax and camel_case parameter names.

For more information, including full Python documentation, see setVZiewLimits() in the full API reference.