RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html below:

WebMap | API Reference | ArcGIS Maps SDK for JavaScript 4.33

ESM: import WebMap from "@arcgis/core/WebMap.js";

CDN: const WebMap = await $arcgis.import("@arcgis/core/WebMap.js");

Class: @arcgis/core/WebMap

Since: ArcGIS Maps SDK for JavaScript 4.0

Loads a WebMap from ArcGIS Online or ArcGIS Enterprise portal into a MapView. It defines the content, style, and bookmarks of your webmap, and it can be shared across multiple ArcGIS web and desktop applications. The webmap is saved as a JSON document that can be consumed by the ArcGIS Maps SDK for JavaScript via the WebMap class to easily create compelling 2D applications. The JSON document is written according to the webmap specification. Although you can easily create your own webmaps, there are many sample webmaps in ArcGIS Online that you can use to get started with the API. You may modify or add new content to these webmaps.

To load a WebMap from ArcGIS Online into a MapView, you must reference the ID of the webmap in the portalItem property of this class.

const webmap = new WebMap({
  portalItem: { // autocasts as new PortalItem()
    id: "e691172598f04ea8881cd2a4adaa45ba"
  }
});

To load a Webmap from an on-premise portal, set the portal url in esriConfig.portalUrl.

esriConfig.portalUrl = "https://myHostName.esri.com/arcgis";

const webmap = new WebMap({
  portalItem: { // autocasts as new PortalItem()
    id: "f701172599f04ea8781de2a4adzz46ab"
  }
});

Then you must reference the WebMap instance in the map property of the view.

const view = new MapView({
  map: webmap,  // The WebMap instance created above
  container: "viewDiv"
});

Known Limitations

WCSLayers are currently not supported. WFSLayers must be from a WFS 2.0.0 service and have GeoJSON output format enabled.
In instances when the webmap contains layer types that are not yet supported in the API, layers will be created as an UnsupportedLayer. This layer type is used specifically in these instances where the layer may exist in a given WebMap (e.g. WFS layer from WFS 1.0.0), but may not be currently supported in the version of the API accessing it.
An UnknownLayer will be used if future versions of the WebMap contains a new type of layer. The API version may not recognize this layer type, therefore it would come across as an UnknownLayer.
Embedded Routes
- Prior to the ArcGIS Online 8.1 release (March 2020) when copying a route layer from an item to be stored inside a WebMap it would be stored as an embedded feature collection, and inadvertently not attributed as a route. When these webmaps are loaded by the JS API, the routes will be represented by a GroupLayer rather than a RouteLayer. This does not affect copied route layer items after the ArcGIS Online 8.1 release or routes stored as portal items. Copying route layer items to be stored as part of the webmap is not a common scenario.
Accessing geometries from popup features
- Beginning with version 4.17, webmaps no longer return geometries in its popup's features. If a popup does not have a referenced Arcade expression that works with geometry, it is now required to set either the webmap layer's outFields or its PopupTemplate outFields.

See also

Constructors

WebMap Constructor new WebMap(properties)

Parameter

optional

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

Example

// Typical usage
const map = new WebMap({
  portalItem: {
    id: "e691172598f04ea8881cd2a4adaa45ba"
  }
});

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

Show inherited properties Hide inherited properties

Property Details

Example

// Find a layer with title "US Counties"
const foundLayer = map.allLayers.find(function(layer) {
 return layer.title === "US Counties";
});

// Create a filtered collection of the non-group layers
const nonGroupLayers = map.allLayers.filter(function(layer) {
 return !foundLayer.layers;
});

// Listen for any layer being added or removed in the Map
map.allLayers.on("change", function(event) {
 console.log("Layer added: ", event.added);
 console.log("Layer removed: ", event.removed);
 console.log("Layer moved: ", event.moved);
});

