Class TextPopupElement
- java.lang.Object
-
- com.esri.arcgisruntime.mapping.popup.PopupElement
-
- com.esri.arcgisruntime.mapping.popup.TextPopupElement
-
public final class TextPopupElement extends PopupElement
Represents a pop-up element of type text that defines descriptive text as an element to display in a pop-up for a geoelement. The text may reference values returned from a field attribute or an Arcade expression defined in thePopupDefinition.getExpressions()
. The text may also leverage a basic subset of HTML tags for formatting the look and feel of the text.- Since:
- 100.14.0
- See Also:
PopupElement
-
-
Constructor Summary
Constructors Constructor Description TextPopupElement(String text)
Creates a new text pop-up element with the given text.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getText()
Gets the text to display in the pop-up.void
setText(String text)
Sets the text to display in the pop-up.
-
-
-
Constructor Detail
-
TextPopupElement
public TextPopupElement(String text)
Creates a new text pop-up element with the given text. The text may reference values returned from a field attribute or an Arcade expression defined in thePopupDefinition.getExpressions()
. The text may also leverage a basic subset of HTML tags for formatting the look and feel of the text.- Parameters:
text
- a string indicating the text to be displayed within the pop-up element. If an empty string is provided, the pop-up element will display whatever is specified in thePopupDefinition.getDescription()
.- Throws:
IllegalArgumentException
- if text is null- Since:
- 100.14.0
-
-
Method Detail
-
getText
public String getText()
Gets the text to display in the pop-up.- Returns:
- the text to display in the pop-up
- Since:
- 100.14.0
- See Also:
setText(String)
-
setText
public void setText(String text)
Sets the text to display in the pop-up.- Parameters:
text
- the text to display in the pop-up- Throws:
IllegalArgumentException
- if text is null- Since:
- 100.14.0
- See Also:
getText()
-
-