PointCloudLayer

AMD: require(["esri/layers/PointCloudLayer"], (PointCloudLayer) => { /* code goes here */ });
ESM: import PointCloudLayer from "@arcgis/core/layers/PointCloudLayer.js";
Class: esri/layers/PointCloudLayer
Inheritance: PointCloudLayer Layer Accessor
Since: ArcGIS Maps SDK for JavaScript 4.2

The PointCloudLayer is designed for visualizing large collections of points in a SceneView.

Point cloud data is post-processed spatially organized lidar data that consists of large collections of 3D points. Elevations for the ground, buildings, forest canopy, highway overpasses, and anything else captured during the lidar survey make up the point cloud data. This layer type creates fast visualizations of point cloud data in the browser.

pointcloudlayer

The Scene Service is identified by the URL of the ArcGIS Server REST resource:

let pointCloudLayer = new PointCloudLayer({
  url: "https://tiles.arcgis.com/tiles/V6ZHFr6zdgNZuVG0/arcgis/rest/services/BARNEGAT_BAY_LiDAR_UTM/SceneServer"
});

If the point cloud service is requested from a different domain, a CORS enabled server or a proxy is required.

See also

Constructors

PointCloudLayer

Constructor
new PointCloudLayer(properties)
Parameter
properties Object
optional

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

Example
// Typical usage
let pointCloudLayer = new PointCloudLayer({
  url: "https://tiles.arcgis.com/tiles/V6ZHFr6zdgNZuVG0/arcgis/rest/services/BARNEGAT_BAY_LiDAR_UTM/SceneServer"
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

An authorization string used to access a resource or service.

PointCloudLayer
String

The copyright text as defined by the scene service.

PointCloudLayer
Object

A list of custom parameters appended to the URL of all resources fetched by the layer.

PointCloudLayer
String

The name of the class.

Accessor
Object

Specifies how points are placed on the vertical axis (z).

PointCloudLayer
Field[]

An array of fields accessible in the layer.

PointCloudLayer
FieldsIndex

A convenient property that can be used to make case-insensitive lookups for a field by name.

PointCloudLayer
Array<(PointCloudValueFilter|PointCloudReturnFilter)>

An array of pointCloudFilters used to filter points.

PointCloudLayer
Extent

The full extent of the layer.

Layer
String

The unique ID assigned to the layer.

Layer
Number

The layer ID, or layer index, of a Scene Service layer.

PointCloudLayer
Boolean

Indicates whether the layer will be included in the legend.

PointCloudLayer
String

Indicates how the layer should display in the LayerList widget.

Layer
Boolean

Indicates whether the layer's resources have loaded.

Layer
Error

The Error object returned if an error occurred while loading.

Layer
String

Represents the status of a load operation.

Layer
Object[]

A list of warnings which occurred while loading.

Layer
Number

The maximum scale (most zoomed in) at which the layer is visible in the view.

PointCloudLayer
Number

The minimum scale (most zoomed out) at which the layer is visible in the view.

PointCloudLayer
String[]

An array of field names from the service to include with each feature.

PointCloudLayer
Map|Basemap|Ground|GroupLayer

The parent to which the layer belongs.

Layer
Boolean

Enable persistence of the layer in a WebMap or WebScene.

PointCloudLayer
Boolean

Indicates whether to display popups when points in the layer are clicked.

PointCloudLayer
PopupTemplate

The popup template for the layer.

PointCloudLayer
PortalItem

The portal item from which the layer is loaded.

PointCloudLayer
PointCloudRenderer

The renderer assigned to the layer.

PointCloudLayer
SpatialReference

The spatial reference of the layer.

PointCloudLayer
String

The title of the layer used to identify it in places such as the Legend and LayerList widgets.

PointCloudLayer
String For PointCloudLayer the type is always "point-cloud". PointCloudLayer
String

The URL of the REST endpoint of the layer or scene service.

PointCloudLayer
Object

The version of the scene service specification used for this service.

PointCloudLayer
Boolean

Indicates if the layer is visible in the View.

Layer

Property Details

apiKey

Property
apiKey String
Since: ArcGIS Maps SDK for JavaScript 4.20 PointCloudLayer since 4.2, apiKey added at 4.20.

An authorization string used to access a resource or service. API keys are generated and managed in the ArcGIS Developer dashboard. 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.

Example
// set the api key to access a protected service
const layer = new FeatureLayer({
  url: serviceUrl,
  apiKey: "YOUR_API_KEY"
});
Property
copyright String

The copyright text as defined by the scene service.

customParameters

Property
customParameters Object
Since: ArcGIS Maps SDK for JavaScript 4.18 PointCloudLayer since 4.2, 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"
  }
});

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
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.

