Popup | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Overview

The Popup widget allows users to view content from feature attributes. Popups enhance web applications by providing users with a simple way to interact with and view attributes in a layer. They play an important role in relaying information to the user, which improves the storytelling capabilities of the application.

Loading the Popup

At version 4.27, the view's default popup is loaded on demand when view.popupEnabled is set to true (which is the default), when the view.openPopup() method is called, or when some widgets need the popup, such as Search. Please see the read more section below for details on how to manually load the popup or take advantage of the API lazy loading.

The Popup class can be loaded when the View is instantiated, however, this does not take advantage of the performance improvements of lazily loading the popup.

// Create a new MapView
const view = new MapView({
// set the popup property to a new instance of Popup
  popup: new Popup(...)
});

To utilize the performance improvements and the API automatically lazy loading the popup:

Set options/properties on the view's popup:

const view = MapView({
  popup: {
    dockEnabled: true,
    dockOptions: {
      position: true,
      ...
    }
  }
});

Use view.popupEnabled to prevent the popup appearing when the user clicks the view.

// The popup doesn't show for features on selection, but will on Search results and when `openPopup()` is called.
view.popupEnabled = false;

Use view.openPopup() instead of open() and view.closePopup() instead of close().

// A deprecation warning is prompted if the popup isn't created
// and calls view.openPopup() or view.closePopup() respectively under the hood.
view.popup.open(...);
view.popup.close(...);

// Opens or closes the popup on the View.
view.openPopup(...);
view.closePopup(...);

Use reactiveUtils to watch properties on the popup and its view model instead of the watch() method.

// This will throw an error that watch() is not a method
// since the popup hasn't been created yet.
view.popup.watch("selectedFeature", ...)

// Call reactiveUtils.watch() on popup properties with optional chaining.
reactiveUtils.watch(() => view.popup?.selectedFeature, ...);

Use the reactiveUtils.when() method to check when the popup instance is created. Once its created, then it's properties or methods can be accessed and called.

// This will throw an error that actions is not a property.
view.popup.actions.push(...);

// Wait for the popup to load before accessing properties.
reactiveUtils.when(() => view.popup?.actions, ()=>{
  view.popup.actions.push(...);
});

Popup UI

All Views contain a default popup. This popup can display generic content, which is set in its title and content properties. When content is set directly on the Popup instance it is not tied to a specific feature or layer.

In the image above, the text "Marriage in New York County Census Tract 8" is the popup's title. The remaining text is its content. A dock button popup-dock-btn may also be available in the top right corner of the popup. This allows the user to dock the popup to one of the sides or corners of the view. The options for docking may be set in the dockOptions property.

Popups can also contain actions that act like buttons, which execute a function defined by the developer when clicked. By default, every popup has a "Zoom to" action popupTemplate-zoom-action that allows users to zoom to the selected feature. See the actions property for information about adding custom actions to a popup.

The Popup widget is tied to the View, whether it's docked or anchored to the selected feature. If wanting to utilize the Popup functionality outside of the View, the Features widget can be used to display the same content in its own container that's not tied to the View.

Popup and PopupTemplate

PopupTemplate is closely related to Popup, but is more specific to layers and graphics. It allows you to define custom titles and content templates based on the source of the selected feature. When a layer or a graphic has a defined PopupTemplate, the popup will display the content defined in the PopupTemplate when the feature is clicked. The content may contain field values from the attributes of the selected feature.

Custom PopupTemplates may also be assigned directly to a popup by setting graphics on the features property. For more information about Popup and how it relates to PopupTemplate see the samples listed below.

See also

Constructors

