RelationshipInput

AMD: require(["esri/widgets/FeatureForm/RelationshipInput"], (RelationshipInput) => { /* code goes here */ });
ESM: import RelationshipInput from "@arcgis/core/widgets/FeatureForm/RelationshipInput.js";
Class: esri/widgets/FeatureForm/RelationshipInput
Inheritance: RelationshipInput 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.

See also

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
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 asc or descending desc order.

RelationshipInput

The type of input.

RelationshipInput

Indicates whether the form is currently updating.

RelationshipInput

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

description

Property
description Stringreadonly

The input's description.

displayCount

Property
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 the displayCount, a Show all button displays.

Default Value:3

displayType

Property
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

Property
editable Booleanreadonly

Indicates whether the input is editable.

group

Property
group GroupInputreadonly

The group containing the relationship input.

orderByFields

Property
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 descending desc order.

type

Property
type Stringreadonly

The type of input.

For RelationshipInput the type is always "relationship".

updating

Property
updating Booleanreadonly

Indicates whether the form is currently updating.

Method Overview

Show inherited methods Hide inherited methods
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

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
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();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.