CIMFilteredFindPathsEntity | References | ArcGIS Maps SDK for JavaScript

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

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

Inheritance: CIMFilteredFindPathsEntity→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.32

beta

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	CIMFilteredFindPathsEntityProperties

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
entityTypeName	string \| null \| undefined
iD	string \| null \| undefined
propertyFilterPredicate	string \| null \| undefined
type readonly	"CIMFilteredFindPathsEntity"

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

entityTypeName

Property

Type: string | null | undefined

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

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.

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: "CIMFilteredFindPathsEntity"

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.