import "@arcgis/map-components/components/arcgis-floor-filter";The Floor Filter component simplifies visualization of GIS data for a specific floor of a building in your application.
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
autoDestroyDisabled | auto-destroy-disabled | boolean |
facilityreflected | facility | string |
headingLevel | heading-level | number |
icon | icon | string |
label | label | string |
levelreflected | level | string |
longNames | long-names | boolean |
positiondeprecated | 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 |
sitereflected | site | string |
view | | MapView | SceneView |
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 headings separating floors in buildings.
- Attribute
- heading-level
- Default value
- 2
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
- Attribute
- icon
- Default value
- "urban-model"
longNames
longNames: booleanDetermines if the widget is expanded or collapsed.
- Attribute
- long-names
- Default value
- false
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"slot instead.- Attribute
- position
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
view
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
viewproperty which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Floor Filter component will be associated with a map or scene component rather than using theviewproperty.
Methods
| Method | Signature |
|---|---|
componentOnReady | componentOnReady(): Promise<void> |
destroy | destroy(): Promise<void> |
updateWebDocument | updateWebDocument(webMap: __esri.WebMap): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisFloorFilter = document.querySelector("arcgis-floor-filter");
document.body.append(arcgisFloorFilter);
await arcgisFloorFilter.componentOnReady();
console.log("arcgis-floor-filter is ready to go!");- Returns
- Promise<void>
updateWebDocument
updateWebDocument(webMap: __esri.WebMap): Promise<void>Parameters
| Parameter | Type | Optional? |
|---|---|---|
| webMap | WebMap |
- Returns
- Promise<void>
Events
| Event | Type |
|---|---|
arcgisReady | CustomEvent<void> |
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is ready to be interacted with.