| 1234567891011121314151617181920212223242526 |
- import { GeoJsonProperties, BBox, Feature, Polygon } from 'geojson';
- import { Id } from '@turf/helpers';
- /**
- * Takes a bbox and returns an equivalent {@link Polygon|polygon}.
- *
- * @function
- * @param {BBox} bbox extent in [minX, minY, maxX, maxY] order
- * @param {Object} [options={}] Optional parameters
- * @param {GeoJsonProperties} [options.properties={}] Translate properties to Polygon
- * @param {string|number} [options.id={}] Translate Id to Polygon
- * @returns {Feature<Polygon>} a Polygon representation of the bounding box
- * @example
- * var bbox = [0, 0, 10, 10];
- *
- * var poly = turf.bboxPolygon(bbox);
- *
- * //addToMap
- * var addToMap = [poly]
- */
- declare function bboxPolygon<P extends GeoJsonProperties = GeoJsonProperties>(bbox: BBox, options?: {
- properties?: P;
- id?: Id;
- }): Feature<Polygon, P>;
- export { bboxPolygon, bboxPolygon as default };
|