import RelationshipType from "@arcgis/core/rest/knowledgeGraph/RelationshipType.js";const RelationshipType = await $arcgis.import("@arcgis/core/rest/knowledgeGraph/RelationshipType.js");- Inheritance
- RelationshipType→
GraphObjectType→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.25
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
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| inherited | ||
| readonly inherited | ||
| | ||
| inherited | ||
| inherited | ||
| inherited | ||
| inherited |
alias
- The display name of the graph object type that can be updated.
endPoints
- Type
- RelationshipTypeEndPoints[]
Specifies valid origin and destination entity type pairs for this relationship.
- Example
- //endpoints for the employed_by relationship"endpoints": [{"originEntityType": "Person","destinationEntityType": "Company"}]
fieldIndexes
- Type
- FieldIndex[]
Specifies index fields for a graph object type. executeSearch() will include content from indexed text and GUID fields.
name
- Type
- string
The name of the graph object type.
properties
- Type
- GraphProperty[]
Specifies the properties of a graph object type such as an EntityType or RelationshipType.
role
- Type
- NamedObjectType
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"
Methods
| Method | Signature | Class |
|---|---|---|
| inherited static | fromJSON(json: any): any | |
| inherited | toJSON(): any |
fromJSON
- Signature
-
fromJSON (json: any): any
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.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | 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
- any
Returns a new instance of this class.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.