Building Explorer

ESM:

Use dark colors for code blocksCopy
import "@arcgis/map-components/components/arcgis-building-explorer";

CDN:

No specific import is needed for this component.

Since:ArcGIS Maps SDK for JavaScript 4.28

The Building Explorer 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.

Known limitations

Building Explorer is only supported in a 3D Scene component.

Demo

Properties

Property	Attribute	Type
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`headingLevel`	`heading-level`	`number`
`hideDisciplines`	`hide-disciplines`	`boolean`
`hideLevels`	`hide-levels`	`boolean`
`hidePhases`	`hide-phases`	`boolean`
`icon`	`icon`	`string`
`label`	`label`	`string`
`layers`		`Collection<BuildingSceneLayer>`
`level` readonly		`BuildingLevel`
`phase` readonly		`BuildingPhase`
`position` deprecated	`position`	`"bottom-leading" \| "bottom-left" \| "bottom-right" \| "bottom-trailing" \| "manual" \| "top-leading" \| "top-left" \| "top-right" \| "top-trailing"`
`referenceElement`	`reference-element`	`HTMLArcgisLinkChartElement \| HTMLArcgisMapElement \| HTMLArcgisSceneElement \| string`
`state` readonlyreflected	`state`	`"disabled" \| "failed" \| "loading" \| "ready"`
`view`		`SceneView`

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 component title.

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

See also

Calcite Icons

Attribute: icon
Default value: "organization"

label

Property

label: string

The component's default label.

Attribute: label

layers

Property

layers: Collection<BuildingSceneLayer>

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

level

readonlyProperty

level: BuildingLevel

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.

phase

readonlyProperty

phase: BuildingPhase

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.

position

deprecatedProperty

position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"

Deprecatedsince 4.34, use slot instead.

Attribute: position

referenceElement

Property

referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string

By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.

See also

Associate components with a Map or Scene component

Attribute: reference-element

state

readonly

Property

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

The component's state. The values mean the following:

disabled - component is being created
loading - layers and statistics are loading
ready - component is ready
failed - component failed to load data

Attribute: state
Default value: "disabled"

view

Property

view: SceneView

The view associated with the component.

Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this view property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Building Explorer component will be associated with a map or scene component rather than using the view property.

Methods

Method	Signature
`componentOnReady`	`componentOnReady(): Promise<void>`
`destroy`	`destroy(): Promise<void>`

componentOnReady

Method

componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Example

Use dark colors for code blocksCopy
const arcgisBuildingExplorer = document.querySelector("arcgis-building-explorer");
document.body.append(arcgisBuildingExplorer);
await arcgisBuildingExplorer.componentOnReady();
console.log("arcgis-building-explorer is ready to go!");

Returns: Promise<void>

destroy

Method

destroy(): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

Events

Event	Type
`arcgisPropertyChange`	`CustomEvent<{ name: "state" \| "level" \| "phase"; }>`
`arcgisReady`	`CustomEvent<void>`

arcgisPropertyChange

Event

arcgisPropertyChange: CustomEvent<{ name: "state" | "level" | "phase"; }>

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

arcgisReady

Event

arcgisReady: CustomEvent<void>

Emitted when the component associated with a map or scene view is ready to be interacted with.