PointCloudLayer

require(["esri/layers/PointCloudLayer"], function(PointCloudLayer) { /* code goes here */ });
Class: esri/layers/PointCloudLayer
Inheritance: PointCloudLayer Layer Accessor
Since: ArcGIS API 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:

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. If CORS is enabled on the server add the point cloud service domain to esriConfig.request.corsEnabledServers. Alternatively, if CORS cannot be enabled on ArcGIS Server, you can set up a proxy on your web server and then add it to the proxy rules list in esriConfig using addProxyRule().

An instance of this class is also a Promise. This allows you to execute code once the promise resolves, or when the layer finishes loading its resources. See then() for additional details.

See also:

Constructors

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
PointCloudLayer = new PointCloudLayer({
  url: // url to the service
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The copyright text as defined by the scene service.

more details
more detailsPointCloudLayer
String

The name of the class.

more details
more detailsAccessor
Object

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

more details
more detailsPointCloudLayer
Field[]

An array of fields accessible in the layer.

more details
more detailsPointCloudLayer
Extent

The full extent of the layer.

more details
more detailsLayer
String

The unique ID assigned to the layer.

more details
more detailsLayer
Number

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

more details
more detailsPointCloudLayer
Boolean

Indicates whether the layer will be included in the legend.

more details
more detailsPointCloudLayer
String

Indicates how the layer should display in the LayerList widget.

more details
more detailsLayer
Boolean

Indicates whether the layer's resources have loaded.

more details
more detailsLayer
Error

The Error object returned if an error occurred while loading.

more details
more detailsLayer
String

Represents the status of a load operation.

more details
more detailsLayer
Object[]

A list of warnings which occurred while loading.

more details
more detailsLayer
PortalItem

The portal item from which the layer is loaded.

more details
more detailsPointCloudLayer
PointCloudRenderer

The renderer assigned to the layer.

more details
more detailsPointCloudLayer
SpatialReference

The spatial reference of the layer.

more details
more detailsPointCloudLayer
String

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

more details
more detailsPointCloudLayer
String

Token generated by the token service using the specified userId and password.

more details
more detailsPointCloudLayer
String

For PointCloudLayer the type is point-cloud.

more details
more detailsPointCloudLayer
String

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

more details
more detailsPointCloudLayer
Object

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

more details
more detailsPointCloudLayer
Boolean

Indicates if the layer is visible in the View.

more details
more detailsLayer

Property Details

The copyright text as defined by the scene service.

declaredClassStringreadonly inherited

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

elevationInfoObject

Since: ArcGIS API for JavaScript 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.

ModeDescription
absolute-heightPoints are placed at an absolute height above sea level. This height 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.
offset Number
optional

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

Default value: 0

fieldsField[]

An array of fields accessible in the 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.then(function(){
  view.extent = layer.fullExtent;
});

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

layerIdNumber

The layer ID, or layer index, of a Scene Service layer. This is particularly useful when loading a single SceneLayer 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:
// loads the third layer in the given Portal Item
var lyr = new SceneLayer({
  portalItem: {
    id: "73df987984b24094b848d580eb83b0fb"
  },
  layerId: 2
});
// If not specified, the first layer (layerId: 0) will be returned
var lyr = new SceneLayer({
  portalItem: {
    id: "73df987984b24094b848d580eb83b0fb"
  }
});
// Can also be used if URL points to service and not layer
var lyr = new SceneLayer({
  url: "http://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
var lyr = new SceneLayer({
  url: "http://scenesampleserverdev.arcgis.com/arcgis/rest/services/Hosted/DevA_Trees/SceneServer/0",
  // The layer id is specified in the URL
});

legendEnabledBoolean

Since: ArcGIS API for JavaScript 4.5

Indicates whether the layer will be included in the legend.

Default Value: true

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

ValueDescription
showThe layer is visible in the table of contents.
hideThe layer is hidden in the table of contents.
hide-childrenIf the layer is a GroupLayer, hide the children layers from the table of contents.
Default Value: show

loadedBooleanreadonly inherited

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

Default Value: false

loadErrorErrorreadonly inherited

The Error object returned if an error occurred while loading.

Default Value: null

loadStatusStringreadonly inherited

Represents the status of a load operation.

ValueDescription
not-loadedThe object's resources have not loaded.
loadingThe object's resources are currently loading.
loadedThe object's resources have loaded without errors.
failedThe object's resources failed to load. See loadError for more details.
Default Value: not-loaded

loadWarningsObject[]readonly inherited

A list of warnings which occurred while loading.

portalItemPortalItem

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.

Examples:
// while this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids
var lyr = 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
var lyr = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  // loads the third item in the given feature service
  layerId: 2
});

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

spatialReferenceSpatialReference autocast

The spatial reference of the layer.

titleString

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.

tokenStringreadonly

Token generated by the token service using the specified userId and password. The recommended approach to pass a token on a layer is to use IdentityManager.registerToken().

typeStringreadonly

For PointCloudLayer the type is point-cloud.

The URL of the REST endpoint of the layer or scene service. The URL may either point to a resource on ArcGIS Server, Portal for ArcGIS, 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
var sceneLayer = new SceneLayer({
  url: "http://scene.arcgis.com/arcgis/rest/services/Hosted/Building_Hamburg/SceneServer/layers/0"
});
// Can also be used if URL points to service and not layer
var lyr = new SceneLayer({
  // Notice that the url doesn't end with /0
  url: "http://scenesampleserverdev.arcgis.com/arcgis/rest/services/Hosted/DevA_Trees/SceneServer",
  layerId: 0
});

versionObjectreadonly

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

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

NameReturn TypeSummaryClass
Promise

An instance of this class is a Promise.

more details
more detailsLayer

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

more details
more detailsLayer

Emits an event on the instance.

more details
more detailsLayer
Promise<Object>

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

more details
more detailsLayer
Boolean

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

more details
more detailsLayer
Boolean

An instance of this class is a Promise.

more details
more detailsLayer
Boolean

An instance of this class is a Promise.

more details
more detailsLayer
Boolean

An instance of this class is a Promise.

more details
more detailsLayer
Promise

Loads the resources referenced by this class.

more details
more detailsLayer
Object

Registers an event handler on the instance.

more details
more detailsLayer
Promise

An instance of this class is a Promise.

more details
more detailsLayer
Promise

An instance of this class is a Promise.

more details
more detailsLayer

Method Details

always(callbackOrErrback){Promise}inherited

An instance of this class is a Promise. Therefore always() may be used to execute a function if the promise is rejected or resolved. The input function will always execute no matter the response. For more information about promises, see the Working with Promises guide page.

Parameter:
callbackOrErrback Function
optional

The function to execute when the promise is rejected or resolved.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callbackOrErrback.
Example:
// Although this example uses MapView, any class instance that is a promise may use always() in the same way
var view = new MapView();
view.always(function(){
  // This function will always execute whether or not the promise is resolved or rejected
});

cancelLoad()inherited

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

emit(type, event)protectedinherited

Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses that inherit from Evented.

Parameters:
type String

The name of the event.

event Object

The event payload.

fetchAttributionData(){Promise<Object>}inherited

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

Returns:
TypeDescription
Promise< Object>Resolves to an object containing custom attribution data for the layer.

hasEventListener(type){Boolean}inherited

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:
TypeDescription
BooleanReturns true if the class supports the input event.

isFulfilled(){Boolean}inherited

An instance of this class is a Promise. Therefore isFulfilled() may be used to verify if the promise is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited

An instance of this class is a Promise. Therefore isRejected() may be used to verify if the promise is rejected. If it is rejected, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been rejected.

isResolved(){Boolean}inherited

An instance of this class is a Promise. Therefore isResolved() may be used to verify if the promise is resolved. If it is resolved, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been resolved.

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.

Returns:
TypeDescription
PromiseResolves when the resources have loaded.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of listened events.

Parameters:
type String

The name of event to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

otherwise(errback){Promise}inherited

An instance of this class is a Promise. Use otherwise() to call a function once the promise is rejected.

Parameter:
errback Function
optional

The function to execute when the promise fails.

Returns:
TypeDescription
PromiseReturns a new promise for the result of errback.
Example:
// Although this example uses MapView, any class instance that is a promise may use otherwise() in the same way
var view = new MapView();
view.otherwise(function(error){
  // This function will execute if the promise is rejected due to an error
});

then(callback, errback, progback){Promise}inherited

An instance of this class is a Promise. Therefore then() 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 promise resolves (when the instance of the class loads). The errback executes if the promise fails. See the Working with Promises guide page for additional details.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

progback Function
optional

The function to invoke when the promise emits a progress update.

Returns:
TypeDescription
PromiseReturns 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 then() in the same way
var view = new MapView();
view.then(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

NameTypeSummaryClass
{view: View,layerView: LayerView}

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

more details
more detailsLayer
{view: View,layerView: LayerView}

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

more details
more detailsLayer

Event Details

layerview-createinherited

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-destroyinherited

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.

API Reference search results

NameTypeModule

There were no match results from your search criteria.