Relationship

AMD: require(["esri/layers/support/Relationship"], (Relationship) => { /* code goes here */ });
ESM: import Relationship from "@arcgis/core/layers/support/Relationship";
Class: esri/layers/support/Relationship
Inheritance: Relationship Accessor
Since: ArcGIS Maps SDK for JavaScript 4.7

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

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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name 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.

more details
Relationship
Boolean

Indicates whether the relationship is composite.

more details
Relationship
String

The name of the class.

more details
Accessor
Number

The unique ID for the relationship.

more details
Relationship
String

The field used to establish the relate within the FeatureLayer.

more details
Relationship
String

The key field in an attributed relationship class table that matches the keyField.

more details
Relationship
String

The name of the relationship.

more details
Relationship
Number

The unique ID of the related FeatureLayer.

more details
Relationship
Number

The relationship table id.

more details
Relationship
String

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

more details
Relationship

Property Details

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 Boolean
Since: ArcGIS Maps SDK for JavaScript 4.16

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

declaredClass Stringreadonly inherited

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

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 String

The field used to establish the relate within the FeatureLayer.

keyFieldInRelationshipTable String
Since: ArcGIS Maps SDK for JavaScript 4.16

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

name String

The name of the relationship.

relatedTableId Number

The unique ID of the related FeatureLayer.

relationshipTableId Number
Since: ArcGIS Maps SDK for JavaScript 4.16

The relationship table id.

role String
Since: ArcGIS Maps SDK for JavaScript 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
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
this

Creates a deep clone of this object.

more details
Relationship
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
Relationship
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
Relationship

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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(){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(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(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 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(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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(){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.

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