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  
This functions creates a new map. It accepts a single `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.

JavaScript

```javascript
const map = createMap({apiKey: "<api-key>"});
```

Python

```python
map = create_map(api_key="<api-key>")
```

For example, you can also load published maps from the Map SDK by setting `initialState.publishedMapId`:

JavaScript

```javascript
const map = createMap({
  apiKey: "<api-key>",
  initialState: {publishedMapId: '<uuid>'}
})
```

Python

```python
map = create_map(
  api_key="<api-key>",
  initial_state={'published_map_id': '<uuid>'}
)
```

### Arguments  
This is the full list of additional properties within `MapCreationProps` that you can provide when creating a map.

> Note: Python Arguments require Python syntax and snake_case parameter names.

| Argument | Type | Description |
| --- | --- | --- |
| `apiKey` (required) | `string` | Your Map SDK API Key (see [Authentication](https://docs.foursquare.com/developer/docs/studio-map-sdk-authentication)). |
| `container` | `HTMLElement` | DOM element to embed map into. |
| `style` | `CSSProperties` | Map container CSS style customization. |
| `eventHandlers` | [`MapEventHandlers`](https://docs.foursquare.com/developer/docs/studio-map-sdk-types#mapeventhandlers) | Event handlers to attach to the map. |
| `showPlaceholder` | `bool` | Visibility of loading screen placeholder. Default: `true` |
| `initialState` | `object` | Information about the state to load upon creation. |
| `initialState.publishedMapId` | `string` | Identifier of the map to load. Note: the map must be [published](https://docs.foursquare.com/studio/docs/publish) (currently an action available in the Studio UI). _Not_ supported in the [on-prem SDK](https://docs.foursquare.com/developer/docs/studio-map-sdk-introduction#on-prem-features). |
| `basemaps` | `object` | Basemap customization settings. |
| `basemaps.customMapStyles` | [`MapStyleCreationProps[]`](https://docs.foursquare.com/developer/docs/studio-map-sdk-types#mapstylecreationprops) | Custom map styles to make available for usage. |
| `basemaps.mapboxAccessToken` | `string` | Mapbox token to be used when loading the provided custom map styles. |
| `basemaps.initialMapStyleId` | `string` | Identifier for the map style to be used initially. |
| `transformRequest` | `function` | Function to transform basemap resource requests. |
| `raster` | `object` | Customization related to raster datasets and tiles. |
| `raster.serverUrls` | `string[]` | URLs to custom servers to target when serving raster tiles. |
| `raster.stacSearchUrls` | `string` | URL to pass to the backend for searching a STAC Collection. |
| `raster.onTileLoadUpdate` | [`RasterTileLoadEvent`](https://docs.foursquare.com/developer/docs/studio-map-sdk-map-functions#doc:studio-map-sdk-types#rastertileloadevent) | Called whenever a raster layer tile loading status updates. |
| `uiConfig` | `object` | UI configuration object. |
| `uiConfig.mapName` | `string` | Name of the map to show in the title. Default = `Studio` |
| `uiConfig.sidePanel` | `object` | A UI component displaying options for data, layer, and map manipulation. |
| `uiConfig.sidePanel.view` | `string` | View state of the side panel. Options include `'hidden'`,`'collapsed'`, or `'visible'`. |
| `uiConfig.sidePanel.isAddLayerVisible` | `bool` | When enabled, display the "Add Layer" button. |
| `uiConfig.sidePanel.addDataButton` | `object` | Custom settings for the Add Data button. |
| `uiConfig.sidePanel.addDatabutton.onClick` |  | Custom event handler for the Add Data button. |
| `uiConfig.sideNav` | `object` | A UI element containing company logo and relevant links. |
| `uiConfig.sideNav.isVisible` | `bool` | When enabled, display the sidenav sidePanel. |
| `urls.staticAssetUrlBase` | `string` | Custom URL base for static assets. |
| `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.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#createmap)

* * *

# Get Map Configuration  
Gets the configuration representing the current map state.

