BuildingPhase

Class: esri/widgets/BuildingExplorer/BuildingPhase
Inheritance: BuildingPhase Accessor
Since: ArcGIS API for JavaScript 4.16

BuildingPhase provides information for the construction phase filter, such as the value selected by the user or the minimum and maximum allowed values. Construction phases are used to track site development for a BuildingSceneLayer. Setting a construction phase in the BuildingExplorer selects everything in the layer which is already constructed at that phase (created phase <= selected phase) but not yet demolished (demolished phase > selected phase). The goal is to display what the building or construction site looks like at that selected phase.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Number[]

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

more details
more detailsBuildingPhase
String

The name of the class.

more details
more detailsAccessor
Boolean

Whether the filter is enabled.

more details
more detailsBuildingPhase
Boolean

Whether the next value can be selected.

more details
more detailsBuildingPhase
Boolean

Whether the previous value can be selected.

more details
more detailsBuildingPhase
Number

The maximum value allowed for the filter.

more details
more detailsBuildingPhase
Number

The minimum value allowed for the filter.

more details
more detailsBuildingPhase
Number

The value which is currently set on the filter.

more details
more detailsBuildingPhase

Property Details

allowedValues Number[]readonly

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

declaredClass Stringreadonly inherited

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

enabled Booleanreadonly

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

Default Value:false
hasNext Booleanreadonly

Whether the next value can be selected.

hasPrevious Booleanreadonly

Whether the previous value can be selected.

max Numberreadonly

The maximum value allowed for the filter.

min Numberreadonly

The minimum value allowed for the filter.

value Numberreadonly

The value which is currently set on the filter.

Method Overview

Name Return Type Summary Class

Removes the filter by setting enabled to false.

more details
more detailsBuildingPhase
String|null

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.

more details
more detailsBuildingPhase

Selects the next value, if available.

more details
more detailsBuildingPhase

Selects the previous value, if available.

more details
more detailsBuildingPhase

Selects the specified value for the filter.

more details
more detailsBuildingPhase

Method Details

clear()

Removes the filter by setting enabled to false.

getValueLabel(value){String|null}

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.

Parameter:
value Number

A filter value.

Returns:
Type Description
String | null The label corresponding to the filter value.

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

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

select(value)

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

Parameter:
value Number

The value which is to be selected.