require(["esri/rest/knowledgeGraph/GraphProperty"], (GraphProperty) => { /* code goes here */ });
import GraphProperty from "@arcgis/core/rest/knowledgeGraph/GraphProperty.js";
esri/rest/knowledgeGraph/GraphProperty
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.
//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
-
new GraphProperty(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The display name for the property. more details | GraphProperty | |
String | The name of the class. more details | Accessor | |
unknown | Specifies a default value for the object type. more details | GraphProperty | |
Boolean | Specifies whether the property is visible by default. more details | GraphProperty | |
Boolean | Specifies whether the property is editable. more details | GraphProperty | |
String | Specifies the field type for the property. more details | GraphProperty | |
String | Specifies the geometry type for the property. more details | GraphProperty | |
Boolean | Specifies whether the property has an m-value. more details | GraphProperty | |
Boolean | Specifies whether property has a z-value. more details | GraphProperty | |
String | The name of the property. more details | GraphProperty | |
Boolean | Specifies whether the property can be | GraphProperty | |
Boolean | Specifies whether the property is required. more details | GraphProperty | |
String | Specifies the role of the property. more details | GraphProperty | |
Boolean | Specifies if the property is system maintained. more details | GraphProperty |
Property Details
-
alias String
-
The display name for the property.
-
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"|"esriFieldTypeTimestampOffset"|"esriFieldTypeTimeOnly"|"esriFieldTypeDateOnly"
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
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | GraphProperty | |
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 | ||
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | GraphProperty |
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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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(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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.