import Entity from "@arcgis/core/rest/knowledgeGraph/Entity.js";const Entity = await $arcgis.import("@arcgis/core/rest/knowledgeGraph/Entity.js");- Inheritance:
- Entity→
GraphNamedObject→ GraphObject→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.25
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
Examples
//create a new entityconst [knowledgeGraphModule, Entity] = await $arcgis.import([ "@arcgis/core/rest/knowledgeGraphService.js", "@arcgis/core/rest/knowledgeGraph/Entity.js",]);const newEntity = new Entity({ typeName: "Supplier", properties: { Name: "Supplier 5", EmployeeCount: 681 }});//searches for 'solar' in the properties of all entities in a knowledge graphconst KnowledgeGraphModule = await $arcgis.import( "@arcgis/core/rest/knowledgeGraphService.js");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
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Example
// create a new entity objectconst newEntity = new Entity({ typeName: "Supplier", properties: { Name: "Supplier 5", EmployeeCount: 681 }s});Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
id inherited | ||
properties inherited | ||
typeName inherited |
properties
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
- Type
- string
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'.
Methods
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.