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

RelationshipPopupElement

class RelationshipPopupElement : PopupElement

Represents a pop-up element of type relationship that is displayed in a pop-up for a geoelement. A typical UI implementation displays a preview of RelationshipPopupElement.displayCount related records with a possibility to show more records and more detailed info by record.

Since

200.1.0

Constructors

RelationshipPopupElement

constructor(relationshipId: Long)

Creates a new relationship pop-up element with the given relationship ID.

Properties

description

var description: String

A string value describing the element in detail. Can be an empty string.

displayCount

var displayCount: Int

The maximum number of records to display. The default value is 3.

orderByFields

val orderByFields: MutableList<OrderBy>

A MutableList of OrderBy objects indicating the display order for the related records and whether they should be sorted in ascending or descending order. If this collection is empty, the related records are displayed in whatever order the server decides.

relationshipId

val relationshipId: Long

The id of the relationship as defined in the feature layer definition.

title

var title: String

A string value indicating what the element represents. Can be an empty string.

Inherited properties

isEvaluated

val isEvaluated: Boolean

True if the pop-up element is contained in the Popup.evaluatedElements, false otherwise.

Inherited functions

toJson

open override fun toJson(): String

Convert an object to JSON string.