esri/basemaps | API Reference | ArcGIS API for JavaScript 3.29

Object: esri/basemaps

[ AMD Module Require | Legacy Module Require ]

require(["esri/basemaps"], function(esriBasemaps) { /* code goes here */ });

Description

(Added at v3.12)

This class contains properties referencing default basemaps used in the JS API that allow you to add map services as default basemaps in web applications. esri/basemaps replaces esri.config.defaults.map.basemaps, which is deprecated as of v3.12.

To view documentation for the baseLayers property of each basemap object, see the BasemapLayer class.

  require([
    "esri/basemaps",
    "esri/map",
    "dojo/domReady!"
  ], function (esriBasemaps, Map){
    esriBasemaps.delorme = {
      baseMapLayers: [{url: "https://services.arcgisonline.com/ArcGIS/rest/services/Specialty/DeLorme_World_Base_Map/MapServer"}
      ],
      thumbnailUrl: "https://www.example.com/images/thumbnail_2014-11-25_61051.png",
      title: "Delorme"
    };

    var map = new Map("ui-map", {
      basemap: "delorme",
      center: [-111.879655861, 40.571338776], // long, lat
      zoom: 13,
      sliderStyle: "small"
    });
});

See also

Map constructor

Samples

Search for samples that use this class.

Properties

Name	Type	Summary
dark-gray	`Object`	The Dark Gray Canvas basemap is designed to be used as a soothing background map for overlaying and focus attention on other map layers. https://services.arcgisonline.com/ArcGIS/rest/services/Canvas/World_Dark_Gray_Reference/MapServer https://services.arcgisonline.com/ArcGIS/rest/services/Canvas/World_Dark_Gray_Base/MapServer.
dark-gray-vector	`Object`	The Dark Gray Canvas [v2] vector tile layer provides a detailed basemap for the world featuring a neutral background style with minimal colors, labels, and features.
gray	`Object`	The Light Gray Canvas basemap is designed to be used as a neutral background map for overlaying and emphasizing other map layers. https://services.arcgisonline.com/ArcGIS/rest/services/Canvas/World_Light_Gray_Reference/MapServer https://services.arcgisonline.com/ArcGIS/rest/services/Canvas/World_Light_Gray_Base/MapServer.
gray-vector	`Object`	The Light Gray Canvas [v2] vector tile layer provides a detailed basemap for the world featuring a neutral background style with minimal colors, labels, and features.
hybrid	`Object`	The World Imagery with Labels map is a detailed imagery map layer and labels that is designed to be used as a basemap for various maps and applications: https://services.arcgisonline.com/ArcGIS/rest/services/Reference/World_Boundaries_and_Places/MapServer https://services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer.
national-geographic	`Object`	The National Geographic basemap is designed to be used as a general reference map for informational and educational purposes: https://services.arcgisonline.com/ArcGIS/rest/services/NatGeo_World_Map/MapServer.
oceans	`Object`	The Ocean Basemap is designed to be used as a basemap by marine GIS professionals and as a reference map by anyone interested in ocean data. https://services.arcgisonline.com/arcgis/rest/services/Ocean/World_Ocean_Reference/MapServer https://services.arcgisonline.com/arcgis/rest/services/Ocean/World_Ocean_Base/MapServer.
osm	`Object`	The OpenStreetMap is a community map layer that is designed to be used as a basemap for various maps and applications.
satellite	`Object`	The World Imagery map is a detailed imagery map layer that is designed to be used as a basemap for various maps and applications: https://services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer.
streets	`Object`	The Streets basemap presents a multiscale street map for the world: https://services.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer.
streets-navigation-vector	`Object`	The World Navigation Map [v2] vector tile layer provides a detailed basemap for the world featuring a custom navigation map style.
streets-night-vector	`Object`	The World Street Map (Night) [v2] vector tile layer provides a detailed basemap for the world featuring a custom "night time" street map style.
streets-relief-vector	`Object`	The World Street Map (with Relief) [v2] vector tile layer provides a detailed basemap for the world featuring a classic Esri street map style designed for use with a relief map.
streets-vector	`Object`	The World Street Map [v2] vector tile layer provides a detailed basemap for the world featuring a classic Esri street map style.
terrain	`Object`	The Terrain with Labels basemap is designed to be used to overlay and emphasize other thematic map layers. https://services.arcgisonline.com/ArcGIS/rest/services/Reference/World_Reference_Overlay/MapServer https://services.arcgisonline.com/ArcGIS/rest/services/World_Terrain_Base/MapServer.
topo	`Object`	The Topographic map includes boundaries, cities, water features, physiographic features, parks, landmarks, transportation, and buildings: https://services.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer.
topo-vector	`Object`	The World Topographic Map [v2] vector tile layer provides a detailed basemap for the world featuring a classic Esri topographic map style designed for use with a relief map.

Property Details

