KBE3D / KBCore / turf / squareGrid

函数: squareGrid()

squareGrid<P>(bbox: BBox, cellSide: number, options?: { units?: Units; properties?: P; mask?: Polygon | MultiPolygon | Feature<Polygon | MultiPolygon, GeoJsonProperties>; }): FeatureCollection<Polygon, P>

Function

Creates a grid of square polygons with cell length consistent in degrees

类型参数

P

P extends GeoJsonProperties = GeoJsonProperties

参数

bbox

BBox

extent of grid in [minX, minY, maxX, maxY] order. If the grid does not fill the bbox perfectly, it is centered.

cellSide

number

length of each cell side.

options?

Optional parameters

units?

Units

the units of the cellSide value. Supports all valid Turf Units

. If you are looking for squares with sides of equal lengths in linear units (e.g. kilometers) this is not the module for you. The cellSide is converted from units provided to degrees internally, so the width and height of resulting polygons will be consistent only in degrees.

properties?

P

passed to each point of the grid

mask?

Polygon | MultiPolygon | Feature<Polygon | MultiPolygon, GeoJsonProperties>

if passed a Polygon or MultiPolygon, the grid Points will be created only inside it

返回

FeatureCollection<Polygon, P>

a grid of polygons with equal width and height in degrees.

示例

var bbox = [-95, 30 ,-85, 40];
var cellSide = 50;
var options = {units: 'miles'};

var squareGrid = turf.squareGrid(bbox, cellSide, options);

//addToMap
var addToMap = [squareGrid]