BasemapStyle

const basemap = new Basemap({
  style: new BasemapStyle({
    id: "arcgis/human-geography",
    language: "es" // place labels will be displayed in spanish
  })
})

Property Overview

Property Details

declaredClass Stringreadonly inherited

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

id String

The id of the basemap style. The values are of the form {provider}/{style} where provider is "arcgis" or "osm". Examples include arcgis/navigation and osm/standard. See ArcGIS basemap styles and OSM basemap styles for the full list of available styles.

See also

• ArcGIS basemap styles

• OSM basemap styles

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 String

The language of the place labels in the basemap style. Choose from a variety of supported languages, including global and local.

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

• Supported languages

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";

serviceUrl String

The URL to the basemap styles service.

Default Value:"https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps"

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

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();

Parameters

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

groupKey * optional Key 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(groupKey){Boolean}inherited

Returns true if a named group of handles exist.

Parameter

groupKey * optional A group key.

Returns

Type	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)inherited

Removes a group of handles owned by the object.

Parameter

groupKey * optional A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");