overlap_type (Optional) | Specifies the spatial relationship to be evaluated. - INTERSECT —The features in the input layer will be selected if they intersect a selecting feature. This is the default.
- INTERSECT_3D —The features in the input layer will be selected if they intersect a selecting feature in three-dimensional space (x, y, and z).
- INTERSECT_DBMS —The features in the input layer will be selected if they intersect a selecting feature. This option applies to enterprise geodatabases only. The selection will be processed in the enterprise geodatabase DBMS rather than on the client when all requirements are met (see usage notes). This option may provide better performance than performing the selection on the client.
- WITHIN_A_DISTANCE —The features in the input layer will be selected if they are within the specified distance (using Euclidean distance) of a selecting feature. Use the search_distance parameter to specify the distance.
- WITHIN_A_DISTANCE_3D —The features in the input layer will be selected if they are within a specified distance of a selecting feature in three-dimensional space. Use the search_distance parameter to specify the distance.
- WITHIN_A_DISTANCE_GEODESIC —The features in the input layer will be selected if they are within a specified distance of a selecting feature. Distance between features will be calculated using a geodesic formula that takes into account the curvature of the spheroid and correctly handles data near and across the dateline and poles. Use the search_distance parameter to specify the distance.
- CONTAINS —The features in the input layer will be selected if they contain a selecting feature.
- COMPLETELY_CONTAINS —The features in the input layer will be selected if they completely contain a selecting feature.
- CONTAINS_CLEMENTINI —This spatial relationship yields the same results as COMPLETELY_CONTAINS with the exception that if the selecting feature is entirely on the boundary of the input feature (no part is properly inside or outside), the feature will not be selected. CLEMENTINI defines the boundary polygon as the line separating inside and outside, the boundary of a line is defined as its end points, and the boundary of a point is always empty.
- WITHIN —The features in the input layer will be selected if they are within a selecting feature.
- COMPLETELY_WITHIN —The features in the input layer will be selected if they are completely within or contained by a selecting feature.
- WITHIN_CLEMENTINI —The result will be identical to WITHIN with the exception that if the entirety of the feature in the input layer is on the boundary of the feature in the selecting layer, the feature will not be selected. CLEMENTINI defines the boundary polygon as the line separating inside and outside, the boundary of a line is defined as its end points, and the boundary of a point is always empty.
- ARE_IDENTICAL_TO —The features in the input layer will be selected if they are identical (in geometry) to a selecting feature.
- BOUNDARY_TOUCHES —The features in the input layer will be selected if they have a boundary that touches a selecting feature. When the inputs features are lines or polygons, the boundary of the input feature can only touch the boundary of the selecting feature, and no part of the input feature can cross the boundary of the selecting feature.
- SHARE_A_LINE_SEGMENT_WITH —The features in the input layer will be selected if they share a line segment with a selecting feature. The input and selecting features must be line or polygon.
- CROSSED_BY_THE_OUTLINE_OF —The features in the input layer will be selected if they are crossed by the outline of a selecting feature. The input and selecting features must be lines or polygons. If polygons are used for the input or selecting layer, the polygon's boundary (line) will be used. Lines that cross at a point will be selected, not lines that share a line segment.
- HAVE_THEIR_CENTER_IN —The features in the input layer will be selected if their center falls within a selecting feature. The center of the feature is calculated as follows: for polygon and multipoint, the geometry's centroid is used; for line input, the geometry's midpoint is used.
| String |
search_distance (Optional) | The specified distance that will be searched. This parameter is only valid if the overlap_type parameter is set to one of the following: WITHIN_A_DISTANCE, WITHIN_A_DISTANCE_GEODESIC, WITHIN_A_DISTANCE_3D, INTERSECT, INTERSECT_3D, HAVE_THEIR_CENTER_IN, or CONTAINS. If the WITHIN_A_DISTANCE_GEODESIC option is selected, use a linear unit such as kilometers or miles.
| Linear Unit |
invert_spatial_relationship (Optional) | Specifies whether the spatial relationship evaluation result will be used as is, or the opposite result will be used. For example, this parameter can be used to get a list of features that do not intersect or are not within a given distance of features in another dataset.
- NOT_INVERT —The query will used as is. This is the default.
- INVERT —The opposite of the query will be used. If the selection_type parameter is used, the reversal of the selection occurs before it is combined with existing selections.
| Boolean |