SceneFilter

Property Overview

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

• SceneLayer

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS Maps SDK 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 }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

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 Maps SDK 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 Maps SDK 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");