Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.mapping.popup

Class PopupMediaValue

java.lang.Object

com.esri.arcgisruntime.mapping.popup.PopupMediaValue

public final class PopupMediaValue
extends Object

Represents the media info values correlating to the type of media.

Since:

100.0.0

Constructor Summary

Constructors

Constructor	Description
PopupMediaValue()	Constructs an empty PopupMediaValue.

Method Summary

Modifier and Type	Method	Description
List<Object>	getData()	Gets the attribute values for the pop-up media's fields defined in getFieldNames().
List<String>	getFieldNames()	Gets the field names of the fields to display in the chart.
List<String>	getLabels()	Gets the user-friendly display names for the pop-up media's fields defined in getFieldNames().
String	getLinkUrl()	Gets the link URL for an image media.
String	getNormalizeFieldName()	Gets the optional field name used to normalize the chart.
String	getSourceUrl()	Gets the source URL for an image media.
String	getTooltipFieldName()	Gets the tooltip field name.
void	setLinkUrl(String linkUrl)	Sets the link URL for an image media.
void	setNormalizeFieldName(String normalizeFieldName)	Sets the optional field name used to normalize the chart.
void	setSourceUrl(String sourceUrl)	Sets the source URL for an image media.
void	setTooltipFieldName(String tooltipFieldName)	Sets the tooltip field name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PopupMediaValue

public PopupMediaValue()

Constructs an empty PopupMediaValue.

Since:

100.0.0

Method Details

getSourceUrl

public String getSourceUrl()

Gets the source URL for an image media.

For PopupMediaValue objects used with a chart, this will be empty.

Returns:

the source URL for an image media

Since:

100.0.0

setSourceUrl

public void setSourceUrl(String sourceUrl)

Sets the source URL for an image media.

Parameters:

sourceUrl - the source URL for an image media

Since:

100.0.0

getLinkUrl

public String getLinkUrl()

Gets the link URL for an image media.

For PopupMediaValue objects used with a chart, this will be empty.

Returns:

the link URL for an image media

Since:

100.0.0

setLinkUrl

public void setLinkUrl(String linkUrl)

Sets the link URL for an image media.

Parameters:

linkUrl - the link URL for an image media

Since:

100.0.0

getNormalizeFieldName

public String getNormalizeFieldName()

Gets the optional field name used to normalize the chart.

Returns:

the optional field name used to normalize the chart

Since:

100.0.0

setNormalizeFieldName

public void setNormalizeFieldName(String normalizeFieldName)

Sets the optional field name used to normalize the chart.

Parameters:

normalizeFieldName - the optional field name used to normalize the chart

Since:

100.0.0

getTooltipFieldName

public String getTooltipFieldName()

Gets the tooltip field name.

Returns:

the tooltip field name

Since:

100.0.0

setTooltipFieldName

public void setTooltipFieldName(String tooltipFieldName)

Sets the tooltip field name.

Parameters:

tooltipFieldName - the tooltip field name

Since:

100.0.0

getData

public List<Object> getData()

Gets the attribute values for the pop-up media's fields defined in getFieldNames(). This property is populated when Popup.evaluateExpressionsAsync() is called.

For PopupMediaValue objects used with an image or if PopupElement.isEvaluated() is false, this will be an empty collection. The data will be normalized if getNormalizeFieldName() is not empty.

Returns:

the attribute values for the pop-up media's fields defined in PopupMediaValue.getFieldNames()

Since:

200.1.0

getFieldNames

public List<String> getFieldNames()

Gets the field names of the fields to display in the chart.

Returns:

the field names of the fields to display in the chart

Since:

100.0.0

getLabels

public List<String> getLabels()

Gets the user-friendly display names for the pop-up media's fields defined in getFieldNames(). This property is populated when Popup.evaluateExpressionsAsync() is called.

For PopupMediaValue objects used with an image or if PopupElement.isEvaluated() is false, this will be an empty collection.

Returns:

the user-friendly display names for the pop-up media's fields defined in PopupMediaValue.getFieldNames()

Since:

200.1.0