Add Layer

Add a new layer to the map.

This function requires the user to supply at least one valid layer configuration object.

Note:

For Typescript, we recommend using addLayerFromConfig().

For Python users, we recommend using add_layer_from_config() and specialized layer classes. See Python layer guide.

JavaScript

map.addLayer({
  id: "test-layer-01",
  type: "point",
  dataId: "test-dataset-01",
  label: "New Layer",
  isVisible: true,
  fields: {
    lat: "latitude",
    lng: "longitude",
  },
  config: {
    visualChannels: {
      colorField: {
        name: "cityName",
        type: "string",
      },
      colorScale: "ordinal",
    },
  },
});

Python

map.add_layer(
    LayerCreationProps(
        id="test-layer-01",
        type=LayerType.POINT,
        data_id="test-dataset-01",
        label="New Layer",
        is_visible=True,
        fields={"lat": "latitude", "lng": "longitude"},
        config={
            "visual_channels": {
                "color_field": {"name": "city_name", "type": "string"},
                "color_scale":"ordinal",
            }
        },
    )
)

Arguments

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

Add Layer From Config

Adds a layer using the specified config. Provides improved typing over addLayer(), and can work with JSON objects from the JSON editor for layers directly.

Note:

Use addLayerFromConfig() over addLayer() when working with large, non-trivial layer configurations. For more information, see the full Python layer guide.

JavaScript

map.addLayerFromConfig({
  type: 'point',
  config: {
    dataId: myDataset.id,
    columnMode: 'points',
    columns: {
      lat: 'lat',
      lng: 'lon'
    },
    visConfig: {},
    color: [0, 255, 0],
    textLabel: []
  }
});

Python

map.add_layer_from_config(
  {
    "id": "sample-layer",
    "type": "point",
    "config": {
      "dataId": "sample-data",
      "label": "Sample layer",
      "columnMode": "points",
      "columns": {"lat": "Latitude", "lng": "Longitude"},
      "visConfig": {},
      "color": [0, 255, 0],
      "textLabel": [],
    },
  }
)

Arguments

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

Add Layer Group

Add a new layer group to the map.

Layer groups do not impact the visualization itself, and instead serve as folders that organize layers within the sidebar. Assign layerIds to be a member of the layer group.

JavaScript

map.addLayerGroup({
  id: "layer-group-1",
  label: "Layer Group 1",
  isVisible: true,
  layerIds: ["layer1", "layer2", "layer3"],
});

Python

map.add_layer_group(LayerGroupCreationProps(
    id="layer-group-1",
    label="Layer Group 1",
    is_visible=True,
    layer_ids=["layer1", "layer2", "layer3"]
))

Arguments

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

Get Layer by ID

Retrieve a Layer object by passing a valid layer layerId.

JavaScript

layer = map.getLayerById("test-layer-01");

Python

layer = map.get_layer_by_id('test-layer-01')

Arguments

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

Get Layer Group by ID

Retrieve a LayerGroup object by passing a valid layer group LayerGroupId.

JavaScript

layerGroup = map.getLayerGroupById("layer-group-1");

Python

layer_group = map.get_layer_group_by_id("layer-group-1")

Arguments

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

Get Layer Groups

Retrieve all LayerGroups present on the map.

JavaScript

layerGroups = map.getLayerGroups();

Python

layer_groups = map.get_layer_groups()

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

Get Layers

Gets all the Layers currently available on the map.

JavaScript

layers = map.getLayers();

Python

layers = map.get_layers()

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

Get Layer Timeline

Retrieve the LayerTimeline object associated with the map.

JavaScript

layerTimeline = map.getLayerTimeline();

Python

layer_timeline = map.get_layer_timeline()

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

Remove Layer

Remove a layer from the map by passing a valid layerId.

JavaScript

map.removeLayer("test-layer-01");

Python

map.remove_layer('test-layer-01')

Arguments

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

Remove Layer Group

Remove a layer group by passing a valid layerGroupId.

JavaScript

map.removeLayerGroup("layer-group-1");

Python

map.remove_layer_group("layer-group-1")

Arguments

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

Update Layer

Update an existing layer with the given values. Pass the layerId to target the layer you wish to update, then provide new Layer parameters in a values object.

JavaScript

map.updateLayer("test-layer-01", {
  type: "point",
  dataId: "test-dataset-01",
  label: "Updated Layer",
  isVisible: true,
  fields: {
    lat: "latitude",
    lng: "longitude",
    alt: "altitude",
  },
  config: {
    visualChannels: {
      colorField: {
        name: "cityName",
        type: "string",
      },
    },
    visConfig: {
      radius: 10,
      fixedRadius: false,
      opacity: 0.8,
      outline: false,
      thickness: 2,
    },
  },
});

Python

map.update_layer('layer-id', LayerUpdateProps(
    label="My new label"
))

Arguments

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

Update Layer Group

Update an existing layer group with the given values. Pass the layerGroupId to target the layer you wish to update, then provide new LayerGroup parameters in a values object.

JavaScript

map.updateLayerGroup(
    "layer-group-1",
    {
      id: "layer-group-1",
      label: "Layer Group 1",
      isVisible: false,
      layerIds: ["layer1", "layer2", "layer3"]
    }
);

Python

map.update_layer_group(LayerGroupUpdateProps(
    "layer-group-1",
    label = "New Layer Group 1",
    layers = ["layer1", "layer2"]
))

Arguments

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

Update Layer Timeline

Updates the current layer timeline configuration. Pass LayerTimeline parameters in a values object.

JavaScript

map.updateLayerTimeline({
  currentTime: 1660637600498,
  isAnimating: true,
  isVisible: true,
  animationSpeed: 1,
  timeFormat: "YYYY-MM-DDTHH:mm:ss",
  timezone: "America/Los_Angeles",
});

Python

map.update_layer_timeline(LayerTimelineUpdateProps(
    current_time=1660637600498,
    is_animating=True,
    is_visible=True,
    animation_speed=1,
    time_format="YYYY-MM-DDTHH:mm:ss",
    timezone="America/Los_Angeles"
))

Arguments

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