// Watching for changes to the visible layers in the Map
reactiveUtils.watch(
  () => view.map.allLayers.filter((layer) => layer.visible),
  (newVisibleLayers, oldVisibleLayers) => {
    const added = newVisibleLayers.filter(
      (layer) => !oldVisibleLayers.includes(layer)
    );
    const removed = oldVisibleLayers.filter(
      (layer) => !newVisibleLayers.includes(layer)
    );
    added.forEach((layer) => console.log(layer.title, "is visible"));
    removed.forEach((layer) => console.log(layer.title, "is not visible"));
  }
);

Since: ArcGIS Maps SDK for JavaScript 4.17 Map since 4.0, allTables added at 4.17.

A flattened collection of tables anywhere in the map's hierarchy. This will contain individual tables within the map's tables, in addition to any group layer tables. In order for the table(s) to be recognized as such, the FeatureLayer.isTable property must return true.

Currently, only feature layer tables are recognized.
To access spatial layers, use the allLayers property instead.

Example

// A feature layer where isTable = true.
const foundTable = map.allTables.find(function(table) {
  // Find a table with title "US Counties"
  return table.title === "US Counties";
});

Since: ArcGIS Maps SDK for JavaScript 4.14 WebDocument2D since 4.31, applicationProperties added at 4.14.: The applicationProperties contains the viewing properties of the WebMap.

Since: ArcGIS Maps SDK for JavaScript 4.14 WebDocument2D since 4.31, authoringApp added at 4.14.: The name of the application that authored the WebMap.

Since: ArcGIS Maps SDK for JavaScript 4.14 WebDocument2D since 4.31, authoringAppVersion added at 4.14.: The version of the application that authored the WebMap.

Specifies a basemap for the map. The basemap is a set of layers that give geographic context to the MapView or SceneView and the other operational layers in the map.

The basemap can be created in a variety of ways:

From the basemap styles service (v2)
From an instance of the Basemap class
From a basemap id

Basemap Id 3D

Since version 4.28

The 3D Basemaps can be accessed using the basemap id in the table below. They are designed to be used as basemaps in SceneView.

Known Limitations

3D Basemaps can only be used in SceneView.

2D (legacy)

Since version 4.0

The legacy basemaps can be accessed using the basemap id in the table below. These are references to enhanced basemap endpoints.

Examples

// create the basemap from a string id representing the basemap style
const map = new Map({
  basemap: "arcgis/topographic"
});

// create the basemap from a BasemapStyle object
const map = new Map({
 basemap: {
  style: {
   id:  "arcgis/outdoor",
   language: "es" // place labels will be displayed in spanish
  }
 }
});

// Set the basemap from a string ID in the constructor
const map = new Map({
  basemap: "dark-gray-3d"
});

// Set the basemap after the map instance is created
map.basemap = "topo-3d";

// Create a VectorTileLayer from a style URL
const mapBaseLayer = new VectorTileLayer({
  url: "https://arcgis.com/sharing/rest/content/items/b5676525747f499687f12746441101ef/resources/styles/root.json"
});

// Create a Basemap with the VectorTileLayer
const customBasemap = new Basemap({
  baseLayers: [mapBaseLayer],
  title: "Terrain"
});

// Set the basemap to the customBasemap
const map = new Map({
  basemap: customBasemap
});

: An array of saved geographic extents that allow end users to quickly navigate to a particular area of interest.

declaredClass Inherited Property declaredClass Stringreadonly Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.: The name of the class. The declared class name is formatted as esri.folder.className.

Since: ArcGIS Maps SDK for JavaScript 4.20 Map since 4.0, editableLayers added at 4.20.: A collection of editable layers. Layers are considered editable if they have editing capabilities, and if the authenticated user has the necessary privileges needed to edit the layers.

Since: ArcGIS Maps SDK for JavaScript 4.19 WebDocument2D since 4.31, floorInfo added at 4.19.: When a web map is configured as floor-aware, it has a floorInfo property defined. A floor-aware map is a map that contains indoor GIS data representing floor plan features. The floor info must contain levelLayer and facilityLayer properties at a minimum. The siteLayer property is optional.

Since: ArcGIS Maps SDK for JavaScript 4.24 WebMap since 4.0, geotriggersInfo added at 4.24.: Information relating to a list of Geotriggers.

