require(["esri/rest/knowledgeGraph/RelationshipType"], (RelationshipType) => { /* code goes here */ });
import RelationshipType from "@arcgis/core/rest/knowledgeGraph/RelationshipType.js";
esri/rest/knowledgeGraph/RelationshipType
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
-
new RelationshipType(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The display name of the graph object type. more details | GraphObjectType | |
String | The name of the class. more details | Accessor | |
Object[] | Specifies valid origin and destination entity type pairs for this relationship. more details | RelationshipType | |
FieldIndex[] | Specifies index fields for a graph object type. more details | GraphObjectType | |
String | The name of the graph object type. more details | GraphObjectType | |
GraphProperty[] | Specifies the properties of a graph object type such as an EntityType or RelationshipType. more details | GraphObjectType | |
String | The object type's role in the knowledge graph. more details | GraphObjectType |
Property Details
-
The display name of the graph object type.
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
Specifies valid origin and destination entity type pairs for this relationship.
- Properties
-
originEntityType String
The
name
of the origin entity type.destinationEntityType StringThe
name
of the destination entity type.
Example//endpoints for the employed_by relationship "endpoints": [ { "originEntityType": "Person", "destinationEntityType": "Company" } ]
-
fieldIndexes FieldIndex[] inherited
-
Specifies index fields for a graph object type. knowledgeGraphService.executeSearch() will include content from indexed text and GUID fields.
-
The name of the graph object type.
-
properties GraphProperty[] inherited
-
Specifies the properties of a graph object type such as an EntityType or RelationshipType.
-
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 associatedHasDocument
relationship) are included in all knowledge graph services by default.- Default Value:"Regular"
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | GraphObjectType | |
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 | GraphObjectType |
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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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(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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.