RelationshipInput

Property Overview

Property Details

declaredClass Stringreadonly inherited

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

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 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 Booleanreadonly

Indicates whether the input is editable.

group GroupInputreadonly

The group containing the relationship input.

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 Stringreadonly

The type of input. This value will always be "relationship".

For RelationshipInput the type is always "relationship".

updating Booleanreadonly

Indicates whether the form is currently updating.

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

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(groupKey){Boolean}inherited

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(groupKey)inherited

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");