import GraphObjectType from "@arcgis/core/rest/knowledgeGraph/GraphObjectType.js";
Inheritance
GraphObjectTypeAccessor
Subclasses
EntityType, RelationshipType
Since
ArcGIS Maps SDK for JavaScript 4.25

Parent object for entity types and relationship types defined in the graph schema.

See also
Example
//sample structure of an entity type
{
"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"
]
}
]
}

Constructors

Constructor

Constructor

Parameters

ParameterTypeDescriptionRequired
properties
See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

alias

Property
Type
string | null | undefined
  • The display name of the graph object type that can be updated.

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor

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

fieldIndexes

autocast Property
Type
FieldIndex[]

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

name

Property
Type
string

The name of the graph object type.

properties

autocast Property
Type
GraphProperty[]

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

role

Property
Type
NamedObjectType

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"

Methods

MethodSignatureClass
inherited static
fromJSON(json: any): any
inherited
toJSON(): any

fromJSON

inheritedstatic Method
Signature
fromJSON (json: any): any
Inherited from: JSONSupportMixin

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

ParameterTypeDescriptionRequired
json
any

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

inherited Method
Signature
toJSON (): any
Inherited from: JSONSupportMixin

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.

Type definitions

NamedObjectType

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"Regular" | "Provenance" | "Document"