elevationInfo

Property
elevationInfo Object
Since: ArcGIS Maps SDK for JavaScript 4.4 PointCloudLayer since 4.2, elevationInfo added at 4.4.

Specifies how points are placed on the vertical axis (z). This property only affects PointCloudLayers when using the absolute-height mode.

Properties
mode String

Defines how the points are placed on the vertical axis (z). Currently only absolute-height mode is supported.

Mode Description
absolute-height Points are placed at an absolute elevation (z-value) above sea level. This z-value is determined by summing up the offset value and the point's z-value. It doesn't take the elevation of the terrain into account. This is the only supported elevation mode for a PointCloudLayer.

The value is always "absolute-height".

offset Number
optional
Default Value:0

An elevation offset, which is added to the vertical position of each point.

unit String
optional
Default Value:meters

The unit for offset values.

Possible Values:"feet"|"meters"|"kilometers"|"miles"|"us-feet"|"yards"

fields

Property
fields Field[]

An array of fields accessible in the layer. The most common fields for PointCloudLayers are described more in detail in the following table:

Name Comment
ELEVATION Check the LAS Specification for details.
INTENSITY Check the LAS Specification for details.
CLASS_CODE Get the list with the class label with PointCloudLayer.queryCachedStatistics.
RGB The individual RGB channels (uint8) are packed into a single uint32 value. See example for decode.
RETURNS Bits 0-5 for Return Number and Number of Returns. See example for decode.
FLAGS Check the LAS Specification for details.
Example
// decode the rgb value with Arcade:
var rgb = $feature.RGB;
var red = Floor(rgb/65536,0);
var green = Floor((rgb-(red*65536))/256,0);
var blue = rgb-(red*65536)-(green*256);
return "rgb(" + red + "," + green + "," + blue + ")";

// decode the returns value with Arcade:
var returnnumber = $feature.RETURNS % 16;
var numberofreturns = Floor($feature.RETURNS / 16)
return returnnumber + " / " + numberofreturns;

fieldsIndex

Property
fieldsIndex FieldsIndexreadonly
Since: ArcGIS Maps SDK for JavaScript 4.13 PointCloudLayer since 4.2, fieldsIndex added at 4.13.

A convenient property that can be used to make case-insensitive lookups for a field by name. It can also provide a list of the date fields in a layer.

Example
// lookup a field by name. name is case-insensitive
const field = layer.fieldsIndex.get("SoMeFiEld");

if (field) {
  console.log(field.name); // SomeField
}
Since: ArcGIS Maps SDK for JavaScript 4.10 PointCloudLayer since 4.2, filters added at 4.10.

An array of pointCloudFilters used to filter points. Only the points that satisfy all the filters are displayed in the view. There are two types of filters that can be set: PointCloudValueFilter filters points based on classification values and PointCloudReturnFilter filters points based on return values.

Example
// filter out points that don't belong to ground or building
const pcLayer = new PointCloudLayer({
  ...,
  filters: [{
    type: "value",
    field: "CLASS_CODE",
    mode: "include",
    // values include ground(2) and building(6)
    values: [2, 6]
  }]
});

fullExtent

Inherited
Property
fullExtent Extentautocast
Inherited from Layer

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

id

Inherited
Property
id String
Inherited from Layer

The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded.

layerId

Property
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:

  • When loading the layer via the portalItem property.
  • When pointing the layer url directly to the Scene Service.

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

legendEnabled

Property
legendEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.5 PointCloudLayer since 4.2, legendEnabled added at 4.5.

Indicates whether the layer will be included in the legend.

Default Value:true

listMode

Inherited
Property
listMode String
Inherited from Layer

Indicates how the layer should display in the LayerList widget. The possible values are listed below.

Value Description
show The layer is visible in the table of contents.
hide The layer is hidden in the table of contents.
hide-children If the layer is a GroupLayer, BuildingSceneLayer, KMLLayer, MapImageLayer, TileLayer or WMSLayer, hide the children layers from the table of contents.

Possible Values:"show"|"hide"|"hide-children"

Default Value:"show"

loaded

Inherited
Property
loaded Booleanreadonly
Inherited from Layer

Indicates whether the layer's resources have loaded. When true, all the properties of the object can be accessed.

Default Value:false

loadError

Inherited
Property
loadError Errorreadonly
Inherited from Layer

The Error object returned if an error occurred while loading.

Default Value:null

loadStatus

Inherited
Property
loadStatus Stringreadonly
Inherited from Layer

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

loadWarnings

Inherited
Property
loadWarnings Object[]readonly
Inherited from Layer

A list of warnings which occurred while loading.

maxScale

Property
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.

Default Value:0
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

Property
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.

Default Value:0
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;

