@xylabs/geo 5.0.83 → 5.0.84

package/README.md

@@ -65,6 +65,8 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ***
 
+Provides GeoJSON geometry and MapBox source generation from a quadkey.
+
 ## Constructors
 
 ### Constructor
@@ -91,16 +93,22 @@ new GeoJson(quadkey): GeoJson;
 static featureCollection(features): FeatureCollection;
 ```
 
+Creates a GeoJSON FeatureCollection from an array of features.
+
 ### Parameters
 
 #### features
 
 `Feature`\<`Geometry`, `GeoJsonProperties`\>[]
 
+The features to include
+
 ### Returns
 
 `FeatureCollection`
 
+A GeoJSON FeatureCollection
+
 ***
 
 ### featuresSource()
@@ -109,16 +117,22 @@ static featureCollection(features): FeatureCollection;
 static featuresSource(data): GeoJSONSourceSpecification;
 ```
 
+Creates a MapBox GeoJSON source specification from a FeatureCollection.
+
 ### Parameters
 
 #### data
 
 `FeatureCollection`
 
+The FeatureCollection to use as the source data
+
 ### Returns
 
 `GeoJSONSourceSpecification`
 
+A MapBox GeoJSON source specification
+
 ***
 
 ### geometryFeature()
@@ -127,16 +141,22 @@ static featuresSource(data): GeoJSONSourceSpecification;
 static geometryFeature(geometry): Feature;
 ```
 
+Wraps a geometry object in a GeoJSON Feature.
+
 ### Parameters
 
 #### geometry
 
 `Geometry`
 
+The geometry to wrap
+
 ### Returns
 
 `Feature`
 
+A GeoJSON Feature containing the geometry
+
 ***
 
 ### center()
@@ -145,6 +165,8 @@ static geometryFeature(geometry): Feature;
 center(): LngLat;
 ```
 
+Computes and caches the center point of the quadkey's bounding box as a MapBox LngLat.
+
 ### Returns
 
 `LngLat`
@@ -157,6 +179,8 @@ center(): LngLat;
 point(): Point;
 ```
 
+Returns a GeoJSON Point geometry at the center of the quadkey's bounding box.
+
 ### Returns
 
 `Point`
@@ -169,6 +193,8 @@ point(): Point;
 pointFeature(): Feature;
 ```
 
+Returns a GeoJSON Feature containing the center point geometry.
+
 ### Returns
 
 `Feature`
@@ -181,6 +207,8 @@ pointFeature(): Feature;
 pointFeatureCollection(): FeatureCollection;
 ```
 
+Returns a GeoJSON FeatureCollection containing the center point feature.
+
 ### Returns
 
 `FeatureCollection`
@@ -193,6 +221,8 @@ pointFeatureCollection(): FeatureCollection;
 pointSource(): GeoJSONSourceSpecification;
 ```
 
+Returns a MapBox GeoJSON source specification for the center point.
+
 ### Returns
 
 `GeoJSONSourceSpecification`
@@ -205,6 +235,8 @@ pointSource(): GeoJSONSourceSpecification;
 polygon(): Polygon;
 ```
 
+Returns a GeoJSON Polygon geometry representing the quadkey's bounding box.
+
 ### Returns
 
 `Polygon`
@@ -217,6 +249,8 @@ polygon(): Polygon;
 polygonFeature(): Feature;
 ```
 
+Returns a GeoJSON Feature containing the polygon geometry.
+
 ### Returns
 
 `Feature`
@@ -229,6 +263,8 @@ polygonFeature(): Feature;
 polygonFeatureCollection(): FeatureCollection;
 ```
 
+Returns a GeoJSON FeatureCollection containing the polygon feature.
+
 ### Returns
 
 `FeatureCollection`
@@ -241,6 +277,8 @@ polygonFeatureCollection(): FeatureCollection;
 polygonSource(): GeoJSONSourceSpecification;
 ```
 
+Returns a MapBox GeoJSON source specification for the polygon.
+
 ### Returns
 
 `GeoJSONSourceSpecification`
@@ -253,6 +291,8 @@ polygonSource(): GeoJSONSourceSpecification;
 zoom(): number;
 ```
 
+Returns the zoom level derived from the quadkey length.
+
 ### Returns
 
 `number`
@@ -263,6 +303,8 @@ zoom(): number;
 
 ***
 
+Abstract base class for managing MapBox map layers with add/remove lifecycle.
+
 ## Type Parameters
 
 ### T
@@ -315,16 +357,22 @@ source: string;
 update(map, show?): void;
 ```
 
