FeatureFilter

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

Description of spatial and attribute filters that will be applied to Feature data. For example, used in Fence Parameters for Geotriggers.

Example:
let filter = new FeatureFilter({
  where: "facility = 6",
  geometry: {
    x: 13871520.850500003,
    y: 3910293.086000003,
    spatialReference: {
      wkid: 102100,
      latestWkid: 3857
    }
  }
})

Constructors

new FeatureFilter(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
Geometrymore details

An optional geometry used to filter the features from a feature table.

more detailsFeatureFilter
Stringmore details

An optional SQL-based definition expression string that narrows the data to be used.

more detailsFeatureFilter

Property Details

declaredClass Stringreadonly inherited

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

geometry Geometry

An optional geometry used to filter the features from a feature table. Any features that intersect the area of interest will be used. It can be any of the supported geometry types

Default Value:null
where String

An optional SQL-based definition expression string that narrows the data to be used. Any features that satisfy the query will be used.

Default Value:null

Method Overview

Name Return Type Summary Class
thismore details

Creates a deep clone of this object.

more detailsFeatureFilter
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsFeatureFilter
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsFeatureFilter

Method Details

clone(){this}

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns:
Type Description
this A deep clone of the class instance that invoked this method.
fromJSON(json){*}static

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

Parameter:
json Object

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

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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