Specifies the surface properties for the map. In MapView, this property is used by the ElevationProfile widget when the profile contains an ElevationProfileLineGround. In 3D SceneView, it renders the terrain or topographical variations in the real world on the map's surface with a collection of ElevationLayers.

This value can be an instance of Ground, or one of the following strings:

world-elevation for a default instance of ground using the Terrain3D Service.
world-topobathymetry for an instance of ground that combines surface elevation and bathymetry using the TopoBathy3D Service.

The ground may not be set to null or undefined, it is guaranteed to always contain an instance of type Ground. The elevation can be removed from the ground by setting the ground property to a new empty Ground instance or by removing all the ground layers.

Examples

// Use the world elevation service
const map = new Map({
  basemap: "topo-vector",
  ground: "world-elevation"
});

// Create a map with the world elevation layer overlaid by a custom elevation layer
const worldElevation = new ElevationLayer({
  url: "//elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer"
});
const customElevation = new ElevationLayer({
  url: "https://my.server.com/arcgis/rest/service/MyElevationService/ImageServer"
});
const map = new Map({
  basemap: "topo-vector",
  ground: new Ground({
   layers: [ worldElevation, customElevation ]
  })
});

: The initial view of the WebMap. This object contains properties such as viewpoint, spatialReference, that will be applied to the view when the WebMap loads.

Since: ArcGIS Maps SDK for JavaScript 4.31 WebMap since 4.0, ipsInfo added at 4.31.: Contains indoor positioning system information for the map.

A collection of operational layers. This property contains the operational layers, such as FeatureLayers, WebTileLayers and GraphicsLayers that may be queried, assigned different renderers, analyzed, etc. It does not include basemaps.

A layer is a collection of one or more features, or graphics, that represent real-world phenomena. Each feature contains a symbol and geographic data that allows it to be rendered on the map as a graphic with spatial context. Features within the layer may also contain data attributes that provide additional information that may be viewed in popup windows and used for rendering the layer.

Layers may be added in the constructor, with the add() or addMany() methods, or directly to the layers collection using add() or addMany().

In 3D, for layers that are rendered on the terrain, the order of the layers also depends on the type of layer. Tiled layers (BaseTileLayer, ImageryTileLayer, OpenStreetMapLayer, TileLayer, VectorTileLayer, WCSLayer, WebTileLayer and WMTSLayer) are always drawn first in the same order as specified in the layer collection. Dynamic layers (MapImageLayer, ImageryLayer, WMSLayer, and feature based layers with elevation mode on-the-ground) are rendered on top using the order from the layer collection.

A layer may only be added to one parent. Adding the same layer to multiple Maps or GroupLayers is not possible. If you attempt to do so, the layer will automatically be removed from its current parent and placed in the new parent.

let layer = new GraphicsLayer();
// The layer belongs to map1
map1.layers.add(layer);
// The layer now belongs to map2
// and implicitly does: map1.layers.remove(layer)
map2.layers.add(layer);

Example

// Add layers in the constructor of Map using an array
let fl = new FeatureLayer(url);
let gl = new GraphicsLayer();
let map = new Map({
  layers: [fl, gl]
});

// Add layers using add()
map.addMany([fl, gl]);

// Add layers using layers collection
map.layers.addMany([fl, gl]);

// Add layers using layers collection's push method
map.layers.push(fl, gl);

: The Error object returned if an error occurred while loading.

loadStatus Inherited Property loadStatus Stringreadonly

Represents the status of a load operation.

Value Description not-loaded The object's resources have not loaded. loading The object's resources are currently loading. loaded The object's resources have loaded without errors. failed The object's resources failed to load. See loadError for more details.

Possible Values:"not-loaded" |"loading" |"failed" |"loaded"

Default Value:"not-loaded"

loaded Inherited Property loaded Booleanreadonly: Indicates whether the instance has loaded. When true, the properties of the object can be accessed. A WebMap is considered loaded when its layers and basemap are created, but not yet loaded.

: The portal item from which the WebMap is loaded.

