Neonatal Penguin March

    @turf/points-within-polygon
    TypeScript icon, indicating that this package has built-in type declarations

    6.5.0 • Public • Published

    @turf/points-within-polygon

    pointsWithinPolygon

    Finds Points that fall within (Multi)Polygon(s).

    Parameters

    Examples

    var points = turf.points([
        [-46.6318, -23.5523],
        [-46.6246, -23.5325],
        [-46.6062, -23.5513],
        [-46.663, -23.554],
        [-46.643, -23.557]
    ]);
    
    var searchWithin = turf.polygon([[
        [-46.653,-23.543],
        [-46.634,-23.5346],
        [-46.613,-23.543],
        [-46.614,-23.559],
        [-46.631,-23.567],
        [-46.653,-23.560],
        [-46.653,-23.543]
    ]]);
    
    var ptsWithin = turf.pointsWithinPolygon(points, searchWithin);
    
    //addToMap
    var addToMap = [points, searchWithin, ptsWithin]
    turf.featureEach(ptsWithin, function (currentFeature) {
      currentFeature.properties['marker-size'] = 'large';
      currentFeature.properties['marker-color'] = '#000';
    });

    Returns FeatureCollection<Point> points that land within at least one polygon


    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/points-within-polygon

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

    $ npm install @turf/turf

    Install

    npm i @turf/points-within-polygon

    DownloadsWeekly Downloads

    179,965

    Version

    6.5.0

    License

    MIT

    Unpacked Size

    10.6 kB

    Total Files

    7

    Last publish

    Collaborators

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