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. See https://developers.arcgis.com/web-map-specification/objects/formRelationshipElement/.

interface FormRelationshipElementJson {
    description?: string;
    displayCount?: number;
    displayType?: "list";
    editable?: boolean;
    label?: string;
    type: "relationship";
    visibilityExpression?: string;
}

Properties

description?: string

A string that describes the element in detail.

displayCount?: number

An integer that indicates the maximum number of records to display.

displayType

A string that defines how the related records should be displayed.

editable?: boolean

A Boolean determining whether users can edit this form element. If not supplied the default value is true.

label?: string

A string value indicating what the element represents.

type

String value indicating which type of element to use.

visibilityExpression?: string

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.