presentation Property presentation Object: Provides multiple slides. Each slide has a different "title", "extent", "basemap", "layers" etc.

Since: ArcGIS Maps SDK for JavaScript 4.1 WebMap since 4.0, sourceVersion added at 4.1.

The version of the source document from which the WebMap was read. The WebMap must be version 2.x to load into an app.

Properties

The major version of the WebMap.

The minor version of the WebMap.

A collection of layer instances that are tables saved in a Map and/or a WebMap. In order for the table(s) to be recognized as such, the FeatureLayer's isTable property must return true. A table can be created via one of the options below:

Referencing the URL to a table in a feature service.
Create a feature layer using the Layer.fromArcGISServerUrl method and confirm that it is a table using feature layer's isTable property. This can be either a feature service or feature collection.
Create a feature layer using the Layer.fromPortalItem method and confirm that it is a table using feature layer's isTable property. This can be either a feature service or feature collection.
Create an in-memory, non-spatial, client-side feature layer.

Beginning with 4.17, it is possible to persist non-spatial, tables in a feature service to a WebMap, although in-memory (feature collection) tables are not yet supported.

Persisting tables within a GroupLayer is not yet supported. If this is needed, add them to the Map and/or WebMap.

Currently, only feature service feature layers are recognized.
To access spatial layers, use the layers property in either Map or WebMap classes

Examples

// This snippet shows how to add a table to a map's table collection.

// FeatureLayer.isTable = false
const featureLayer = new FeatureLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/SF311/FeatureServer/0"
});
// Add featureLayer to the map
map.add(featureLayer);

// FeatureLayer.isTable = true
const table = new FeatureLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/SF311/FeatureServer/1"
});

// In order for the table to be stored within
// the map's table collection, load it and confirm it is the right type.

table.load().then(() => {
  // Add the table to the collection
  map.tables.add(table);
  console.log("Table is added to map's table collection");
});

// This snippet shows how to persist a table to an existing web map

// FeatureLayer.isTable = true
const table = new FeatureLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Crash_details_table/FeatureServer/0"
});

// Create Webmap instance
const webmap = new WebMap({
  portalItem: {
    id: webmapId
  }
});

// When web map is ready, load the table and add it to the web map
webmap.when(() => {
  table.load().then(() => {
    console.log("Adding table");
    // Add table to the webmap's table collection
    webmap.tables.add(table);
  });
});

// Call updateFrom on webmap and pass in the existing view
webmap.updateFrom(view).then(() => {
  // Call saveAs (or save) on the web map
  webmap.saveAs({
    // autocasts as new PortalItem()
    title: "New WebMap"
  });
});

// This snippet shows how to add an in-memory table to a map

// Create the array of objects containing field info
const fields = [{
  name: "ObjectID",
  alias: "ObjectID",
  type: "oid"
},
{
  name: "tree_type",
  alias: "Tree type",
  type: "string"
},
{
  name: "species",
  alias: "Species",
  type: "string"
}];

// Create the array of graphics holding attribute info
const graphics = [{
  attributes: {
    "tree_type": "deciduous",
    "species": "maple",
    "ObjectID": 2
  }
}, {
  attributes: {
    "tree_type": "coniferous",
    "species": "pine",
    "ObjectID": 3
  }
}];

// Create the feature layer (feature collection) table
const table = new FeatureLayer({
  fields: fields,
  objectIdField: "ObjectID",
  source: graphics
});

// Check when map is ready and load the table
map.when(() => {
  table.load().then(() => {
    console.log("Adding table");
    map.tables.add(table);
  });
});

Since: ArcGIS Maps SDK for JavaScript 4.14 WebDocument2D since 4.31, thumbnailUrl added at 4.14.

The URL to the thumbnail used for the webmap. The thumbnailUrl will default to the thumbnail URL from the portal item associated to the webmap. The thumbnail of the webmap may be updated by changing the thumbnail URL and saving the webmap. Use updateFrom to update the thumbnail automatically from a specified view.

Example

