GraphAddNamedTypesResult | API Reference | ArcGIS Maps SDK for JavaScript

The result returned when adding a new entity type or relationship type to a knowledge graph. This contains the names of the new types, the number of types added and any errors encountered.

Constructors

GraphAddNamedTypesResult Constructor new GraphAddNamedTypesResult(properties)

Parameter

properties Object

optional

See the properties for a full list of the properties that may be passed into the constructor.

Property Overview

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

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
Error\|null\|undefined	Any errors encountered while decoding the results.	GraphDataModelOperationResult
AddResultsObject []	Information specific to each added entity type.	GraphAddNamedTypesResult
Number	The number of entity types added to the graph.	GraphAddNamedTypesResult
AddResultsObject []	Information specific to each added relationship type.	GraphAddNamedTypesResult
Number	The number of relationship types added to the graph.	GraphAddNamedTypesResult
ResultsObject []	Information about the add, update or delete modifications made to the data model.	GraphDataModelOperationResult
Number	The number of modifications made to the graph.	GraphDataModelOperationResult
KnowledgeGraph\|null\|undefined	The updated knowledge graph with the applied additions, updates, and deletions.	GraphDataModelOperationResult

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

decoderError Inherited Property decoderError Error |null |undefined Inherited from GraphDataModelOperationResult

Any errors encountered while decoding the results.

entityAddResults Property entityAddResults AddResultsObject[]

Information specific to each added entity type.

entityAddResultsCount Property entityAddResultsCount Number

The number of entity types added to the graph.

relationshipAddResults Property relationshipAddResults AddResultsObject[]

Information specific to each added relationship type.

relationshipAddResultsCount Property relationshipAddResultsCount Number

The number of relationship types added to the graph.

results Inherited Property results ResultsObject[] Inherited from GraphDataModelOperationResult

Information about the add, update or delete modifications made to the data model.

resultsCount Inherited Property resultsCount Number Inherited from GraphDataModelOperationResult

The number of modifications made to the graph.

updatedKnowledgeGraph Inherited Property updatedKnowledgeGraph KnowledgeGraph |null |undefined Inherited from GraphDataModelOperationResult

The updated knowledge graph with the applied additions, updates, and deletions.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) 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();

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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

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 Inherited Method removeHandles(groupKey) Inherited from Accessor

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

Type Definitions

AddResultsObject Type Definition AddResultsObject Object

Information about the success of adding a new entity type or relationship type to the graph.

Properties: name String

Then name of the entity type or relationship type added

error Error|null|undefined

optional
Any errors encountered while attempting to add the new entity or relationship type.