@seasketch/geoprocessing/dist/src/toolbox/booleanOverlap.d.ts

Geoprocessing and reporting framework for SeaSketch 2.0

import { Feature, Geometry } from "../types/index.js";
/**
 * Returns all B items that overlap with a A items
 * Not all Feature types are supported, see typedoc
 * A and B must have the same geometry dimension (single or multi). Builds on @turf/boolean-overlap.
 * @param  {Geometry|Feature<LineString|MultiLineString|Polygon|MultiPolygon>} featuresA - single or array
 * @param  {Geometry|Feature<LineString|MultiLineString|Polygon|MultiPolygon>} featuresB - single or array
 * @param idProperty - property in Feature B to track if overlap already found.
 * Useful if multiple features have same property value and you only want the first match.
 */
export declare function booleanOverlap<B extends Feature<any>>(featureAInput: Feature<Geometry> | Feature<Geometry>[], featureBInput: B | B[], idProperty?: string): Promise<B[]>;
export declare function booleanOverlap<B extends Feature<Geometry>>(featureAInput: Geometry[], featureBInput: B | B[], idProperty?: string): Promise<B[]>;
export declare function booleanOverlap<B extends Geometry>(featureAInput: Feature<Geometry> | Feature<Geometry>[], featureBInput: B | B[], idProperty?: string): Promise<B[]>;
export declare function booleanOverlap<B extends Geometry>(featureAInput: Geometry | Geometry[], featureBInput: B | B[], idProperty?: string): Promise<B[]>;