java.lang.Object
- com.esri.arcgisruntime.mapping.popup.Popup

```
public final class Popup
extends Object
```
Represents the combination of a PopupDefinition and a GeoElement, which allows a visual representation of the GeoElement's attributes as well as the ability to edit them.

Since:

100.0.0

Constructor Summary

Constructors
Constructor	Description
`Popup(GeoElement geoElement)`	Creates a new popup from a `GeoElement`.
`Popup(GeoElement geoElement, PopupDefinition popupDefinition)`	Creates a new popup from a `GeoElement` and `PopupDefinition`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ListenableFuture<List<PopupExpressionEvaluation>>`	`evaluateExpressionsAsync()`	Asynchronously evaluates all expressions available at `PopupDefinition.getExpressions()` or at `ExpressionPopupElement.getPopupExpression()`.
`String`	`getDescription()`	Gets the description of the Popup.
`List<PopupElement>`	`getEvaluatedElements()`	Gets an unmodifiable list of `PopupElement` objects evaluated asynchronously by `evaluateExpressionsAsync()`.
`String`	`getFormattedValue(PopupField popupField)`	Gets the formatted value of the popup field.
`GeoElement`	`getGeoElement()`	Gets the `GeoElement` of the pop-up.
`PopupDefinition`	`getPopupDefinition()`	Gets the popup definition associated with the popup.
`Symbol`	`getSymbol()`	Gets the symbol of the Popup.
`String`	`getTitle()`	Gets the title of the Popup.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Popup
```
public Popup(GeoElement geoElement)
```
    Creates a new popup from a GeoElement. This method creates a default PopupDefinition with default properties and default popup elements based on the given GeoElement.
    
    Parameters:
    
    geoElement - the GeoElement for the popup, such as a Feature or Graphic
    
    Throws:
    
    IllegalArgumentException - if geoElement is null
    
    Since:
    
    100.0.0
  - Popup
```
public Popup(GeoElement geoElement,
             PopupDefinition popupDefinition)
```
    Creates a new popup from a GeoElement and PopupDefinition.
    If the PopupDefinition is null, a new one will be created based off the attributes of the GeoElement.
    
    Parameters:
    
    geoElement - the GeoElement for the popup, such as a Feature or Graphic
    
    popupDefinition - the PopupDefinition
    
    Throws:
    
    IllegalArgumentException - if geoElement is null
    
    Since:
    
    100.0.0
- Method Detail
  - getPopupDefinition
```
public PopupDefinition getPopupDefinition()
```
    Gets the popup definition associated with the popup.
    
    Returns:
    
    the popup definition associated with the popup
    
    Since:
    
    100.0.0
  - getGeoElement
```
public GeoElement getGeoElement()
```
    Gets the GeoElement of the pop-up.
    
    Returns:
    
    the GeoElement of the pop-up
    
    Since:
    
    100.0.0
  - getTitle
```
public String getTitle()
```
    Gets the title of the Popup.
    
    Returns:
    
    the title of the Popup
    
    Since:
    
    100.0.0
  - getDescription
```
public String getDescription()
```
    Gets the description of the Popup.
    
    Returns:
    
    the description of the Popup
    
    Since:
    
    100.0.0
  - getSymbol
```
public Symbol getSymbol()
```
    Gets the symbol of the Popup.
    
    Returns:
    
    the symbol of the Popup
    
    Since:
    
    100.0.0
  - getFormattedValue
```
public String getFormattedValue(PopupField popupField)
```
    Gets the formatted value of the popup field.
    Dates/times are returned in the local timezone. If PopupDefinition.getExpressions() is not empty, then it is possible that the PopupField may be using expressions with Arcade FeatureSets functions. Use evaluateExpressionsAsync() to evaluate the Arcade expressions before trying to get the formatted String representation of the popup field's value; otherwise it may return an empty string or "0.00" if the return type is PopupExpression.ReturnType.NUMBER.
    If the field is part of a CodedValueDomain, the CodedValue.getName() is returned.
    
    Parameters:
    
    popupField - the popup field
    
    Returns:
    
    the formatted string representing the value of the popup field.
    
    Since:
    
    100.3.0
  - evaluateExpressionsAsync
```
public ListenableFuture<List<PopupExpressionEvaluation>> evaluateExpressionsAsync()
```
    Asynchronously evaluates all expressions available at PopupDefinition.getExpressions() or at ExpressionPopupElement.getPopupExpression(). The expression can include Arcade FeatureSet functions, which need to be evaluated asynchronously.
    Also populates the getEvaluatedElements() from the PopupDefinition.getElements(). During the evaluation, each ExpressionPopupElement is replaced by the PopupElement returned by the Arcade expression and each placeholder is replaced by its value.
    This method must be called before displaying the popup information in a UI so you can use synchronous methods getFormattedValue(PopupField) and substitute(String) to get the formatted String representation. If there are no PopupDefinition.getExpressions() and no popup elements of type ExpressionPopupElement then the result array will be empty.
    The PopupExpression may be used in the PopupDefinition.getFields(), PopupDefinition.getMedia(), PopupDefinition.getTitle() and PopupDefinition.getDescription().
    
    Returns:
    
    a ListenableFuture that contains an array of PopupExpressionEvaluation
    
    Since:
    
    100.8.0
  - getEvaluatedElements
```
public List<PopupElement> getEvaluatedElements()
```
    Gets an unmodifiable list of PopupElement objects evaluated asynchronously by evaluateExpressionsAsync(). During the evaluation, each ExpressionPopupElement is replaced by the PopupElement returned by the Arcade expression and each placeholder is replaced by its value. If the Arcade expression returns a list of attributes to be used by the popup element, these attributes will be used by getFormattedValue(PopupField)}.
    The list is empty while evaluateExpressionsAsync() has not been executed, and is cleared if evaluateExpressionsAsync() is executed more than once. After evaluation, the order of the popup elements in the list matches the order elements present in PopupDefinition.getElements() and shown in the pop-up window. If an ExpressionPopupElement fails to be evaluated, then it will be skipped in the list. Use the array of PopupExpressionEvaluation returned from evaluateExpressionsAsync() to learn the cause of the error.
    
    Returns:
    
    an unmodifiable list of PopupElement evaluated asynchronously by evaluateExpressionsAsync(). During the evaluation, each ExpressionPopupElement is replaced by the PopupElement returned by the Arcade expression and each placeholder is replaced by its value. If the Arcade expression returns a list of attributes to be used by the popup element, these attributes will be used by getFormattedValue(PopupField).
    
    Since:
    
    100.14.0
    
    See Also:
    
    PopupDefinition.getElements(), evaluateExpressionsAsync()

Class Popup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Popup

Popup

Method Detail

getPopupDefinition

getGeoElement

getTitle

getDescription

getSymbol

getFormattedValue

evaluateExpressionsAsync

getEvaluatedElements