require(["esri/layers/support/DisplayFilter"], (DisplayFilter) => { /* code goes here */ });
import DisplayFilter from "@arcgis/core/layers/support/DisplayFilter.js";
esri/layers/support/DisplayFilter
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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
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
-
id
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
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
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
title String
-
A descriptive name or label that helps users identify and understand the purpose of the filter.
- Default Value:""
-
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
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
-
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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
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.
ReturnsType Description this A deep clone of the class instance that invoked this method.
-
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.Parameterjson ObjectA 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
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.