Floor Filter

ESM:
Use dark colors for code blocksCopy
1
import "@arcgis/map-components/components/arcgis-floor-filter";
CDN:
No specific import is needed for this component.

The Floor Filter component simplifies visualization of GIS data for a specific floor of a building in your application.

Demo

Properties

PropertyAttributeType
auto-destroy-disabled
boolean
facility
string
heading-level
number
icon
string
label
string
level
string
long-names
boolean
position
"bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
reference-element
site
string

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

facility

reflected

Attribute changes are reflected on the DOM.

Property
facility: string

The currently selected facility.

Read more...

Attribute
facility

headingLevel

Property
headingLevel: number

Indicates the heading level to use for the headings separating floors in buildings.

Attribute
heading-level
Default value
2

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
Attribute
icon
Default value
"floor-plan"

label

Property
label: string

The widget's label.

Read more...

Attribute
label

level

reflected

Attribute changes are reflected on the DOM.

Property
level: string

The currently selected floor level.

Read more...

Attribute
level

longNames

Property
longNames: boolean

Determines if the widget is expanded or collapsed.

Read more...

Attribute
long-names
Default value
false

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

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
Attribute
reference-element

site

reflected

Attribute changes are reflected on the DOM.

Property
site: string

The currently selected site.

Read more...

Attribute
site

Slots

No slots to display.

Events

EventType

arcgisReady

Event
arcgisReady: CustomEvent<void>

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

bubbles

Events triggered on this element will be propagated to their outermost elements.

composed

The event is composable and will propagate across the shadow DOM into the standard DOM.

cancelable

The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.

Methods

MethodSignature
componentOnReady(): Promise<void>
destroy(): Promise<void>
updateWebDocument(webMap: __esri.WebMap): Promise<void>

componentOnReady

Method
componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Example
Use dark colors for code blocksCopy
1
2
3
4
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>

destroy

Method
destroy(): Promise<void>

Permanently destroy the component.

Returns
Promise<void>

updateWebDocument

Method
updateWebDocument(webMap: __esri.WebMap): Promise<void>
Parameters
ParameterTypeOptional?
webMap
Returns
Promise<void>

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