Nine Pomeranian Monsters

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

    6.5.0 • Public • Published

    @turf/square-grid

    squareGrid

    Creates a square grid from a bounding box.

    Parameters

    • bbox Array<number> extent in [minX, minY, maxX, maxY] order
    • cellSide number of each cell, in units
    • options Object Optional parameters (optional, default {})
      • options.units string used in calculating cellSide, can be degrees, radians, miles, or kilometers (optional, default 'kilometers')
      • options.mask Feature<(Polygon | MultiPolygon)>? if passed a Polygon or MultiPolygon, the grid Points will be created only inside it
      • options.properties Object passed to each point of the grid (optional, default {})

    Examples

    var bbox = [-95, 30 ,-85, 40];
    var cellSide = 50;
    var options = {units: 'miles'};
    
    var squareGrid = turf.squareGrid(bbox, cellSide, options);
    
    //addToMap
    var addToMap = [squareGrid]

    Returns FeatureCollection<Polygon> grid a grid of polygons


    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/square-grid

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

    $ npm install @turf/turf

    Install

    npm i @turf/square-grid

    DownloadsWeekly Downloads

    211,279

    Version

    6.5.0

    License

    MIT

    Unpacked Size

    8.91 kB

    Total Files

    7

    Last publish

    Collaborators

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