Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.mapping.popup

Class FieldsPopupElement

java.lang.Object
com.esri.arcgisruntime.mapping.popup.PopupElement
com.esri.arcgisruntime.mapping.popup.FieldsPopupElement
All Implemented Interfaces:
JsonSerializable
public final class FieldsPopupElement extends PopupElement
Represents a pop-up element of type fields that defines an array of PopupField displayed as a table within a pop-up for a geoelement.
Since:
100.14.0

  • Constructor Details

    • FieldsPopupElement

      public FieldsPopupElement(Iterable<PopupField> fields)
      Creates a new fields pop-up element with the given collection of PopupField.
      Parameters:
      fields - a collection of PopupField defining how each field participates in the pop-up window. When an empty collection is passed, this element will display whatever is specified in the PopupDefinition.getFields().
      Throws:
      IllegalArgumentException - if fields is null
      Since:
      100.14.0

  • Method Details

    • getDescription

      public String getDescription()
      Gets a string value describing the element in detail. Can be an empty string.
      Returns:
      a string value describing the element in detail. Can be an empty string.
      Since:
      100.14.0
      See Also:

    • setDescription

      public void setDescription(String description)
      Sets a string value describing the element in detail. Can be an empty string.
      Parameters:
      description - a string value describing the element in detail. Can be an empty string.
      Throws:
      IllegalArgumentException - if description is null
      Since:
      100.14.0
      See Also:

    • getFields

      public List<PopupField> getFields()
      Gets a mutable list of PopupField defining how each field participates in the pop-up window.
      Returns:
      a mutable list of PopupField defining how each field participates in the pop-up window
      Since:
      100.14.0

    • getFormattedValues

      public List<String> getFormattedValues()
      Gets the formatted values for the fields defined in getFields(). This property is populated when Popup.evaluateExpressionsAsync() is called.

      Dates and times are returned in the local timezone.

      If a field is part of a CodedValueDomain, the CodedValue.getName() is returned.

      If PopupElement.isEvaluated() is false, this property will return an empty collection.

      Returns:
      the formatted values for the fields defined in FieldsPopupElement.getFields()
      Since:
      200.1.0

    • getLabels

      public List<String> getLabels()
      Gets the user-friendly display names for the fields defined in getFields(). This property is populated when Popup.evaluateExpressionsAsync() is called.

      If PopupElement.isEvaluated() is false, this property will return an empty collection.

      Returns:
      the user-friendly display names for the fields defined in FieldsPopupElement.getFields()
      Since:
      200.1.0

    • getTitle

      public String getTitle()
      Gets a string value indicating what the element represents. Can be an empty string.
      Returns:
      a string value indicating what the element represents. Can be an empty string.
      Since:
      100.14.0
      See Also:

    • setTitle

      public void setTitle(String title)
      Sets a string value indicating what the element represents. Can be an empty string.
      Parameters:
      title - a string value indicating what the element represents. Can be an empty string.
      Throws:
      IllegalArgumentException - if title is null
      Since:
      100.14.0
      See Also: