require(["esri/Basemap"], function(Basemap) { /* code goes here */ });
Class: esri/Basemap
Inheritance: Basemap Accessor
Since: ArcGIS API for JavaScript 4.0

Basemap is used for creating custom basemaps. These basemaps may be created from tiled services you publish to your own server or from tiled services published by third parties.

An instance of Basemap is also a Promise. Call the then() method on the Basemap instance to execute processes that may only run after the Basemap is loaded.

See also:

Constructors

new Basemap(properties)

Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
Collection<Layer>

A collection of tile layers that make up the basemap's features.

more details
more detailsBasemap
String

The name of the class.

more details
more detailsAccessor
String

An identifier used to refer to the basemap when referencing it elsewhere.

more details
more detailsBasemap
Boolean

Indicates whether the basemap instance has loaded.

more details
more detailsBasemap
Error

The Error object returned if an error occurred while loading.

more details
more detailsBasemap
String

Represents the status of a load operation.

more details
more detailsBasemap
Object[]

A list of warnings which occurred while loading.

more details
more detailsBasemap
PortalItem

The portal item.

more details
more detailsBasemap
Collection<Layer>

A collection of tiled reference layers for displaying labels.

more details
more detailsBasemap
String

The URL pointing to an image that represents the basemap.

more details
more detailsBasemap
String

The title of the basemap.

more details
more detailsBasemap

Property Details

baseLayersCollection<Layer>

A collection of tile layers that make up the basemap's features.

declaredClassStringreadonly inherited

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

An identifier used to refer to the basemap when referencing it elsewhere.

Example:
var customBasemap = new Basemap({
  baseLayers: [layers],
  title: "Custom Basemap",
  id: "myBasemap"
});

loadedBooleanreadonly

Indicates whether the basemap instance has loaded. When true, all the properties of the object can be accessed.

Default Value: false

loadErrorErrorreadonly

The Error object returned if an error occurred while loading.

Default Value: null

loadStatusStringreadonly

Represents the status of a load operation.

ValueDescription
not-loadedThe object's resources have not loaded.
loadingThe object's resources are currently loading.
loadedThe object's resources have loaded without errors.
failedThe object's resources failed to load. See loadError for more details.
Default Value: not-loaded

loadWarningsObject[]readonly

A list of warnings which occurred while loading.

The portal item.

referenceLayersCollection<Layer>

A collection of tiled reference layers for displaying labels.

thumbnailUrlString

The URL pointing to an image that represents the basemap. When using a custom basemap in the BasemapToggle widget, the image specified here will display in the widget. When the user clicks the image, the map's basemap will update to the basemap associated with the image.

See also:

titleString

The title of the basemap.

Method Overview

NameReturn TypeSummaryClass
Promise

An instance of this class is a Promise.

more details
more detailsBasemap

Cancels a load() operation if it is already in progress.

more details
more detailsBasemap
Basemap

Creates a deep clone of this object.

more details
more detailsBasemap
Basemap

Creates a new basemap instance from a well known basemap ID.

more details
more detailsBasemap
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsBasemap
Boolean

An instance of this class is a Promise.

more details
more detailsBasemap
Boolean

An instance of this class is a Promise.

more details
more detailsBasemap
Boolean

An instance of this class is a Promise.

more details
more detailsBasemap
Promise

Loads the resources referenced by this class.

more details
more detailsBasemap
Promise

An instance of this class is a Promise.

more details
more detailsBasemap
Promise

An instance of this class is a Promise.

more details
more detailsBasemap
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsBasemap

Method Details

always(callbackOrErrback){Promise}

An instance of this class is a Promise. Therefore always() may be used to execute a function if the promise is rejected or resolved. The input function will always execute no matter the response. For more information about promises, see the Working with Promises guide page.

Parameter:
callbackOrErrback Function
optional

The function to execute when the promise is rejected or resolved.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callbackOrErrback.
Example:
// Although this example uses MapView, any class instance that is a promise may use always() in the same way
var view = new MapView();
view.always(function(){
  // This function will always execute whether or not the promise is resolved or rejected
});

cancelLoad()

Cancels a load() operation if it is already in progress.

clone(){Basemap}

Creates a deep clone of this object.

Returns:
TypeDescription
BasemapA deep clone of the Basemap instance that invoked this method.

fromId(id){Basemap}static

Creates a new basemap instance from a well known basemap ID. See Map.basemap for a list of possible values.

Parameter:

The basemap ID.

Returns:
TypeDescription
BasemapA new Basemap instance.
Examples:
var streetsBasemap = Basemap.fromId("streets");
var nightBasemap = Basemap.fromId("streets-night-vector");

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
TypeDescription
*Returns a new instance of this class.

isFulfilled(){Boolean}

An instance of this class is a Promise. Therefore isFulfilled() may be used to verify if the promise is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been fulfilled (either resolved or rejected).

isRejected(){Boolean}

An instance of this class is a Promise. Therefore isRejected() may be used to verify if the promise is rejected. If it is rejected, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been rejected.

isResolved(){Boolean}

An instance of this class is a Promise. Therefore isResolved() may be used to verify if the promise is resolved. If it is resolved, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been resolved.

load(){Promise}

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

Returns:
TypeDescription
PromiseResolves when the resources have loaded.

otherwise(errback){Promise}

An instance of this class is a Promise. Use otherwise() to call a function once the promise is rejected.

Parameter:
errback Function
optional

The function to execute when the promise fails.

Returns:
TypeDescription
PromiseReturns a new promise for the result of errback.
Example:
// Although this example uses MapView, any class instance that is a promise may use otherwise() in the same way
var view = new MapView();
view.otherwise(function(error){
  // This function will execute if the promise is rejected due to an error
});

then(callback, errback, progback){Promise}

An instance of this class is a Promise. Therefore then() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the promise resolves (when the instance of the class loads). The errback executes if the promise fails. See the Working with Promises guide page for additional details.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

progback Function
optional

The function to invoke when the promise emits a progress update.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callback that may be used to chain additional functions.
Example:
// Although this example uses MapView, any class instance that is a promise may use then() in the same way
var view = new MapView();
view.then(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

toJSON(){Object}

Converts an instance of this class to its ArcGIS Portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.