SceneFilter

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

A SceneFilter is a collection of polygons and a type which can be set on a layer to spatially mask out features.

Known Limitations

  • Suboptimal performance with many masks.
  • Behavior might change slightly in the next release.

Constructors

new SceneFilter(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
Collection<Polygon>more details

The geometries to apply to the spatial filter.

more detailsSceneFilter
Stringmore details

The type of masking to perform.

more detailsSceneFilter

Property Details

declaredClass Stringreadonly inherited

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

geometries 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 String

The type of masking to perform.

Illustration Modification Description
filter-type-disjoint 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.
filter-type-contains 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, if you want 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
SceneFiltermore details

Creates a deep clone of the SceneFilter object.

more detailsSceneFilter

Method Details

clone(){SceneFilter}

Creates a deep clone of the SceneFilter object.

Returns:
Type Description
SceneFilter A new instance of a SceneFilter object equal to the object used to call .clone().

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