Provides the ability to navigate and view related records from a layer or table associated within the pop-up.

Referenced by: popupElement

Properties

PropertyDetails
descriptionA string that describes the element in detail.
displayCountAn integer that indicates the maximum number of records to display.
displayTypeA string that defines how the related records should be displayed.
Valid value of this property list
orderByFields[]Array of orderByField objects indicating the display order for the related records, and whether they should be sorted in ascending 'asc' or descending 'desc' order. If orderByFields is not provided, the popupElement will display whatever is specified directly in the popupInfo.relatedRecordsInfo.orderByFields property.
relationshipIdThe id of the relationship as defined in the feature layer definition
titleA string value indicating what the element represents.
typeString value indicating which type of element to use.
Valid value of this property relationship

Example

{
"description": "Inspection Reports",
"displayCount": 3,
"displayType": "list",
"title": "Inspections",
"orderByFields": [
{
"field": "inspectionDate",
"order": "desc"
}
],
"relationshipId": 0,
"type": "relationship"
}