GraphProperty

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

Specifies the properties of for entity types and relationship types defined in the graph schema by the data model. Each instance of a specified graph object type will include these properties.

Examples
//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
  }]
}

Constructors

GraphProperty

Constructor
new GraphProperty(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

The display name for the property.

GraphProperty

The name of the class.

Accessor
unknown

Specifies a default value for the object type.

GraphProperty

Specifies whether the property is visible by default.

GraphProperty

Specifies whether the property is editable.

GraphProperty

Specifies the field type for the property.

GraphProperty

Specifies the geometry type for the property.

GraphProperty

Specifies whether the property has an m-value.

GraphProperty

Specifies whether property has a z-value.

GraphProperty

The name of the property.

GraphProperty

Specifies whether the property can be null.

GraphProperty

Specifies whether the property is required.

GraphProperty

Specifies the role of the property.

GraphProperty

Specifies if the property is system maintained.

GraphProperty

Property Details

alias

Property
alias String

The display name for the property.

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

defaultValue

Property
defaultValue unknown

Specifies a default value for the object type.

defaultVisibility

Property
defaultVisibility Boolean

Specifies whether the property is visible by default.

Default Value:true

editable

Property
editable Boolean

Specifies whether the property is editable.

Default Value:true

fieldType

Property
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" |"esriFieldTypeTimestampOffset" |"esriFieldTypeTimeOnly" |"esriFieldTypeDateOnly"

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

geometryType

Property
geometryType String

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

hasM

Property
hasM Boolean

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

hasZ

Property
hasZ Boolean

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

name

Property
name String

The name of the property.

nullable

Property
nullable Boolean

Specifies whether the property can be null.

Default Value:true

required

Property
required Boolean

Specifies whether the property is required.

Default Value:false

role

Property
role String

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

Possible Values:"esriGraphPropertyUNSPECIFIED" |"esriGraphPropertyRegular" |"esriGraphPropertyDocumentName" |"esriGraphPropertyDocumentTitle" |"esriGraphPropertyDocumentUrl" |"esriGraphPropertyDocumentText" |"esriGraphPropertyDocumentKeywords" |"esriGraphPropertyDocumentContentType" |"esriGraphPropertyDocumentMetadata" |"esriGraphPropertyDocumentFileExtension" |"esriGraphPropertyProvenanceInstanceId" |"esriGraphPropertyProvenanceSourceType" |"esriGraphPropertyProvenanceSourceName" |"esriGraphPropertyProvenanceSource" |"esriGraphPropertyProvenanceComment" |"esriGraphPropertyProvenanceTypeName" |"esriGraphPropertyProvenancePropertyName"

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

Property
systemMaintained Boolean

Specifies if the property is system maintained.

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.

Accessor
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

GraphProperty

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Converts an instance of this class to its ArcGIS portal JSON representation.

GraphProperty

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.

fromJSON

Method
fromJSON(json){*}static

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.

Parameter
json Object

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
Type Description
* Returns a new instance of this class.

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

toJSON

Method
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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