RelationshipElementInput

Since

ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

The input's description.

A numeric value indicating the maximum number of related features to display in the list of related records. If the total amount of features is greater than the displayCount, a Show all button displays.

A string value indicating how to display related records within the relationship content. Currently, list is the only supported value.

Indicates if the input is editable.

The type of edit operation the form is being used for. This can influence whether a field is editable or not (e.g., the layer only allows certain edit operations)

This is also the value that will be set for the Arcade variable $editcontext.editType in the Arcade context used to evaluate form expressions.

Accepted values are "INSERT", "UPDATE", "DELETE", and "NA".

For FieldInputs with value expressions, this property is also used in determining whether or not the value expressions should be applied. Per the Web Map Specification, value expressions are ignored if the associated layer field is not editable. Determining whether the layer field is editable must consider whether the specific type of edit being attempted is allowed. For example, if a layer has the supportsAdd capability but does not have the supportsUpdate capability, then the value expression will be applied if editType is INSERT but ignored if editType is UPDATE.

For the purposes of determining whether or not the layer allows the current edit type, a value of "NA" is always considered allowed.

Indicates whether the input pertains to all the features in the BatchAttributeForm in which the input belongs.

The single feature associated with this relationship element.

See also

• BatchAttributeFormViewModel.features

The group containing the relationship element input.

The input's label.

Identifies the single feature layer associated with this relationship element. The layer must support feature editing and field access.

The following layer types are supported:

• FeatureLayer
• GeoJSONLayer
• SceneLayer (with featureLayer property)
• SubtypeSublayer
• OrientedImageryLayer
• KnowledgeGraphSublayer

See also

• BatchAttributeFormViewModel.layers

An array of layers included in the BatchAttributeForm. Each layer must support feature editing and field access.

The following layer types are supported:

• FeatureLayer
• GeoJSONLayer
• SceneLayer (with featureLayer property)
• SubtypeSublayer
• OrientedImageryLayer
• KnowledgeGraphSublayer

See also

• BatchAttributeFormViewModel.layers

An array of RelatedRecordsInfoFieldOrder objects indicating the field display order for the related records and whether they should be sorted in ascending asc or descending desc order.

The numeric id value for the defined relationship. This value can be found on the service itself or on the service's relationships resource if supportsRelationshipResource is true.

The type of input.

Indicates whether the form is currently updating.

Indicates whether the input currently has valid user input.

Indicates whether the input is visible.