outFields

Property
outFields String[]

An array of field names from the service to include with each feature. To fetch the values from all fields in the layer, use ["*"]. Fields specified in outFields will be requested alongside with required fields for rendering and filtering. The required fields and outFields are used to populate PointCloudLayerView.availableFields.

Default Value:null
See also
Examples
// Includes all fields from the service in the layer
pcl.outFields = ["*"];
// Get the specified fields from the service in the layer
// These fields will be added to FeatureLayerView.availableFields
// along with rendering and labeling fields. Use these fields
// for client-side filtering and querying.
pcl.outFields = ["ELEVATION", "RGB", "CLASS_CODE];

parent

Inherited
Property
parent Map|Basemap|Ground|GroupLayer
Inherited from Layer
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

Property
persistenceEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.28 PointCloudLayer since 4.2, persistenceEnabled added at 4.28.

Enable persistence of the layer in a WebMap or WebScene.

Default Value:true

popupEnabled

Property
popupEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.13 PointCloudLayer since 4.2, popupEnabled added at 4.13.

Indicates whether to display popups when points in the layer are clicked. The layer needs to have a popupTemplate to define what information should be displayed in the popup. Alternatively, a default popup template may be automatically used if Popup.defaultPopupTemplateEnabled is set to true.

Default Value:true
See also

popupTemplate

Property
popupTemplate PopupTemplateautocast
Since: ArcGIS Maps SDK for JavaScript 4.13 PointCloudLayer since 4.2, popupTemplate added at 4.13.

The popup template for the layer. When set on the layer, the popupTemplate allows users to access attributes and display their values in the view's popup when a feature is selected using text and/or charts. See the PointCloudLayer.fields for the most common attributes information. See the PopupTemplate sample for an example of how PopupTemplate interacts with a FeatureLayer. Setting a PopupTemplate on this layer type is done in the same way as a FeatureLayer.

A default popup template is automatically used if no popupTemplate has been defined when Popup.defaultPopupTemplateEnabled is set to true.

portalItem

Property
portalItem PortalItem

The portal item from which the layer is loaded. If the portal item references a Feature Service or Scene Service, then you can specify a single layer to load with the layerId property.

Beginning with version 4.17, it is possible to load tables from feature service items hosted in ArcGIS Online and ArcGIS Enterprise. This only applies to feature layers, and will successfully load if FeatureLayer.isTable returns true.

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(function() {
  if (table.isTable) {
    map.tables.add(table);
  }
});

renderer

Property
renderer PointCloudRendererautocast

The renderer assigned to the layer. The renderer defines how to visualize each point in the layer.

Example
// all points in the layer will be colorized with the RGB attribute
layer.renderer = {
  type: "point-cloud-rgb",  // autocasts as new PointCloudRGBRenderer()
  field: "RGB"
};

spatialReference

Property
spatialReference SpatialReferenceautocast

The spatial reference of the layer.

title

Property
title String

The title of the layer used to identify it in places such as the Legend and LayerList widgets.

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.

type

Property
type Stringreadonly

For PointCloudLayer the type is always "point-cloud".

url

Property
url String

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

Property
version Objectreadonly

The version of the scene service specification used for this service.

Properties
major Number

The major version of the scene layer.

minor Number

The minor version of the scene layer.

versionString String

The complete version string of the scene layer.

See also
Example
// Prints the version to the console - e.g. 1.4, 1.5, etc.
console.log(layer.version.versionString);

visible

Inherited
Property
visible Boolean
Inherited from Layer

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.

Default Value:true
Example
// The layer is no longer visible in the view
layer.visible = false;

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

Cancels a load() operation if it is already in progress.

Layer
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.

Layer
PopupTemplate

Creates a default popup template for the layer, populated with all the fields of the layer.

PointCloudLayer

Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer).

Layer
Boolean

Emits an event on the instance.

Layer
Promise<object>

Fetches custom attribution data for the layer when it becomes available.

Layer
Domain

Returns the Domain associated with the given field name.

PointCloudLayer
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

Layer
Boolean

Returns true if a named group of handles exist.

Accessor
Boolean

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

Layer
Boolean

isRejected() may be used to verify if creating an instance of the class is rejected.

Layer
Boolean

isResolved() may be used to verify if creating an instance of the class is resolved.

Layer
Promise

Loads the resources referenced by this class.

Layer
Object

Registers an event handler on the instance.

Layer
Object

Queries cached statistics from the service for a given field.

PointCloudLayer

Removes a group of handles owned by the object.

Accessor
Promise

when() may be leveraged once an instance of the class is created.

Layer

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
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
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

cancelLoad

Inherited
Method
cancelLoad()
Inherited from Layer

Cancels a load() operation if it is already in progress.