Popup Constructor new Popup(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Collection<(ActionButton\|ActionToggle)>	Collection of action or action toggle objects.	Popup
Boolean	Indicates if the widget is active when it is visible and is not waiting for results.	Popup
String\|Function	Position of the popup in relation to the selected feature.	Popup
Boolean	This closes the popup when the View camera or Viewpoint changes.	Popup
Boolean	Indicates whether to enable collapse functionality for the popup.	Popup
Boolean	Indicates whether the popup displays its content.	Popup
String\|HTMLElement	The ID or node representing the DOM element containing the widget.	Widget
String\|HTMLElement\|Widget	The content of the popup.	Popup
String	Dock position in the View.	Popup
String	The name of the class.	Accessor
Boolean	Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined.	Popup
Boolean	Indicates whether the placement of the popup is docked to the side of the view.	Popup
Object	Docking the popup allows for a better user experience, particularly when opening popups in apps on mobile devices.	Popup
Number	The number of selected features available to the popup.	Popup
Graphic []	An array of features associated with the popup.	Popup
GoToOverride	This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.	Popup
Number	Indicates the heading level to use for the title of the popup.	Popup
Boolean	Highlight the selected popup feature using the highlightOptions set on the MapView or the highlightOptions set on the SceneView.	Popup
String	Icon displayed in the widget's button.	Popup
String	The unique ID assigned to the widget when the widget is created.	Widget
String	The widget's default label.	Popup
Point	Point used to position the popup.	Popup
Promise[]	An array of pending Promises that have not yet been fulfilled.	Popup
Graphic	The selected feature accessed by the popup.	Popup
Number	Index of the feature that is selected.	Popup
Feature	Returns a reference to the current Feature that the Popup is using.	Popup
Boolean	Indicates whether to display a spinner at the popup location prior to its display when it has pending promises.	Popup
String	The title of the popup.	Popup
MapView\|SceneView	A reference to the MapView or SceneView.	Popup
PopupViewModel	This is a class that contains all the logic (properties and methods) that controls this widget's behavior.	Popup
Boolean	Indicates whether the popup is visible.	Popup
VisibleElements	The visible elements that are displayed within the widget.	Popup

Property Details

actions Property actions Collection<(ActionButton|ActionToggle)>autocast Autocasts from Object []

Collection of action or action toggle objects. Each action may be executed by clicking the icon or image symbolizing them. By default, popups have a Zoom To action styled with a magnifying glass icon popupTemplate-zoom-action . When this icon is clicked, the view zooms in four LODs and centers on the selected feature.

You may remove this default action by setting includeDefaultActions to false, or by setting the overwriteActions property to true in a PopupTemplate. The order of each action is the order in which they appear in the actions Collection.

The trigger-action event fires each time an action is clicked.

Actions are defined with the properties listed in the ActionButton or ActionToggle classes.

See also

Example

// Defines an action button to zoom out from the selected feature
const zoomOutAction = {
  type: "button",
  // This text is displayed as a tooltip
  title: "Zoom out",
  // The ID by which to reference the action in the event handler
  id: "zoom-out",
  // Sets the icon used to style the action button
  icon: "magnifying-glass-minus"
};
// Adds the custom action to the popup.
view.popup.actions.push(zoomOutAction);

active Property active Booleanreadonly Since: ArcGIS Maps SDK for JavaScript 4.30 Popup since 4.0, active added at 4.30.

Indicates if the widget is active when it is visible and is not waiting for results.

Default Value:false

alignment Property alignment String |Function Since: ArcGIS Maps SDK for JavaScript 4.8 Popup since 4.0, alignment added at 4.8.

Position of the popup in relation to the selected feature. The default behavior is to display above the feature and adjust if not enough room. If needing to explicitly control where the popup displays in relation to the feature, choose an option besides auto.

Default Value:"auto"

Example

// Popup will display on the bottom-right of the selected feature regardless of where that feature is located
view.popup.alignment = "bottom-right";

autoCloseEnabled Property autoCloseEnabled Boolean Since: ArcGIS Maps SDK for JavaScript 4.5 Popup since 4.0, autoCloseEnabled added at 4.5.

This closes the popup when the View camera or Viewpoint changes.

Default Value:false

collapseEnabled Property collapseEnabled Boolean Deprecated since 4.29. Use PopupVisibleElements.collapseButton instead.

Indicates whether to enable collapse functionality for the popup.

Default Value:true

collapsed Property collapsed Booleanreadonly Since: ArcGIS Maps SDK for JavaScript 4.5 Popup since 4.0, collapsed added at 4.5.

Indicates whether the popup displays its content. If true, only the header displays.

Default Value:false

container Inherited Property container String |HTMLElement Inherited from Widget

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 container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.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 UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

content Property content String |HTMLElement |Widget

The content of the popup. When set directly on the Popup, this content is static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see PopupTemplate.content.

See also

Example

// This sets generic instructions in the popup that will always be displayed
// unless it is overridden by a PopupTemplate
view.popup.content = "Click a feature on the map to view its attributes";

currentDockPosition Property currentDockPosition Stringreadonly

Dock position in the View.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

The name of the class. The declared class name is formatted as esri.folder.className.

defaultPopupTemplateEnabled Property defaultPopupTemplateEnabled Boolean Since: ArcGIS Maps SDK for JavaScript 4.11 Popup since 4.0, defaultPopupTemplateEnabled added at 4.11.

Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the createPopupTemplate method. (Supported for FeatureLayer, GeoJSONLayer, OGCFeatureLayer, SceneLayer, CSVLayer, PointCloudLayer, StreamLayer, ImageryLayer, and VoxelLayer).

Starting with version 4.12, PopupTemplate content can no longer be set using a wildcard, e.g. *. Instead, set the defaultPopupTemplateEnabled property to true.
Starting with 4.16, the default popup has been improved to no longer display system fields that do not hold significant value, e.g. Shape__Area and Shape__Length are two fields that no longer display.
Starting with version 4.28, date fields are formatted using the short-date-short-time preset dateFormat rather than long-month-day-year in default popup templates created by setting the defaultPopupTemplateEnabled property to true. For example, previously a date that may have appeared as "December 30, 1997" will now appear as "12/30/1997 6:00 PM".

Default Value:false

dockEnabled Property dockEnabled Boolean

Indicates whether the placement of the popup is docked to the side of the view.

Docking the popup allows for a better user experience, particularly when opening popups in apps on mobile devices. When a popup is "dockEnabled" it means the popup no longer points to the selected feature or the location assigned to it. Rather it is attached to a side, the top, or the bottom of the view.

See dockOptions to override default options related to docking the popup.

Default Value:false

See also

Sample - Popup docking

Example

// The popup will automatically be dockEnabled when made visible
view.popup.dockEnabled = true;

dockOptions Property dockOptions Object

Docking the popup allows for a better user experience, particularly when opening popups in apps on mobile devices. When a popup is "dockEnabled" it means the popup no longer points to the selected feature or the location assigned to it. Rather it is placed in one of the corners of the view or to the top or bottom of it. This property allows the developer to set various options for docking the popup.

See the object specification table below to override default docking properties on the popup.

Properties

breakpoint Object|Boolean

optional

Default Value:true

Defines the dimensions of the View at which to dock the popup. Set to false to disable docking at a breakpoint.

Specification: width Number

optional
Default Value:544

The maximum width of the View at which the popup will be set to dockEnabled automatically.

height Number

optional
Default Value:544

The maximum height of the View at which the popup will be set to dockEnabled automatically.

buttonEnabled Boolean

optional

If true, displays the dock button. If false, hides the dock button from the popup.

position String|Function

optional

Default Value:auto

The position in the view at which to dock the popup. Can be set as either a string or function. See the table below for known string values and their position in the view based on the view's size.

Known Value	View size > breakpoint	View size < breakpoint (at xsmall view breakpoint)
auto	top-right	top-right
top-left	top-left	top-left
top-center	top-center	top 100%
top-right	top-right	top right
bottom-left	bottom-left	bottom left
bottom-center	bottom-center	bottom 100%
bottom-right	bottom-right	bottom right

If viewing the popup in a mobile UI, the default dock position is bottom 100%.

See also

Sample - Popup docking

Example

view.popup.dockOptions = {
  // Disable the dock button so users cannot undock the popup
  buttonEnabled: false,
  // Dock the popup when the size of the view is less than or equal to 600x1000 pixels
  breakpoint: {
    width: 600,
    height: 1000
  }
};

featureCount Property featureCount Numberreadonly

The number of selected features available to the popup.

Default Value:0

features Property features Graphic[]

An array of features associated with the popup. Each graphic in this array must have a valid PopupTemplate set. They may share the same PopupTemplate or have unique PopupTemplates depending on their attributes. The content and title of the popup is set based on the content and title properties of each graphic's respective PopupTemplate.

When more than one graphic exists in this array, the current content of the Popup is set based on the value of the selected feature.

This value is null if no features are associated with the popup.

Example

// When setting the features property, the graphics pushed to this property
// must have a PopupTemplate set.
let g1 = new Graphic();
g1.popupTemplate = new PopupTemplate({
  title: "Results title",
  content: "Results: {ATTRIBUTE_NAME}"
});
// Set the graphics as an array to the popup instance. The content and title of
// the popup will be set depending on the PopupTemplate of the graphics.
// Each graphic may share the same PopupTemplate or have a unique PopupTemplate
let graphics = [g1, g2, g3, g4, g5];
view.popup.features = graphics;

goToOverride Property goToOverride GoToOverride Since: ArcGIS Maps SDK for JavaScript 4.8 Popup since 4.0, goToOverride added at 4.8.

This function provides the ability to override either the MapView goTo() or SceneView goTo() methods.

See also

esri/views/MapView#goTo
SceneView

Example

// The following snippet uses the Search widget but can be applied to any
// widgets that support the goToOverride property.
search.goToOverride = function(view, goToParams) {
  goToParams.options = {
    duration: updatedDuration
  };
  return view.goTo(goToParams.target, goToParams.options);
};

headingLevel Property headingLevel Number Since: ArcGIS Maps SDK for JavaScript 4.20 Popup since 4.0, headingLevel added at 4.20.

Indicates the heading level to use for the title of the popup. By default, the title is rendered as a level 2 heading (e.g. <h2>Popup title</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.

Default Value:2

See also

Heading Elements

Example

// popup title will render as an <h3>
popup.headingLevel = 3;

highlightEnabled Property highlightEnabled Boolean

Highlight the selected popup feature using the highlightOptions set on the MapView or the highlightOptions set on the SceneView.

Default Value:true

icon Property icon String Since: ArcGIS Maps SDK for JavaScript 4.27 Popup since 4.0, icon added at 4.27.

Icon displayed in the widget's button.

Default Value:"popup"

See also

Calcite Icon Search

id Inherited Property id String Inherited from Widget

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

label Property label String

The widget's default label.

location Property location Pointautocast

Point used to position the popup. This is automatically set when viewing the popup by selecting a feature. If using the Popup to display content not related to features in the map, such as the results from a task, then you must set this property before making the popup visible to the user.

See also

Intro to popups

Examples

// Sets the location of the popup to the center of the view
view.popup.location = view.center;
// Displays the popup
view.popup.visible = true;

// Sets the location of the popup to a specific place (using autocast)
// Note: using latitude/longitude only works if view is in Web Mercator or WGS84 spatial reference.
view.popup.location = {latitude: 34.0571, longitude: -117.1968};

// Sets the location of the popup to the location of a click on the view
reactiveUtils.on(()=>view, "click", (event)=>{
  view.popup.location = event.mapPoint;
  // Displays the popup
  view.popup.visible = true;
});

promises Property promises Promise[]

An array of pending Promises that have not yet been fulfilled. If there are no pending promises, the value is null. When the pending promises are resolved they are removed from this array and the features they return are pushed into the features array.

selectedFeature Property selectedFeature Graphicreadonly

The selected feature accessed by the popup. The content of the Popup is determined based on the PopupTemplate assigned to this feature.

selectedFeatureIndex Property selectedFeatureIndex Number

Index of the feature that is selected. When features are set, the first index is automatically selected.

selectedFeatureWidget Property selectedFeatureWidget Featurereadonly Since: ArcGIS Maps SDK for JavaScript 4.7 Popup since 4.0, selectedFeatureWidget added at 4.7.

Returns a reference to the current Feature that the Popup is using. This is useful if needing to get a reference to the widget in order to make any changes to it.

spinnerEnabled Property spinnerEnabled Boolean Deprecated since 4.29. Use PopupVisibleElements.spinner instead.

Indicates whether to display a spinner at the popup location prior to its display when it has pending promises.

title Property title String

The title of the popup. This can be set generically on the popup no matter the features that are selected. If the selected feature has a PopupTemplate, then the title set in the corresponding template is used here.

See also

headingLevel

Example

// This title will display in the popup unless a selected feature's
// PopupTemplate overrides it
view.popup.title = "Population by zip codes in Southern California";

view Property view MapView |SceneView

A reference to the MapView or SceneView. Set this to link the widget to a specific view.

viewModel Property viewModel PopupViewModelautocast

This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the PopupViewModel class to access all properties and methods on the widget.

visible Property visible Boolean

Indicates whether the popup is visible. This property is true when the popup is querying for results, even if it is not open in the view. Use the PopupViewModel.active property to check if the popup is visible and is not waiting for results.

See also

PopupViewModel.active

visibleElements Property visibleElements VisibleElements Since: ArcGIS Maps SDK for JavaScript 4.15 Popup since 4.0, visibleElements added at 4.15.

The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget's display on/off.

Example

popup.visibleElements = {
  closeButton: false
};

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
	Use this method to remove focus from the Widget.	Popup
String	A utility method used for building the value for a widget's `class` property.	Widget
	Removes promises, features, content, title and location from the Popup.	Popup
	Closes the popup by setting its visible property to `false`.	Popup
	Destroys the widget instance.	Widget
Boolean	Emits an event on the instance.	Popup
Promise<FetchPopupFeaturesResult>	Use this method to return feature(s) at a given screen location.	Popup
	Use this method to give focus to the Widget if the widget is able to be focused.	Popup
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name.	Popup
Boolean	Returns true if a named group of handles exist.	Accessor
Boolean	`isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).	Widget
Boolean	`isRejected()` may be used to verify if creating an instance of the class is rejected.	Widget
Boolean	`isResolved()` may be used to verify if creating an instance of the class is resolved.	Widget
PopupViewModel	Selects the feature at the next index in relation to the selected feature.	Popup
Object	Registers an event handler on the instance.	Popup
	Opens the popup at the given location with content defined either explicitly with `content` or driven from the PopupTemplate of input features.	Popup
	Adds one or more handles which are to be tied to the lifecycle of the widget.	Widget
	Executes after widget is ready for rendering.	Widget
PopupViewModel	Selects the feature at the previous index in relation to the selected feature.	Popup
	Removes a group of handles owned by the object.	Accessor
Object	This method is implemented by subclasses for rendering.	Widget
	Renders widget to the DOM immediately.	Widget
	Positions the popup on the view.	Popup
	Schedules widget rendering.	Widget
	Triggers the trigger-action event and executes the action at the specified index in the actions array.	Popup
Promise	`when()` may be leveraged once an instance of the class is created.	Widget

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

blur Method blur() Since: ArcGIS Maps SDK for JavaScript 4.6 Popup since 4.0, blur added at 4.6.

Use this method to remove focus from the Widget.

classes Inherited Method classes(classNames){String} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.7 Widget since 4.2, classes added at 4.7.

A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.

Parameter

classNames String|String []|Object

repeatable

The class names.

Returns

Type	Description
String	The computed class name.

Example

// .tsx syntax showing how to set css classes while rendering the widget

render() {
  const dynamicClasses = {
    [css.flip]: this.flip,
    [css.primary]: this.primary
  };

  return (
    <div class={classes(css.root, css.mixin, dynamicClasses)} />
  );
}

clear Method clear()

Removes promises, features, content, title and location from the Popup.

close Method close()

Closes the popup by setting its visible property to false. Users can alternatively close the popup by directly setting the visible property to false.

See also

Popup.visible

destroy Inherited Method destroy() Inherited from Widget

Destroys the widget instance.

emit Method emit(type, event){Boolean} Since: ArcGIS Maps SDK for JavaScript 4.5 Popup since 4.0, emit added at 4.5.

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

type String

The name of the event.

event Object

optional

The event payload.

Returns

Type	Description
Boolean	`true` if a listener was notified

fetchFeatures Method fetchFeatures(screenPoint, options){Promise<FetchPopupFeaturesResult>} Since: ArcGIS Maps SDK for JavaScript 4.15 Popup since 4.0, fetchFeatures added at 4.15.

Use this method to return feature(s) at a given screen location. These features are fetched from all of the LayerViews in the view. In order to use this, a layer must already have an associated PopupTemplate and have its popupEnabled. These features can then be used within a custom Popup or Feature widget experience. One example could be a custom side panel that displays feature-specific information based on an end user's click location. This method allows a developer the ability to control how the input location is handled, and then subsequently, what to do with the results.

Parameters

screenPoint Object

An object representing a point on the screen. This point can be in either the MapView or SceneView.

Specification

x Number

The x coordinate.

y Number

The y coordinate.

options FetchFeaturesOptions

optional

The options to pass into the fetchFeatures method.

Returns

Type Description

Promise<FetchPopupFeaturesResult> Resolves with the selected hitTest location. In addition, it also returns an array of graphics if the hitTest is performed directly on the view, a single Promise containing an array of all resulting graphics, or an array of objects containing this array of resulting graphics in addition to its associated layerview. Most commonly if accessing all features, use the single promise returned in the result's allGraphicsPromise and call .then() as seen in the example snippet.

Type	Description
Promise<FetchPopupFeaturesResult>	Resolves with the selected `hitTest` location. In addition, it also returns an array of graphics if the `hitTest` is performed directly on the view, a single Promise containing an array of all resulting graphics, or an array of objects containing this array of resulting graphics in addition to its associated layerview. Most commonly if accessing all features, use the single promise returned in the result's allGraphicsPromise and call `.then()` as seen in the example snippet.

See also

Sample - Feature widget - Query graphics from multiple layers

Example

// Add Feature widget to UI
view.ui.add(featureWidget, "top-right");

// Get view's click event
reactiveUtils.on(()=>view, "click", (event)=>{
  // Call fetchFeatures and pass in the click event screenPoint
  view.popup.fetchFeatures(event.screenPoint).then((response) => {
    // Access the response from fetchFeatures
    response.allGraphicsPromise.then((graphics) => {
      // Set the feature widget's graphic to the returned graphic from fetchFeatures
      featureWidget.graphic = graphics[0];
    });
  });
});

focus Method focus() Since: ArcGIS Maps SDK for JavaScript 4.6 Popup since 4.0, focus added at 4.6.

Use this method to give focus to the Widget if the widget is able to be focused.

hasEventListener Method hasEventListener(type){Boolean}

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter

type String

The name of the event.

Returns

Type	Description
Boolean	Returns true if the class supports the input event.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

isFulfilled Inherited Method isFulfilled(){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isFulfilled added at 4.19.

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

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected Inherited Method isRejected(){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isRejected added at 4.19.

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved Inherited Method isResolved(){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isResolved added at 4.19.

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

next Method next(){PopupViewModel}

Selects the feature at the next index in relation to the selected feature.

Returns

Type	Description
PopupViewModel	Returns an instance of the popup's view model.

See also

selectedFeatureIndex

on Method on(type, listener){Object}

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

type String|String []

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns

Type Description

Object

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);
});

open Method open(options)

Opens the popup at the given location with content defined either explicitly with content or driven from the PopupTemplate of input features. This method sets the popup's visible property to true. Users can alternatively open the popup by directly setting the visible property to true.

The popup will only display if the view's size constraints in dockOptions are met or the location property is set to a geometry.

Parameters

Specification

options Object

optional

Defines the location and content of the popup when opened.

Specification

title String

optional

Sets the title of the popup.

content String|HTMLElement|Widget

optional

Sets the content of the popup.

location Point

optional

Sets the popup's location, which is the geometry used to position the popup.

fetchFeatures Boolean

optional

Default Value: false

When true, indicates the popup should fetch the content of this feature and display it. If no PopupTemplate exists, a default template is created for the layer if defaultPopupTemplateEnabled = true. In order for this option to work, there must be a valid view and location set.

features Graphic []

optional

Sets the popup's features, which populate the title and content of the popup based on each graphic's PopupTemplate.

promises Promise[]

optional

Sets pending promises on the popup. The popup will display once the promises resolve. Each promise must resolve to an array of Graphics.

featureMenuOpen Boolean

optional

Default Value: false

Since: 4.5
This property enables multiple features in a popup to display in a list rather than displaying the first selected feature. Setting this to true allows the user to scroll through the list of features returned from the query and choose the selection they want to display within the popup.

updateLocationEnabled Boolean

optional

Default Value: false

When true indicates the popup should update its location for each paginated feature based on the selected feature's geometry.

collapsed Boolean

optional

Default Value: false

Since: 4.5
When true, indicates that only the popup header will display.

shouldFocus Boolean

optional

Default Value: false

Since: 4.23
When true, indicates that the focus should be on the popup after it has been opened.

See also

Examples

reactiveUtils.on(()=>view, "click", (event)=>{
  view.popup.open({
   location: event.mapPoint,  // location of the click on the view
   title: "You clicked here",  // title displayed in the popup
   content: "This is a point of interest"  // content displayed in the popup
  });
});

reactiveUtils.on(()=>view, "click", (event)=>{
   view.popup.open({
     location: event.mapPoint,  // location of the click on the view
     fetchFeatures: true // display the content for the selected feature if a popupTemplate is defined.
   });
 });

view.popup.open({
  title: "You clicked here",  // title displayed in the popup
  content: "This is a point of interest",  // content displayed in the popup
  location: event.mapPoint,
  updateLocationEnabled: true  // updates the location of popup based on
  // selected feature's geometry
});

view.popup.open({
  features: graphics,  // array of graphics
  featureMenuOpen: true, // selected features initially display in a list
  location: graphics[0].geometry // location of the first graphic in the array of graphics
});

own Inherited Method own(handleOrHandles) Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.24 Widget since 4.2, own added at 4.24. Deprecated since 4.28 Use addHandles() instead.

Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.

const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true}
);

this.own(handle); // Handle gets removed when the widget is destroyed.

Parameter

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the widget is destroyed.

postInitialize Inherited Method postInitialize() Inherited from Widget

Executes after widget is ready for rendering.

previous Method previous(){PopupViewModel}

Selects the feature at the previous index in relation to the selected feature.

Returns

Type	Description
PopupViewModel	Returns an instance of the popup's view model.

See also

selectedFeatureIndex

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

render Inherited Method render(){Object} Inherited from Widget

This method is implemented by subclasses for rendering.

Returns

Type	Description
Object	The rendered virtual node.

renderNow Inherited Method renderNow() Inherited from Widget

Renders widget to the DOM immediately.

reposition Method reposition()

Positions the popup on the view. Moves the popup into the view's extent if the popup is partially or fully outside the view's extent.

If the popup is partially out of view, the view will move to fully show the popup. If the popup is fully out of view, the view will move to the popup's location.

scheduleRender Inherited Method scheduleRender() Inherited from Widget

Schedules widget rendering. This method is useful for changes affecting the UI.

triggerAction Method triggerAction(actionIndex)

Triggers the trigger-action event and executes the action at the specified index in the actions array.

Parameter

actionIndex Number

The index of the action to execute.

when Inherited Method when(callback, errback){Promise} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, when added at 4.19.

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters

callback Function

optional

The function to call when the promise resolves.

errback Function

optional

The function to execute when the promise fails.

Returns

Type	Description
Promise	Returns a new Promise for the result of `callback`.

Example

// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.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
});

Type Definitions

FetchFeaturesOptions Type Definition FetchFeaturesOptions

Optional properties to use with the fetchFeatures method.

Properties: event Object

optional
The click event for either the MapView or SceneView. The event can be supplied in order to adjust the query radius depending on the pointer type. For example, touch events query a larger radius.

signal AbortSignal

optional
The signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

FetchPopupFeaturesResult Type Definition FetchPopupFeaturesResult

The resulting features returned from the fetchFeatures method.

Properties: allGraphicsPromise Promise<Graphic []>

optional
An array of promises containing graphics from the selected location. This can be a combination of graphics derived from a layerview, and/or graphics that reside directly on the view, ie. view.graphics.

location Point

optional
The resulting location of the MapView or SceneView's' hitTest.

VisibleElements Type Definition VisibleElements

The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.

popup-visibleElements

Properties: actionBar Boolean

optional
Default Value:true

Since 4.29. Indicates whether to display the action bar that holds the feature's actions.

closeButton Boolean

optional
Default Value:true

Indicates whether to display a close button on the widget dialog.

collapseButton Boolean

optional
Default Value:true

Since 4.29. Indicates whether to display the collapse button on the widget dialog.

featureNavigation Boolean

optional
Default Value:true

Indicates whether pagination for feature navigation will be displayed. This allows the user to scroll through various selected features using pagination arrows.

featureListLayerTitle Boolean

optional
Default Value:true

Since 4.30. Indicates whether to display the group heading for a list of multiple features.

heading Boolean

optional
Default Value:true

Since 4.29. Indicates whether to display the widget heading.

spinner Boolean

optional
Default Value:true

Since 4.29. Indicates whether to display the widget's loading spinner.

Event Overview

Name	Type	Summary	Class
	{action: ActionButton\|ActionToggle}	Fires after the user clicks on an action or action toggle inside a popup.	Popup

Event Details

trigger-action Event trigger-action

Fires after the user clicks on an action or action toggle inside a popup. This event may be used to define a custom function to execute when particular actions are clicked. See the example below for details of how this works.

Property

action ActionButton|ActionToggle

The action clicked by the user. For a description of this object and a specification of its properties, see the actions property of this class.

See also

actions

Example

// Defines an action button to zoom out from the selected feature
const zoomOutAction = {
  type: "button",
  // This text is displayed as a tooltip
  title: "Zoom out",
  // The ID by which to reference the action in the event handler
  id: "zoom-out",
  // Sets the icon used to style the action button
  icon: "magnifying-glass-minus"
};
// Adds the custom action to the popup.
view.popup.actions.push(zoomOutAction);

// This event fires for each click on any action
reactiveUtils.on(()=>view.popup?.popupViewModel, "trigger-action", (event)=>{
  // If the zoom-out action is clicked, fire the zoomOut() function
  if(event.action.id === "zoom-out"){
    // in this case the view zooms out two LODs on each click
    view.goTo({
      center: view.center,
      zoom: view.zoom - 2
    });
  }
});