formRelationshipElement
Defines how a relationship between feature layers and tables can participate in the form. When present in the form, the user may have the option to add or edit related records.
Referenced by: formGroupElement, formInfo
Properties
Property | Details |
---|---|
description | A string that describes the element in detail. |
displayCount | An integer that indicates the maximum number of records to display. |
displayType | A string that defines how the related records should be displayed. Valid value of this property list |
editable | A Boolean determining whether users can edit this form element. If not supplied the default value is true . |
label | A string value indicating what the element represents. |
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. |
relationshipId | The id of the relationship as defined in the feature layer definition |
type | String value indicating which type of element to use. Valid value of this property relationship |
visibilityExpression | A reference to an Arcade expression that returns a boolean value. When this expression evaluates to true , the element is displayed. When the expression evaluates to false the element is not displayed. If no expression is provided, the default behavior is that the element is displayed. |
Example
{
"description": "Inspection Reports",
"displayCount": 3,
"displayType": "list",
"editable": true,
"label": "Inspections",
"orderByFields": [
{
"field": "inspectionDate",
"order": "desc"
}
],
"relationshipId": 0,
"type": "relationship",
"visibilityExpression": "expr0"
}