import BasemapItem from "@arcgis/core/basemapGallery/support/BasemapItem.js";
Inheritance
BasemapItem→Accessor
Since
ArcGIS Maps SDK for JavaScript 5.2

Represents one of the basemaps in BasemapGalleryModel.items.

See also

Constructors

Constructor

Constructor

Parameters

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

basemap

Property
Type
Basemap

The item's associated basemap.

compatibilityFunction

Property
Type
BasemapCompatibilityFunction | null

Function used to determine whether a basemap is compatible with the current view. This is mostly needed for SceneView.

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor
Since
ArcGIS Maps SDK for JavaScript 4.7

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

error

readonly Property
Type
EsriError | null | undefined

The Error object returned if an error occurred.

spatialReference

readonly Property
Type
SpatialReference | null | undefined

The spatial reference of the item's basemap.

state

readonly Property
Type
BasemapItemState

The item's state.

uid

readonlyinherited Property
Type
string
Inherited from: IdentifiableMixin
Since
ArcGIS Maps SDK for JavaScript 4.33

An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.

view

Property
Type
MapViewOrSceneView | null | undefined

The view associated with this item.

Methods

MethodSignatureClass
destroy(): void
refresh(): void

destroy

Method
Signature
destroy (): void

Destroys the basemap item.

Returns
void

refresh

Method
Signature
refresh (): void

Refreshes the item's state.

Returns
void

Type definitions

BasemapItemState

Type definition
Type
"ready" | "loading" | "error"