require(["esri/layers/pointCloudFilters/PointCloudFilter"], (PointCloudFilter) => { /* code goes here */ });
import PointCloudFilter from "@arcgis/core/layers/pointCloudFilters/PointCloudFilter.js";
esri/layers/pointCloudFilters/PointCloudFilter
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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| String | The name of the class. | Accessor | |
| String | The field used for applying the filter. | PointCloudFilter | |
| String | The type of filter. | PointCloudFilter |
Property Details
-
field
Propertyfield String -
The field used for applying the filter.
-
type
Propertytype Stringreadonly -
The type of filter.
Possible Values:"value"|"bitfield"|"return"
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | PointCloudFilter | |
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor | ||
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | PointCloudFilter |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();ParametershandleOrHandles WatchHandle|WatchHandle[]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.
-
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
jsonparameter 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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 from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.