Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: RelationParameters

require(["esri/tasks/RelationParameters"], function(RelationParameters) { /* code goes here */ });

Description

(Added at v2.0)
Sets the relation and other parameters for Relation operation.

Samples

Search for samples that use this class.

Constructors

NameSummary
new RelationParameters()Creates a new RelationParameter object.

Constants

NameDescription
SPATIAL_REL_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.
SPATIAL_REL_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.
SPATIAL_REL_DISJOINTTwo geometries are disjoint if their intersection is empty. Two geometries intersect if disjoint is "false".
SPATIAL_REL_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.
SPATIAL_REL_INTERIORINTERSECTIONGeometries intersect excluding boundary touch.
SPATIAL_REL_INTERSECTIONGeometry interiors intersect or boundaries touch, same as 'not disjoint'.
SPATIAL_REL_LINETOUCHTwo 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.
SPATIAL_REL_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.
SPATIAL_REL_POINTTOUCHTwo 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).
SPATIAL_REL_RELATIONAllows specification of any relationship defined using the Shape Comparison Language.
SPATIAL_REL_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.
SPATIAL_REL_WITHINSame as SPATIAL_REL_IN but also allows polylines that are strictly on the boundaries of polygons to be considered in the polygon.

Properties

NameTypeSummary
geometries1Geometry[]The first array of geometries to compute the relations.
geometries2Geometry[]The second array of geometries to compute the relations.
relationStringThe spatial relationship to be tested between the two input geometry arrays.
relationParamStringThe 'Shape Comparison Language' string to evaluate.
Constructor Details

new RelationParameters()

Creates a new RelationParameter object.
Property Details

<Geometry[]> geometries1

The first array of geometries to compute the relations. The structure of each geometry in the array is same as the structure of the json geometry objects returned by the ArcGIS REST API.
Sample:
relationParams.geometries1 = geometries;

<Geometry[]> geometries2

The second array of geometries to compute the relations. The structure of each geometry in the array is same as the structure of the json geometry objects returned by the ArcGIS REST API.
Sample:
relationParams.geometries2 = geometries;

<String> relation

The spatial relationship to be tested between the two input geometry arrays. See the constants table for a list of valid values.

If the relation is specified as esri.tasks.RelationParameter.SPATIAL_REL_RELATION, the relationParam parameter describes the spatial relationship and must be specified.
Sample:
require([
  "esri/tasks/RelationParameters", ... 
], function(RelationParameters, ... ) {
  var relationParams = new RelationParameters();
  relationParams.relation = RelationParameters.SPATIAL_REL_WITHIN;
  ...
});

<String> relationParam

The 'Shape Comparison Language' string to evaluate. Examples of valid strings are:

RELATE(G1,G2,"FFFTTT***)
dim (g1.boundary,g2.boundary) = linear
dim (g1.exterior, g2.boundary)= linear

The string describes the spatial relationship to be tested when the relation parameter is specified as esr.tasks.RelationParamter.SPATIAL_REL_RELATION. The Shape Comparison Language EDN topic has additional details.