GraphProperty

//The `EntityType`  'person' may have the following properties.
[{
  name: "first_name"
  alias: "First Name",
  defaultValue: null,
  defaultVisibility: true,
  editable: true,
  fieldType: "esriFieldTypeString",
  geometryType: "esriGeometryNull",
  hasM: false,
  hasZ: false,
  nullable: true,
  required: false,
  searchable: false,
  systemMaintained: false
},
{
  name: "age",
  alias: "Age",
  defaultValue: null,
  defaultVisibility: true,
  editable: true,
  fieldType: "esriFieldTypeNumber",
  geometryType: "esriGeometryNull",
  hasM: false,
  hasZ: false,
  nullable: false,
  required: false,
  searchable: true,
  systemMaintained: false
}]

//example of a RelationshipType definition including properties.
{
  "declaredClass": "esri.rest.knowledgeGraph.RelationshipType",
  "name": "employed_by",
  "alias": "Employed By",
  "role": "Regular",
  "strict": false,
  "properties": [{
    "declaredClass": "esri.rest.knowledgeGraph.GraphProperty",
    "name": "id",
    "alias": "id",
    "fieldType": "esriFieldTypeGUID",
    "geometryType": "esriGeometryNull",
    "hasM": false,
    "hasZ": false,
    "nullable": false,
    "editable": false,
    "required": true,
    "defaultVisibility": true,
    "systemMaintained": true,
    "role": "esriGraphPropertyRegular",
    "defaultValue": null
  },
  {
    "declaredClass": "esri.rest.knowledgeGraph.GraphProperty",
    "name": "start_date",
    "alias": "Start Date",
    "fieldType": "esriFieldTypeString",
    "geometryType": "esriGeometryNull",
    "hasM": false,
    "hasZ": false,
    "nullable": false,
    "editable": true,
    "required": true,
    "defaultVisibility": true,
    "systemMaintained": false,
    "role": "esriGraphPropertyRegular",
    "defaultValue": null
  }]
}

Property Overview

Property Details

alias String

The display name for the property.

declaredClass Stringreadonly inherited

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

defaultValue unknown

Specifies a default value for the object type.

defaultVisibility Boolean

Specifies whether the property is visible by default.

Default Value:true

editable Boolean

Specifies whether the property is editable.

Default Value:true

fieldType String

Specifies the field type for the property.

Possible Values:"esriFieldTypeSmallInteger"|"esriFieldTypeInteger"|"esriFieldTypeSingle"|"esriFieldTypeDouble"|"esriFieldTypeString"|"esriFieldTypeDate"|"esriFieldTypeOID"|"esriFieldTypeGeometry"|"esriFieldTypeBlob"|"esriFieldTypeRaster"|"esriFieldTypeGUID"|"esriFieldTypeGlobalID"|"esriFieldTypeXML"|"esriFieldTypeBigInteger"

Example

// possible field types
"esriFieldTypeSmallInteger"
"esriFieldTypeInteger"
"esriFieldTypeSingle"
"esriFieldTypeDouble"
"esriFieldTypeLong"
"esriFieldTypeString"
"esriFieldTypeDate"
"esriFieldTypeOID"
"esriFieldTypeGeometry"
"esriFieldTypeBlob"
"esriFieldTypeRaster"
"esriFieldTypeGUID"
"esriFieldTypeGlobalID"
"esriFieldTypeXML"

geometryType String

Specifies the geometry type for the property. Will not be present if property is not of type geometry.

hasM Boolean

Specifies whether the property has an m-value. This only applies if the property is of type geometry.

hasZ Boolean

Specifies whether property has a z-value. This only applies if the property is of type geometry.

name String

The name of the property.

nullable Boolean

Specifies whether the property can be null.

Default Value:true

required Boolean

Specifies whether the property is required.

Default Value:false

role String

Specifies the role of the property. Entity types with the role document have properties with specific roles.

Possible Values:"esriGraphPropertyRegular"|"esriGraphPropertyDocumentName"|"esriGraphPropertyDocumentTitle"|"esriGraphPropertyDocumentUrl"|"esriGraphPropertyDocumentText"|"esriGraphPropertyDocumentKeywords"|"esriGraphPropertyDocumentContentType"|"esriGraphPropertyDocumentMetadata"|"esriGraphPropertyDocumentFileExtension"

Example

{
	"declaredClass": "esri.rest.knowledgeGraph.EntityType",
	"name": "documents",
	"alias": "Documents",
	"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": "esriGraphPropertyDocumentName",
			"defaultValue": null
		},
		{
			"declaredClass": "esri.rest.knowledgeGraph.GraphProperty",
			"name": "text",
			"alias": "text",
			"fieldType": "esriFieldTypeString",d
			"geometryType": "esriGeometryNull",
			"hasM": false,
			"hasZ": false,
			"nullable": false,
			"editable": false,
			"required": true,
			"defaultVisibility": true,
			"systemMaintained": true,
			"role": "esriGraphPropertyDocumentText",
			"defaultValue": null
		}
	]
}

systemMaintained Boolean

Specifies if the property is system maintained.

Method Overview

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

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