Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
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.mybasemap= {
baseMapLayers: [{url: "https://www.example.com/arcgis/rest/services/MyBasemap/MapServer"}
],
thumbnailUrl: "https://www.example.com/images/thumbnail_2014-11-25_61051.png",
title: "Second best basemap"
};
var map = new Map("ui-map", {
basemap: "mybasemap"
});
});
See also
Samples
Search for samples that use this class.Properties
| Name | Type | Summary |
|---|---|---|
| dark-gray | Object | [deprecated] The services used in this basemap are now in Mature Support and are no longer updated - please use dark-gray-vector instead. |
| 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 | [deprecated] The services used in this basemap are now in Mature Support and are no longer updated - please use gray-vector instead. |
| 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. |
| national-geographic | Object | [deprecated] The service used in this basemap is now in Mature Support and is no longer updated. |
| 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. |
| 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 | [deprecated] The service used in this basemap is now in Mature Support and is no longer updated - please use streets-vector instead. |
| 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. |
| topo | Object | [deprecated] The World_Topo_Map service used in this basemap is now in Mature Support and is no longer updated - please use topo-vector instead. |
| 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
Object[deprecated]
The services used in this basemap are now in Mature Support and are no longer updated - please use dark-gray-vector instead. The Dark Gray Canvas basemap is designed to be used as a soothing background map for overlaying and focus attention on other map layers. It contains:
<Object
ObjectThe 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
Object[deprecated]
The services used in this basemap are now in Mature Support and are no longer updated - please use gray-vector instead. The Light Gray Canvas basemap is designed to be used as a neutral background map for overlaying and emphasizing other map layers. It contains:
<Object
ObjectThe 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
ObjectThe 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. It contains:
<Object
Object[deprecated]
The service used in this basemap is now in Mature Support and is no longer updated. Please use another basemap.
The National Geographic basemap was 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.
The National Geographic basemap was 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
ObjectThe 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. It contains:
<Object
ObjectThe OpenStreetMap is a community map layer that is designed to be used as a basemap for various maps and applications.
<Object
ObjectThe 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
Object[deprecated]
The service used in this basemap is now in Mature Support and is no longer updated - please use streets-vector instead.
The Streets basemap presents a multiscale street map for the world: https://services.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer.
The Streets basemap presents a multiscale street map for the world: https://services.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer.
<Object
ObjectThe World Navigation Map [v2] vector tile layer provides a detailed basemap for the world featuring a custom navigation map style. (Added at v3.16)
<Object
ObjectThe 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
ObjectThe 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
ObjectThe 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
ObjectThe Terrain with Labels basemap is designed to be used to overlay and emphasize other thematic map layers. It contains:
<Object
Object[deprecated]
The World_Topo_Map service used in this basemap is now in Mature Support and is no longer updated - please use topo-vector instead. The Topographic map includes boundaries, cities, water features, physiographic features, parks, landmarks, transportation, and buildings.
<Object
ObjectThe 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)