require(["esri/rest/knowledgeGraph/Entity"], (Entity) => { /* code goes here */ });
import Entity from "@arcgis/core/rest/knowledgeGraph/Entity.js";
esri/rest/knowledgeGraph/Entity
An entity is a specific instance of an EntityType that can exist in the knowledge graph. Entities typically represent real-world objects or locations such as a person, an organization, a building, or a vehicle. Each entity has a set of properties that is defined by the entity type it belongs to.
- See also
//create a new entity
require([
"esri/rest/knowledgeGraphService",
"esri/rest/knowledgeGraph/Entity",
], (knowledgeGraphModule, Entity) => {
const newEntity = new Entity({
typeName: "Supplier",
properties: {
Name: "Supplier 5",
EmployeeCount: 681
}
});
});//searches for 'solar' in the properties of all entities in a knowledge graph
require([
"esri/rest/knowledgeGraphService"
], (KnowledgeGraphModule) => {
KnowledgeGraphModule
.executeSearch(kg, {
searchQuery: "solar",
typeCategoryFilter: "entity",
})
.then((queryResult) => {
// do something with the search results
console.log("Graph Search Result", queryResult);
});
});//example of a return from the above search, printed to the console.
{
resultRows: [{
"declaredClass": "esri.rest.knowledgeGraph.Entity",
"properties": {
"shape": {
"declaredClass": "esri.geometry.Point",
"cache": {},
"hasM": false,
"hasZ": false,
"latitude": 53.589000000000009,
"longitude": -0.9633,
"type": "point",
"extent": null,
"spatialReference": {
"wkid": 4326
},
"x": -0.9633,
"y": 53.589000000000009
},
"Name": "Suncommon",
"Employee_Count": 400,
"energyType": "solar"
},
"typeName": "Company",
"id": ""{9D2D6AFD-41F1-49A4-8412-CACCC9906E88}","
}]
}Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Example// create a new entity object const newEntity = new Entity({ typeName: "Supplier", properties: { Name: "Supplier 5", EmployeeCount: 681 } s});
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| String | The name of the class. | Accessor | |
| String | The unique ID of the object. | GraphNamedObject | |
| Object | The properties of the graph object. | GraphObject | |
| String | Specifies the name for all similar types of objects (entities or relationships) defined in the knowledge graph. | GraphNamedObject |
Property Details
-
id
InheritedPropertyid StringInherited from GraphNamedObject -
The unique ID of the object.
-
properties
InheritedPropertyproperties ObjectInherited from GraphObject -
The properties of the graph object. For entities and relationships the properties are specified by its entity type or relationship type. The values of the properties are specific to the object.
Examples//example of properties structure that includes geometry "properties": { "shape": { "declaredClass": "esri.geometry.Point", "cache": {}, "hasM": false, "hasZ": false, "latitude": 53.589000000000009, "longitude": -0.9633, "type": "point", "extent": null, "spatialReference": { "wkid": 4326 }, "x": -0.9633, "y": 53.589000000000009 }, "Name": "Suncommon", "Employee_Count": 400, "Address": "123 Broadway, New York, New York", "EnergyType": "solar" }//two entities of different entity types with different properties [{ "declaredClass": "esri.rest.knowledgeGraph.Entity", "properties": { "Name": "Suncommon", "Employee_Count": 400, "energyType": "solar" }, "typeName": "Company", "id": "1256" }, { "declaredClass": "esri.rest.knowledgeGraph.Entity", "properties": { "Name": "Empire State Building", "height": 1454, "heightUnits": "feet", "city": "New York" }, "typeName": "Building", "id": "B7889541" }]//two relationships of different relationship types with different properties [{ "declaredClass": "esri.rest.Relationship.Relationship", "properties": { "start_date": "2020-04-17", "employee_id": "4589", "office": "152 Building A" }, "typeName": "Employed_by", "id": "B7889541" }, { "declaredClass": "esri.rest.Relationship.Relationship", "properties": { "quantity": 125000, "frequency": "bi-weekly", "contact_person": "Betty White" }, "typeName": "buys_part", "id": "B7889541" }]
-
typeName
InheritedPropertytypeName StringInherited from GraphNamedObject -
Specifies the name for all similar types of objects (entities or relationships) defined in the knowledge graph. For example, all 'employee' entities in a knowledge graph of an organization might have the typeName 'employee'.
Method Overview
| Name | 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. | GraphObject | |
| 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. | GraphObject |
Method Details
-
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();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.
-
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
jsonparameter 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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
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"); }
-
Inherited from Accessor
-
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");
-
toJSON
InheritedMethodtoJSON(){Object}Inherited from GraphObject -
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.