PointCloudFilter

AMD: require(["esri/layers/pointCloudFilters/PointCloudFilter"], (PointCloudFilter) => { /* code goes here */ });
ESM: import PointCloudFilter from "@arcgis/core/layers/pointCloudFilters/PointCloudFilter";
Class: esri/layers/pointCloudFilters/PointCloudFilter
Inheritance: PointCloudFilter Accessor
Since: ArcGIS API for JavaScript 4.10

Point cloud filters are used to hide points that do not satisfy the filter criteria.

There are two types of filters that can be assigned to PointCloudLayer.filters:

PointCloudValueFilter is useful for filtering points based on their classification value. If only the points that represent ground and buildings should be displayed, the following filter can be set:

const pcLayer = new PointCloudLayer({
  ...,
  filters: [{
    type: "value",
    field: "CLASS_CODE",
    mode: "include",
    // values include ground(2) and building(6)
    values: [2, 6]
  }]
});

PointCloudReturnFilter is used to filter points based on the return value stored with each point in the RETURNS field. The following filter can be set to display only the points that represent the highest feature in a landscape:

const pointCloudLayer = new PointCloudLayer({
 ...,
 filters: [{
   type: "return",
   field: "RETURNS",
   values: ["firstOfMany", "single"]
 }]
});

Filters can also be combined by setting several filters on one layer. Only points that satisfy all filters are displayed.

See also:

Constructors

new PointCloudFilter(properties)
Parameter:
properties Object
optional

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

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
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The field used for applying the filter.

more detailsPointCloudFilter
Stringmore details

The type of filter.

more detailsPointCloudFilter

Property Details

declaredClass Stringreadonly inherited

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

field String

The field used for applying the filter.

type Stringreadonly

The type of filter.

Possible Values:"value"|"bitfield"|"return"

Method Overview

Name Return Type Summary Class
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsPointCloudFilter
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsPointCloudFilter

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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