@map-colonies/mc-utils 2.0.0 → 2.0.2

package/dist/geo/tiles.d.ts

@@ -1,83 +1,83 @@
-import { BBox2d } from '@turf/helpers/dist/js/lib/geojson';
-import { Feature, FeatureCollection, MultiPolygon, Polygon } from '@turf/turf';
-import { ITile, ITileRange } from '../models/interfaces/geo/iTile';
-/**
- * calculates tile size (resolution) in degrees
- * @param zoomLevel zoom level of returned tile size
- * @returns tile size (resolution) in degrees
- */
-export declare function degreesPerTile(zoomLevel: number): number;
-/**
- * returns pixel size (resolution) in degrees
- * @param zoomLevel tile zoom level of returned tile pixel size
- * @returns pixel size (resolution) in degrees
- */
-export declare function degreesPerPixel(zoomLevel: number): number;
-/**
- * coverts tile coordinates between ll and ul
- * @param tile source tile
- * @returns converted tile
- */
-export declare function flipYAxis(tile: ITile): ITile;
-/**
- * converts zoom level (integer) to matching resolution degree value
- * @param zoom zoom level in range of 0-22
- * @returns resolution represented in degrees, or undefined if zoom level is out of range
- */
-export declare function zoomLevelToResolutionDeg(zoom: number): number | undefined;
-/**
- * converts zoom level (integer) to matching resolution meter value
- * @param zoom zoom level in range of 0-22
- * @returns resolution represented in Meters, or undefined if zoom level is out of range
- */
-export declare function zoomLevelToResolutionMeter(zoom: number): number | undefined;
-/**
- * converts pixel size (resolution) in degrees to matching zoom level (rounded down)
- * @param resolution pixel size (resolution) in degrees
- * @returns zoom level for given pixel size
- */
-export declare function degreesPerPixelToZoomLevel(resolution: number): number;
-/**
- * returns bbox of given tile
- * @param tile
- * @returns
- */
-export declare function tileToBbox(tile: ITile): BBox2d;
-/**
- * returns the batch area
- * @param ITileRange
- * @returns
- */
-export declare function tileRangeToTilesCount(batch: ITileRange): number;
-/**
- * returns tiles amount of given feature and zoom ranges - based on 2:1 tile scheme
- * use the bboxToTileRange method and provide sanitized bbox coverage of tiles
- * @param feature
- * If feature's properties include attributes of "maxResolutionDeg" and "minResolutionDeg" or just one of them -
- * It will be converted to maxZoom and minZoom instead of default params to calculate
- * minResolutionDeg >= 0.703125
- * maxResolutionDeg <= 0.000000167638063430786
- * @param layerFootprint - referenced layer geometry to snap on the bbox
- * @param defaultMaxZoom optional - default is 22 - if maxResolutionDeg property was provided, the param will be ignored
- * @param defaultMinZoom optional - default is 0 - if minResolutionDeg property was provided, the param will be ignored
- * @returns tile count included on provided feature and zooms ranges
- */
-export declare function featureToTilesCount(feature: Feature<Polygon | MultiPolygon>, defaultMaxZoom?: number, defaultMinZoom?: number): number;
-/**
- * returns tiles amount of given featureCollection [each feature may include maxResolutionDeg and minResolutionDeg
- * if no resolutions in property will calculate all features with optional argument]
- * based on 2:1 tile scheme
- * use the bboxToTileRange method and provide sanitized bbox coverage of tiles
- * @param fc - FeatureCollection
- * foreach feature in featuresCollection features array:
- * If feature's properties include attributes of "maxResolutionDeg" and "minResolutionDeg" or just one of them -
- * It will be converted to maxZoom and minZoom instead of default params to calculate
- * minResolutionDeg >= 0.703125
- * maxResolutionDeg <= 0.000000167638063430786
- * for current feature in the array
- * @param defaultMaxZoom optional - default is 22 - if maxResolutionDeg property was provided, the param will be ignored
- * @param defaultMinZoom optional - default is 0 - if minResolutionDeg property was provided, the param will be ignored
- * @returns tile count included on provided feature and zooms ranges
- */
-export declare function featureCollectionToTilesCount(fc: FeatureCollection, defaultMaxZoom?: number, defaultMinZoom?: number): number;
+import { BBox2d } from '@turf/helpers/dist/js/lib/geojson';
+import { Feature, FeatureCollection, MultiPolygon, Polygon } from '@turf/turf';
+import { ITile, ITileRange } from '../models/interfaces/geo/iTile';
+/**
+ * calculates tile size (resolution) in degrees
+ * @param zoomLevel zoom level of returned tile size
+ * @returns tile size (resolution) in degrees
+ */
+export declare function degreesPerTile(zoomLevel: number): number;
+/**
+ * returns pixel size (resolution) in degrees
+ * @param zoomLevel tile zoom level of returned tile pixel size
+ * @returns pixel size (resolution) in degrees
+ */
+export declare function degreesPerPixel(zoomLevel: number): number;
+/**
+ * coverts tile coordinates between ll and ul
+ * @param tile source tile
+ * @returns converted tile
+ */
+export declare function flipYAxis(tile: ITile): ITile;
+/**
+ * converts zoom level (integer) to matching resolution degree value
+ * @param zoom zoom level in range of 0-22
+ * @returns resolution represented in degrees, or undefined if zoom level is out of range
+ */
+export declare function zoomLevelToResolutionDeg(zoom: number): number | undefined;
+/**
+ * converts zoom level (integer) to matching resolution meter value
+ * @param zoom zoom level in range of 0-22
+ * @returns resolution represented in Meters, or undefined if zoom level is out of range
+ */
+export declare function zoomLevelToResolutionMeter(zoom: number): number | undefined;
+/**
+ * converts pixel size (resolution) in degrees to matching zoom level (rounded down)
+ * @param resolution pixel size (resolution) in degrees
+ * @returns zoom level for given pixel size
+ */
+export declare function degreesPerPixelToZoomLevel(resolution: number): number;
+/**
+ * returns bbox of given tile
+ * @param tile
+ * @returns
+ */
+export declare function tileToBbox(tile: ITile): BBox2d;
+/**
+ * returns the batch area
+ * @param ITileRange
+ * @returns
+ */
+export declare function tileRangeToTilesCount(batch: ITileRange): number;
+/**
+ * returns tiles amount of given feature and zoom ranges - based on 2:1 tile scheme
+ * use the bboxToTileRange method and provide sanitized bbox coverage of tiles
+ * @param feature
+ * If feature's properties include attributes of "maxResolutionDeg" and "minResolutionDeg" or just one of them -
+ * It will be converted to maxZoom and minZoom instead of default params to calculate
+ * minResolutionDeg >= 0.703125
+ * maxResolutionDeg <= 0.000000167638063430786
+ * @param layerFootprint - referenced layer geometry to snap on the bbox
+ * @param defaultMaxZoom optional - default is 22 - if maxResolutionDeg property was provided, the param will be ignored
+ * @param defaultMinZoom optional - default is 0 - if minResolutionDeg property was provided, the param will be ignored
+ * @returns tile count included on provided feature and zooms ranges
+ */
+export declare function featureToTilesCount(feature: Feature<Polygon | MultiPolygon>, defaultMaxZoom?: number, defaultMinZoom?: number): number;
+/**
+ * returns tiles amount of given featureCollection [each feature may include maxResolutionDeg and minResolutionDeg
+ * if no resolutions in property will calculate all features with optional argument]
+ * based on 2:1 tile scheme
+ * use the bboxToTileRange method and provide sanitized bbox coverage of tiles
+ * @param fc - FeatureCollection
+ * foreach feature in featuresCollection features array:
+ * If feature's properties include attributes of "maxResolutionDeg" and "minResolutionDeg" or just one of them -
+ * It will be converted to maxZoom and minZoom instead of default params to calculate
+ * minResolutionDeg >= 0.703125
+ * maxResolutionDeg <= 0.000000167638063430786
+ * for current feature in the array
+ * @param defaultMaxZoom optional - default is 22 - if maxResolutionDeg property was provided, the param will be ignored
+ * @param defaultMinZoom optional - default is 0 - if minResolutionDeg property was provided, the param will be ignored
+ * @returns tile count included on provided feature and zooms ranges
+ */
+export declare function featureCollectionToTilesCount(fc: FeatureCollection, defaultMaxZoom?: number, defaultMinZoom?: number): number;
 //# sourceMappingURL=tiles.d.ts.map