Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Object: esri/basemaps

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

Samples

Search for samples that use this class.

Properties

NameTypeSummary
dark-grayObjectThe Dark Gray Canvas basemap is designed to be used as a soothing background map for overlaying and focus attention on other map layers.
dark-gray-vectorObjectThis vector tile layer provides a detailed basemap for the world featuring a neutral background style with minimal colors, labels, and features.
grayObjectThe Light Gray Canvas basemap is designed to be used as a neutral background map for overlaying and emphasizing other map layers.
gray-vectorObjectThis vector tile layer provides a detailed basemap for the world featuring a neutral background style with minimal colors, labels, and features.
hybridObjectThe World Imagery map is a detailed imagery map layer and labels that is designed to be used as a basemap for various maps and applications.
national-geographicObjectThe National Geographic basemap is designed to be used as a general reference map for informational and educational purposes.
oceansObjectThe 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.
osmObjectThe OpenStreetMap is a community map layer that is designed to be used as a basemap for various maps and applications.
satelliteObjectThe World Imagery map is a detailed imagery map layer that is designed to be used as a basemap for various maps and applications.
streetsObjectThe Streets basemap presents a multiscale street map for the world.
streets-navigation-vectorObjectThis vector tile layer provides a detailed basemap for the world featuring a custom navigation map style.
streets-night-vectorObjectThis vector tile layer provides a detailed basemap for the world featuring a custom "night time" street map style.
streets-relief-vectorObjectThis 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-vectorObjectThis vector tile layer provides a detailed basemap for the world featuring a classic Esri street map style.
terrainObjectThe Terrain with Labels basemap is designed to be used to overlay and emphasize other thematic map layers.
topoObjectThe Topographic map includes boundaries, cities, water features, physiographic features, parks, landmarks, transportation, and buildings.
topo-vectorObjectThis 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.

<Object> dark-gray-vector

This vector tile layer provides a detailed basemap for the world featuring a neutral background style with minimal colors, labels, and features. This vector tile layer is currently in beta release.
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.

<Object> gray-vector

This vector tile layer provides a detailed basemap for the world featuring a neutral background style with minimal colors, labels, and features. This vector tile layer is currently in beta release.
This vector tile layer is built using the same data sources used for the Light Gray Canvas and other Esri basemaps. The map includes highways, major roads, minor roads, railways, water features, cities, parks, landmarks, building footprints, and administrative boundaries. (Added at v3.16)

<Object> hybrid

The World Imagery map is a detailed imagery map layer and labels that is designed to be used as a basemap for various maps and applications.

<Object> national-geographic

The National Geographic basemap is designed to be used as a general reference map for informational and educational purposes.

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

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

<Object> streets

The Streets basemap presents a multiscale street map for the world.

<Object> streets-navigation-vector

This 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

This vector tile layer provides a detailed basemap for the world featuring a custom "night time" street map style. This vector tile layer is currently in beta release. (Added at v3.16)

<Object> streets-relief-vector

This vector tile layer provides a detailed basemap for the world featuring a classic Esri street map style designed for use with a relief map. This vector tile layer is currently in beta release. (Added at v3.16)

<Object> streets-vector

This vector tile layer provides a detailed basemap for the world featuring a classic Esri street map style. This vector tile layer is currently in beta release. (Added at v3.16)

<Object> terrain

The Terrain with Labels basemap is designed to be used to overlay and emphasize other thematic map layers.

<Object> topo

The Topographic map includes boundaries, cities, water features, physiographic features, parks, landmarks, transportation, and buildings.

<Object> topo-vector

This vector tile layer provides a detailed basemap for the world featuring a classic Esri topographic map style designed for use with a relief map. This vector tile layer is currently in beta release. (Added at v3.16)