Sets the relation and other parameters for the geometryService.relation() operation.
Constructors

new RelationParameters(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 name of the class. more details  Accessor  
Geometry[]  The first array of geometries to compute the relation. more details  RelationParameters  
Geometry[]  The second array of geometries to compute the relation. more details  RelationParameters  
String  The spatial relationship to be tested between the two input geometry arrays. more details  RelationParameters  
String  The string describes the spatial relationship to be tested when  RelationParameters 
Property Details

Since: ArcGIS Maps SDK for JavaScript 4.7

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

The first array of geometries to compute the relation. The structure of each geometry in the array is same as the structure of the json geometry objects returned by the ArcGIS REST API.

The second array of geometries to compute the relation. The structure of each geometry in the array is same as the structure of the json geometry objects returned by the ArcGIS REST API.

relation String

The spatial relationship to be tested between the two input geometry arrays. See table below for a list of possible values. If the relation is specified as
relation
, therelationParameter
parameter describes the spatial relationship and must be specified.Value Description cross Two polylines cross if they share only points in common, at least one of which is not an endpoint. A polyline and an polygon cross if they share a polyline in common on the interior of the polygon which is not equivalent to the entire polyline. Cross is a Clementini operator. If either one of the geometries is empty, the geometries do not cross. disjoint Two geometries are disjoint if their intersection is empty. Two geometries intersect if disjoint is "false". in The base geometry is within the comparison geometry if the base geometry is the intersection of the geometries and the intersection of their interiors is not empty. An empty geometry is within another geometry, unless the other geometry is empty. interiorintersection Geometries intersect excluding boundary touch. intersection Geometry interiors intersect or boundaries touch, same as 'not disjoint'. linecoincidence The boundaries of the geometries must share an intersection, but the relationship between the interiors of the shapes is not considered (they could overlap, one could be contained in the other, or their interiors could be disjoint). This relation applies to polylines and polygons. linetouch Two geometries are said to touch when the intersection of the geometries is nonempty, but the intersection of their interiors is empty. This evaluates if the touch occurs along a boundary (not a point). Valid for polygons. overlap Two polylines share a common subline, or two polygons share a common subarea. Two geometries do not overlap if either one is empty. pointtouch Two geometries are said to touch when the intersection of the geometries is nonempty, but the intersection of their interiors is empty. This evaluates if the touch occurs at a point (not a boundary). relation Allows specification of any relationship defined using the Shape Comparison Language. If this value is used, a value for relationParameter
must be specified.touch The union of point touch and line touch. Two geometries are said to touch when the intersection of the geometries is nonempty, but the intersection of their interiors is empty. For example, a point touches a polyline only if the point is coincident with one of the polyline end points. If either one of the two geometries is empty, the geometries are not touched. within Same as in
but also allows polylines that are strictly on the boundaries of polygons to be considered in the polygon.Possible Values:"cross""disjoint""in""interiorintersection""intersection""linecoincidence""linetouch""overlap""pointtouch""relation""touch""within"

relationParameter String

The string describes the spatial relationship to be tested when
RelationParameters.relation = 'relation'
. The Relational functions for ST_Geometry topic has additional details. An example of a valid string is:FFFTTT**
. Also see the description of geometryEngine.relate() for additional examples of valid strings.
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  RelationParameters  
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  RelationParameters 
Method Details

addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25

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 WatchHandleWatchHandle[]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.

Since: ArcGIS Maps SDK for JavaScript 4.25

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("watchviewupdates")) { obj.removeHandles("watchviewupdates"); }

removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25

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("handlegroup"); obj.removeHandles("otherhandlegroup");

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.