Building Explorer

1
import "@arcgis/map-components/components/arcgis-building-explorer";

BuildingExplorer component 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 component, buildings can be filtered by level, construction phase or by disciplines and categories.

Demo

Properties

PropertyAttributeType
auto-destroy-disabled
boolean
heading-level
number
hide-disciplines
boolean
hide-levels
boolean
hide-phases
boolean
icon
string
label
string
level
readonly
phase
readonly
position
"bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
reference-element
ArcgisLinkChart | ArcgisMap | ArcgisScene | string
state
readonly
state
"disabled" | "failed" | "loading" | "ready"

autoDestroyDisabled

Property
autoDestroyDisabled: boolean

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the `destroy` method when you are done to prevent memory leaks.

Attribute
auto-destroy-disabled
Default value
false

headingLevel

Property
headingLevel: number

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

Read more...

Attribute
heading-level
Default value
3

hideDisciplines

Property
hideDisciplines: boolean
Attribute
hide-disciplines
Default value
false

hideLevels

Property
hideLevels: boolean
Attribute
hide-levels
Default value
false

hidePhases

Property
hidePhases: boolean
Attribute
hide-phases
Default value
false

icon

Property
icon: string

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component). Search Calcite Icons for possible values.

Attribute
icon
Default value
"organization"

label

Property
label: string

The component's default label.

Attribute
label

layers

Property

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

Read more...

level

readonlyProperty

Contains information about the level filter, such as the value selected by the user in the Level element or the minimum and maximum allowed values.

Read more...

phase

readonlyProperty

Contains information about the construction phase filter, such as the value selected by the user in the Construction phases element and the minimum and maximum allowed values.

Read more...

position

Property
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Attribute
position
Default value
"bottom-left"

referenceElement

Property
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
Attribute
reference-element

state

readonly
Property
state: "disabled" | "failed" | "loading" | "ready"

The current state of the view model that can be used for rendering the UI of the widget.

Read more...

Attribute
state
Default value
"disabled"

Methods

MethodSignature
componentOnReady(): Promise<void>
destroy(): Promise<void>

componentOnReady

Method
componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns
Promise<void>

destroy

Method
destroy(): Promise<void>

Permanently destroy the component

Returns
Promise<void>

Events

EventType
{ name: "state" | "level" | "phase"; }
undefined

arcgisPropertyChange

Event
arcgisPropertyChange: { name: "state" | "level" | "phase"; }

Fired when the value of a property is changed. Use this to listen to changes to properties.

arcgisReady

Event
arcgisReady: undefined

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close