require(["esri/widgets/BasemapGallery/support/LocalBasemapsSource"], (LocalBasemapsSource) => { /* code goes here */ });
import LocalBasemapsSource from "@arcgis/core/widgets/BasemapGallery/support/LocalBasemapsSource.js";
esri/widgets/BasemapGallery/support/LocalBasemapsSource
The LocalBasemapsSource class is a Collection-driven Basemap source in the BasemapGalleryViewModel or BasemapGallery widget.
- See also
// in this example, the portal item is a webmap
let basemap = new Basemap({
portalItem: {
id: "867895a71a1840399476fc717e76bb43" // Mid-Century Map
}
});
let basemapGallery = new BasemapGallery({
source: new LocalBasemapsSource({
basemaps: [
Basemap.fromId("topo-vector"), // create a basemap from a well known id
basemap
]
}),
view: view
});
view.ui.add(basemapGallery, 'top-right');
Constructors
-
new LocalBasemapsSource(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Collection<Basemap> | A collection of Basemaps. more details | LocalBasemapsSource | |
String | The name of the class. more details | Accessor | |
String | The source's state. more details | LocalBasemapsSource |
Property Details
-
basemaps Collection<Basemap>
-
A collection of Basemaps.
-
Since: ArcGIS Maps SDK for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
state Stringreadonly
-
The source's state. The state is always
ready
.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");