createLayerView

Inherited
Method
createLayerView(view, options){Promise<LayerView>}
Inherited from Layer

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.

options Object
optional

An object specifying additional options. See the object specification table below for the required properties of this object.

Specification
signal AbortSignal
optional

A signal to abort the creation of the layerview.

Returns
Type Description
Promise<LayerView> Resolves with a LayerView instance.

createPopupTemplate

Method
createPopupTemplate(options){PopupTemplate}
Since: ArcGIS Maps SDK for JavaScript 4.13 PointCloudLayer since 4.2, createPopupTemplate added at 4.13.

Creates a default popup template for the layer, populated with all the fields of the layer. The field CLASS_CODE is decoded with the category name. The field RGB describes rgb with decimal-codes. The field RETURNS is decoded with the number of returns out of total like (1/3), which shows number 1 out of 3.

Starting with version 4.28, date fields are formatted using the short-date-short-time preset dateFormat rather than long-month-day-year in popup templates created with the createPopupTemplate() method. For example, previously a date that may have appeared as "December 30, 1997" will now appear as "12/30/1997 6:00 PM".

Parameter
optional

Options for creating the popup template.

Returns
Type Description
PopupTemplate The popup template, or null if the layer does not have any fields.

destroy

Inherited
Method
destroy()
Inherited from Layer
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.

emit

Inherited
Method
emit(type, event){Boolean}
Inherited from Layer
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
type String

The name of the event.

event Object
optional

The event payload.

Returns
Type Description
Boolean true if a listener was notified

fetchAttributionData

Inherited
Method
fetchAttributionData(){Promise<object>}
Inherited from Layer

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.

getFieldDomain

Method
getFieldDomain(fieldName){Domain}
Since: ArcGIS Maps SDK for JavaScript 4.13 PointCloudLayer since 4.2, getFieldDomain added at 4.13.

Returns the Domain associated with the given field name. The domain can be either a CodedValueDomain or RangeDomain.

Parameter
fieldName String

Name of the field.

Returns
Type Description
Domain The Domain object associated with the given field name for the given feature.

hasEventListener

Inherited
Method
hasEventListener(type){Boolean}
Inherited from Layer

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter
type String

The name of the event.

Returns
Type Description
Boolean Returns true if the class supports the input event.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
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}
Inherited from Layer

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}
Inherited from Layer

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}
Inherited from Layer

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(signal){Promise}
Inherited from Layer

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.

Parameter
signal AbortSignal
optional

Signal 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.

on

Inherited
Method
on(type, listener){Object}
Inherited from Layer

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns
Type Description
Object Returns an event handler with a remove() 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);
});

queryCachedStatistics

Method
queryCachedStatistics(fieldName, options){Object}
Since: ArcGIS Maps SDK for JavaScript 4.13 PointCloudLayer since 4.2, queryCachedStatistics added at 4.13.

Queries cached statistics from the service for a given field. Check for the response details the I3S PointCloud Specification

Parameters
fieldName String

The name of the field to query statistics for.

options Object
optional

An object with the following properties.

Specification
signal AbortSignal
optional

Signal 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
Object The statistics document.
Example
layer.queryCachedStatistics("ELEVATION")
 .then(function(statistics) {
   console.log(statistics);
});

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
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");

when

Inherited
Method
when(callback, errback){Promise}
Inherited from Layer
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
callback Function
optional

The function to call when the promise resolves.

errback Function
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
});

Event Overview

Show inherited events Hide inherited events
Name Type Summary Class
{view: View,layerView: LayerView}

Fires after the layer's LayerView is created and rendered in a view.

Layer
{view: View,error: Error}

Fires when an error emits during the creation of a LayerView after a layer has been added to the map.

Layer
{view: View,layerView: LayerView}

Fires after the layer's LayerView is destroyed and no longer renders in a view.

Layer

Event Details

layerview-create

Inherited
Event
layerview-create
Inherited from Layer

Fires after the layer's LayerView is created and rendered in a view.

Properties
view View

The view in which the layerView was created.

layerView LayerView

The LayerView rendered in the view representing the layer in layer.

See also
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;
});

layerview-create-error

Inherited
Event
layerview-create-error
Inherited from Layer

Fires when an error emits during the creation of a LayerView after a layer has been added to the map.

Properties
view View

The view that failed to create a layerview for the layer emitting this event.

error Error

An error object describing why the layer view failed to create.

See also
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);
});

layerview-destroy

Inherited
Event
layerview-destroy
Inherited from Layer

Fires after the layer's LayerView is destroyed and no longer renders in a view.

Properties
view View

The view in which the layerView was destroyed.

layerView LayerView

The destroyed LayerView representing the layer.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.