+Removes and re-adds the layer on the map, optionally hiding it.
+
 ### Parameters
 
 #### map
 
 `Map$1`
 
+The MapBox map instance
+
 #### show?
 
 `boolean` = `true`
 
+Whether to show the layer after updating (default true)
+
 ### Returns
 
 `void`
@@ -337,6 +385,8 @@ update(map, show?): void;
 abstract buildLayer(): T;
 ```
 
+Builds the MapBox layer configuration object.
+
 ### Returns
 
 `T`
@@ -347,6 +397,8 @@ abstract buildLayer(): T;
 
 ***
 
+A Mercator bounding box extending MapBox LngLatBounds.
+
 ## Extends
 
 - `LngLatBounds`
@@ -385,6 +437,8 @@ MapBox.LngLatBounds.constructor
 
 ***
 
+A Mercator coordinate extending MapBox LngLat.
+
 ## Extends
 
 - `LngLat`
@@ -429,16 +483,22 @@ MapBox.LngLat.constructor
 function boundingBoxToBoundary(box): MercatorBoundary;
 ```
 
+Converts a bounding box to an ordered boundary polygon (closed ring of corner points).
+
 ## Parameters
 
 ### box
 
 [`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
 
+The bounding box to convert
+
 ## Returns
 
 [`MercatorBoundary`](#../type-aliases/MercatorBoundary)
 
+An array of corner points forming a closed boundary
+
   ### <a id="boundingBoxToCenter"></a>boundingBoxToCenter
 
 [**@xylabs/geo**](#../README)
@@ -449,20 +509,28 @@ function boundingBoxToBoundary(box): MercatorBoundary;
 function boundingBoxToCenter(boundingBox, decimal?): number[];
 ```
 
+Computes the center point of a bounding box as [lng, lat], rounded to the specified decimal places.
+
 ## Parameters
 
 ### boundingBox
 
 [`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
 
+The bounding box to find the center of
+
 ### decimal?
 
 `number` = `6`
 
+Number of decimal places for rounding (default 6)
+
 ## Returns
 
 `number`[]
 
+A [longitude, latitude] tuple representing the center
+
   ### <a id="boundingBoxToPolygon"></a>boundingBoxToPolygon
 
 [**@xylabs/geo**](#../README)
@@ -473,16 +541,22 @@ function boundingBoxToCenter(boundingBox, decimal?): number[];
 function boundingBoxToPolygon(box): Polygon;
 ```
 
+Converts a bounding box to a GeoJSON Polygon geometry.
+
 ## Parameters
 
 ### box
 
 [`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
 
+The bounding box to convert
+
 ## Returns
 
 `Polygon`
 
+A GeoJSON Polygon representing the bounding box
+
   ### <a id="hasSiblings"></a>hasSiblings
 
 [**@xylabs/geo**](#../README)
@@ -493,20 +567,28 @@ function boundingBoxToPolygon(box): Polygon;
 function hasSiblings(tiles, tile): boolean;
 ```
 
+Checks whether all four siblings of the given tile exist in the tile array.
+
 ## Parameters
 
 ### tiles
 
 [`MercatorTile`](#../type-aliases/MercatorTile)[]
 
+The array of tiles to search
+
 ### tile
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The tile whose siblings to check for
+
 ## Returns
 
 `boolean`
 
+True if all siblings are present in the array
+
   ### <a id="tileFromPoint"></a>tileFromPoint
 
 [**@xylabs/geo**](#../README)
@@ -517,20 +599,28 @@ function hasSiblings(tiles, tile): boolean;
 function tileFromPoint(point, z): MercatorTile;
 ```
 
+Converts a geographic point to the integer Mercator tile containing it at the given zoom level.
+
 ## Parameters
 
 ### point
 
 [`MercatorLngLat`](#../classes/MercatorLngLat)
 
+The geographic coordinate
+
 ### z
 
 `number`
 
+The zoom level
+
 ## Returns
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The tile as [x, y, zoom]
+
   ### <a id="tileFromQuadkey"></a>tileFromQuadkey
 
 [**@xylabs/geo**](#../README)
@@ -541,16 +631,22 @@ function tileFromPoint(point, z): MercatorTile;
 function tileFromQuadkey(quadkey): MercatorTile;
 ```
 
+Converts a quadkey string to a Mercator tile [x, y, zoom].
+
 ## Parameters
 
 ### quadkey
 
 `string`
 
+The quadkey string to decode
+
 ## Returns
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The tile as [x, y, zoom]
+
   ### <a id="tileToBoundingBox"></a>tileToBoundingBox
 
 [**@xylabs/geo**](#../README)
@@ -561,16 +657,22 @@ function tileFromQuadkey(quadkey): MercatorTile;
 function tileToBoundingBox(tile): MercatorBoundingBox;
 ```
 
+Converts a Mercator tile to its geographic bounding box.
+
 ## Parameters
 
 ### tile
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The tile as [x, y, zoom]
+
 ## Returns
 
 [`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
 
+The bounding box covering the tile's geographic extent
+
   ### <a id="tileToChildren"></a>tileToChildren
 
 [**@xylabs/geo**](#../README)
@@ -581,16 +683,22 @@ function tileToBoundingBox(tile): MercatorBoundingBox;
 function tileToChildren(tile): MercatorTile[];
 ```
 
+Returns the four child tiles at one zoom level higher.
+
 ## Parameters
 
 ### tile
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The parent tile as [x, y, zoom]
+
 ## Returns
 
 [`MercatorTile`](#../type-aliases/MercatorTile)[]
 
+An array of four child tiles at zoom + 1
+
   ### <a id="tileToGeoJson"></a>tileToGeoJson
 
 [**@xylabs/geo**](#../README)
@@ -601,16 +709,22 @@ function tileToChildren(tile): MercatorTile[];
 function tileToGeoJson(tile): Polygon;
 ```
 
+Converts a Mercator tile to a GeoJSON Polygon geometry.
+
 ## Parameters
 
 ### tile
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The tile as [x, y, zoom]
+
 ## Returns
 
 `Polygon`
 
+A GeoJSON Polygon representing the tile's geographic extent
+
   ### <a id="tileToParent"></a>tileToParent
 
 [**@xylabs/geo**](#../README)
@@ -621,16 +735,22 @@ function tileToGeoJson(tile): Polygon;
 function tileToParent(tile): MercatorTile;
 ```
 
+Returns the parent tile at one zoom level lower.
+
 ## Parameters
 
 ### tile
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The tile as [x, y, zoom]
+
 ## Returns
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The parent tile at zoom - 1
+
   ### <a id="tileToPoint"></a>tileToPoint
 
 [**@xylabs/geo**](#../README)
@@ -641,16 +761,22 @@ function tileToParent(tile): MercatorTile;
 function tileToPoint(tile): MercatorLngLat;
 ```
 
+Returns the center point of a Mercator tile.
+
 ## Parameters
 
 ### tile
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The tile as [x, y, zoom]
+
 ## Returns
 
 [`MercatorLngLat`](#../classes/MercatorLngLat)
 
+The center coordinate as a MercatorLngLat
+
   ### <a id="tileToQuadkey"></a>tileToQuadkey
 
 [**@xylabs/geo**](#../README)
@@ -658,19 +784,25 @@ function tileToPoint(tile): MercatorLngLat;
 ***
 
 ```ts
-function tileToQuadkey(__namedParameters): string;
+function tileToQuadkey(param0): string;
 ```
 
+Converts a Mercator tile to its quadkey string representation.
+
 ## Parameters
 
-### \_\_namedParameters
+### param0
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The tile as [tileX, tileY, tileZoom]
+
 ## Returns
 
 `string`
 
+The quadkey string encoding the tile's position and zoom
+
   ### <a id="tileToSiblings"></a>tileToSiblings
 
 [**@xylabs/geo**](#../README)
@@ -681,16 +813,22 @@ function tileToQuadkey(__namedParameters): string;
 function tileToSiblings(tile): MercatorTile[];
 ```
 
+Returns the four sibling tiles (children of the parent tile) for the given tile.
+
 ## Parameters
 
 ### tile
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The tile as [x, y, zoom]
+
 ## Returns
 
 [`MercatorTile`](#../type-aliases/MercatorTile)[]
 
+An array of four sibling tiles at the same zoom level
+
   ### <a id="tilesEqual"></a>tilesEqual
 
 [**@xylabs/geo**](#../README)
@@ -698,23 +836,31 @@ function tileToSiblings(tile): MercatorTile[];
 ***
 
 ```ts
-function tilesEqual(__namedParameters, __namedParameters): boolean;
+function tilesEqual(param0, param1): boolean;
 ```
 
+Checks whether two Mercator tiles are equal by comparing their x, y, and zoom values.
+
 ## Parameters
 
-### \_\_namedParameters
+### param0
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
-### \_\_namedParameters
+The first tile as [x, y, zoom]
+
+### param1
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The second tile as [x, y, zoom]
+
 ## Returns
 
 `boolean`
 
+True if both tiles have identical coordinates and zoom
+
   ### <a id="tilesFromBoundingBox"></a>tilesFromBoundingBox
 
 [**@xylabs/geo**](#../README)
@@ -725,20 +871,28 @@ function tilesEqual(__namedParameters, __namedParameters): boolean;
 function tilesFromBoundingBox(box, zoom): MercatorTile[];
 ```
 
+Returns all Mercator tiles that intersect the given bounding box at the specified zoom level.
+
 ## Parameters
 
 ### box
 
 [`MercatorBoundingBox`](#../classes/MercatorBoundingBox)
 
+The geographic bounding box
+
 ### zoom
 
 `number`
 
+The zoom level
+
 ## Returns
 
 [`MercatorTile`](#../type-aliases/MercatorTile)[]
 
+An array of tiles covering the bounding box
+
   ### <a id="tilesHasTile"></a>tilesHasTile
 
 [**@xylabs/geo**](#../README)
@@ -749,20 +903,28 @@ function tilesFromBoundingBox(box, zoom): MercatorTile[];
 function tilesHasTile(tiles, tile): boolean;
 ```
 
+Checks whether a specific tile exists in the given tile array.
+
 ## Parameters
 
 ### tiles
 
 [`MercatorTile`](#../type-aliases/MercatorTile)[]
 
+The array of tiles to search
+
 ### tile
 
 [`MercatorTile`](#../type-aliases/MercatorTile)
 
+The tile to look for
+
 ## Returns
 
 `boolean`
 
+True if the tile is found in the array
+
 ### type-aliases
 
   ### <a id="MercatorBoundary"></a>MercatorBoundary
@@ -775,6 +937,8 @@ function tilesHasTile(tiles, tile): boolean;
 type MercatorBoundary = MercatorLngLat[];
 ```
 
+An ordered array of MercatorLngLat points forming a boundary.
+
   ### <a id="MercatorTile"></a>MercatorTile
 
 [**@xylabs/geo**](#../README)
@@ -785,6 +949,8 @@ type MercatorBoundary = MercatorLngLat[];
 type MercatorTile = readonly [number, number, number];
 ```
 
+A Mercator tile represented as [x, y, zoom].
+
 ### variables
 
   ### <a id="d2r"></a>d2r
@@ -797,6 +963,8 @@ type MercatorTile = readonly [number, number, number];
 const d2r: number;
 ```
 
+Conversion factor from degrees to radians.
+
   ### <a id="r2d"></a>r2d
 
 [**@xylabs/geo**](#../README)
@@ -807,6 +975,8 @@ const d2r: number;
 const r2d: number;
 ```
 
+Conversion factor from radians to degrees.
+
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/dist/neutral/GeoJson.d.ts

@@ -1,5 +1,6 @@
 import type { Feature, FeatureCollection, Geometry, Point, Polygon } from 'geojson';
 import MapBox from 'mapbox-gl';
+/** Provides GeoJSON geometry and MapBox source generation from a quadkey. */
 declare class GeoJson {
     private _lngLat?;
     private _point?;
@@ -7,18 +8,43 @@ declare class GeoJson {
     private _zoom?;
     private quadkey;
     constructor(quadkey: string);
+    /**
+     * Creates a GeoJSON FeatureCollection from an array of features.
+     * @param features - The features to include
+     * @returns A GeoJSON FeatureCollection
+     */
     static featureCollection(features: Feature[]): FeatureCollection;
+    /**
+     * Creates a MapBox GeoJSON source specification from a FeatureCollection.
+     * @param data - The FeatureCollection to use as the source data
+     * @returns A MapBox GeoJSON source specification
+     */
     static featuresSource(data: FeatureCollection): MapBox.GeoJSONSourceSpecification;
+    /**
+     * Wraps a geometry object in a GeoJSON Feature.
+     * @param geometry - The geometry to wrap
+     * @returns A GeoJSON Feature containing the geometry
+     */
     static geometryFeature(geometry: Geometry): Feature;
+    /** Computes and caches the center point of the quadkey's bounding box as a MapBox LngLat. */
     center(): MapBox.LngLat;
+    /** Returns a GeoJSON Point geometry at the center of the quadkey's bounding box. */
     point(): Point;
+    /** Returns a GeoJSON Feature containing the center point geometry. */
     pointFeature(): Feature;
+    /** Returns a GeoJSON FeatureCollection containing the center point feature. */
     pointFeatureCollection(): FeatureCollection;
+    /** Returns a MapBox GeoJSON source specification for the center point. */
     pointSource(): MapBox.GeoJSONSourceSpecification;
+    /** Returns a GeoJSON Polygon geometry representing the quadkey's bounding box. */
     polygon(): Polygon;
+    /** Returns a GeoJSON Feature containing the polygon geometry. */
     polygonFeature(): Feature;
+    /** Returns a GeoJSON FeatureCollection containing the polygon feature. */
     polygonFeatureCollection(): FeatureCollection;
+    /** Returns a MapBox GeoJSON source specification for the polygon. */
     polygonSource(): MapBox.GeoJSONSourceSpecification;
+    /** Returns the zoom level derived from the quadkey length. */
     zoom(): number;
 }
 export { GeoJson };

package/dist/neutral/GeoJson.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GeoJson.d.ts","sourceRoot":"","sources":["../../src/GeoJson.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EACrD,MAAM,SAAS,CAAA;AAChB,OAAO,MAAM,MAAM,WAAW,CAAA;AAM9B,cAAM,OAAO;IACX,OAAO,CAAC,OAAO,CAAC,CAAe;IAC/B,OAAO,CAAC,MAAM,CAAC,CAAO;IACtB,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,KAAK,CAAC,CAAQ;IAEtB,OAAO,CAAC,OAAO,CAAQ;gBAEX,OAAO,EAAE,MAAM;IAI3B,MAAM,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,iBAAiB;IAOhE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM,CAAC,0BAA0B;IAOjF,MAAM,CAAC,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO;IAQnD,MAAM,IAAI,MAAM,CAAC,MAAM;IAUvB,KAAK,IAAI,KAAK;IAUd,YAAY,IAAI,OAAO;IAIvB,sBAAsB,IAAI,iBAAiB;IAI3C,WAAW,IAAI,MAAM,CAAC,0BAA0B;IAOhD,OAAO,IAAI,OAAO;IAOlB,cAAc,IAAI,OAAO;IAIzB,wBAAwB,IAAI,iBAAiB;IAI7C,aAAa,IAAI,MAAM,CAAC,0BAA0B;IAIlD,IAAI,IAAI,MAAM;CAIf;AAED,OAAO,EAAE,OAAO,EAAE,CAAA"}
+{"version":3,"file":"GeoJson.d.ts","sourceRoot":"","sources":["../../src/GeoJson.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EACrD,MAAM,SAAS,CAAA;AAChB,OAAO,MAAM,MAAM,WAAW,CAAA;AAM9B,6EAA6E;AAC7E,cAAM,OAAO;IACX,OAAO,CAAC,OAAO,CAAC,CAAe;IAC/B,OAAO,CAAC,MAAM,CAAC,CAAO;IACtB,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO,CAAC,KAAK,CAAC,CAAQ;IAEtB,OAAO,CAAC,OAAO,CAAQ;gBAEX,OAAO,EAAE,MAAM;IAI3B;;;;OAIG;IACH,MAAM,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,iBAAiB;IAOhE;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM,CAAC,0BAA0B;IAOjF;;;;OAIG;IACH,MAAM,CAAC,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO;IAQnD,6FAA6F;IAC7F,MAAM,IAAI,MAAM,CAAC,MAAM;IAUvB,oFAAoF;IACpF,KAAK,IAAI,KAAK;IAUd,sEAAsE;IACtE,YAAY,IAAI,OAAO;IAIvB,+EAA+E;IAC/E,sBAAsB,IAAI,iBAAiB;IAI3C,0EAA0E;IAC1E,WAAW,IAAI,MAAM,CAAC,0BAA0B;IAOhD,kFAAkF;IAClF,OAAO,IAAI,OAAO;IAOlB,iEAAiE;IACjE,cAAc,IAAI,OAAO;IAIzB,0EAA0E;IAC1E,wBAAwB,IAAI,iBAAiB;IAI7C,qEAAqE;IACrE,aAAa,IAAI,MAAM,CAAC,0BAA0B;IAIlD,8DAA8D;IAC9D,IAAI,IAAI,MAAM;CAIf;AAED,OAAO,EAAE,OAAO,EAAE,CAAA"}