GraphObjectType

AMD: require(["esri/rest/knowledgeGraph/GraphObjectType"], (GraphObjectType) => { /* code goes here */ });
ESM: import GraphObjectType from "@arcgis/core/rest/knowledgeGraph/GraphObjectType";
Class: esri/rest/knowledgeGraph/GraphObjectType
Inheritance: GraphObjectType Accessor
Since: ArcGIS API for JavaScript 4.25
beta

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,
     "searchable": false,
     "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,
     "searchable": false,
     "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

new GraphObjectType(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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The display name of the graph object type.

more details
GraphObjectType
String

The name of the class.

more details
Accessor
FieldIndex[]

Specifies index fields for a graph object type.

more details
GraphObjectType
String

The name of the graph object type.

more details
GraphObjectType
GraphProperty[]

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

more details
GraphObjectType
String

The object type's role in the knowledge graph.

more details
GraphObjectType

Property Details

alias String

The display name of the graph object type.

declaredClass Stringreadonly inherited

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

fieldIndexes FieldIndex[]

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

name String

The name of the graph object type.

properties GraphProperty[]

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

role String

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"

Method Overview

Show inherited methods Hide inherited methods
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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

hasHandles(groupKey){Boolean}inherited

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(groupKey)inherited

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");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.