KBE3D / KBCore / turf / rectangleGrid

函数: rectangleGrid()

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

Function

Creates a grid of rectangular polygons with width and height 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.

cellWidth

number

width of each cell, in units

cellHeight

number

height of each cell, in units

options?

Optional parameters

units?

Units

the units of the cell width and height value. Supports all valid Turf Units

. If you are looking for rectangles with equal width and height in linear units (e.g. kilometers) this is not the module for you. The cellWidth and cellHeight 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

示例

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

var rectangleGrid = turf.rectangleGrid(bbox, cellWidth, cellHeight, options);

//addToMap
var addToMap = [rectangleGrid]