Relationship | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Describes a layer's relationship with another layer or table. These relationships are listed in the ArcGIS Services directory as described in the REST API documentation.

See also

Constructors

Relationship Constructor new Relationship(properties)

Parameter

properties Object

optional

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

Property Overview

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

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The cardinality which specifies the number of objects in the origin FeatureLayer related to the number of objects in the destination FeatureLayer.	Relationship
Boolean	Indicates whether the relationship is composite.	Relationship
String	The name of the class.	Accessor
Number	The unique ID for the relationship.	Relationship
String	The field used to establish the relate within the FeatureLayer.	Relationship
String	The key field in an attributed relationship class table that matches the keyField.	Relationship
String	The name of the relationship.	Relationship
Number	The unique ID of the related FeatureLayer.	Relationship
Number	The relationship table id.	Relationship
String	Indicates whether the table participating in the relationship is the `origin` or `destination` table.	Relationship

Property Details

cardinality Property cardinality String

The cardinality which specifies the number of objects in the origin FeatureLayer related to the number of objects in the destination FeatureLayer. Please see the Desktop help for additional information on cardinality.

Possible Values:"one-to-one" |"one-to-many" |"many-to-many"

composite Property composite Boolean Since: ArcGIS Maps SDK for JavaScript 4.16 Relationship since 4.7, composite added at 4.16.

Indicates whether the relationship is composite. In a composite relationship, a destination object cannot exist independently of its origin object.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

id Property id Number

The unique ID for the relationship. These ids for the relationships the FeatureLayer participates in are listed in the ArcGIS Services directory.

keyField Property keyField String

The field used to establish the relate within the FeatureLayer.

keyFieldInRelationshipTable Property keyFieldInRelationshipTable String Since: ArcGIS Maps SDK for JavaScript 4.16 Relationship since 4.7, keyFieldInRelationshipTable added at 4.16.

The key field in an attributed relationship class table that matches the keyField. This is returned only for attributed relationships.

name Property name String

The name of the relationship.

relatedTableId Property relatedTableId Number

The unique ID of the related FeatureLayer.

relationshipTableId Property relationshipTableId Number Since: ArcGIS Maps SDK for JavaScript 4.16 Relationship since 4.7, relationshipTableId added at 4.16.

The relationship table id.

role Property role String Since: ArcGIS Maps SDK for JavaScript 4.16 Relationship since 4.7, role added at 4.16.

Indicates whether the table participating in the relationship is the origin or destination table.

Possible Values:"origin" |"destination"

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
this	Creates a deep clone of this object.	Relationship
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	Relationship
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	Relationship

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

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.

clone Method clone(){this}

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns

Type	Description
this	A deep clone of the class instance that invoked this method.

fromJSON Method fromJSON(json){*}static

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.

Parameter

json Object

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

Type	Description
*	Returns a new instance of this class.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

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 Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

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

toJSON Method toJSON(){Object}

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

Returns

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.