BuildingFilterBlock | References | ArcGIS Maps SDK for JavaScript

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

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

Inheritance: BuildingFilterBlock→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.0

Object contained in the BuildingFilter.filterBlocks collection:

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	BuildingFilterBlockProperties

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
filterExpression	string \| null
filterMode	BuildingFilterModeSolid \| BuildingFilterModeWireFrame \| BuildingFilterModeXRay
title	string

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

filterExpression

Property

Type: string | null

The SQL where clause used to match features to this filter block. Only the features that satisfy the filter expression are displayed in the SceneView. This property is evaluated on the client using the cached attributes and it only supports standardized SQL.

filterMode

autocast Property

Type: BuildingFilterModeSolid | BuildingFilterModeWireFrame | BuildingFilterModeXRay

Defines how features are drawn while the filter is active.

title

Property

Type: string

Title of the filter for display in UIs, for example when the filter block is edited in ArcGIS Pro.

Default value: ""

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
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.

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.