require(["esri/layers/support/SceneFilter"], (SceneFilter) => { /* code goes here */ });
import SceneFilter from "@arcgis/core/layers/support/SceneFilter.js";
esri/layers/support/SceneFilter
A SceneFilter defines parameters for setting a client-side spatial filter on a SceneLayer.
It is possible to define a collection of polygon geometries which will mask out different parts of the layer. The spatialRelationship attribute defines if the content inside or outside of the polygons should be masked.
This filter is also persisted in WebScenes and when saving the SceneLayer.
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 | |
| Collection<Polygon> | The geometries to apply to the spatial filter. | SceneFilter | |
| String | The type of masking to perform. | SceneFilter |
Property Details
-
geometries
Propertygeometries Collection<Polygon>autocast -
The geometries to apply to the spatial filter.
The spatial relationship as specified by spatialRelationship will indicate how the geometry should be used to filter features. Multiple, overlapping geometries are applied as the union of their spatialRelationship operation. For multiple rings within a polygon the even odd rule is used to determine whether a point is inside.
Known Limitations
Polygon is the only supported geometries type.
-
spatialRelationship
PropertyspatialRelationship String -
The type of masking to perform.
Illustration Modification Description 
disjoint - removes selected area Remove portions of the scene layer. Use a polygon and don't draw the parts inside that polygon. For example to add another layer which shows a new development for that part of the city. 
contains - displays only selected area Define an area of interest. Use a polygon and draw only parts of the scene layer inside that polygon. For example, to show only a portion of a scene layer within the boundaries of a city. Possible Values:"disjoint"|"contains"
- Default Value:"disjoint"
- See also
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| SceneFilter | Creates a deep clone of the SceneFilter object. | SceneFilter | |
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor |
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.
-
clone
Methodclone(){SceneFilter} -
Creates a deep clone of the SceneFilter object.
ReturnsType Description SceneFilter A new instance of a SceneFilter object equal to the object used to call .clone().
-
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");