require(["esri/support/BasemapStyle"], (BasemapStyle) => { /* code goes here */ });
import BasemapStyle from "@arcgis/core/support/BasemapStyle.js";
esri/support/BasemapStyle
The style of the basemap from the basemap styles service (v2). The basemap styles service is a ready-to-use location service that serves vector and image tiles representing geographic features around the world.
You can use the basemap styles service to display:
- Streets and navigation styles
- Imagery, oceanic, and topographic styles
- OSM standard and streets styles
- Creative styles such as nova and blue print
- Localized place labels
- Places with styles - since 4.29
- Worldview boundaries - since 4.29
Use of the basemap style service requires authentication via an API key or user authentication. To learn more about API keys, see the API keys section in the Esri Developer documentation.
- See also
const basemap = new Basemap({
style: new BasemapStyle({
id: "arcgis/human-geography",
language: "es" // place labels will be displayed in spanish
})
})
Constructors
-
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 |
---|---|---|---|
The name of the class. | Accessor | ||
The id of the basemap style. | BasemapStyle | ||
The language of the place labels in the basemap style. | BasemapStyle | ||
Indicates whether to display places with the basemap style. | BasemapStyle | ||
The URL to the basemap styles service. | BasemapStyle | ||
Displays country boundaries and labels based on a specific view of a country. | BasemapStyle |
Property Details
-
id
id String
-
The id of the basemap style. The values are of the form
{provider}/{style}
where provider is "arcgis" or "osm". Examples includearcgis/navigation
andosm/standard
. See ArcGIS basemap styles and OSM basemap styles for the full list of available styles.- See also
Example// sets the basemap to the OSM standard relief style basemap.style = { id: "osm/standard-relief" } // sets the basemap to the arcgis outdoor style basemap.style.id = "arcgis/outdoor";
-
language
language String
-
The language of the place labels in the basemap style. Choose from a variety of supported languages, including
global
andlocal
.If not set, the app's current locale is used. If the app's locale is not supported by the service, the language will fall back to
"global"
.- See also
Example// basemap place labels will in spanish basemap.style = { id: "arcgis/outdoor", language: "es" } // basemap style will use the names of places in their local language (e.g. "Lisboa" for Lisbon) basemap.style.language = "local";
-
places
places String
Since: ArcGIS Maps SDK for JavaScript 4.29BasemapStyle since 4.28, places added at 4.29. -
Indicates whether to display places with the basemap style. Only supported with the
arcgis/navigation
andarcgis/navigation-night
styles.Possible Values:"all" |"attributed" |"none"
- See also
Exampleconst basemapWithPlaces = new Basemap({ style: new BasemapStyle({ id: "arcgis/navigation", places: "all" }) })
-
worldview
worldview String
Since: ArcGIS Maps SDK for JavaScript 4.29BasemapStyle since 4.28, worldview added at 4.29. -
Displays country boundaries and labels based on a specific view of a country. Choose from a variety of supported worldviews.
Worldviews can only be specified for
arcgis
basemap styles (OSM is not supported). When a specific worldview is chosen, it is possible for some place labels to change language. However, when a specific language is provided, it will take priority over the language changes associated with the worldview.- See also
Exampleconst moroccoBasemap = new Basemap({ style: new BasemapStyle({ id: "arcgis/streets", worldview: "morocco", language: "ar" }) })
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
-
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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
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"); }
-
Inherited from Accessor
-
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");