For more information, see the [JSON reference for the map configuration file](https://docs.foursquare.com/developer/docs/studio-map-configuration).

JavaScript

```javascript
mapConfig = map.getMapConfig();
```

Python

```python
map_config = map.get_map_config()
```

For more information, including full Python documentation, [see `getMapConfig()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#getmapconfig)

* * *

# 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.

JavaScript

```javascript
mapVisibilitySettings = map.getMapControlVisibility();
```

Python

```python
map_visibility_settings = map.get_map_control_visibility()
```

For more information, including full Python documentation, [see `getMapControlVisibility()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#getmapcontrolvisibility)

* * *

# Get Split Mode  
Gets the current split mode of the map along with its associated layers.

JavaScript

```javascript
splitMode = map.getSplitMode();
```

Python

```python
split_mode = map.get_split_mode();
```

For more information, including full Python documentation, [see `getSplitMode()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#getsplitmode)

* * *

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

JavaScript

```javascript
view = map.getView();
```

Python

```python
view = map.get_view()
```

For more information, including full Python documentation, [see `getView()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#getview)

* * *

# 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.

JavaScript

```javascript
viewLimits = map.getViewLimits();
```

Python

```python
view_limits = map.get_view_limits()
```

For more information, including full Python documentation, [see `getViewLimits()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#getviewlimits)

* * *

# Get View Mode  
Gets the current view mode of the map. View mode can be one of `"2D"`, `"3D"`, or `"globe"`.

JavaScript

```javascript
viewMode = map.getViewMode();
```

Python

```python
view_mode = map.get_view_mode()
```

* * *

# 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.

Python

```python
map.remove_event_handlers(["on_view_update"])
```

### Arguments  
| Argument | Type | Description |
| --- | --- | --- |
| `event_handlers` | `Sequence[string]` | A list of event handlers to remove. Passed in as a list of strings. |

For more information, [see `remove_event_handlers()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#remove_event_handlers)

* * *

# 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.

Python

```python
map.set_event_handlers(EventHandlers(on_view_update=my_handler_func))
```

### Arguments  
| Argument | Type | Description |
| --- | --- | --- |
| `event_handlers` | [`MapEventHandlers`](https://docs.foursquare.com/developer/docs/studio-map-sdk-types#mapeventhandlers), [`LayerEventHandlers`](https://docs.foursquare.com/developer/docs/studio-map-sdk-types#layereventhandlers), [`FilterEventHandlers`](https://docs.foursquare.com/developer/docs/studio-map-sdk-types#filtereventhandlers), `dict` | Event handlers to set. Can be passed as in through the aforementioned objects, as a dict, or through keyword arguments. |

For more information, [see `set_event_handlers()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#set_event_handlers)

* * *

# Set Map Config  
Loads the provided configuration into the map. See the [the map format reference](https://docs.foursquare.com/developer/docs/studio-map-configuration) to learn about Studio's map configuration JSON schema.

JavaScript

```javascript
map.setMapConfig({
  version: "v1",
  config: {
    visState: {
      filters: [],
      layers: [],
      interactionConfig: {
        tooltip: {
          fieldsToShow: {},
          compareMode: false,
          compareType: "absolute",
          enabled: true
        },
        brush: {
          size: 0.5,
          enabled: false
        },
        geocoder: {
          enabled: false
        },
        coordinate: {
          enabled: false
        }
      },
      layerBlending: "normal",
      overlayBlending: "normal",
      splitMaps: [],
      animationConfig: {
        currentTime: null,
        speed: 1
      },
      editor: {
        features: [],
        visible: true
      },
      metrics: [],
      geoKeys: [],
      groupBys: [],
      datasets: {
        fieldDisplayNames: {},
        fieldDisplayFormats: {},
        datasetColors: {}
      },
      joins: [],
      analyses: [],
      charts: []
    },
    mapState: {
      bearing: 0,
      dragRotate: false,
      latitude: 37.75043,
      longitude: -122.34679,
      pitch: 0,
      zoom: 9,
      isSplit: false,
      isViewportSynced: true,
      isZoomLocked: false,
      splitMapViewports: [],
      mapViewMode: "MODE_2D",
      mapSplitMode: "SINGLE_MAP",
      globe: {
        enabled: false,
        config: {
          atmosphere: true,
          azimuth: false,
          azimuthAngle: 45,
          terminator: true,
          terminatorOpacity: 0.35,
          basemap: true,
          labels: false,
          labelsColor: [
            114.75,
            114.75,
            114.75
          ],
          adminLines: true,
          adminLinesColor: [
            40,
            63,
            93
          ],
          water: true,
          waterColor: [
            17,
            35,
            48
          ],
          surface: true,
          surfaceColor: [
            9,
            16,
            29
          ]
        }
      }
    },
    mapStyle: {
      styleType: "dark",
      topLayerGroups: {},
      visibleLayerGroups: {
        label: true,
        road: true,
        border: false,
        building: true,
        water: true,
        land: true,
        3d building: false
      },
      threeDBuildingColor: [
        9.665468314072013,
        17.18305478057247,
        31.1442867897876
      ],
      backgroundColor: [
        255,
        255,
        255
      ],
      mapStyles: {}
    }
  }
)
```

Python

```python
map.set_map_config({
  "version": "v1",
  "config": {
    "visState": {
      "filters": [],
      "layers": [],
      "interactionConfig": {
        "tooltip": {
          "fieldsToShow": {},
          "compareMode": False,
          "compareType": "absolute",
          "enabled": True
        },
        "brush": {
          "size": 0.5,
          "enabled": False
        },
        "geocoder": {
          "enabled": False
        },
        "coordinate": {
          "enabled": False
        }
      },
      "layerBlending": "normal",
      "overlayBlending": "normal",
      "splitMaps": [],
      "animationConfig": {
        "currentTime": null,
        "speed": 1
      },
      "editor": {
        "features": [],
        "visible": True
      },
      "metrics": [],
      "geoKeys": [],
      "groupBys": [],
      "datasets": {
        "fieldDisplayNames": {},
        "fieldDisplayFormats": {},
        "datasetColors": {}
      },
      "joins": [],
      "analyses": [],
      "charts": []
    },
    "mapState": {
      "bearing": 0,
      "dragRotate": False,
      "latitude": 37.75043,
      "longitude": -122.34679,
      "pitch": 0,
      "zoom": 9,
      "isSplit": False,
      "isViewportSynced": True,
      "isZoomLocked": False,
      "splitMapViewports": [],
      "mapViewMode": "MODE_2D",
      "mapSplitMode": "SINGLE_MAP",
      "globe": {
        "enabled": False,
        "config": {
          "atmosphere": True,
          "azimuth": False,
          "azimuthAngle": 45,
          "terminator": True,
          "terminatorOpacity": 0.35,
          "basemap": True,
          "labels": False,
          "labelsColor": [
            114.75,
            114.75,
            114.75
          ],
          "adminLines": True,
          "adminLinesColor": [
            40,
            63,
            93
          ],
          "water": True,
          "waterColor": [
            17,
            35,
            48
          ],
          "surface": True,
          "surfaceColor": [
            9,
            16,
            29
          ]
        }
      }
    },
    "mapStyle": {
      "styleType": "dark",
      "topLayerGroups": {},
      "visibleLayerGroups": {
        "label": True,
        "road": True,
        "border": False,
        "building": True,
        "water": True,
        "land": True,
        "3d building": False
      },
      "threeDBuildingColor": [
        9.665468314072013,
        17.18305478057247,
        31.1442867897876
      ],
      "backgroundColor": [
        255,
        255,
        255
      ],
      "mapStyles": {}
    }
  }
})
```

| Argument | Type | Description |
| --- | --- | --- |
| `config` | [`Studio MapConfig`](https://docs.foursquare.com/developer/docs/studio-map-configuration) | Configuration to load into the map. For details around the format see [the map format reference](https://docs.foursquare.com/developer/docs/studio-map-configuration). |
| `options` | [`SetMapConfigOptions`](https://docs.foursquare.com/developer/docs/studio-map-sdk-types#setmapconfigoptions) | A set of options for the map configuration. |

For more information, [see `setMapConfig()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#setmapconfig)

* * *

# Set Map Control Visibility  
Sets the visibility of map controls, including the `legend`, `toggle-3d`, `split-map`, and `map-draw` buttons.

JavaScript

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

Python

```python
map.set_map_control_visibility(
    PartialMapControlVisibility(
      legend=False,
      toggle_3d=True
    )
)
```

### Arguments  
| Argument | Type | Description |
| --- | --- | --- |
| `mapControls` | `object` | Object containing map control visibility settings. |
| `mapControls.legend` | `bool` | Whether the legend is visible. |
| `mapControls.toggle-3d` | `bool` | Whether the 3D toggle is visible. |
| `mapControls.split-map` | `bool` | Whether the split map button is visible. |
| `mapControls.map-draw` | `bool` | Whether the map draw button is visible. |

For more information, including full Python documentation, [see `setMapControlVisibility()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#set_event_handlers)

* * *

# Set Split Mode  
Set the split mode of the map. Takes `SplitMode` and an `options` object.

JavaScript

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

Python

```python
map.set_split_mode(split_mode='dual', options=PartialSplitModeContext(
    is_view_synced=True,
    is_zoom_synced=False,
))
```

### Arguments  
| Argument | Type | Description |
| --- | --- | --- |
| `splitMode` | `string` | Supported split map modes. Either `'single'`, `'dual'`, or `'swipe'`. |
| `splitModeOptions` | `object` | An object containing split mode map options. |
| `splitModeOptions.layers` | `string[][]` | Optional array of `layerIds` to show on either side of the split. Only applicable for dual and swipe split modes. |
| `splitModeOptions.isViewSynced` | `bool` | Boolean indicating whether views are synced. Only applicable to dual split mode. |
| `splitModeOptions.isZoomSynced` | `bool` | Boolean indicating whether zoom is synced between views. Only applicable to dual split mode. |

For more information, including full Python documentation, [see `setSplitMode()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#setsplitmode)

* * *

# 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`.

JavaScript

```javascript
map.setTheme({
  preset: "light",
  options: {
    backgroundColor: "lightseagreen",
  },
});
```

Python

```python
map.set_theme(
  preset="dark",
  background_color="lightseagreen"
)
```

### Arguments  
| Argument | Type | Description |
| --- | --- | --- |
| `theme` | `object` | An object containing UI theme preset options. |
| `theme.preset` | `string` | UI theme preset name. |
| `theme.options` | `object` | Optional UI theme customization options. |
| `theme.options.backgroundColor` | `string` | Background color of UI elements in a CSS color string. |

For more information, including full Python documentation, [see `setTheme()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#settheme)

* * *

# Set Tooltip  
Defines that status of the interactive tooltip on the map.

JavaScript

```javascript
map.setTooltipConfig({
  enabled: true,
  tooltipConfig: {
      fieldsToShow: {
        compareType: "relative",
        compareMode: true,
        "datasetId1": [{
            name: "lat",
            format: null
        }, {
            name: "lon",
            format: null
        }],
        "datasetId2": [{
            name: "datasetColumnName",
            format: null
        }]
      }
  },
})
```

Python

```python
map.set_tooltip_config(map.TooltipInteractionConfig(
    enabled=True,
    tooltip_config=map.TooltipConfig(
        compare_type="relative",
        compare_mode=True
        fields_to_show={
            "datasetId1": [
                map_sdk.TooltipField(name = "lat"),
                map_sdk.TooltipField(name = "lon"),
            ],
            "datasetId2": [
                map_sdk.TooltipField(name = "dataset_column_name")
            ]
        }
    )
))
```

### Arguments  
| Argument | Type | Description |
| --- | --- | --- |
| `fieldsToShow` | `{ [key: string]: [TooltipField] }` | Key value pairs where key is ID of dataset, and value is list of fields to show on Tooltip. |
| `TooltipField.name` | `string` | Field name (name of column in the dataset). |
| `TooltipField.format` | `string` | Format of text. |
| `compareMode` | `Boolean` | Is compare mode enabled. |
| `compareType` | `'absolute' |  'relative'` | Which compare type is active. |

For more information, including full Python documentation, [see `setTooltip()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#settooltip)

* * *

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

JavaScript

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

Python

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

### Arguments  
| Argument | Type | Description |
| --- | --- | --- |
| `view` | `object` | An object containing view options. |
| `view.longitude` | `number` | Longitude of the view center [-180, 180]. |
| `view.latitude` | `number` | Latitude of the view center [-90, 90]. |
| `view.zoom` | `number` | View zoom level [0-22]. |
| `view.pitch` | `number` | View pitch value [0-90]. |
| `view.bearing` | `number` | View bearing. |
| `view.dragRotate` | `boolean` | Whether to allow point drag rotate. |

For more information, including full Python documentation, [see `setView()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#setview)

* * *

# 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.

JavaScript

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

Python

```python
map.set_view_limits(PartialViewLimits(
    min_zoom=0,
    max_zoom=22,
    max_bounds=Bounds(
        min_longitude=-122.4845632122524,
        max_longitude=-121.7461580455235,
        min_latitude=37.49028773126059,
        max_latitude=37.94131376494916
    )
))
```

### Arguments  
| Argument | Type | Description |
| --- | --- | --- |
| `viewLimits` | `object` | An object containing view limit options. |
| `viewLimit.sminZoom` | `number` | Minimum allowed zoom level. |
| `viewLimit.maxZoom` | `number` | Maximum allowed zoom level. |
| `viewLimit.maxBounds` | `object` | Object containing optional maximum allowed bounds. |
| `viewLimit.maxBound.minLongitude` | `number` | Minimum (left) longitude value. |
| `viewLimit.maxBound.maxLongitude` | `number` | Maximum (right) longitude value. |
| `viewLimit.maxBound.minLatitude` | `number` | Minimum (bottom) latitude value. |
| `viewLimit.maxBound.maxLatitude` | `number` | Maximum (top) latitude value. |

For more information, including full Python documentation, [see `setVZiewLimits()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#setviewlimits)

* * *

# Set View Mode  
Sets the view mode of the map to one of `2D`, `3D`, or `globe`.

JavaScript

```javascript
map.setViewMode("3d");
```

Python

```python
map.set_view_mode("3d")
```

### Arguments  
| Argument | Type | Description |
| --- | --- | --- |
| `view_mode` | [`ViewMode`](https://docs.foursquare.com/developer/docs/studio-map-sdk-types#videmode) | An object containing view modes. One of `"2d"`,`"3d"`, or `"globe"` |

For more information, including full Python documentation, [see `setView()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#setviewmode)

# Set Animation From Config  
Sets the animation properties from the animation JSON configuration.

This function can configure animation to either of types of animation (layer and timeline type of animation).

JavaScript

```javascript
map.setAnimationFromConfig({
  currentTime: 123,
  speed: 1.1,
  domain: [100, 200],
  timeFormat: 'L LTS'
});
```

Python

```python
map.set_animation_from_config(
    Animation(
        currentTime=1655250000,
        domain=[1655250000, 1655251000],
        speed=1.1,
        timeFormat="L LTS",
    )
)
```

For more information, including full Python documentation, [see `setAnimationFromConfig()` in the full API reference.](https://docs.foursquare.com/developer/docs/studio-map-sdk-api-reference#setanimationfromconfig)

* * *

# Effect Functions  
The Map SDK allows you to apply post-processing effects to your maps. With a robust set of post-processing effects available, users familiar with Photoshop and other image editing programs should find a similar set of functionality.

## Add Effect  
Add a new effect to the map.

JavaScript

```javascript
map.addEffect({
  type: "light-and-shadow",
  parameters: {
    shadowIntensity: 0.5,
    shadowColor: [0, 0, 0],
    sunLightColor: [255, 255, 255],
    sunLightIntensity: 1,
    ambientLightColor: [255, 255, 255],
    ambientLightIntensity: 1,
    timeMode: "current",
  },
});
```

Python

```python
map.add_effect(
    EffectCreationProps(
        id="effect-id",
        type=EffectType.INK,
        is_enabled=False,
        parameters={"strength": 0.33},
    )
)
```

### Parameters  
| Argument | Type | Description |
| --- | --- | --- |
| id | `string` | Unique identifier of the effect. |
| type | [`EffectType`](https://docs.foursquare.com/developer/docs/studio-map-sdk-map-functions#effecttype) | Required. The type of the effect. [See types and respective parameters here.](https://docs.foursquare.com/developer/docs/studio-effect-configuration) |
| isEnabled | `bool` | Flag indicating whether the effect is enabled or not. |
| parameters | `dict` | Effect-specific settings. [See all available parameters here.](https://docs.foursquare.com/developer/docs/studio-effect-configuration) |

## Update Effect  
Update an effect on the map.

JavaScript

```javascript
map.updateEffect({
  id: "effect-id",
  isEnabled: false,
  parameters: {
    shadowIntensity: 0.75,
    shadowColor: [25, 50, 75]
  },
});
```

Python

```python
map.update_effect(
    "effect-id",
    values=EffectUpdateProps(
        is_enabled=True,
        parameters={"strength": 0.5}
    ),
)
```

### Parameters  
| Argument | Type | Description |
| --- | --- | --- |
| id | `string` | Required. Unique identifier of the effect to update. |
| type | [`EffectType`](https://docs.foursquare.com/developer/docs/studio-map-sdk-map-functions#effecttype) | The type of the effect. [See types and respective parameters here.](https://docs.foursquare.com/developer/docs/studio-effect-configuration) |
| isEnabled | `bool` | Flag indicating whether the effect is enabled or not. |
| parameters | `dict` | Effect-specific settings to update. [See all available parameters here.](https://docs.foursquare.com/developer/docs/studio-effect-configuration) |

## Get Effects  
Get a list of effects added to the map.

JavaScript

```javascript
map.getEffects()
```

Python

```python
map.get_effects()
```

## Get Effect by ID  
Get an effect by specifying its ID.

JavaScript

```javascript
map.getEffectByID("effect-id")
```

Python

```python
map.get_effect_by_id("effect-id")
```

## Remove Effect  
Remove an effect from the map.

JavaScript

```javascript
map.removeEffect("effect-id")
```

Python

```python
map.remove_effect("effect-id")
```