RelationshipElement | References | ArcGIS Maps SDK for JavaScript

import RelationshipElement from "@arcgis/core/form/elements/RelationshipElement.js";

Inheritance:: RelationshipElement→Element→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.27

A RelationshipElement form element defines how a relationship between FeatureLayer or MapImageLayer and Map.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

and 1

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. Relationship editing on layers with preset and group templates are not yet supported.

See also

Example

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`RelationshipElementProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`description` inherited	`string \| null \| undefined`	Element
`displayCount`	`number \| null \| undefined`
`displayType` readonly	`"list"`
`editableExpression`	`string \| null \| undefined`
`label` inherited	`string \| null \| undefined`	Element
`orderByFields`	`RelatedRecordsInfoFieldOrder[] \| null \| undefined`
`relationshipId`	`number`
`type` readonly	`"relationship"`
`visibilityExpression` inherited	`string \| null \| undefined`	Element

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

description

inherited Property

Type: string | null | undefined

Inherited from: Element

The element's description providing the purpose behind it.

displayCount

Property

Type: number | null | undefined

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 RelationshipInput defaults to 3. If the total amount of features is greater than the displayCount, a Show all button displays.

Default value: 3

displayType

readonly Property

Type: "list"

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.

Default value: "list"

editableExpression

Property

Type: string | null | undefined

A reference to the ExpressionInfo.name of an Arcade expression defined in the FormTemplate.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 either true or false.

When this expression evaluates to true, it is possible to edit the field value, and vice-versa if false. 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 FormTemplate.expressionInfos. It cannot be set inline within the element object.

See also

Form Constraint Arcade Profile

label

inherited Property

Type: string | null | undefined

Inherited from: Element

A string value containing the field alias. This should not be used for referencing fields in Arcade expressions. Rather, the service FieldElement.fieldName should be referenced.

orderByFields

autocast Property

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.

relationshipId

Property

Type: 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 is true.

type

readonly Property

Type: "relationship"

Indicates the type of form Element.

visibilityExpression

inherited Property

Type: string | null | undefined

Inherited from: Element

A reference to the ExpressionInfo.name of an Arcade expression defined in the FormTemplate.expressionInfos of the FormTemplate.

When this expression evaluates to true, the element is displayed. When the expression evaluates to false 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 FormTemplate.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.

See also

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 ];

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): RelationshipElement`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	A 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.

Returns: any
Returns a new instance of this class.

clone

Method

Signature: clone (): RelationshipElement

Creates a deep clone of the RelationshipElement class.

Returns: RelationshipElement
A deep clone of the RelationshipElement instance.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.