BuildingNumericFilterViewModel | References | ArcGIS Maps SDK for JavaScript

import BuildingNumericFilterViewModel from "@arcgis/core/widgets/BuildingExplorer/BuildingNumericFilterViewModel.js";

const BuildingNumericFilterViewModel = await $arcgis.import("@arcgis/core/widgets/BuildingExplorer/BuildingNumericFilterViewModel.js");

Inheritance: BuildingNumericFilterViewModel→Accessor

Subclasses: BuildingLevel, BuildingPhase

Since: ArcGIS Maps SDK for JavaScript 4.16

Base class for the level filter and the construction phase filter in the BuildingExplorerViewModel.

Properties

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

Property	Type	Class
allowedValues	readonly number[]
declaredClass readonly inherited	string	Accessor
enabled	boolean
hasNext readonly	boolean
hasPrevious readonly	boolean
max readonly	number \| null \| undefined
min readonly	number \| null \| undefined
value	number

allowedValues

autocast Property

Type: readonly number[]

List of all the values which are allowed for the filter.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

enabled

Property

Type: boolean

Whether the filter is enabled. If false, the filter's expression won't be used to filter a BuildingSceneLayer.

Default value: false

hasNext

readonly Property

Type: boolean

Whether the next value can be selected.

hasPrevious

readonly Property

Type: boolean

Whether the previous value can be selected.

max

readonly Property

Type: number | null | undefined

The maximum value allowed for the filter.

min

readonly Property

Type: number | null | undefined

The minimum value allowed for the filter.

value

Property

Type: number

The value which is currently set on the filter.

Methods

Method	Signature	Class
clear	clear(): void
getValueLabel	getValueLabel(value: number): string \| null \| undefined
next	next(): void
previous	previous(): void
select	select(value: number): void

clear

Method

Signature: clear (): void

Removes the filter by setting enabled to false.

Returns: void

getValueLabel

Method

Signature: getValueLabel (value: number): string | null | undefined

If the field that is used for filtering has a coded value domain, the label for the value can be used to be displayed in a tooltip or in the widget UI. This method returns the label corresponding to a certain value.

Parameters

Parameter	Type	Description	Required
value	number	A filter value.

Returns: string | null | undefined
The label corresponding to the filter value.

Method

Signature: next (): void

Selects the next value, if available. If enabled is false, the first allowed value is selected.

Returns: void

Method

Signature: previous (): void

Selects the previous value, if available. If enabled is false, the last allowed value is selected.

Returns: void

select

Method

Signature: select (value: number): void

Selects the specified value for the filter. In case the filter is disabled, this method also enables it by setting enabled to true.

Parameters

Parameter	Type	Description	Required
value	number	The value which is to be selected.

Returns: void