CIMFilteredFindPathsPathFilter | References | ArcGIS Maps SDK for JavaScript

import CIMFilteredFindPathsPathFilter from "@arcgis/core/rest/knowledgeGraph/toolService/findPaths/CIMFilteredFindPathsPathFilter.js";

const CIMFilteredFindPathsPathFilter = await $arcgis.import("@arcgis/core/rest/knowledgeGraph/toolService/findPaths/CIMFilteredFindPathsPathFilter.js");

Inheritance: CIMFilteredFindPathsPathFilter→Accessor

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	CIMFilteredFindPathsPathFilterProperties

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
declaredClass readonly inherited	string	Accessor
filterType	FilterType
iD	string \| null \| undefined
itemType	"Entity" \| "Relationship"
itemTypeName	string \| null \| undefined
propertyFilterPredicate	string \| null \| undefined
type readonly	"CIMFilteredFindPathsPathFilter"

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

filterType

Property

Type: FilterType

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.

Default value: "Exclude"

iD

Property

Type: string | null | undefined

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

itemType

Property

Type: "Entity" | "Relationship"

Whether the iD or itemTypeName is an entity or relationship.

Default value: "Entity"

itemTypeName

Property

Type: string | null | undefined

The GraphNamedObject.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

Type: 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

readonly Property

Type: "CIMFilteredFindPathsPathFilter"

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
toJSON inherited	toJSON(): any	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	any	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: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.

Type definitions

FilterType

Type definition

Type: "IncludeOnly" | "Exclude" | "MandatoryWaypoint" | "OptionalWaypoint"