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
//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
-
new KnowledgeGraph(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 name of the class. more details | Accessor | |
| String | The url to a hosted knowledge graph. more details | KnowledgeGraph |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className.
-
url String
-
The url to a hosted knowledge graph. See ArcGIS Hosted Knowledge Graph for more information on knowledge graph services.
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 | ||
| 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 |
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.
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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");