Floor Filter

1
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

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
ArcgisLinkChart | ArcgisMap | ArcgisScene | string
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

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.

Read more...

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). Search Calcite Icons for possible values.

Attribute
icon
Default value
"floor-plan"

label

Property
label: string

The component's default label.

Attribute
label

level

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
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
Attribute
reference-element

site

Property
site: string

The currently selected site.

Read more...

Attribute
site

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.

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>

Events

EventType
undefined

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