Class EsriFeatureFilter

Hierarchy

Accessor
JSONSupport
- EsriFeatureFilter

Index

Constructors

constructor

new EsriFeatureFilter(properties?): EsriFeatureFilter
This class defines parameters for setting a client-side filter on a featureEffect or layer view.

Read more...
Parameters
- Optional properties: FeatureFilterProperties
Returns EsriFeatureFilter
Inherited from Accessor.constructor
- Defined in node_modules/@arcgis/core/interfaces.d.ts:20247

Properties

declaredClass

declaredClass: string

destroyed

destroyed: boolean

distance

distance: number

Specifies a search distance from a given geometry in a spatial filter.

geometry

geometry: EsriGeometry

The geometry to apply to the spatial filter.

initialized

initialized: boolean

objectIds

objectIds: number[]

An array of objectIds of the features to be filtered.

spatialRelationship

spatialRelationship: string

For spatial filters, this parameter defines the spatial relationship to filter features in the layer view against the filter geometry.

Default

intersects

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#spatialRelationship)

timeExtent

timeExtent: TimeExtent

A range of time with start and end date.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#timeExtent)

units

The unit for calculating the buffer distance when distance is specified in a spatial filter.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureFilter.html#units)

where

where: string

A where clause for the feature filter.

Methods

`Protected` _get

_get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from Accessor._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:32
_get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Accessor._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:33

`Protected` _set

_set<T>(propertyName, value): EsriFeatureFilter
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriFeatureFilter
Inherited from Accessor._set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:34

addHandles

addHandles<T>(handles, groupKey?): void
Type Parameters
- T
Parameters
- handles: IHandle | IHandle[]
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from Accessor.addHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:28

clone

clone(): EsriFeatureFilter
Creates a deep clone of the FeatureFilter object.

Read more...

Returns EsriFeatureFilter
- Defined in node_modules/@arcgis/core/interfaces.d.ts:20253

createQuery

createQuery(): EsriQuery
Creates query parameters that can be used to fetch features that satisfy the layer's current filters and definitions.

Read more...

Returns EsriQuery
- Defined in node_modules/@arcgis/core/interfaces.d.ts:20259

destroy

destroy(): void
Returns void
Inherited from Accessor.destroy
- Defined in node_modules/@arcgis/core/interfaces.d.ts:20

get

get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Accessor.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:21
get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from Accessor.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:22

hasHandles

hasHandles<T>(groupKey?): boolean
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns boolean
Inherited from Accessor.hasHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30

`Protected` notifyChange

notifyChange(propertyName): void
Parameters
- propertyName: string
Returns void
Inherited from Accessor.notifyChange
- Defined in node_modules/@arcgis/core/interfaces.d.ts:31

own

own(handles): void
Deprecated
Since 4.25. Use addHandles(), removeHandles() and hasHandles() instead.
Parameters
- handles: IHandle | IHandle[]
Returns void
Inherited from Accessor.own
- Defined in node_modules/@arcgis/core/interfaces.d.ts:27

removeHandles

removeHandles<T>(groupKey?): void
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from Accessor.removeHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:29

set

set<T>(propertyName, value): EsriFeatureFilter
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriFeatureFilter
Inherited from Accessor.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:23
set(props): EsriFeatureFilter
Parameters
- props: HashMap<any>
Returns EsriFeatureFilter
Inherited from Accessor.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:24

toJSON

toJSON(): any
Converts an instance of this class to its ArcGIS portal JSON representation.

Read more...

Returns any
Inherited from JSONSupport.toJSON
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2167

watch

watch(path, callback, sync?): WatchHandle
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle
Inherited from Accessor.watch
- Defined in node_modules/@arcgis/core/interfaces.d.ts:25

`Static` fromJSON

fromJSON(json): EsriFeatureFilter
Parameters
- json: any
Returns EsriFeatureFilter
- Defined in node_modules/@arcgis/core/interfaces.d.ts:20260

Class EsriFeatureFilter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional properties: FeatureFilterProperties

Returns EsriFeatureFilter

Properties

declaredClass

destroyed

distance

geometry

initialized

objectIds

spatialRelationship

Default

timeExtent

Default

units

Default

where

Methods

Protected _get

Parameters

propertyName: string

Returns any

Type Parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type Parameters

T

Parameters

propertyName: string

value: T

Returns EsriFeatureFilter

addHandles

Type Parameters

T

Parameters

handles: IHandle | IHandle[]

Optional groupKey: Exclude<T, IHandle>

Returns void

clone

Returns EsriFeatureFilter

createQuery

Returns EsriQuery

destroy

Returns void

get

Type Parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

hasHandles

Type Parameters

T

Parameters

Optional groupKey: Exclude<T, IHandle>

Returns boolean

Protected notifyChange

Parameters

propertyName: string

Returns void

own

Deprecated

Parameters

handles: IHandle | IHandle[]

Returns void

removeHandles

`Optional` properties: FeatureFilterProperties

`Protected` _get

`Protected` _set

`Optional` groupKey: Exclude<T, IHandle>

`Optional` groupKey: Exclude<T, IHandle>

`Protected` notifyChange

`Optional` groupKey: Exclude<T, IHandle>

`Optional` sync: boolean

`Static` fromJSON