CIMFilteredFindPathsPathFilter

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

Defines path filters to determine what records are used to find paths in the graph between the origin and destination entities. A path filter can be used for a specific record, in this case the iD is used, or for all records of an entity or relationship type, in which case the iD is null.

Constructors

CIMFilteredFindPathsPathFilter

Constructor
new CIMFilteredFindPathsPathFilter(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 Watch for changes topic.
Show inherited properties Hide inherited properties
Name Type Summary Class

The name of the class.

Accessor

Specifies the filter type to use in the path filter for the specified entity or relationship.

CIMFilteredFindPathsPathFilter

The unique ID to use as a filter.

CIMFilteredFindPathsPathFilter

Whether the iD or itemTypeName is an entity or relationship.

CIMFilteredFindPathsPathFilter

The typeName of the entity or relationship specified in iD.

CIMFilteredFindPathsPathFilter

The property filter predicate (openCypher syntax) associated with the path filter.

CIMFilteredFindPathsPathFilter
For CIMFilteredFindPathsPathFilter the type is always "CIMFilteredFindPathsPathFilter". CIMFilteredFindPathsPathFilter

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.

filterType

Property
filterType String

Specifies the filter type to use in the path filter for the specified entity or relationship. Multiple filters can be defined and multiple of the same filters can be defined.

Filter Description
IncludeOnly The filtered find paths algorithm will only consider paths which contain included types (type is active). If a path filter does not use the include only option, all types are active.
Exclude The filtered find paths algorithm will ignore paths that contain excluded types (type is not active).
MandatoryWaypoint The filtered find paths algorithm will only consider paths passing through each mandatory waypoint.
OptionalWaypoint The filtered find paths algorithm will only consider paths passing through at least one of the optional waypoints.

Possible Values:"IncludeOnly" |"Exclude" |"MandatoryWaypoint" |"OptionalWaypoint"

Default Value:"Exclude"

iD

Property
iD String |null |undefined

The unique ID to use as a filter. If iD is undefined, all instances of the type are used.

itemType

Property
itemType String

Whether the iD or itemTypeName is an entity or relationship.

Possible Values:"Entity" |"Relationship"

Default Value:"Entity"

itemTypeName

Property
itemTypeName String |null |undefined

The typeName of the entity or relationship specified in iD. If iD is unspecified, all records of the entity or relationship type will be used.

propertyFilterPredicate

Property
propertyFilterPredicate String |null |undefined

The property filter predicate (openCypher syntax) associated with the path filter. The predicate is only taken into account when iD has no value.

type

Property
type Stringreadonly

For CIMFilteredFindPathsPathFilter the type is always "CIMFilteredFindPathsPathFilter".

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.

CIMFilteredFindPathsPathFilter

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.

CIMFilteredFindPathsPathFilter

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){* |null |undefined}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
* | null | undefined 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.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close