<`Object`> dark-gray

The Dark Gray Canvas basemap is designed to be used as a soothing background map for overlaying and focus attention on other map layers.
https://services.arcgisonline.com/ArcGIS/rest/services/Canvas/World_Dark_Gray_Reference/MapServer
https://services.arcgisonline.com/ArcGIS/rest/services/Canvas/World_Dark_Gray_Base/MapServer

<`Object`> dark-gray-vector

The Dark Gray Canvas [v2] vector tile layer provides a detailed basemap for the world featuring a neutral background style with minimal colors, labels, and features. The vector tile layer is similar in content and style to the popular Dark Gray Canvas map, which is delivered as two map services with raster fused map cache. (Added at v3.16)

<`Object`> gray

The Light Gray Canvas basemap is designed to be used as a neutral background map for overlaying and emphasizing other map layers.
https://services.arcgisonline.com/ArcGIS/rest/services/Canvas/World_Light_Gray_Reference/MapServer
https://services.arcgisonline.com/ArcGIS/rest/services/Canvas/World_Light_Gray_Base/MapServer

<`Object`> gray-vector

The Light Gray Canvas [v2] vector tile layer provides a detailed basemap for the world featuring a neutral background style with minimal colors, labels, and features. (Added at v3.16)

<`Object`> hybrid

The World Imagery with Labels map is a detailed imagery map layer and labels that is designed to be used as a basemap for various maps and applications: https://services.arcgisonline.com/ArcGIS/rest/services/Reference/World_Boundaries_and_Places/MapServer
https://services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer

<`Object`> national-geographic

The National Geographic basemap is designed to be used as a general reference map for informational and educational purposes: https://services.arcgisonline.com/ArcGIS/rest/services/NatGeo_World_Map/MapServer.

<`Object`> oceans

The Ocean Basemap is designed to be used as a basemap by marine GIS professionals and as a reference map by anyone interested in ocean data. https://services.arcgisonline.com/arcgis/rest/services/Ocean/World_Ocean_Reference/MapServer
https://services.arcgisonline.com/arcgis/rest/services/Ocean/World_Ocean_Base/MapServer

<`Object`> osm

The OpenStreetMap is a community map layer that is designed to be used as a basemap for various maps and applications.

<`Object`> satellite

The World Imagery map is a detailed imagery map layer that is designed to be used as a basemap for various maps and applications: https://services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer.

<`Object`> streets

The Streets basemap presents a multiscale street map for the world: https://services.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer.

<`Object`> streets-navigation-vector

The World Navigation Map [v2] vector tile layer provides a detailed basemap for the world featuring a custom navigation map style. This vector tile layer is currently in beta release. (Added at v3.16)

<`Object`> streets-night-vector

The World Street Map (Night) [v2] vector tile layer provides a detailed basemap for the world featuring a custom "night time" street map style. (Added at v3.16)

<`Object`> streets-relief-vector

The World Street Map (with Relief) [v2] vector tile layer provides a detailed basemap for the world featuring a classic Esri street map style designed for use with a relief map. (Added at v3.16)

<`Object`> streets-vector

The World Street Map [v2] vector tile layer provides a detailed basemap for the world featuring a classic Esri street map style. (Added at v3.16)

<`Object`> terrain

The Terrain with Labels basemap is designed to be used to overlay and emphasize other thematic map layers. https://services.arcgisonline.com/ArcGIS/rest/services/Reference/World_Reference_Overlay/MapServer
https://services.arcgisonline.com/ArcGIS/rest/services/World_Terrain_Base/MapServer

<`Object`> topo

The Topographic map includes boundaries, cities, water features, physiographic features, parks, landmarks, transportation, and buildings: https://services.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer

<`Object`> topo-vector

The World Topographic Map [v2] vector tile layer provides a detailed basemap for the world featuring a classic Esri topographic map style designed for use with a relief map. (Added at v3.16)

	Site wide shortcuts
`?`	Bring up this help dialog
`esc`	Dismiss this help dialog
`gh`	Go to Home
`gg`	Go to Guide
`ga`	Go to API Reference
`gs`	Go to Sample Code
`gt`	Scroll to top of page
`spacebar`	Scroll page down
`shift spacebar`	Scroll page up
`gb`	Scroll to bottom of page

	API Reference
`/`	Focus search
`c`	Go to Constructors
`p`	Go to Properties
`m`	Go to Methods
`e`	Go to Events

Description

Samples

Properties

<Object> dark-gray

<Object> dark-gray-vector

<Object> gray

<Object> gray-vector

<Object> hybrid

<Object> national-geographic

<Object> oceans

<Object> osm

<Object> satellite

<Object> streets

<Object> streets-navigation-vector

<Object> streets-night-vector

<Object> streets-relief-vector

<Object> streets-vector

<Object> terrain

<Object> topo

<Object> topo-vector

Keyboard shortcuts