BuildingPhase | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Number []	List of all the values which are allowed for the filter.	BuildingPhase
String	The name of the class.	Accessor
Boolean	Whether the filter is enabled.	BuildingPhase
Boolean	Whether the next value can be selected.	BuildingPhase
Boolean	Whether the previous value can be selected.	BuildingPhase
Number	The maximum value allowed for the filter.	BuildingPhase
Number	The minimum value allowed for the filter.	BuildingPhase
Number	The value which is currently set on the filter.	BuildingPhase

Property Details

allowedValues Property allowedValues Number[]

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

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

enabled Property 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 Property hasNext Booleanreadonly

Whether the next value can be selected.

hasPrevious Property hasPrevious Booleanreadonly

Whether the previous value can be selected.

max Property max Numberreadonly

The maximum value allowed for the filter.

min Property min Numberreadonly

The minimum value allowed for the filter.

value Property value Numberreadonly

The value which is currently set on the filter.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
	Removes the filter by setting enabled to `false`.	BuildingPhase
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.	BuildingPhase
Boolean	Returns true if a named group of handles exist.	Accessor
	Selects the next value, if available.	BuildingPhase
	Selects the previous value, if available.	BuildingPhase
	Removes a group of handles owned by the object.	Accessor
	Selects the specified value for the filter.	BuildingPhase

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

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();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

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

clear Method clear()

Removes the filter by setting enabled to false.

getValueLabel Method 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.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	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");
}

next Method next()

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

previous Method previous()

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

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

select Method 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.