RelationParameters

require(["esri/tasks/support/RelationParameters"], function(RelationParameters) { /* code goes here */ });
Class: esri/tasks/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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Geometry[]

The first array of geometries to compute the relation.

more details
more detailsRelationParameters
Geometry[]

The second array of geometries to compute the relation.

more details
more detailsRelationParameters
String

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

more details
more detailsRelationParameters
String

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

more details
more detailsRelationParameters

Property Details

declaredClassStringreadonly inherited

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

geometries1Geometry[]

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.

geometries2Geometry[]

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.

relationString

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 relationParam parameter describes the spatial relationship and must be specified.

ValueDescription
crossTwo 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.
disjointTwo geometries are disjoint if their intersection is empty. Two geometries intersect if disjoint is "false".
inThe 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-intersectionGeometries intersect excluding boundary touch.
intersectionGeometry interiors intersect or boundaries touch, same as 'not disjoint'.
line-coincidenceThe 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-touchTwo 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.
overlapTwo 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-touchTwo 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).
touchThe 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.
withinSame as in but also allows polylines that are strictly on the boundaries of polygons to be considered in the polygon.
relationAllows specification of any relationship defined using the Shape Comparison Language. If this value is used, a value for relationParam must be specified.

relationParamString

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

NameReturn TypeSummaryClass
Object

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

more details
more detailsRelationParameters

Method Details

toJSON(){Object}

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

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.