require(["esri/rest/knowledgeGraph/toolService/findPaths/CIMFilteredFindPathsEntity"], (CIMFilteredFindPathsEntity) => { /* code goes here */ });
import CIMFilteredFindPathsEntity from "@arcgis/core/rest/knowledgeGraph/toolService/findPaths/CIMFilteredFindPathsEntity.js";
esri/rest/knowledgeGraph/toolService/findPaths/CIMFilteredFindPathsEntity
Defines an origin or destination entity, in this case the iD is used, or all entities of an entity type, in which case the iD is null.
Constructors
-
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 |
---|---|---|---|
The name of the class. | Accessor | ||
CIMFilteredFindPathsEntity | |||
The unique ID to use as a filter. | CIMFilteredFindPathsEntity | ||
The property filter predicate (openCypher syntax) associated with the path filter. | CIMFilteredFindPathsEntity | ||
For CIMFilteredFindPathsEntity the type is always "CIMFilteredFindPathsEntity". | CIMFilteredFindPathsEntity |
Property Details
-
The unique ID to use as a filter. If
iD
is undefined, all instances of the type are used.
-
The property filter predicate (openCypher syntax) associated with the path filter. The predicate is only taken into account when iD has no value.
-
type
type Stringreadonly
-
For CIMFilteredFindPathsEntity the type is always "CIMFilteredFindPathsEntity".
Method Overview
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. | CIMFilteredFindPathsEntity | ||
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. | CIMFilteredFindPathsEntity |
Method Details
-
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();
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.
-
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.
Returns
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
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"); }
-
Inherited from Accessor
-
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
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.