Skip to content

Commit 76b99f5

Browse files
committed
update docstring
1 parent d4737ea commit 76b99f5

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

packages/geotiff/src/tile-matrix-set.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,12 @@ function buildTileMatrix(
7474
* Produces one TileMatrix per overview (coarsest first) plus a final entry
7575
* for the full-resolution level. The GeoTIFF must be tiled.
7676
*
77+
* This requires a crs definition that includes a `units` property, so that we
78+
* can convert pixel sizes to physical screen units. Use [`wkt-parser`] to parse
79+
* a WKT string or PROJJSON object, then pass the result as the `crs` argument.
80+
*
81+
* [`wkt-parser`]: https://github.com/proj4js/wkt-parser
82+
*
7783
* @see https://docs.ogc.org/is/17-083r4/17-083r4.html
7884
*/
7985
export function generateTileMatrixSet(

0 commit comments

Comments
 (0)