BuildingLevel

AMD: require(["esri/widgets/BuildingExplorer/BuildingLevel"], (BuildingLevel) => { /* code goes here */ });
ESM: import BuildingLevel from "@arcgis/core/widgets/BuildingExplorer/BuildingLevel";
Class: esri/widgets/BuildingExplorer/BuildingLevel
Inheritance: BuildingLevel Accessor
Since: ArcGIS API for JavaScript 4.16

Provides information for the building level filter, such as the value selected by the user or the minimum and maximum allowed values.

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
BuildingLevel
String

The name of the class.

more details
Accessor
Boolean

Whether the filter is enabled.

more details
BuildingLevel
Boolean

Whether the next value can be selected.

more details
BuildingLevel
Boolean

Whether the previous value can be selected.

more details
BuildingLevel
Number

The maximum value allowed for the filter.

more details
BuildingLevel
Number

The minimum value allowed for the filter.

more details
BuildingLevel
Number

The value which is currently set on the filter.

more details
BuildingLevel

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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor

Removes the filter by setting enabled to false.

more details
BuildingLevel
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
BuildingLevel
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Selects the next value, if available.

more details
BuildingLevel

Selects the previous value, if available.

more details
BuildingLevel

Removes a group of handles owned by the object.

more details
Accessor

Selects the specified value for the filter.

more details
BuildingLevel

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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()

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.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 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");
}

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.

removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 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(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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.