Popup

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

Property Overview

Property Details

actions Collection<(ActionButton|ActionToggle)>autocast

Autocasts from Object[]

Defines actions that may be executed by clicking the icon or image symbolizing them in the popup. By default, every popup has a zoom-to action styled with a magnifying glass icon . When this icon is clicked, the view zooms in four LODs and centers on the selected feature.

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

The trigger-action event fires each time an action in the popup is clicked. This event should be used to execute custom code for each action clicked. For example, if you would like to add a zoom-out action to the popup that zooms the view out several LODs, you would define the zoom-out code in a separate function. Then you would call the custom zoom-out function in the trigger-action event handler. See the sample code snippet below for more details on how this works.

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

See also

• Sample - Popup actions

• Sample - Custom popup actions per feature

• Sample - Popup with edit action

Example

// Defines an action to zoom out from the selected feature
let zoomOutAction = {
  // 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 font used to style the action button
  className: "esri-icon-zoom-out-magnifying-glass"
};
// Adds the custom action to the popup.
view.popup.actions.push(zoomOutAction);

// The function to execute when the zoom-out action is clicked
function zoomOut() {
  // in this case the view zooms out two LODs on each click
  view.goTo({
    center: view.center,
    zoom: view.zoom - 2
  });
}

// This event fires for each click on any action
view.popup.on("trigger-action", function(event){
  // If the zoom-out action is clicked, fire the zoomOut() function
  if(event.action.id === "zoom-out"){
    zoomOut();
  }
});

alignment String|Function

Since: ArcGIS Maps SDK for JavaScript 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.

Possible Values:"auto"|"top-center"|"top-right"|"bottom-left"|"bottom-center"|"bottom-right"

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 Boolean

Since: ArcGIS Maps SDK for JavaScript 4.5

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

Default Value:false

autoOpenEnabled Boolean

Since: ArcGIS Maps SDK for JavaScript 4.10

Deprecated since 4.27. Use MapView/SceneView.popupEnabled instead.

This property indicates to the Popup that it needs to allow or disallow the click event propagation.

Use view.popup.autoOpenEnabled = false; when needing to stop the click event propagation.

Default Value:true

Example

view.popup.autoOpenEnabled = false;
view.on("click", function(event) {
  view.popup.open({
    // Set the popup
  });
});

collapsed Booleanreadonly

Since: ArcGIS Maps SDK for JavaScript 4.5

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

Default Value:false

collapseEnabled Boolean

Indicates whether to enable collapse functionality for the popup.

Default Value:true

container String|HTMLElement inherited

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 cases 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 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

• Sample - Popup Docking

• Sample - Popup with DOM node

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 Stringreadonly

Dock position in the View.

Possible Values:"auto"|"top-center"|"top-right"|"top-left"|"bottom-left"|"bottom-center"|"bottom-right"

declaredClass Stringreadonly inherited

Since: ArcGIS Maps SDK for JavaScript 4.7

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

defaultPopupTemplateEnabled Boolean

Since: ArcGIS Maps SDK for JavaScript 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, and ImageryLayer).

• 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.

Default Value:false

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 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 auto top-right bottom 100% top-left top-left top 100% top-center top-center top 100% top-right top-right top 100% bottom-left bottom-left bottom 100% bottom-center bottom-center bottom 100% bottom-right bottom-right bottom 100% 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 Numberreadonly

The number of selected features available to the popup.

Default Value:0

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 GoToOverride

Since: ArcGIS Maps SDK for JavaScript 4.8

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

See also

• MapView
• 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 Number

Since: ArcGIS Maps SDK for JavaScript 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 Boolean

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

Default Value:true

id String inherited

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 String

The widget's default label.

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 latlong 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
view.on("click", function(event){
  view.popup.location = event.mapPoint;
  // Displays the popup
  view.popup.visible = true;
});

maxInlineActions Number|null

Defines the maximum icons displayed at one time in the action area.

Default Value:3

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 Graphicreadonly

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

selectedFeatureIndex Number

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

selectedFeatureWidget Featurereadonly

Since: ArcGIS Maps SDK for JavaScript 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 Boolean

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

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 MapView|SceneView

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

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 Boolean

Indicates whether the popup is visible.

visibleElements VisibleElements

Since: ArcGIS Maps SDK for JavaScript 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

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 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()

Since: ArcGIS Maps SDK for JavaScript 4.6

Use this method to remove focus from the Widget.

classes(classNames){String}inherited

Since: ArcGIS Maps SDK for JavaScript 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.

See also

• Guide - Custom widget basics (rendering)

Example

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

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

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

clear()

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

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

Destroys the widget instance.

emit(type, event){Boolean}

Since: ArcGIS Maps SDK for JavaScript 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(screenPoint, options){Promise<FetchPopupFeaturesResult>}

Since: ArcGIS Maps SDK for JavaScript 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.

See also

• Sample - Feature widget - Query graphics from multiple layerViews

Example

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

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

focus()

Since: ArcGIS Maps SDK for JavaScript 4.6

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

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(groupKey){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 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(){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 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(){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 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(){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 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(){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(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(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 Geometry 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

• Intro to popups

• Popup.visible

• Sample - Query with rest/query

• Sample - Popup with DOM node

Examples

view.on("click", function(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
  });
});

view.on("click", function(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(handleOrHandles)inherited

Since: ArcGIS Maps SDK for JavaScript 4.24

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

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

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(groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 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(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns

Type	Description
Object	The rendered virtual node.

renderNow()inherited

Renders widget to the DOM immediately.

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

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

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(callback, errback){Promise}inherited

Since: ArcGIS Maps SDK for JavaScript 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

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.

FetchPopupFeaturesPromisesPerLayerView

An object containing popup features for a specific location in addition to its associated layerview.

Properties

layerView LayerView The associated layerview in which the features are fetched.

promise Promise<Graphic[]> A promise containing an array of graphics for the selected location associated with a specific layerview.

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.

clientOnlyGraphics Graphic[] optional An array of graphics that do not have any associated LayerView, ie. view.graphics.

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

promisesPerLayerView FetchPopupFeaturesPromisesPerLayerView[] optional An array of FetchPopupFeaturesPromisesPerLayerView.

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.

Properties

featureNavigation Boolean optional Indicates whether pagination for feature navigation will be displayed. Default value is true. This allows the user to scroll through various selected features using pagination arrows.

closeButton Boolean optional Indicates whether to display a close button on the popup dialog. Default value is true.

Event Overview

Event Details

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 to zoom out from the selected feature
let zoomOutAction = {
 // This text is displayed as a tooltip
 title: "Zoom out",
 // The ID used to reference this action in the event handler
 id: "zoom-out",
 // Sets the icon font used to style the action button
 className: "esri-icon-zoom-out-magnifying-glass"
};
// Adds the custom action to the popup
view.popup.actions.push(zoomOutAction);

// Fires each time an action is clicked
view.popup.on("trigger-action", function(event){
  // If the zoom-out action is clicked, than execute the following code
  if(event.action.id === "zoom-out"){
    // Zoom out two levels (LODs)
    view.goTo({
      center: view.center,
      zoom: view.zoom - 2
    });
  }
});