KnowledgeGraph | API Reference | ArcGIS Maps SDK for JavaScript 4.31

The knowledge graph associated with the knowledgeGraphService. This is a graph database that stores entities and relationships.

See also

knowledgeGraphService.fetchKnowledgeGraph()
Hosted Knowledge Graph Service for information on the structure knowledge graph services on ArcGIS Enterprise and the REST API

Examples

//fetch the knowledge graph
require([
  "esri/rest/knowledgeGraphService"
], (KnowledgeGraphModule)  => {
  const url = "https://<web server hostname>/server/rest/admin/services/<serviceName>/KnowledgeGraphServer";
  KnowledgeGraphModule.fetchKnowledgeGraph(url)
   .then((kg) => {
      //do something with result
     console.log(kg)
  });
});

//sample result returned from fetchKnowledgeGraph()
{
 "url":"https://myHostName.domain.com/arcgis/rest/services/Hosted/myServiceName/KnowledgeGraphServer"
 {
 "dataModel": {
   "declaredClass": "esri.rest.knowledgeGraph.DataModel",
   "timestamp": {},
   "spatialReference": {
     "latestWkid": 0,
     "wkid": 4326,
     "vcsWkid": 0,
     "latestVcsWkid": 0
   },
   "strict": false,
   "entityTypes": [
     {
       "declaredClass": "esri.rest.knowledgeGraph.EntityType",
       "name": "company",
       "alias": "Company",
       "role": "Regular",
       "strict": false,
       "properties": [
         {
           "declaredClass": "esri.rest.knowledgeGraph.GraphProperty",
           "name": "Name",
           "alias": "Name",
           "fieldType": "esriFieldTypeString",
           "geometryType": "esriGeometryNull",
           "hasM": false,
           "hasZ": false,
           "nullable": true,
           "editable": true,
           "required": false,
           "defaultVisibility": true,
           "systemMaintained": false,
           "role": "esriGraphPropertyRegular",
           "defaultValue": null
         },
         {
           "declaredClass": "esri.rest.knowledgeGraph.GraphProperty",
           "name": "id",
           "alias": "ID",
           "fieldType": "esriFieldTypeOID",
           "geometryType": "esriGeometryNull",
           "hasM": false,
           "hasZ": false,
           "nullable": false,
           "editable": false,
           "required": true,
           "defaultVisibility": true,
           "systemMaintained": true,
           "role": "esriGraphPropertyRegular",
           "defaultValue": null
         }
       ],
       "fieldIndexes": [
         {
           "declaredClass": "esri.rest.knowledgeGraph.FieldIndex",
           "name": "esri__id_idx",
           "unique": true,
           "ascending": true,
           "description": "",
           "fieldNames": [
             "id"
           ]
         },
         {
           "declaredClass": "esri.rest.knowledgeGraph.FieldIndex",
           "name": "esri__name_idx",
           "unique": true,
           "ascending": true,
           "description": "",
           "fieldNames": [
             "name"
           ]
         }
       ]
     }
   ],
   "relationshipTypes": [
     {
       "declaredClass": "esri.rest.knowledgeGraph.RelationshipType",
       "name": "employed_bu",
       "alias": "Employed By",
       "role": "Regular",
       "strict": false,
       "properties": [
         {
           "declaredClass": "esri.rest.knowledgeGraph.GraphProperty",
           "name": "id",
           "alias": "id",
           "fieldType": "esriFieldTypeGUID",
           "geometryType": "esriGeometryNull",
           "hasM": false,
           "hasZ": false,
           "nullable": false,
           "editable": false,
           "required": true,
           "defaultVisibility": true,
           "systemMaintained": true,
           "role": "esriGraphPropertyRegular",
           "defaultValue": null
         },
         {
           "declaredClass": "esri.rest.knowledgeGraph.GraphProperty",
           "name": "start_date",
           "alias": "Start Date",
           "fieldType": "esriFieldTypeGUID",
           "geometryType": "esriGeometryNull",
           "hasM": false,
           "hasZ": false,
           "nullable": false,
           "editable": false,
           "required": true,
           "defaultVisibility": true,
           "systemMaintained": false,
           "role": "esriGraphPropertyRegular",
           "defaultValue": null
         }
       ],
       "fieldIndexes": [
            {
            "ascending": true,
            "description": "index on id field",
            "fieldNames": ["id"],
            "name": "esri_id_idx",
            "unique": "true",
          }
       ],
       "originEntityTypes": [
         "Person"
       ],
       "destinationEntityTypes": [
         "Company"
       ]
     }
   ]
  }
 }
}

Constructors

KnowledgeGraph Constructor new KnowledgeGraph(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
DataModel	The data model of the knowledge graph service.	KnowledgeGraph
String	The name of the class.	Accessor
ServiceDefinition	The service definition of the knowledge graph service.	KnowledgeGraph
String\|undefined	The url to a hosted knowledge graph.	KnowledgeGraph

Property Details

dataModel Property dataModel DataModelreadonly

The data model of the knowledge graph service. The data model defines the types of entities and relationships that can exist in the knowledge graph and the properties that can exist for each type of entity and relationship.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

serviceDefinition Property serviceDefinition ServiceDefinitionreadonly

The service definition of the knowledge graph service. The service definition outlines the capabilities of the knowledge graph such as search indexes, operations allowed etc.

url Property url String |undefined

The url to a hosted knowledge graph. See ArcGIS Hosted Knowledge Graph for more information on knowledge graph services.

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

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 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 Method toJSON(){Object}

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.