RelationshipType

Property Overview

Property Details

alias String inherited

The display name of the graph object type.

declaredClass Stringreadonly inherited

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

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 FieldIndex[] inherited

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

name String inherited

The name of the graph object type.

properties GraphProperty[] inherited

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

role String inherited

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

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