import RelationshipInput from "@arcgis/core/widgets/FeatureForm/RelationshipInput.js";const RelationshipInput = await $arcgis.import("@arcgis/core/widgets/FeatureForm/RelationshipInput.js");- Inheritance:
- RelationshipInput→
EditableInput<RelationshipElement>→ InputBase→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.27
This is a read-only support class that represents a relationship input field. It is used by the FeatureForm widget. The values are computed internally by the FeatureFormViewModel.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
displayCount readonly | | |
displayType readonly | "list" | |
editable readonly | | |
editType inherited | ||
group readonly | GroupInput | null | undefined | |
orderByFields readonly | | |
type readonly | "relationship" | |
updating readonly | |
displayCount
- Type
- number
A numeric value indicating the maximum number of related features to display in the list of related records.
If no value is specified, the Show all button will be available to display all related records and the associated displayCount defaults to 3. If the total amount of features is greater than the displayCount, a Show all button displays.
- Default value
- 3
editType
- Type
- EditType
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.
- Default value
- "NA"
group
- Type
- GroupInput | null | undefined
The group containing the relationship input.
orderByFields
- Type
- RelatedRecordsInfoFieldOrder[] | null | undefined
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.