webmap.updateFrom(view)
  .then(function() {
    return webmap.save();
  })
  // thumbnail will be updated based on current extent of webmap
  .then(function(portalItem) {
    console.log("Saved to portal", portalItem.id);
  })
  .catch(function(error) {
    console.error("Error saving to portal", error);
  });

: The utilityNetworks object contains a collection of UtilityNetworks saved on the web map.

: The widgets object contains widgets that are exposed to the user.

Method Overview

Show inherited methods Hide inherited methods

Method Details

add Inherited Method add(layer, index)

Adds a layer to the layers collection. The before-changes, before-add, after-add, after-changes and change events will be emitted when this method is called.

Parameters

Layer or a promise that resolves to a layer to add to the layers collection.

optional

A layer can be added at a specified index in the layers collection. If no index is specified or the index specified is greater than the current number of layers, the layer is automatically appended to the list of layers in the layers collection and the index is normalized.

Example

// add() and push methods can be used
// to add a layer to layers collection

// add a layer to layers collection using add
map.add(layer);

// add a layer at the end of layers collection
map.layers.push(layer);

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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();

Parameters

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.

addMany Inherited Method addMany(layers, index)

Parameters

Layer(s) to be added to the layers collection.

optional

Example

// addMany and push methods can be used
// to add layers to layers collection

// add an array of layers to layers collection using addMany
map.addMany([layer, layer2]);

// add layers to layers collection using push method
map.layers.push(layer, layer2);

destroy Inherited Method destroy() Since: ArcGIS Maps SDK for JavaScript 4.17 WebDocument2D since 4.31, destroy added at 4.17.

Destroys the webmap, and any associated resources, including its layers, basemap, ground, tables, and portalItem. These can no longer be used once the map has been destroyed. To prevent these objects from being destroyed, remove them from the webmap before calling destroy().

// prevent the layers from being destroyed by removing them from the webmap
const layers = webmap.layers.removeAll();

// prevent the tables from being destroyed by removing them from the webmap
const tables = webmap.tables.removeAll();

// unset basemap from the webmap so that it is not destroyed
const basemap = webmap.basemap;
webmap.basemap = null;

// unset portalItem from the webmap so that it is not destroyed
const portalItem = webmap.portalItem;
webmap.portalItem = null;

// prevent the utility networks from being destroyed by removing them from the webmap
const networks = webmap.utilityNetworks.removeAll();

// destroy the webmap and any remaining associated resources
webmap.destroy();

Returns a layer based on the given layer ID.

Parameter

The ID assigned to the layer.

Returns

Since: ArcGIS Maps SDK for JavaScript 4.18 Map since 4.0, findTableById added at 4.18.

Returns a table based on the given table ID.

Parameter

The ID assigned to the table.

Returns

fromJSON Method fromJSON(json){*}static Since: ArcGIS Maps SDK for JavaScript 4.12 WebMap since 4.0, fromJSON added at 4.12.

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. 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. If the WebMap is used outside of a view, you must call load() explicitly to interact with its resources. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter

A JSON representation of the instance in the ArcGIS format. See the web map specification for more detailed information on serializing web map to JSON.

Returns

Type Description * Returns a new instance of this class.

Example

// Retrieve a WebMap JSON by url and deserialize it into a WebMap API instance
const [esriRequest, WebMap] = await $arcgis.import(["@arcgis/core/request.js", "@arcgis/core/WebMap.js"]);
esriRequest("https://domain/url/to/webmap.json").then(function(json) {
  const webmap = WebMap.fromJSON(json);

  const view = new MapView({
    map: webmap,
    container: "viewDiv"
  });
});

hasHandles Inherited Method hasHandles(groupKey){Boolean} Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

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

isFulfilled Inherited Method isFulfilled(){Boolean}

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected Inherited Method isRejected(){Boolean}

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been rejected.

isResolved Inherited Method isResolved(){Boolean}

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been resolved.

load Inherited Method load(){Promise}

Triggers the loading of the WebMap instance.

A WebMap is considered loaded when its operational layers and basemap are fully created. When created with a portalItem, load() will first fetch its data to create the content, otherwise it resolves immediately.

