import "@arcgis/map-components/components/arcgis-building-explorer";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 |
|---|---|---|
auto-destroy-disabled | boolean | |
heading-level | number | |
hide-disciplines | boolean | |
hide-levels | boolean | |
hide-phases | boolean | |
icon | string | |
label | string | |
| ||
levelreadonly | | |
phasereadonly | | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
statereadonly | state | "disabled" | "failed" | "loading" | "ready" |
autoDestroyDisabled
autoDestroyDisabled: booleanIf 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
headingLevel: numberIndicates the heading level to use for the component title.
- Attribute
- heading-level
- Default value
- 3
icon
icon: stringIcon 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"
layers
layers: Collection<BuildingSceneLayer>A collection of layers of type BuildingSceneLayer that are added to the componen for exploration.
level
level: BuildingLevelContains 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
phase: BuildingPhaseContains 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
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
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | stringBy 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.
- Attribute
- reference-element
state
state: "disabled" | "failed" | "loading" | "ready"The component's state. The values mean the following:
disabled- component is being createdloading- layers and statistics are loadingready- component is readyfailed- component failed to load data
- Attribute
- state
- Default value
- "disabled"
Slots
Events
| Event | Type |
|---|---|
CustomEvent<{ name: "state" | "level" | "phase"; }> | |
CustomEvent<void> |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state" | "level" | "phase"; }>Emitted when the value of a property is changed. Use this to listen to changes to properties.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods
| Method | Signature |
|---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
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>