Relationship | API Reference | ArcGIS Maps SDK for JavaScript 4.31

A relationship is an instance of a relationship type that defines an association between two entities. Examples include "owns", "called", or "employed by". A relationship is described in a single direction. Every relationship describes an association from one entity to another entity. If two people in a family are siblings, each person entity requires a separate sibling-of relationship to the other entity to fully describe the relationship.

See also

Entity

Examples

// sample creation of new Relationship object
require([
 "esri/rest/knowledgeGraphService",
 "esri/rest/knowledgeGraph/Relationship",
], (knowledgeGraphModule, Relationship) => {
  const newRelationship = new Relationship({
    typeName: "buys_part",
    properties: {
      quantity: 5000
    },
    destinationId: "{HNEIS053-AW6F-G9W4-8412-MROEJHM25694}",
    originId: "{D1HRH4D3-1RE5-JTRH-1D5F-21TH8HRDHTRS}"
  })
});

// sample relationship returned as a result of a search or query on a knowledge graph
[{
 "declaredClass": "esri.rest.Relationship.Relationship",
 "originId": "1234",
 "destinationId": "5678",
 "properties": {
   "order_day": "Sunday",
   "quantity": 15000
 },
 "typeName": "buys_part",
 "id": "{ANWIFHSAS-AW6F-G9W4-8412-A1A8W4F1A5S6F}",
}]

Constructors

Relationship Constructor new Relationship(properties)

Parameter

properties Object

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

Example

const newRelationship = new Relationship({
  typeName: "buys_part",
  properties: {
    quantity: 5000
  },
  destinationId: "{HNEIS053-AW6F-G9W4-8412-MROEJHM25694}",
  originId: "{D1HRH4D3-1RE5-JTRH-1D5F-21TH8HRDHTRS}"
});

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 name of the class.	Accessor
String	The ID of the destination entity of the relationship (i.e.	Relationship
String	The unique ID of the object.	GraphNamedObject
String	The ID of the origin entity of the relationship (i.e.	Relationship
Object	The properties of the graph object.	GraphObject
String	Specifies the name for all similar types of objects (entities or relationships) defined in the knowledge graph.	GraphNamedObject

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

destinationId Property destinationId String

The ID of the destination entity of the relationship (i.e. the 'to' entity).

id Inherited Property id String Inherited from GraphNamedObject

The unique ID of the object.

originId Property originId String

The ID of the origin entity of the relationship (i.e. the 'from' entity).

properties Inherited Property properties Object Inherited from GraphObject

The properties of the graph object. For entities and relationships the properties are specified by its entity type or relationship type. The values of the properties are specific to the object.

Examples

//example of properties structure that includes geometry
"properties": {
  "shape": {
    "declaredClass": "esri.geometry.Point",
    "cache": {},
    "hasM": false,
    "hasZ": false,
    "latitude": 53.589000000000009,
    "longitude": -0.9633,
    "type": "point",
    "extent": null,
    "spatialReference": {
      "wkid": 4326
    },
    "x": -0.9633,
    "y": 53.589000000000009
  },
  "Name": "Suncommon",
  "Employee_Count": 400,
  "Address": "123 Broadway, New York, New York",
  "EnergyType": "solar"
}

//two entities of different entity types with different properties
[{
  "declaredClass": "esri.rest.knowledgeGraph.Entity",
  "properties": {
    "Name": "Suncommon",
    "Employee_Count": 400,
    "energyType": "solar"
  },
  "typeName": "Company",
  "id": "1256"
},
{
  "declaredClass": "esri.rest.knowledgeGraph.Entity",
  "properties": {
    "Name": "Empire State Building",
    "height": 1454,
    "heightUnits": "feet",
    "city": "New York"
  },
  "typeName": "Building",
  "id": "B7889541"
}]

//two relationships of different relationship types with different properties
[{
  "declaredClass": "esri.rest.Relationship.Relationship",
  "properties": {
    "start_date": "2020-04-17",
    "employee_id": "4589",
    "office": "152 Building A"
  },
  "typeName": "Employed_by",
  "id": "B7889541"
},
{
  "declaredClass": "esri.rest.Relationship.Relationship",
  "properties": {
    "quantity": 125000,
    "frequency": "bi-weekly",
    "contact_person": "Betty White"
  },
  "typeName": "buys_part",
  "id": "B7889541"
}]

typeName Inherited Property typeName String Inherited from GraphNamedObject

Specifies the name for all similar types of objects (entities or relationships) defined in the knowledge graph. For example, all 'employee' entities in a knowledge graph of an organization might have the typeName 'employee'.

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
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	GraphObject
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.	GraphObject

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) 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();

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.

fromJSON Inherited 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

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

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 Inherited Method toJSON(){Object} Inherited from GraphObject

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.