import FloorFilter from "@arcgis/core/widgets/FloorFilter.js";const FloorFilter = await $arcgis.import("@arcgis/core/widgets/FloorFilter.js");- Since
- ArcGIS Maps SDK for JavaScript 4.19
The FloorFilter widget simplifies visualization of GIS data for a specific floor of a building in your application. It allows you to filter down the floor plan data displayed in your MapView or SceneView to a site, a facility in the site, or a level in the facility.
To visualize your data based on site, facility, or level, your map must contain the related floor plan layers, with features linked together in a floor plan hierarchy. Once you define your map as floor-aware in the map properties, the interactive, on-screen FloorFilter widget appears and can be used to explore the floor-aware data based on the configured site, facility, and levels layers. The FloorFilter widget currently supports FeatureLayers, SceneLayers and MapImageLayers (map services).
The widget can also be used alongside other filtering functionalities, such as definition queries, selection, range, and time, to further control visualization. For example, you may want to visualize all of the features on a specific level in a facility, or all the office units within a range of levels in a facility.
Note
If a default site, facility, or level is selected in the floor filter when sharing a floor-aware web map from ArcGIS Pro, it will also be the default selection within the FloorFilter widget.
- Example
- // Initialize FloorFilterconst floorFilter = new FloorFilter({view: view});
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| inherited | HTMLElement | null | undefined | |
| readonly inherited | ||
| readonly inherited | ||
| | ||
| | ||
| Icon["icon"] | | |
| inherited | ||
| inherited | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| inherited |
container
- Type
- HTMLElement | null | undefined
The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.
- Examples
- // Create the HTML div element programmatically at runtime and set to the widget's containerconst basemapGallery = new BasemapGallery({view: view,container: document.createElement("div")});// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, {position: "top-right"});// Specify an already-defined HTML div element in the widget's containerconst basemapGallery = new BasemapGallery({view: view,container: basemapGalleryDiv});// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, {position: "top-right"});// HTML markup<body><div id="viewDiv"></div><div id="basemapGalleryDiv"></div></body>// Specify the widget while adding to the view's UIconst basemapGallery = new BasemapGallery({view: view});// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, {position: "top-right"});
headingLevel
- Type
- HeadingLevel
- Since
- ArcGIS Maps SDK for JavaScript 4.20
Indicates the heading level to use for the headings separating floors in buildings.
By default, the building name is rendered
as a level 2 heading (e.g. <h2>Building name</h2>). Depending on the widget's placement
in your app, you may need to adjust this heading for proper semantics. This is
important for meeting accessibility standards.
- See also
- Default value
- 2
- Example
- // building headings will render as an <h3>floorFilter.headingLevel = 3;
icon
- Type
- Icon["icon"]
- Since
- ArcGIS Maps SDK for JavaScript 4.27
Icon displayed in the widget's button.
- Default value
- "urban-model"
longNames
- Type
- boolean
Determines if the widget is expanded or collapsed.
If the value is true, the widget is expanded and the long names appear.
Otherwise, short names are used and icons appear alone on buttons.
view
- Type
- MapViewOrSceneView | null | undefined
A reference to the MapView or SceneView. If this property is set, the FloorFilter widget will update the view's MapView.floors property whenever the floor filter is manipulated or updated programmatically. This property will affect any floor-aware layer in the view.
viewModel
- Type
- FloorFilterViewModel
The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the FloorFilterViewModel class to access all properties and methods on the widget.
visible
- Type
- boolean
Indicates whether the widget is visible.
If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is
the first of three widgets associated to the upper right hand corner of the DefaultUI, then the other widgets will reposition when this widget is made invisible.
For more information, refer to the css display value of "none".
- Default value
- true
- Example
- // Hides the widget in the viewwidget.visible = false;
Methods
| Method | Signature | Class |
|---|---|---|
| inherited | classes(...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string | |
| inherited | destroy(): void | |
| inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
| inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
| inherited | isFulfilled(): boolean | |
| inherited | isRejected(): boolean | |
| inherited | isResolved(): boolean | |
| inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
| inherited | postInitialize(): void | |
| inherited | render(): any | null | |
| inherited | renderNow(): void | |
| inherited | scheduleRender(): void | |
| updateWebDocument(webmap: WebMap | WebScene): void | | |
| inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
classes
- Signature
-
classes (...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string
A utility method used for building the value for a widget's class property.
This aids in simplifying css class setup.
Parameters
- Returns
- string
The computed class name.
- Example
- // .tsx syntax showing how to set css classes while rendering the widgetrender() {const dynamicClasses = {[css.flip]: this.flip,[css.primary]: this.primary};return (<div class={classes(css.root, css.mixin, dynamicClasses)} />);}
emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
Emits an event on the instance. This method should only be used when creating subclasses of this class.
hasEventListener
- Signature
-
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
- Type parameters
- <Type extends EventNames<this>>
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | The name of the event. | |
- Returns
- boolean
Returns true if the class supports the input event.
isFulfilled
- Signature
-
isFulfilled (): boolean
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
If it is fulfilled, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.
If it is rejected, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.
If it is resolved, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been resolved.
on
- Signature
-
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
- Type parameters
- <Type extends EventNames<this>>
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | An event or an array of events to listen for. | |
| listener | EventedCallback<this["@eventTypes"][Type]> | The function to call when the event fires. | |
- Returns
- ResourceHandle
Returns an event handler with a
remove()method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event.
- Example
- view.on("click", function(event){// event is the event handle returned after the event fires.console.log(event.mapPoint);});
updateWebDocument
- Signature
-
updateWebDocument (webmap: WebMap | WebScene): void
Updates the FloorFilter widget definition in the provided WebMap.
when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled executes when the instance of the class loads. The
onRejected executes if the instance of the class fails to load.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat may be used to chain additional functions.
- Example
- // Although this example uses MapView, any class instance that is a promise may use when() in the same waylet view = new MapView();view.when(function(){// This function will execute once the promise is resolved}, function(error){// This function will execute if the promise is rejected due to an error});