arcgis-maps-kotlin/com.arcgismaps.mapping.popup/PopupMedia

PopupMedia

class PopupMedia

Represents the media that is displayed in a pop-up for a geo-element.

Since

200.1.0

See also

Constructors

Link copied to clipboard
constructor()

Create a new popup media. Use this object to define an image or a chart to be displayed in a pop-up window.

Properties

Link copied to clipboard
var caption: String

The caption that is displayed for the media. This can contain a literal value, or a placeholder for value from the geoelement's attribute for which the pop-up is displayed. The placeholder needs to be of the form {field_name} where field_name is a key in the geoelement's attributes.

Link copied to clipboard
var imageRefreshInterval: Long

The image refresh interval. This property is useful only for a pop-up media of type PopupMediaType.Image. The refresh interval, in milliseconds. A refresh interval of 0 means never refresh. The default value is 0.

Link copied to clipboard
var title: String

The title that is displayed for the media. This can contain a literal value, or a placeholder for value from the geoelement's attribute for which the pop-up is displayed. The placeholder needs to be of the form {field_name} where field_name is a key in the geoelement's attributes.

Link copied to clipboard
var type: PopupMediaType

The type of media.

Link copied to clipboard
var value: PopupMediaValue?

The optional popup media value that are depending on the type of media. A null if an error occurs or if the popup media has no associated value.

Functions

Link copied to clipboard
suspend fun generateChart(parameters: ChartImageParameters): Result<ChartImage>

Generates a ChartImage with an image of the chart. Will fail if the pop_up media is a PopupMediaType.Image or if PopupElement.isEvaluated is false.