require(["esri/widgets/FeatureForm/RelationshipInput"], (RelationshipInput) => { /* code goes here */ });
import RelationshipInput from "@arcgis/core/widgets/FeatureForm/RelationshipInput.js";
esri/widgets/FeatureForm/RelationshipInput
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.
- See also
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
The input's description. | RelationshipInput | ||
A numeric value indicating the maximum number of related features to display in the list of related records. | RelationshipInput | ||
A string value indicating how to display related records within the relationship content. | RelationshipInput | ||
Indicates whether the input is editable. | RelationshipInput | ||
The group containing the relationship input. | RelationshipInput | ||
An array of RelatedRecordsInfoFieldOrder objects indicating the field display order for the related records and whether they should be sorted in ascending | RelationshipInput | ||
The type of input. | RelationshipInput | ||
Indicates whether the form is currently updating. | RelationshipInput |
Property Details
-
description
description Stringreadonly
-
The input's description.
-
displayCount
displayCount Numberreadonly
-
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 FeatureForm/RelationshipInput defaults to 3. If the total amount of features is greater than thedisplayCount
, aShow all
button displays.- Default Value:3
-
displayType
displayType Stringreadonly
-
A string value indicating how to display related records within the relationship content. Currently,
list
is the only supported value.Value Description list Shows a list of related records from the specified relationship. For RelationshipInput the displayType is always "list".
- Default Value:"list"
-
editable
editable Booleanreadonly
-
Indicates whether the input is editable.
-
group
group GroupInputreadonly
-
The group containing the relationship input.
-
orderByFields
orderByFields RelatedRecordsInfoFieldOrder[]readonly
-
An array of RelatedRecordsInfoFieldOrder objects indicating the field display order for the related records and whether they should be sorted in ascending
asc
or descendingdesc
order.
-
type
type Stringreadonly
-
The type of input.
For RelationshipInput the type is always "relationship".
-
updating
updating Booleanreadonly
-
Indicates whether the form is currently updating.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");