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

    6.3.0 • Public • Published

    @turf/bbox-clip

    bboxClip

    Takes a Feature and a bbox and clips the feature to the bbox using lineclip. May result in degenerate edges when clipping Polygons.

    Parameters

    Examples

    var bbox = [0, 0, 10, 10];
    var poly = turf.polygon([[[2, 2], [8, 4], [12, 8], [3, 7], [2, 2]]]);
    
    var clipped = turf.bboxClip(poly, bbox);
    
    //addToMap
    var addToMap = [bbox, poly, clipped]

    Returns Feature<(LineString | MultiLineString | Polygon | MultiPolygon)> clipped Feature


    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/bbox-clip

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

    $ npm install @turf/turf

    Install

    npm i @turf/[email protected]

    Version

    6.3.0

    License

    MIT

    Unpacked Size

    18.2 kB

    Total Files

    10

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar