Natural Preference for Minification

    @turf/boolean-overlap
    TypeScript icon, indicating that this package has built-in type declarations

    6.5.0 • Public • Published

    @turf/boolean-overlap

    booleanOverlap

    Compares two geometries of the same dimension and returns true if their intersection set results in a geometry different from both but of the same dimension. It applies to Polygon/Polygon, LineString/LineString, Multipoint/Multipoint, MultiLineString/MultiLineString and MultiPolygon/MultiPolygon.

    Parameters

    Examples

    var poly1 = turf.polygon([[[0,0],[0,5],[5,5],[5,0],[0,0]]]);
    var poly2 = turf.polygon([[[1,1],[1,6],[6,6],[6,1],[1,1]]]);
    var poly3 = turf.polygon([[[10,10],[10,15],[15,15],[15,10],[10,10]]]);
    
    turf.booleanOverlap(poly1, poly2)
    //=true
    turf.booleanOverlap(poly2, poly3)
    //=false

    Returns boolean true/false


    This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

    Installation

    Install this module individually:

    $ npm install @turf/boolean-overlap

    Or install the Turf module that includes it as a function:

    $ npm install @turf/turf

    Diagrams

    esri-overlaps

    Install

    npm i @turf/boolean-overlap

    DownloadsWeekly Downloads

    265,844

    Version

    6.5.0

    License

    MIT

    Unpacked Size

    13.3 kB

    Total Files

    7

    Last publish

    Collaborators

    • twelch
    • jamesmilneruk
    • rowanwins
    • tmcw
    • morganherlocker
    • tcql
    • mdfedderly