The MapView automatically calls the load() method when a WebMap instance is added to its map property so it can display in the view and load each individual layer. If the WebMap is used outside of a view, for example to preload it, you must call load() explicitly to interact with its resources.

Returns

Type Description Promise Resolves when the WebMap is loaded.

Example

const WebMap = await $arcgis.import("@arcgis/core/WebMap.js");

const map = new WebMap({
  portalItem: {
    id: "e691172598f04ea8881cd2a4adaa45ba"
  }
});

map.load()
  .then(function() {
    // load the basemap to get its layers created
    return map.basemap.load();
  })
  .then(function() {
    // grab all the layers and load them
    const allLayers = map.allLayers;
    const promises = allLayers.map(function(layer) {
      return layer.load();
    });
    return Promise.all(promises.toArray());
  })
  .then(function(layers) {
    // each layer load promise resolves with the layer
    console.log("all " + layers.length + " layers loaded");
  })
  .catch(function(error) {
    console.error(error);
  });

Since: ArcGIS Maps SDK for JavaScript 4.9 WebDocument2D since 4.31, loadAll added at 4.9.

Loads all the externally loadable resources associated with the webmap. For the webmap this will load the ground, basemap and layers.

Returns

Type Description Promise<WebDocument2D> Resolves when all the loadable resources have been loaded. Rejects if at least one of the loadable resources failed to load.

Example

// Load all resources but ignore if one or more of them failed to load
webmap.loadAll()
  .catch(function(error) {
    // Ignore any failed resources
  })
  .then(function() {
    console.log("All loaded");
  });

removeHandles Inherited Method removeHandles(groupKey) Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

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

removeMany Inherited Method removeMany(layers){Layer[]}

Removes the specified layers. The before-changes, before-remove, after-remove, after-changes and change events will be emitted when this method is called.

Parameter

Array of layers to remove from the layers collection.

Returns

Type Description Layer [] Returns the layers removed from the layers collection.

Changes the layer order. The first layer added is always the base layer, even if its order is changed. The change event will be emitted when this method is called.

Parameters

The layer to be moved.

The index location for placing the layer. The bottom-most layer has an index of 0.

Returns

save Inherited Method save(options){Promise<PortalItem>} Since: ArcGIS Maps SDK for JavaScript 4.14 WebDocument2D since 4.31, save added at 4.14.

Saves the WebMap or WebLinkChart to its associated portal item. The portal item must already exist and be valid. This is a convenience method that will use update to store the WebMap / WebLinkChart in the item.

Use updateFrom to store the current view properties in the webmap before saving it.

Note that this saves the WebMap / WebLinkChart to its existing item. Depending on how it is shared, users that do not own the WebMap / WebLinkChart may be able to modify it. To save an existing WebMap / WebLinkChart as a new item owned by the user signed into the portal instance, use saveAs().

The WebMap / WebLinkChart will be automatically loaded if it is not already before saving.

Wait until each save() operation has resolved before starting a new save() operation to avoid a potential abort-error.

Known Limitations

Feature collections and multi-layer feature collections cannot currently be saved.

Parameters

optional

Additional options.

Specification

optional

When true, the WebMap / WebLinkChart will save even if it contains unsupported content (layers, renderers, symbols). Any content that is not supported will not be saved and the webmap may appear different when reloaded from its portal item.

Returns

Type Description Promise<PortalItem> A promise that resolves with the PortalItem instance when the item has successfully been saved, or rejected otherwise.

Example

webmap.updateFrom(view)
  .then(function() {
    return webmap.save();
  })
  .then(function(portalItem) {
    console.log("Saved to portal", portalItem.id);
  })
  .catch(function(error) {
    console.error("Error saving to portal", error);
  });

saveAs Inherited Method saveAs(portalItem, options){Promise<PortalItem>} Since: ArcGIS Maps SDK for JavaScript 4.14 WebDocument2D since 4.31, saveAs added at 4.14.

