require(["esri/form/elements/RelationshipElement"], (RelationshipElement) => { /* code goes here */ });
import RelationshipElement from "@arcgis/core/form/elements/RelationshipElement.js";
esri/form/elements/RelationshipElement
A RelationshipElement
form element defines how a relationship between FeatureLayer or MapImageLayer and tables participates in the FeatureForm. When this element is present in the form, the option to add or edit related records is provided per the underlying service's editing permissions and whether it allows relationship editing.
Known Limitations when editing related data
- Support is limited to 1:1 and 1:M cardinality.
- Support is limited to feature-to-table and feature-to-feature relationships, ie. origin-to-destination. The origin's entry point must be a feature with geometry.
- Relationship editing is only supported using ArcGIS Online and ArcGIS Enterprise version 11.2 or higher feature services.
- The layer and associated relationship elements must be editable in order for the relationship to display.
- Data containing related records will display the relationship in the associated form as long as there is a relationship element configured in the layer or form's formTemplate. This can be accomplished via the Map Viewer's authoring experience, Field Maps Designer, or programmatically using the API.
- The related layer or table must also be added to the map to be able to configure relationship elements.
- See also
// Create the relationship element
const relationshipElement = new RelationshipElement({
description: "Past and present building owners",
displayCount: 5,
label: "Building owners",
orderByFields: [{ //autocastable to RelatedRecordsInfoFieldOrder
field: "owner_name",
order: "desc"
}],
relationshipId: 0
});
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
The element's description providing the purpose behind it. | Element | ||
A numeric value indicating the maximum number of related features to display in the list of related records. | RelationshipElement | ||
A string value indicating how to display related records within the relationship content. | RelationshipElement | ||
A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate. | RelationshipElement | ||
A string value containing the field alias. | Element | ||
An array of RelatedRecordsInfoFieldOrder objects indicating the field display order for the related records and whether they should be sorted in ascending | RelationshipElement | ||
The numeric id value for the defined relationship. | RelationshipElement | ||
Indicates the type of form element. | RelationshipElement | ||
A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate. | Element |
Property Details
-
displayCount
displayCount 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 FeatureForm/RelationshipInput defaults to 3. If the total amount of features is greater than thedisplayCount
, aShow all
button displays.- Default Value:3
-
displayType
displayType String
-
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 RelationshipElement the displayType is always "list".
- Default Value:list
-
editableExpression
editableExpression String
-
A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate. The expression must follow the specification defined in the Form Constraint Profile. Expressions may reference field values using the
$feature
global input and must return eithertrue
orfalse
.When this expression evaluates to
true
, it is possible to edit the field value, and vice-versa iffalse
. If the referenced related table is not editable, the editable expression is ignored and the element is not editable.The referenced expression must be defined in the form template's expressionInfos. It cannot be set inline within the element object.
- See also
-
orderByFields
orderByFields RelatedRecordsInfoFieldOrder[]autocast
-
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.
-
relationshipId
relationshipId Number
-
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
istrue
.
-
type
type Stringreadonly
-
Indicates the type of form element.
For RelationshipElement the type is always "relationship".
-
visibilityExpression
InheritedPropertyvisibilityExpression String
Inherited from Element -
A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.
When this expression evaluates to
true
, the element is displayed. When the expression evaluates tofalse
the element is not displayed. If no expression is provided, the element is always displayed. Care must be taken when defining a visibility expression for a non-nullable field as to make certain the specified field has either 1) a default value, or 2) is made visible to the end user to enter a value before submitting the form.- The expression must follow the specification defined in the Form Calculation Profile. This expression references field values within an individual feature or in other layers and must return either a date, number, or string value.
- The referenced expression must be defined in the form template's expressionInfos. It cannot be set inline within the element object.
- Field and Group elements must be visible if the field or one of the grouped fields is required.
Example// Expression created within ExpressionInfos and is referenced in element const expression = new ExpressionInfo({ name: "alwaysHidden", expression: "false" }); // Reference an already-defined visibilityExpression set within the ExpressionInfos const fieldElement = new FieldElement({ type: "field", fieldName: "inspemail", label: "Email address", visibilityExpression: "alwaysHidden" }); formTemplate.expressionInfos = [ expression ]; formTemplate.elements = [ fieldElement ];
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Creates a deep clone of the RelationshipElement class. | RelationshipElement | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | Element | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | Element |
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.
-
clone
clone(){RelationshipElement}
-
Creates a deep clone of the RelationshipElement class.
ReturnsType Description RelationshipElement A deep clone of the RelationshipElement instance.
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input
json
parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameterjson ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
ReturnsType Description * Returns a new instance of this class.
-
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");
-
toJSON
InheritedMethodtoJSON(){Object}
Inherited from Element -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.