WebScene

A flattened collection of all layers in the map. This collection contains basemap layers, operational layers and ground layers. Group Layers and their children layers are also part of this collection. Reference layers in the basemap will always be included at the end of the collection.

Layers should not be added directly to this collection. They must only be added via the layers, basemap or ground properties.

A flattened collection of tables anywhere in the map's hierarchy. This will contain individual tables within the map's tables, in addition to any group layer tables. In order for the table(s) to be recognized as such, the FeatureLayer property must return true.

Specifies a basemap for the map. The basemap is a set of layers that give geographic context to the MapView or SceneView and the other operational layers in the map.

The basemap can be created in a variety of ways:

1. From the basemap styles service (v2)
2. From a basemap id
3. From an instance of the Basemap class

Basemap styles

Since version 4.28

Basemaps can be created from the basemap styles service (v2) from a string representing a valid basemap id or an object representing a BasemapStyle. The basemap styles service is a standard, ready-to-use location service that serves vector and image tiles representing geographic features around the world.

You can use the basemap styles service to display:

• Streets and navigation styles
• Imagery, oceanic, and topographic styles
• OSM standard and streets styles
• Creative styles such as nova and blue print
• Localized place labels
• Places with styles - since 4.29
• Worldview boundaries - since 4.29

The string values are of the form {provider}/{style} where provider is "arcgis" or "osm". See ArcGIS basemap styles and OSM basemap styles for the full list of available styles.

// create the basemap from a string id representing the basemap style
const map = new Map({
  basemap: "osm/blueprint"
});

// create the basemap from a BasemapStyle object
const map = new Map({
  basemap: {
    style: { // autocasts to BasemapStyle
      id: "arcgis/outdoor",
      language: "es" // place labels will be displayed in spanish
    }
  }
});

Basemap Id

2D (legacy)

Since version 4.0

The legacy basemaps can be accessed using the basemap id in the table below. These are references to enhanced basemap endpoints.

3D

Since version 4.28

The 3D Basemaps can be accessed using the basemap id in the table below. They are designed to be used as basemaps in SceneView.

// Set the basemap in the constructor
const map = new Map({
  basemap: "hybrid"
});

// Set the basemap after the map instance is created
map.basemap = "topo-3d";

Basemap class

Since version 4.0

The map's basemap can also be created from an instance of the Basemap class. This allows you to create a basemap from a portal item or collection of layers. Using the basemap class, you can also define a custom thumbnail and title for your basemap.

// Set the basemap from a portal item id
const map = new Map({
  basemap: new Basemap({
    portalItem: {
       id: "084291b0ecad4588b8c8853898d72445" // enhanced contrast basemap
    }
  })
});

// Create a VectorTileLayer from a style URL
const mapBaseLayer = new VectorTileLayer({
  url: "https://arcgis.com/sharing/rest/content/items/b5676525747f499687f12746441101ef/resources/styles/root.json"
});

// Create a Basemap with the VectorTileLayer
const customBasemap = new Basemap({
  baseLayers: [mapBaseLayer],
  title: "Terrain"
});

// Set the basemap to the customBasemap
const map = new Map({
  basemap: customBasemap
});

Deprecated basemap styles

Since version 4.18

The deprecated basemap styles are references to basemaps from the basemap styles service (v1). We recommend using the basemap styles service (v2), which supports more dynamic basemaps and new features such as place label localization.

esriConfig.apiKey = "YOUR_API_KEY";
// Set the basemap in the constructor
const map = new Map({
 basemap: "arcgis-streets"
});

// Set the basemap after the map instance is created
map.basemap = "osm-dark-gray";

The name of the class. The declared class name is formatted as esri.folder.className.

A collection of editable layers. Layers are considered editable if they have editing capabilities, and if the authenticated user has the necessary privileges needed to edit the layers.

Specifies the surface properties for the map. In MapView, this property is used by the ElevationProfile widget when the profile contains an ElevationProfileLineGround. In 3D SceneView, it renders the terrain or topographical variations in the real world on the map's surface with a collection of ElevationLayers.

This value can be an instance of Ground, or one of the following strings:

• world-elevation for a default instance of ground using the Terrain3D Service.
• world-topobathymetry for an instance of ground that combines surface elevation and bathymetry using the TopoBathy3D Service.

The ground may not be set to null or undefined, it is guaranteed to always contain an instance of type Ground. The elevation can be removed from the ground by setting the ground property to a new empty Ground instance or by removing all the ground layers.

A collection of operational layers. This property contains the operational layers, such as FeatureLayers, WebTileLayers and GraphicsLayers that may be queried, assigned different renderers, analyzed, etc. It does not include basemaps.

A layer is a collection of one or more features, or graphics, that represent real-world phenomena. Each feature contains a symbol and geographic data that allows it to be rendered on the map as a graphic with spatial context. Features within the layer may also contain data attributes that provide additional information that may be viewed in popup windows and used for rendering the layer.

Layers may be added in the constructor, with the add() or addMany() methods, or directly to the layers collection using add() or addMany().

In 3D, for layers that are rendered on the terrain, the order of the layers also depends on the type of layer. Tiled layers (BaseTileLayer, ImageryTileLayer, OpenStreetMapLayer, TileLayer, VectorTileLayer, WCSLayer, WebTileLayer and WMTSLayer) are always drawn first in the same order as specified in the layer collection. Dynamic layers (MapImageLayer, ImageryLayer, WMSLayer, and feature based layers with elevation mode on-the-ground) are rendered on top using the order from the layer collection.

let layer = new GraphicsLayer();
// The layer belongs to map1
map1.layers.add(layer);
// The layer now belongs to map2
// and implicitly does: map1.layers.remove(layer)
map2.layers.add(layer);

A collection of layer instances that are tables saved in a Map and/or a WebMap. In order for the table(s) to be recognized as such, the FeatureLayer's isTable property must return true. A table can be created via one of the options below:

• Referencing the URL to a table in a feature service.
• Create a feature layer using the Layer.fromArcGISServerUrl method and confirm that it is a table using feature layer's isTable property. This can be either a feature service or feature collection.
• Create a feature layer using the Layer.fromPortalItem method and confirm that it is a table using feature layer's isTable property. This can be either a feature service or feature collection.
• Create an in-memory, non-spatial, client-side feature layer.

Beginning with 4.17, it is possible to persist non-spatial, tables in a feature service to a WebMap, although in-memory (feature collection) tables are not yet supported.

Persisting tables within a GroupLayer is not yet supported. If this is needed, add them to the Map and/or WebMap.