Saves the WebMap or WebLinkChart to a new portal item. If saving has completed successfully, then the saved portal item will be set in the portalItem property of the WebMap / WebLinkChart. This is a convenience method that will create a new PortalItem and use PortalUser.addItem() to store the WebMap / WebLinkChart in a Portal.

Use updateFrom to store the current view properties in the WebMap / WebLinkChart before saving it.

Note that this always saves the WebMap / WebLinkChart as a new portal item owned by the user signed into the portal instance that executes the saveAs() method. If you want to modify an existing item without changing its ownership, use save().

The WebMap / WebLinkChart will be automatically loaded if it is not already before saving.

Wait until each saveAs() operation has resolved before starting a new saveAs() operation to avoid a potential abort-error.

Known Limitations

Feature collections and multi-layer feature collections cannot currently be saved.

Parameters

Specification

The new portal item to which the WebMap / WebLinkChart will be saved.

Portal item properties such as the title or description need to be explicitly set on the item and will not be automatically copied from the current associated WebMap / WebLinkChart portal item (if any).

optional

Additional save options.

Specification

optional

The folder in which to save the item.

optional

Allow the WebMap / WebLinkChart to be saved even in the case it contains unsupported content (layers, renderers, symbols). Any content that is not supported will not be saved and the webmap may appear different when reloaded from its portal item.

Returns

Type Description Promise<PortalItem> A promise that resolves with the PortalItem instance when the item has successfully been saved, or rejected otherwise.

Example

const webmap = new WebMap();
// Use updateFrom to store the current view properties
// in the webmap before saving it
webmap.updateFrom(view);
webmap.saveAs({
  // autocasts as new PortalItem()
  title: "New WebMap"
});

updateFrom Inherited Method updateFrom(view, options){Promise} Since: ArcGIS Maps SDK for JavaScript 4.14 WebDocument2D since 4.31, updateFrom added at 4.14.

Parameters

Specification

The view to update from.

optional

Update options.

Specification

optional

When true, the view's background will not be updated for the webmap. The default is false meaning the background will be updated for the webmap if there is a background.

optional

When true, the initial viewpoint of the view will not be updated for the webmap. Defaults to false, meaning the viewpoint will be updated for the webmap. Must set scalePreserved to true if the view's scale should be updated for the webmap.

optional

When true, the view's scale will be updated for the webmap. Defaults to false meaning view's scale will not be updated for the webmap. It is ignored when viewpointExcluded is true.

optional

When true, the thumbnail will not be updated for the webmap. Defaults to false meaning the thumbnail will be updated for the webmap.

optional

The size of the thumbnail. Defaults to 600x400 (ratio 1.5:1). Note that the thumbnail size may currently not be larger than the size of the view.

Specification

The width of the thumbnail.

The height of the thumbnail.

optional

When true, the webmap's widgets property will not be updated. When false, the definition of the first TimeSlider assigned to the View will be used to update the WebMap.widgets property. The default value is false.

Returns

Type Description Promise Resolves when the update has completed.

when Inherited Method when(callback, errback){Promise} Since: ArcGIS Maps SDK for JavaScript 4.6 WebDocument2D since 4.31, when added at 4.6.

when() 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 instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters

optional

The function to call when the promise resolves.

optional

The function to execute when the promise fails.

Returns

Type Description Promise Returns 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 when() in the same way
let view = new MapView();
view.when(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
});

Type Definitions

FloorFilter Type Definition FloorFilter Accessor

Floor filtering is controlled by a configurable floor filter. Those configurations are saved to the web map as a Floor Filter widget.

Properties

Indicates whether the FloorFilter is active and filtering the displayed content according to the FloorFilter selection.

Indicates whether the levels list is showing the long names from longNameField.

Indicates whether the floor filter has been minimized to show only the levels list.

Indicates whether the levels portion of the floor filter has been pinned to show the levels list.

Contains the site ID for the initially selected site in the floor filter.

Contains the facility ID for the initially selected facility in the floor filter.

Contains the level ID for the initially selected floor, which is used when filtering layers by their configured floor-aware properties.

: The widgets object contains widgets that are exposed to the user.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4