Packagecom.esri.ags.tasks.supportClasses
Classpublic class RelationParameters
InheritanceRelationParameters Inheritance Object

Since : ArcGIS API for Flex 2.0

Input parameters for the relation() method on the GeometryService, for example geometries1, geometries2 and spatialRelationship.

See also

com.esri.ags.tasks.GeometryService.relation()
Relation (Operation) in REST documentation


Public Properties
 PropertyDefined By
  comparisonString : String
The Shape Comparison Language string to be evaluated if spatialRelationship is SPATIAL_REL_RELATION ("esriGeometryRelationRelation").
RelationParameters
  geometries1 : Array
The first array of geometry to compute the relations.
RelationParameters
  geometries2 : Array
The second array of geometry to compute the relations.
RelationParameters
  spatialRelationship : String
The spatial relationship to be tested between the two input geometry vectors.
RelationParameters
Public Constants
 ConstantDefined By
  SPATIAL_REL_COINCIDENCE : String = esriGeometryRelationLineCoincidence
[static] 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).
RelationParameters
  SPATIAL_REL_CROSS : String = esriGeometryRelationCross
[static] Two polylines cross if they share only points in common, at least one of which is not an endpoint.
RelationParameters
  SPATIAL_REL_DISJOINT : String = esriGeometryRelationDisjoint
[static] Two geometries are disjoint if their intersection is empty.
RelationParameters
  SPATIAL_REL_IN : String = esriGeometryRelationIn
[static] 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.
RelationParameters
  SPATIAL_REL_INTERIORINTERSECTION : String = esriGeometryRelationInteriorIntersection
[static] Geometries intersect excluding boundary touch.
RelationParameters
  SPATIAL_REL_INTERSECTION : String = esriGeometryRelationIntersection
[static] Geometry interiors intersect or boundaries touch, same as 'not disjoint'.
RelationParameters
  SPATIAL_REL_LINETOUCH : String = esriGeometryRelationLineTouch
[static] Two geometries are said to touch when the intersection of the geometries is non-empty, but the intersection of their interiors is empty.
RelationParameters
  SPATIAL_REL_OVERLAP : String = esriGeometryRelationOverlap
[static] Two polylines share a common sub-line, or two polygons share a common sub-area.
RelationParameters
  SPATIAL_REL_POINTTOUCH : String = esriGeometryRelationPointTouch
[static] Two geometries are said to touch when the intersection of the geometries is non-empty, but the intersection of their interiors is empty.
RelationParameters
  SPATIAL_REL_RELATION : String = esriGeometryRelationRelation
[static] Allows specification of any relationship defined using the Shape Comparison Language.
RelationParameters
  SPATIAL_REL_TOUCH : String = esriGeometryRelationTouch
[static] The union of esriGeometryRelationPointTouch and esriGeometryRelationLineTouch.
RelationParameters
  SPATIAL_REL_WITHIN : String = esriGeometryRelationWithin
[static] Same as esriGeometryRelationIn but also allows polylines that are strictly on the boundaries of polygons to be considered 'in' the polygon.
RelationParameters
Property Detail
comparisonStringproperty
public var comparisonString:String

The Shape Comparison Language string to be evaluated if spatialRelationship is SPATIAL_REL_RELATION ("esriGeometryRelationRelation").

geometries1property 
public var geometries1:Array

The first array of geometry to compute the relations.

See also

geometries2property 
public var geometries2:Array

The second array of geometry to compute the relations.

See also

spatialRelationshipproperty 
public var spatialRelationship:String

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

Constant Detail
SPATIAL_REL_COINCIDENCEConstant
public static const SPATIAL_REL_COINCIDENCE:String = esriGeometryRelationLineCoincidence

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.

SPATIAL_REL_CROSSConstant 
public static const SPATIAL_REL_CROSS:String = esriGeometryRelationCross

Two polylines cross if they share only points in common, at least one of which is not an endpoint. A polyline and a 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_DISJOINTConstant 
public static const SPATIAL_REL_DISJOINT:String = esriGeometryRelationDisjoint

Two geometries are disjoint if their intersection is empty. Two geometries intersect if disjoint is "false". Disjoint is a Clementini operator.

SPATIAL_REL_INConstant 
public static const SPATIAL_REL_IN:String = esriGeometryRelationIn

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. Within is a Clementini operator. Within is the opposite operator of contains. An empty geometry is within another geometry, unless the other geometry is empty.

SPATIAL_REL_INTERIORINTERSECTIONConstant 
public static const SPATIAL_REL_INTERIORINTERSECTION:String = esriGeometryRelationInteriorIntersection

Geometries intersect excluding boundary touch.

SPATIAL_REL_INTERSECTIONConstant 
public static const SPATIAL_REL_INTERSECTION:String = esriGeometryRelationIntersection

Geometry interiors intersect or boundaries touch, same as 'not disjoint'.

SPATIAL_REL_LINETOUCHConstant 
public static const SPATIAL_REL_LINETOUCH:String = esriGeometryRelationLineTouch

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.

SPATIAL_REL_OVERLAPConstant 
public static const SPATIAL_REL_OVERLAP:String = esriGeometryRelationOverlap

Two polylines share a common sub-line, or two polygons share a common sub-area. Overlaps is a Clementini operator. Two geometries do not overlap if either one is empty.

SPATIAL_REL_POINTTOUCHConstant 
public static const SPATIAL_REL_POINTTOUCH:String = esriGeometryRelationPointTouch

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).

SPATIAL_REL_RELATIONConstant 
public static const SPATIAL_REL_RELATION:String = esriGeometryRelationRelation

Allows specification of any relationship defined using the Shape Comparison Language.

SPATIAL_REL_TOUCHConstant 
public static const SPATIAL_REL_TOUCH:String = esriGeometryRelationTouch

The union of esriGeometryRelationPointTouch and esriGeometryRelationLineTouch. Two geometries are said to touch when the intersection of the geometries is non-empty, but the intersection of their interiors is empty. Touches is a Clementini operator. 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_WITHINConstant 
public static const SPATIAL_REL_WITHIN:String = esriGeometryRelationWithin

Same as esriGeometryRelationIn but also allows polylines that are strictly on the boundaries of polygons to be considered 'in' the polygon.