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

Known Limitations

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

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
String

The name of the class.

more details
Accessor
Collection<Polygon>

The geometries to apply to the spatial filter.

more details
SceneFilter
String

The type of masking to perform.

more details
SceneFilter

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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
SceneFilter

Creates a deep clone of the SceneFilter object.

more details
SceneFilter
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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(){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().
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if 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");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

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