ESM: import WebLinkChart from "@arcgis/core/WebLinkChart.js";
CDN: const WebLinkChart = await $arcgis.import("@arcgis/core/WebLinkChart.js");
Class: @arcgis/core/WebLinkChart
Since: ArcGIS Maps SDK for JavaScript 4.31
The WebLinkChart class contains properties and methods for storing, managing, and overlaying layers in a link chart. Layers can be added and removed from the link chart, but are rendered via a LinkChartView. Thus a WebLinkChart instance is a container that holds the LinkChartLayer, while the LinkChartView is the means of displaying it.
A WebLinkChart also loads a WebLinkChart from an ArcGIS Enterprise portal into a LinkChartView. To load a WebLinkChart from an ArcGIS Enterprise portal into a LinkChartView, you must reference the ID of the WebLinkChart in the portalItem property of this class.
// Load the WebLinkChart and LinkChartView modules
const [LinkChart, LinkChartView, LinkChartLayer] = await $arcgis.import([
"@arcgis/core/WebLinkChart".js,
"@arcgis/core/views/LinkChartView.js",
"@arcgis/core/layers/LinkChartLayer.js"
]);
// Create a WebLinkChart instance
const myLinkChart = new WebLinkChart({
portalItem: { // autocasts as new PortalItem()
id: "e691172598f04ea8881cd2a4adaa45ba"
}
});
// Create a LinkChartView instance and reference the WebLinkChart instance
const view = new LinkChartView({
map: myLinkChart,
container: 'viewDiv'
});
A LinkChartLayer can also be created from a knowledgeGraphService and added to a WebLinkChart. The entire graph can be added to the link chart or a subset of the records in the graph can be included in the layer by specifying the initializationInclusionModeDefinition.
//create a link chart layer from a knowledge graph service with an inclusion definition
// constructing an inclusion list:
// The exact record ids of each of the records of a specific named type (entity type or relationship type)
// to include in the layer. In this case the layer will contain one record
const layerInclusionMemberDefinition = new Map();
layerInclusionMemberDefinition.set("{1A4W8G4-W52G-W89G-1W5G-J1R4S8H52H4S}",{id:"{1A4W8G4-W52G-W89G-1W5G-J1R4S8H52H4S}"})
//The layerInclusionDefinition specifies whether to use all of the data in a named type or only the records
// specified in the 'members' list. In this case we only want the records specified.
const layerInclusionDefinition = {
useAllData: false, //only include instances in the member list
members: layerInclusionMemberDefinition
};
// The namedTypeDefinition is a map of the typeName of each type to be included.
// In this case we are only including the "Observation" entity type.
// The layerInclusionDefinition specifies exactly which "Observation" entities to include in the layer.
const namedTypeDefinition = new Map();
namedTypeDefinition.set("Observation", layerInclusionDefinition);
// Specify if a sublayer should be generated for all named types.
// If true, a sublayer will be created for all named types regardless of
// whether they have a list of instances to include or not.
// If there are no instances the sublayer will be empty. In this case we have set 'generateAllSubLayers' to false so the
// layer will only contain sublayers for the named types (entity types or relationship types) that are specified
// in the namedTypeDefinitions.
// Also defines the collection of named types to include in the layer.
const inclusionListDefinition = {
generateAllSublayers: false, //only create sublayers for the named types in the namedTypeDefinition
namedTypeDefinitions: namedTypeDefinition
}
//create the link chart layer with the inclusion definintion
const myLinkChartLayer = new LinkChartLayer({
title: "link chart layer",
url: "https://sampleserver7.arcgisonline.com/arcgis/rest/services/Hosted/SmallBumbleBees/KnowledgeGraphServer",
initializationInclusionModeDefinition: inclusionListDefinition
});
//add the layer to a new link chart
myLinkChartLayer.load().then(()=>{
const myLinkChart = new WebLinkChart({
layers: [myLinkChartLayer]
});
// Create a LinkChartView instance and reference the WebLinkChart instance
const view = new LinkChartView({
map: myLinkChart,
container: 'viewDiv'
});
})
new WebLinkChart(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsExample
// 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"));
}
);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.
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";
});The applicationProperties contains the viewing properties of the WebMap.
The name of the application that authored the WebMap.
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:
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
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.
Inherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className.
Since: ArcGIS Maps SDK for JavaScript 4.32 WebLinkChart since 4.31, diagramNodesExtent added at 4.32.
The extent of the current layout.
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.
entityCount Numberreadonly
Since: ArcGIS Maps SDK for JavaScript 4.32 WebLinkChart since 4.31, entityCount added at 4.32.
The number of entities in the link chart.
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.
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.32 WebLinkChart since 4.31, knowledgeGraph added at 4.32.
The knowledge graph service containing the data displayed in the link chart.
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.
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"
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.
mapType String
The map type. Will always be "webLinkChart".
For WebLinkChart the mapType is always "webLinkChart".
The portal item from which the WebMap is loaded.
relationshipCount Numberreadonly
Since: ArcGIS Maps SDK for JavaScript 4.32 WebLinkChart since 4.31, relationshipCount added at 4.32.
The number of relationship in the link chart.
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:
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.
layers property in either Map or WebMap classesExamples
// 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);
});
});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 widgets object contains widgets that are exposed to the user.
Show inherited methods Hide inherited methods
Method DetailsInherited
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.
optionalA 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);Inherited
Method addHandles(handleOrHandles, groupKey)
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 *
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.
Inherited
Method addMany(layers, index)
Parameters
Layer(s) to be added to the layers collection.
optionalA 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
// 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); addRecords(records, options){Promise<void>}
Since: ArcGIS Maps SDK for JavaScript 4.32 WebLinkChart since 4.31, addRecords added at 4.32.
Adds records to the link chart layer, given an array of paired ids and named types for each record to add.
Parameters
Specification
An array of objects with an id and named type to be added to the link chart.
optionalAdditional options that can be set when adding records.
Specification
cascadeAddRelationshipEndNodes Boolean optionalIf set to true, adding a relationship will also add it's origin and destination entities.
optionalAbort signal to stop the operation.
Returns
Type Description Promise<void>Example
const newRecords = [{ id: "{A0F6BF5F-6CA8-49CB-B47E-165CEC47CA4E}", typeName: "Observation" }]
webLinkChart.addRecords(newRecords) applyLayout(layoutMode, options){Promise<void>}
Since: ArcGIS Maps SDK for JavaScript 4.32 WebLinkChart since 4.31, applyLayout added at 4.32.
Change the layout applied to the link chart. Link chart layouts fall into different categories depending on how they organize entities and relationships in the link chart.
See layout types for a description of the different layout algorithms.
Parameters
Specification
The layout applied to the link chart.
Possible Values:"organic-standard"|"organic-community"|"basic-grid"|"hierarchical-bottom-to-top"|"radial-root-centric"|"tree-left-to-right"|"geographic-organic-standard"|"chronological-mono-timeline"|"chronological-multi-timeline"
optionalSpecification
optionalAdditional settings for organic layouts (particularly geographic layout) and chronological layouts. If not specified, then the current layout settings will be used.
optionalA map of node IDs to their locked locations. Specify the location of specific entities. When the layout is recalculated these entities are placed at the specified location.
Returns
Type Description Promise<void> changeNonspatialDataDisplay(mode){void}
Since: ArcGIS Maps SDK for JavaScript 4.32 WebLinkChart since 4.31, changeNonspatialDataDisplay added at 4.32.
Indicates whether the nonspatial data on the link chart is visible. Link charts can contain both spatial and nonspatial records. Spatial records are entities with geometry and relationships that connect two spatial entities (both the relationship origin and destination entities have geometry). Nonspatial records are entities without geometry (even if they are a member of a spatially enabled entity type) and relationships that have at least one endpoint with no geometry.
Parameter
A map with a key of the named Type and the list of Identifiers to be added
Possible Values:"hidden"|"visible"
Returns
connectBetweenEntities(entityIds, options){Promise<IdTypePair[]>}
Since: ArcGIS Maps SDK for JavaScript 4.32 WebLinkChart since 4.31, connectBetweenEntities added at 4.32.
Connect between entities adds any existing direct relationships between the selected entities.
Parameters
List of entity ids on the link chart to find direct relationships between.
optionalAdditional options for the connect request.
Returns
Type Description Promise<IdTypePair[]> An array of objects representing the relationships added to connect the entities connectFromEntities(entityIds, options){Promise<IdTypePair[]>}
Since: ArcGIS Maps SDK for JavaScript 4.32 WebLinkChart since 4.31, connectFromEntities added at 4.32.
Connect from entities adds any existing direct relationships between the specified entities and any other entities in the link chart.
Parameters
List of entity ids on the link chart to find direct relationships to any other entities on the link chart.
optionalAdditional options for the connect request.
Returns
Type Description Promise<IdTypePair[]> An array of objects representing the relationships added to connect the entitiesParameter
The name of the named type to create a sublayer for
Returns
Type Description Promise<KnowledgeGraphSublayer>Inherited
Method destroy()
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();
expand(nodeIds, options){Promise<IdTypePair[]>}
Since: ArcGIS Maps SDK for JavaScript 4.32 WebLinkChart since 4.31, expand added at 4.32.
Given a list of entity IDs to expand from, will attempt to retrieve all one-hop connected entities and the connecting relationships. If relationship named types are given, the expand will only look for entities connected by the specified relationship types. Note: the starting nodes must already exist in the link chart layer.
Parameters
Specification
Array of entity IDs to expand from.
optionalAdditional options for the expand request.
Returns
Type Description Promise<IdTypePair[]>Returns a layer based on the given layer ID.
Parameter
The ID assigned to the layer.
Returns
Returns a table based on the given table ID.
Parameter
The ID assigned to the table.
Returns
getMemberIdsByType(typeName){String[]}
Since: ArcGIS Maps SDK for JavaScript 4.32 WebLinkChart since 4.31, getMemberIdsByType added at 4.32.
Retrieve the record IDs for all instances of a specified named type in the link chart.
Parameter
The named type to get the member ids for
Returns
Type Description String[]Inherited
Method hasHandles(groupKey){Boolean}
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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
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).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.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.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);
});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");
}); refreshLinkChartData(ids){Promise<void>}
Since: ArcGIS Maps SDK for JavaScript 4.32 WebLinkChart since 4.31, refreshLinkChartData added at 4.32.
Refreshes the data in the link chart. If an entity or relationship in the link chart no longer exists in the graph it will be removed. Updates any properties on the records in the link chart. Optionally specify a subset of ids to only update the data for a specific set of records.
Parameter
optionalList of specific entities and relationships to update.
Returns
Type Description Promise<void>Inherited
Method removeHandles(groupKey)
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA 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");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. removeRecords(records, options){Promise<IdTypePair[]>}
Since: ArcGIS Maps SDK for JavaScript 4.32 WebLinkChart since 4.31, removeRecords added at 4.32.
Removes records from the link chart layer. Does not delete them from the knowledge graph.
Parameters
An array of objects with an id and named type to be removed from the link chart.
optionalAdditional options that can be set when removing records.
Returns
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.
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.
Parameters
The layer to be moved.
The index location for placing the layer. The bottom-most layer has an index of 0.
Returns
Inherited
Method save(options){Promise<PortalItem>}
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
Parameters
optionalAdditional options.
Specification
optionalWhen 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);
});Inherited
Method saveAs(portalItem, options){Promise<PortalItem>}
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
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).
Additional save options.
Specification
optionalThe folder in which to save the item.
optionalAllow 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"
});Inherited
Method updateFrom(view, options){Promise}
Parameters
Specification
The view to update from.
optionalUpdate options.
Specification
optionalWhen 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.
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.
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.
When true, the thumbnail will not be updated for the webmap. Defaults to false meaning the thumbnail will be updated for the webmap.
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.
optionalWhen 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.Inherited
Method when(callback, errback){Promise}
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
optionalThe function to call when the promise resolves.
optionalThe function to execute when the promise fails.
Returns
Type Description Promise Returns a new promise for the result ofcallback 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
}); GeneralOptions Object
General options for web link chart methods.
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