Represents a pop-up element of type relationship that is displayed in a pop-up for a geoelement. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 200.1 |
| Inherits: |
- List of all members, including inherited members
- RelationshipPopupElement is part of QML Type List.
Properties
- description : string
- displayCount : int
- orderByFields : list<OrderBy>
- relationshipId : string
- relationshipIdAsInt : int
- title : string
Signals
- descriptionChanged()
- displayCountChanged()
- orderByFieldsChanged()
- relationshipIdAsIntChanged()
- relationshipIdChanged()
- titleChanged()
Detailed Description
A typical UI implementation displays a preview of displayCount related records with a possibility to show more records and more detailed info by record.
See also Enums.PopupElementType.
Property Documentation
description : string |
A string value describing the element in detail. Can be an empty string.
displayCount : int |
The maximum number of records to display.
The default value is 3.
If this maximum number is 0, no records will be displayed in the preview.
[read-only] orderByFields : list<OrderBy> |
A list 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.
See also Enums.SortOrder.
relationshipId : string |
The id of the relationship as defined in the feature layer definition.
Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.
Note: relationshipId and relationshipIdIdAsInt can be used interchangeably. Both reference the same underlying API property.
See also relationshipIdAsInt.
relationshipIdAsInt : int |
The same as relationshipId but represented as an integer type (read-only).
Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.
Note: relationshipIdAsInt and relationshipId can be used interchangeably. Both reference the same underlying API property.
title : string |
A string value indicating what the element represents. Can be an empty string.
Signal Documentation
descriptionChanged() |
Emitted when the description property changes.
Note: The corresponding handler is onDescriptionChanged.
displayCountChanged() |
Emitted when the displayCount property changes.
Note: The corresponding handler is onDisplayCountChanged.
orderByFieldsChanged() |
Emitted when the orderByFields property changes.
Note: The corresponding handler is onOrderByFieldsChanged.
relationshipIdAsIntChanged() |
Emitted when the relationshipIdAsInt property changes.
Note: The corresponding handler is onRelationshipIdAsIntChanged.
relationshipIdChanged() |
Emitted when the relationshipId property changes.
Note: The corresponding handler is onRelationshipIdChanged.
titleChanged() |
Emitted when the title property changes.
Note: The corresponding handler is onTitleChanged.