DisplayFilter

AMD: require(["esri/layers/support/DisplayFilter"], (DisplayFilter) => { /* code goes here */ });
ESM: import DisplayFilter from "@arcgis/core/layers/support/DisplayFilter.js";
Class: esri/layers/support/DisplayFilter
Inheritance: DisplayFilterAccessor
Since: ArcGIS Maps SDK for JavaScript 4.32

Display filters limit which features of a layer are displayed. Use display filters when you want to draw a subset of features, while retaining access to all features for querying and analysis. Unlike definitionExpression, which filters features at the data source level, display filters only affect the visibility of features on the map. Features filtered by display filters are still available for querying and analysis, while features filtered by definition expression are not available to the layer at all.

See also

Constructors

DisplayFilter

Constructor
new DisplayFilter(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 Watch for changes topic.
Show inherited properties Hide inherited properties
Name Type Summary Class

The name of the class.

Accessor

The display filter identifier.

DisplayFilter

The maximum scale associated with the display filter.

DisplayFilter

The minimum scale associated with the display filter.

DisplayFilter

A descriptive name or label that helps users identify and understand the purpose of the filter.

DisplayFilter

SQL-based where clause that filters the data to be rendered for display purposes.

DisplayFilter

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

id

Property
id String

The display filter identifier. The id is used to set the activeFilterId property, which applies the active filter to the layer when the filter mode is manual.

maxScale

Property
maxScale Number

The maximum scale associated with the display filter. The maxScale is exclusive, meaning the filter is applied up to (but not including) this scale. A value of 0 means no maximum scale is specified.

Default Value:0

minScale

Property
minScale Number

The minimum scale associated with the display filter. The minScale is inclusive, meaning the filter is applied at this scale and all scales larger than it (i.e., zoomed in). A value of 0 means no minimum scale is specified.

Default Value:0

title

Property
title String

A descriptive name or label that helps users identify and understand the purpose of the filter.

Default Value:""

where

Property
where String |null |undefined

SQL-based where clause that filters the data to be rendered for display purposes. If this element is empty or missing, all features will be rendered for the display filter.

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.

Accessor
this

Creates a deep clone of this object.

DisplayFilter

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

DisplayFilter

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

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

DisplayFilter

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor

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

Method
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

Method
fromJSON(json){* |null |undefined}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
* | null | undefined Returns a new instance of this class.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

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

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor

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

toJSON

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close