ESM: import IntegratedMeshLayer from "@arcgis/core/layers/IntegratedMeshLayer.js";
CDN: const IntegratedMeshLayer = await $arcgis.import("@arcgis/core/layers/IntegratedMeshLayer.js");
Class: @arcgis/core/layers/IntegratedMeshLayer
Since: ArcGIS Maps SDK for JavaScript 4.1
The IntegratedMeshLayer is designed for visualizing accurate representations of built and natural environments in a SceneView.
Integrated mesh data is typically captured by an automated process for constructing 3D objects from large sets of overlapping imagery. The result integrates the original input image information as a realistic textured mesh and can include elevation information and 3D objects, such as buildings and trees. Integrated mesh layers are generally created for citywide 3D mapping; they are often captured by drone and cannot be restyled.
The Scene Service is identified by the URL of the ArcGIS Server REST resource:
IntegratedMeshLayer = new IntegratedMeshLayer({
url: "https://tiles.arcgis.com/tiles/u0sSNqDXr7puKJrF/arcgis/rest/services/Frankfurt2017_v17/SceneServer/layers/0"
});
If the service is requested from a different domain, a CORS enabled server or a proxy is required.
Constructors new IntegratedMeshLayer(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 DetailsSince: ArcGIS Maps SDK for JavaScript 4.20 IntegratedMeshLayer since 4.1, apiKey added at 4.20.
An authorization string used to access a resource or service. This property will append the API key to all requests made by the layer to the service. API keys are generated and managed in the portal. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage. Setting a fine-grained API key on a specific class overrides the global API key.
If loading a secure layer with API authentication via a PortalItem, the API key needs to be set on the portalItem.
Example
// set the api key to access a protected service
const layer = new FeatureLayer({
url: serviceUrl,
apiKey: "YOUR_API_KEY"
});The copyright text as defined by the scene service.
Since: ArcGIS Maps SDK for JavaScript 4.18 IntegratedMeshLayer since 4.1, customParameters added at 4.18.
A list of custom parameters appended to the URL of all resources fetched by the layer. It's an object with key-value pairs where value is a string. The layer's refresh() method needs to be called if the customParameters are updated at runtime.
Example
// send a custom parameter to your special service
let layer = new MapImageLayer({
url: serviceUrl,
customParameters: {
"key": "my-special-key"
}
});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.5 IntegratedMeshLayer since 4.1, elevationInfo added at 4.5.
Specifies how the mesh is placed on the vertical axis (z). This property only affects IntegratedMeshLayers when using the absolute-height mode. Integrated mesh layers always render in front of the ground surface, so setting negative offset values will not render them below the ground.
Defines how the mesh is placed on the vertical axis (z). Currently only absolute-height is supported.
offset value and the mesh's z-value. It doesn't take the elevation of the terrain into account. This is the only supported elevation mode for an IntegratedMeshLayer.
The value is always "absolute-height".
offset Number|null|undefinedAn elevation offset, which is added to the vertical position of the mesh.
unit ElevationUnit|null|undefinedThe unit for offset values.
The full extent of the layer. By default, this is worldwide. This property may be used to set the extent of the view to match a layer's extent so that its features appear to fill the view. See the sample snippet below.
Example
// Once the layer loads, set the view's extent to the layer's fullextent
layer.when(function(){
view.extent = layer.fullExtent;
});Inherited
Property id String
The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded.
layerId Number
The layer ID, or layer index, of a Scene Service layer. This is particularly useful when loading a single layer with the portalItem property from a service containing multiple layers. You can specify this value in one of two scenarios:
If a layerId is not specified in either of the above scenarios, then the first layer in the service (layerId = 0) is selected.
Examples
// while these examples use a SceneLayer, the same pattern can be
// used for other layers that may be loaded from portalItem ids
// loads the third layer in the given Portal Item
let layer = new SceneLayer({
portalItem: {
id: "73df987984b24094b848d580eb83b0fb"
},
layerId: 2
});// If not specified, the first layer (layerId: 0) will be returned
let layer = new SceneLayer({
portalItem: {
id: "73df987984b24094b848d580eb83b0fb"
}
});// Can also be used if URL points to service and not layer
let layer = new SceneLayer({
url: "https://scenesampleserverdev.arcgis.com/arcgis/rest/services/Hosted/DevA_Trees/SceneServer",
layerId: 0 // Notice that the url doesn't end with /2
});// This code returns the same layer as the previous snippet
let layer = new SceneLayer({
url: "https://scenesampleserverdev.arcgis.com/arcgis/rest/services/Hosted/DevA_Trees/SceneServer/layers/0",
// The layer id is specified in the URL
});Inherited
Property listMode String
Indicates how the layer should display in the LayerList widget. The possible values are listed below.
Possible Values:"show" |"hide" |"hide-children"
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 loadWarnings Object[]readonly
A list of warnings which occurred while loading.
Inherited
Property loaded Booleanreadonly
Indicates whether the layer's resources have loaded. When true, all the properties of the object can be accessed.
maxScale Number
The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. The maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.
Examples
// The layer will not be visible when the view is zoomed in beyond a scale of 1:1,000
layer.maxScale = 1000;// The layer's visibility is not restricted to a maximum scale.
layer.maxScale = 0; minScale Number
The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum scale. The minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification.
Examples
// The layer will not be visible when the view is zoomed out beyond a scale of 1:3,000,000
layer.minScale = 3000000;// The layer's visibility is not restricted to a minimum scale.
layer.minScale = 0;Since: ArcGIS Maps SDK for JavaScript 4.16 IntegratedMeshLayer since 4.1, modifications added at 4.16.
A SceneModification collection used to apply client-side modifications to the layer. These modifications are not affected by the offset from elevationInfo. Modifications are persisted when using WebScene.save(), which allows you to share the modified integrated mesh through web scenes. The following types of modifications can be applied to the integrated mesh:
Scene modifications need to be in the same spatial reference as the layer they modify. Reprojection between WGS84 and WebMercator will be done automatically. Reprojection of the geometry to other spatial references can be done with the client-side projection engine.
Example
// create the IntegratedMeshLayer
const layer = new IntegratedMeshLayer({ ... })
// create a polygon
const polygon = new Polygon({ ... });
// create the modifications
let modifications = new SceneModifications(
[
new SceneModification({geometry: polygon, type: 'replace'})
]);
// add the modification to the IntegratedMesh
layer.modifications = modifications;Since: ArcGIS Maps SDK for JavaScript 4.27 Layer since 4.0, parent added at 4.27.
The parent to which the layer belongs.
persistenceEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.28 IntegratedMeshLayer since 4.1, persistenceEnabled added at 4.28.
The portal item from which the layer is loaded. If the portal item references a feature or scene service, then you can specify a single layer to load with the layerId property.
Examples
// While this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids.
const layer = new FeatureLayer({
portalItem: { // autocasts as new PortalItem()
id: "caa9bd9da1f4487cb4989824053bb847"
} // the first layer in the service is returned
});// Set hostname when using an on-premise portal (default is ArcGIS Online)
// esriConfig.portalUrl = "http://myHostName.esri.com/arcgis";
// While this example uses FeatureLayer, this same pattern can be
// used for SceneLayers.
const layer = new FeatureLayer({
portalItem: { // autocasts as new PortalItem()
id: "8d26f04f31f642b6828b7023b84c2188"
},
// loads the third item in the given feature service
layerId: 2
});// Initialize GeoJSONLayer by referencing a portalItem id pointing to geojson file.
const layer = new GeoJSONLayer({
portalItem: new PortalItem({
id: "81e769cd7031482797e1b0768f23c7e1",
// optionally define the portal, of the item.
// if not specified, the default portal defined is used.
// see https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl
portal: new Portal({
url: "https://jsapi.maps.arcgis.com/"
})
}
});// This snippet loads a table hosted in ArcGIS Online.
const table = new FeatureLayer({
portalItem: { // autocasts as esri/portal/PortalItem
id: "123f4410054b43d7a0bacc1533ceb8dc"
}
});
// Before adding the table to the map, it must first be loaded and confirm it is the right type.
table.load().then(() => {
if (table.isTable) {
map.tables.add(table);
}
});// While this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids.
const layer = new FeatureLayer({
portalItem: { // autocasts as esri/portal/PortalItem
id: "caa9bd9da1f4487cb4989824053bb847",
// Set an API key to access a secure portal item configured with API key authentication.
apiKey: "APIKEY"
}
});The spatial reference of the layer.
The title of the layer used to identify it in places such as the LayerList widget.
When loading a layer by service url, the title is derived from the service name. If the service has several layers, then the title of each layer will be the concatenation of the service name and the layer name. When the layer is loaded from a portal item, the title of the portal item will be used instead. Finally, if a layer is loaded as part of a webmap or a webscene, then the title of the layer as stored in the webmap/webscene will be used.
Inherited
Property uid Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.33 Layer since 4.0, uid added at 4.33.
An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.
The URL of the REST endpoint of the layer or scene service. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online.
The layer may be specified using the layerId property when the url points directly to a service and not a specific layer. If layerId is not specified, then it will default to the first layer in the service.
Examples
// Layer from Scene Service on ArcGIS Server
let sceneLayer = new SceneLayer({
url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Paris_3D_Local_WSL2/SceneServer/layers/0"
});// Can also be used if URL points to service and not layer
let layer = new SceneLayer({
// Notice that the url doesn't end with /0
url: "https://scenesampleserverdev.arcgis.com/arcgis/rest/services/Hosted/DevA_Trees/SceneServer",
layerId: 0
}); version Objectreadonly
The version of the scene service specification used for this service.
The major version of the scene layer.
The minor version of the scene layer.
The complete version string of the scene layer.
Example
// Prints the version to the console - e.g. 1.4, 1.5, etc.
console.log(layer.version.versionString);Since: ArcGIS Maps SDK for JavaScript 4.30 Layer since 4.0, visibilityTimeExtent added at 4.30.
Specifies a fixed time extent during which a layer should be visible. This property can be used to configure a layer that does not have time values stored in an attribute field to work with time. Once configured, the TimeSlider widget will display the layer within the set time extent. In the case that only one of the start or end date values are available, the layer remains visible indefinitely in the direction where there is no time value.
Aerial imagery can capture seasonal variations in vegetation, water bodies, and land use patterns. For example, in agricultural regions, aerial imageries taken during different growing seasons provide insights into crop health and productivity. Defining a fixed time extent on imageries from specific time periods provides temporal context and facilitates focused analysis based on specific time periods or events.
Inherited
Property visible Boolean
Indicates if the layer is visible in the View. When false, the layer may still be added to a Map instance that is referenced in a view, but its features will not be visible in the view.
Example
// The layer is no longer visible in the view
layer.visible = false;
// Watch for changes in the layer's visibility
// and set the visibility of another layer when it changes
reactiveUtils.watch(
() => layer.visible,
(visible) => {
if (visible) {
anotherLayer.visible = true;
} else {
anotherLayer.visible = false;
}
}
);Show inherited methods Hide inherited methods
Method DetailsInherited
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 *
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 cancelLoad()
Cancels a load() operation if it is already in progress.
Inherited
Method createLayerView(view, options){Promise<LayerView>}
Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it. This method is used internally and there is no use case for invoking it directly.
Parameters
view *
The parent view.
optionalAn object specifying additional options. See the object specification table below for the required properties of this object.
Returns
Inherited
Method destroy()
Since: ArcGIS Maps SDK for JavaScript 4.17 Layer since 4.0, destroy added at 4.17.
Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer). The layer can no longer be used once it has been destroyed.
The destroyed layer will be removed from its parent object like Map, WebMap, WebScene, Basemap, Ground, or GroupLayer.
Inherited
Method emit(type, event){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.5 Layer since 4.0, emit added at 4.5.
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameters
The name of the event.
optionalThe event payload.
Returns
Type Description Booleantrue if a listener was notified
Inherited
Method fetchAttributionData(){Promise<Object>}
Fetches custom attribution data for the layer when it becomes available.
Returns
Type Description Promise<Object> Resolves to an object containing custom attribution data for the layer.Inherited
Method hasEventListener(type){Boolean}
Indicates whether there is an event listener on the instance that matches the provided event name.
Returns
Type Description Boolean Returns true if the class supports the input event.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 *
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(options){Promise}
Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.
This method must be called by the developer when accessing a resource that will not be loaded in a View.
The load() method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.
It's possible to provide a signal to stop being interested into a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.
Parameters
optionalAdditional options.
Specification
optionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.
Returns
Type Description Promise Resolves when the resources have loaded.Inherited
Method on(type, listener){Object}
Registers an event handler on the instance. Call this method to hook an event with a listener.
Returns
Type Description Object Returns an event handler with aremove() method that should be called to stop listening for the event(s). Property Type Description remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){
// event is the event handle returned after the event fires.
console.log(event.mapPoint);
});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 *
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");Since: ArcGIS Maps SDK for JavaScript 4.31 IntegratedMeshLayer since 4.1, save added at 4.31.
Saves the layer to its existing portal item in the Portal authenticated within the user's current session. If the layer is not saved to a PortalItem, then you should use saveAs.
Returns
Type Description Promise<PortalItem> When resolved, returns the portal item to which the layer is saved.Example
const portalItem = await layer.save(); saveAs(portalItem, options){Promise<PortalItem>}
Since: ArcGIS Maps SDK for JavaScript 4.31 IntegratedMeshLayer since 4.1, saveAs added at 4.31.
Saves the layer to a new portal item in the Portal authenticated within the user's current session.
Parameters
The portal item to which the layer will be saved.
optionaladditional save options
Specification
optionalthe folder where to save the item.
Returns
Type Description Promise<PortalItem> When resolved, returns the portal item to which the layer is saved.Example
const portalItem = new PortalItem();
await layer.saveAs(portalItem);Inherited
Method when(callback, errback){Promise}
Since: ArcGIS Maps SDK for JavaScript 4.6 Layer since 4.0, 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
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
});Show inherited events Hide inherited events
Event DetailsInherited
Event layerview-create
Fires after the layer's LayerView is created and rendered in a view.
The view in which the layerView was created.
The LayerView rendered in the view representing the layer in layer.
Example
// This function will fire each time a layer view is created for this
// particular view.
layer.on("layerview-create", function(event){
// The LayerView for the layer that emitted this event
event.layerView;
});Inherited
Event layerview-create-error
Fires when an error emits during the creation of a LayerView after a layer has been added to the map.
The view that failed to create a layerview for the layer emitting this event.
An error object describing why the layer view failed to create.
Example
// This function fires when an error occurs during the creation of the layer's layerview
layer.on("layerview-create-error", function(event) {
console.error("LayerView failed to create for layer with the id: ", layer.id, " in this view: ", event.view);
});Inherited
Event layerview-destroy
Fires after the layer's LayerView is destroyed and no longer renders in a view.
The view in which the layerView was destroyed.
The destroyed LayerView representing the layer.
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