DisplayFilter | References | ArcGIS Maps SDK for JavaScript

import DisplayFilter from "@arcgis/core/layers/support/DisplayFilter.js";

const DisplayFilter = await $arcgis.import("@arcgis/core/layers/support/DisplayFilter.js");

Inheritance: DisplayFilter→Accessor

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	DisplayFilterProperties

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
declaredClass readonly inherited	string	Accessor
id	string
maxScale	number
minScale	number
title	string
where	string \| null \| undefined

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

id

Property

Type: string

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

maxScale

Property

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

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

Type: string

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

Default value: ""

where

Property

Type: 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.

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone inherited	clone(): this	ClonableMixin
toJSON inherited	toJSON(): any	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	any	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: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

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: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.