RelationParameters

AMD: require(["esri/rest/support/RelationParameters"], (RelationParameters) => { /* code goes here */ });
ESM: import RelationParameters from "@arcgis/core/rest/support/RelationParameters";
Class: esri/rest/support/RelationParameters
Inheritance: RelationParameters Accessor
Since: ArcGIS API for JavaScript 4.0

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

See also:

Constructors

new RelationParameters(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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Geometry[]more details

The first array of geometries to compute the relation.

more detailsRelationParameters
Geometry[]more details

The second array of geometries to compute the relation.

more detailsRelationParameters
Stringmore details

The spatial relationship to be tested between the two input geometry arrays.

more detailsRelationParameters
Stringmore details

The string describes the spatial relationship to be tested when RelationParameters.relation = 'relation'.

more detailsRelationParameters

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

geometries1 Geometry[]

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.

geometries2 Geometry[]

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, the relationParameter 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.
interior-intersection Geometries intersect excluding boundary touch.
intersection Geometry interiors intersect or boundaries touch, same as 'not disjoint'.
line-coincidence 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.
line-touch Two geometries are said to touch when the intersection of the geometries is non-empty, 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 sub-line, or two polygons share a common sub-area. Two geometries do not overlap if either one is empty.
point-touch Two geometries are said to touch when the intersection of the geometries is non-empty, 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 non-empty, 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"|"interior-intersection"|"intersection"|"line-coincidence"|"line-touch"|"overlap"|"point-touch"|"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
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsRelationParameters
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsRelationParameters

Method Details

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.

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
* Returns a new instance of this class.
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.