What is a window?
In ArcGIS Experience Builder, a window is a panel that can display content or widgets on top of your experience. Windows allow users to interact with focused content without leaving the main experience. Windows can be configured to display as either fixed modals or anchored popups.
There are two main configurations for displaying content in a window:
Window Type | Description |
---|---|
Fixed window | A modal overlay that disables interaction with the main window until closed. Commonly used for splash screens or important messages. |
Anchored window | A popup anchored to a widget, such as a button or text, typically used for contextual information or actions. |
In the app configuration, windows are defined by the dialogs
property.
Why use windows?
A window in ArcGIS Experience Builder provides a way to show additional content or functionality without navigating away from the main experience. They can be used to display forms, media, or other widgets in a focused manner, enhancing user interaction and engagement.
You use a window provides to:
- Present important information or actions without navigating away from the main content.
- Show additional details, forms, or media in a dedicated overlay.
- Allow users to interact with widgets or content in a separate space.
- Trigger windows from specific widgets to provide relevant information or options.
How to use a window
Here are the general steps to use a window in ArcGIS Experience Builder:
1. Add a window
To add a window to your experience, follow these steps:
- Navigate to the Page panel, select the Window tab, and click Add window.
- Choose a template for your window.
- Decide on the window type:
- Fixed: Appears in a fixed position on the screen.
- Anchored: Appears adjacent to a linked widget.
The window will be added to your experience, and you can start configuring its properties.
2. Configure window settings
To configure the properties of the window, you will need to consider the following settings:
-
Position and size
- For fixed windows, select one of nine anchor points on the page.
- Specify width and height in
pixel
orpercentage
. - Use Offset X/Y to adjust the window's position.
- Define Margins to set space around the window.
-
Behavior settings
- Block Page: Prevent interaction with the underlying app while the window is active.
- Mask Color: Choose a color to overlay the rest of the app when the window is active.
- Close Options
- Allow users to close the window by clicking outside of it.
- Add a close button within the window.
3. Set window triggers
You can control when and how a window appears by configuring triggers such as app load, page load, or user interaction with widgets.
To set up triggers for the window, you can use the following methods:
-
On app or page load
- Set the window as a Splash to appear when the app loads.
- Link the window to a specific page via the Open with window setting.
-
Widget interaction
- Use the Set link option in a widget's settings to open the window upon user interaction.
- Choose between anchored or fixed windows, excluding splash windows, for this trigger.
Window templates
You can choose from a variety of window templates to match your use case. The table below summarizes common templates and their purposes:
Template | Description |
---|---|
Fixed blocker | Blocks interaction until closed. |
Fixed passthrough | Allows interaction with the main window. |
Anchored | Appropriate when to linking a window to a widget. |