Relationship

// 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}",
}]

Property Overview

Property Details

declaredClass Stringreadonly inherited

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

destinationId String

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

id String inherited

The unique ID of the object.

originId String

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

properties Object inherited

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 String inherited

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

Method Details

addHandles(handleOrHandles, groupKey)inherited

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.

hasHandles(groupKey){Boolean}inherited

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

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