RelationshipType | API Reference | ArcGIS Maps SDK for JavaScript 4.31

A relationship type defines a homogenous collection of relationships that can exist between two entity types, with a common set of properties. For example, a relationship type defining vehicle ownership can associate a vehicle with a person, and the relationship can have properties such as the date a person bought the car and the date a person sold the car.

Many instances of a relationship type can be added to the knowledge graph. For example, to describe a family, multiple instances of the spouse-of, parent-of, and child-of relationships can be defined between two-person entities. Multiple instances of owns, leases, or rents relationship types can be defined between a person entity and vehicle or building entities.

See also

Constructors

RelationshipType Constructor new RelationshipType(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 display name of the graph object type.	GraphObjectType
String	The name of the class.	Accessor
Object []	Specifies valid origin and destination entity type pairs for this relationship.	RelationshipType
FieldIndex []	Specifies index fields for a graph object type.	GraphObjectType
String	The name of the graph object type.	GraphObjectType
GraphProperty []	Specifies the properties of a graph object type such as an EntityType or RelationshipType.	GraphObjectType
String	The object type's role in the knowledge graph.	GraphObjectType

Property Details

alias Inherited Property alias String Inherited from GraphObjectType

The display name of the graph object type.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

endPoints Property endPoints Object[]

Specifies valid origin and destination entity type pairs for this relationship.

Properties: originEntityType String

The name of the origin entity type.

destinationEntityType String

The name of the destination entity type.

Example

//endpoints for the employed_by relationship
"endpoints": [
 {
  "originEntityType": "Person",
  "destinationEntityType": "Company"
 }
]

fieldIndexes Inherited Property fieldIndexes FieldIndex[] Inherited from GraphObjectType

Specifies index fields for a graph object type. knowledgeGraphService.executeSearch() will include content from indexed text and GUID fields.

name Inherited Property name String Inherited from GraphObjectType

The name of the graph object type.

properties Inherited Property properties GraphProperty[] Inherited from GraphObjectType

Specifies the properties of a graph object type such as an EntityType or RelationshipType.

role Inherited Property role String Inherited from GraphObjectType

The object type's role in the knowledge graph. Designates objects that have capabilities that are not available to other objects. For example, the document entity type has a specific role of 'Document'. The Document entity type (and the associated HasDocument relationship) are included in all knowledge graph services by default.

Default Value:"Regular"

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.	GraphObjectType
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.	GraphObjectType

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 GraphObjectType

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.