BuildingExplorer

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

The BuildingExplorer widget is used to filter and explore the various components of BuildingSceneLayers. BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of components grouped in sublayers. Using this widget, buildings can be filtered by level, construction phase or by disciplines and categories. Three elements are used to filter BuildingSceneLayers: the Level element, the Construction phases element and the Disciplines are Categories list. The visibility of these elements can be configured using the widget's visibleElements.

building-explorer

The BuildingSceneLayers to be explored have to be set on the layers property of the widget. When setting multiple layers, the filters set by the widget will be applied on all layers. The widget doesn't allow the user to select between multiple BuildingSceneLayers in a SceneView.

Often, BuildingSceneLayers contain an overview BuildingComponentSublayer that serves as an exterior shell and views the building model as a single feature. When a layer is added to the BuildingExplorer widget, the visibility of the overview layer is turned off, so that the user can interact with the individual features in the full model BuildingGroupSublayer.

The Level element of the BuildingExplorer widget allows to select a single level in one or several buildings. When selecting a level, the levels above it are hidden and the levels below it become semi-transparent for added visual context.

Some BuildingSceneLayers include information indicating the phase when the components were created, and optionally, when they were demolished. If a layer has multiple construction phases, these will be displayed in the Construction phases element. When selecting a construction phase, all the components created during or before the phase are selected. Demolished components aren't displayed.

Discipline layers are group layers that organize the BuildingSceneLayer content into architectural, structural, mechanical, or electrical groups. These layers contain a number of Category layers such as walls, windows, furniture, and lighting fixtures. These layers can be turned on and off in the Disciplines and Categories list.

The widget can only display filters set by the widget itself. Filters set by other applications will be ignored.

For information about gaining full control of widget styles, see the Styling topic.
See also:
Example:
const buildingExplorer = new BuildingExplorer({
  view: view,
  layers: [buildingSceneLayer]
});
// adds the BuildingExplorer to the top right corner of the SceneView
view.ui.add(buildingExplorer, "top-right");

Constructors

new BuildingExplorer(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

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
String|HTMLElementmore details

The ID or node representing the DOM element containing the widget.

more detailsWidget
Stringmore details

The name of the class.

more detailsAccessor
Numbermore details

Indicates the heading level to use for the headings in the widget.

more detailsBuildingExplorer
Stringmore details

The widget's default CSS icon class.

more detailsBuildingExplorer
Stringmore details

The unique ID assigned to the widget when the widget is created.

more detailsWidget
Stringmore details

The widget's default label.

more detailsBuildingExplorer
Collection<BuildingSceneLayer>more details

A collection of layers of type BuildingSceneLayer that are added to the widget for exploration.

more detailsBuildingExplorer
SceneViewmore details

A reference to the SceneView.

more detailsBuildingExplorer
BuildingExplorerViewModelmore details

The view model for this widget.

more detailsBuildingExplorer
Booleanmore details

Indicates whether the widget is visible.

more detailsWidget
VisibleElementsmore details

This property provides the ability to display or hide the individual elements of the widget.

more detailsBuildingExplorer

Property Details

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.

Examples:
// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});
// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>
// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});
declaredClass Stringreadonly inherited

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

headingLevel Number
Since: ArcGIS API for JavaScript 4.20

Indicates the heading level to use for the headings in the widget. By default, they are rendered as level 3 headings (e.g. <h3>Disciplines & categories</h3>). Depending on the widget's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.

Default Value:3
See also:
Example:
buildingExplorer.headingLevel = 4;
iconClass String

The widget's default CSS icon class.

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

label String

The widget's default label.

A collection of layers of type BuildingSceneLayer that are added to the widget for exploration. The widget is only displayed when this property is set. In case of multiple layers, the widget will display and apply the filters on all layers.

view SceneView

A reference to the SceneView.

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the BuildingExplorerViewModel class to access all properties and methods on the widget.

visible Boolean inherited

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the CSS display value of "none".

Default Value:true
Example:
// Hides the widget in the view
widget.visible = false;
visibleElements VisibleElementsautocast

This property provides the ability to display or hide the individual elements of the widget. BuildingExplorer has three elements: buildings levels filter, construction phases filter and the sublayers list. By default they are all displayed. In case the BuildingSceneLayer doesn't provide field statistics information, then the filters for building levels and construction phases will not be displayed.

Example:
// only display the building levels filter
buildingExplorer.visibleElements = {
  phases: false,
  disciplines: false
};

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
Stringmore details

A utility method used for building the value for a widget's class property.

more detailsWidget
more details

Destroys the widget instance.

more detailsWidget
Booleanmore details

Emits an event on the instance.

more detailsWidget
Booleanmore details

Indicates whether there is an event listener on the instance that matches the provided event name.

more detailsWidget
Booleanmore details

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

more detailsWidget
Booleanmore details

isRejected() may be used to verify if creating an instance of the class is rejected.

more detailsWidget
Booleanmore details

isResolved() may be used to verify if creating an instance of the class is resolved.

more detailsWidget
Objectmore details

Registers an event handler on the instance.

more detailsWidget
more details

Widget teardown helper.

more detailsWidget
more details

This method is primarily used by developers when implementing custom widgets.

more detailsWidget
Objectmore details

This method is primarily used by developers when implementing custom widgets.

more detailsWidget
more details

Renders widget to the DOM immediately.

more detailsWidget
more details

This method is primarily used by developers when implementing custom widgets.

more detailsWidget
Promisemore details

when() may be leveraged once an instance of the class is created.

more detailsWidget

Method Details

classes(classNames){String}inherited

A utility method used for building the value for a widget's class property. This aids in simplifying CSS class setup.

Parameter:
classNames String|String[]|Object
repeatable

The class names.

Returns:
Type Description
String The computed class name.
See also:
Example:
// .tsx syntax showing how to set CSS classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}
destroy()inherited

Destroys the widget instance.

emit(type, event){Boolean}inherited

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:
type String

The name of the event.

event Object
optional

The event payload.

Returns:
Type Description
Boolean true if a listener was notified
hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:
type String

The name of the event.

Returns:
Type Description
Boolean Returns true if the class supports the input event.
isFulfilled(){Boolean}inherited
Since: ArcGIS API for JavaScript 4.19

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected(){Boolean}inherited
Since: ArcGIS API for JavaScript 4.19

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been rejected.
isResolved(){Boolean}inherited
Since: ArcGIS API for JavaScript 4.19

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been resolved.
on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of supported events.

Parameters:

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns:
Type Description
Object Returns an event handler with a remove() method that should be called to stop listening for the event(s).
Property Type Description
remove Function When called, removes the listener from the event.
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});
own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:
Type Description
Object The rendered virtual node.
renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

when(callback, errback){Promise}inherited
Since: ArcGIS API for JavaScript 4.19

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns:
Type Description
Promise Returns a new promise for the result of callback that may be used to chain additional functions.
Example:
// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Type Definitions

VisibleElements

The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.

Properties:
levels Boolean
optional
Default Value:true

When set to false, the building levels filter is not displayed.

phases Boolean
optional
Default Value:true

When set to false, the construction phases filter is not displayed.

disciplines Boolean
optional
Default Value:true

When set to false, the disciplines and categories sublayer list is not displayed.

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