@naivemap/image-layer-core 0.2.0-alpha.0 → 0.2.0

package/dist/image-layer-core/src/ImageLayerCore.d.ts

@@ -1,16 +1,42 @@
 import { Coordinates, LayerController, LayerMap } from '@naivemap/map-gl-layer-adaptor';
 import { MaskProperty } from './mask';
 /**
- * the options for ImageLayer
+ * The options for ImageLayer
  */
 export type ImageLayerOption = {
+    /**
+     * The URL of the image to display on the map. The image can be in any projection, and it will be reprojected to Web Mercator using Arrugator and Proj4js.
+     */
     url: string;
+    /**
+     * The projection of the image. It can be any projection supported by Proj4js, such as 'EPSG:4326' or 'EPSG:3857'.
+     */
     projection: string;
+    /**
+     * The coordinates of the image corners in the specified projection.
+     */
     coordinates: Coordinates;
+    /**
+     * The resampling method to use when reprojecting the image. Can be 'linear' or 'nearest'.
+     * @default 'linear'
+     */
     resampling?: 'linear' | 'nearest';
+    /**
+     * The opacity of the image layer.
+     * @default 1.0
+     */
     opacity?: number;
+    /**
+     * The crossOrigin attribute for loading the image. It can be set to 'anonymous' or 'use-credentials' if the image is loaded from a different origin and CORS is enabled on the server.
+     */
     crossOrigin?: string;
+    /**
+     * The step size for the Arrugator algorithm. It controls the level of detail when reprojecting the image.
+     */
     arrugatorStep?: number;
+    /**
+     * The mask property for the image layer. It defines how the image should be masked.
+     */
     mask?: MaskProperty;
 };
 export default class ImageLayerCore implements LayerController {

package/dist/image-layer-core/src/mask/index.d.ts

@@ -1,14 +1,14 @@
 import * as GeoJSON from 'geojson';
 /**
- * the mask property of the image layer
+ * The mask property of the image layer
  */
 export interface MaskProperty {
     /**
-     * the type of the mask, 'in' means the area inside the polygon will be masked, 'out' means the area outside the polygon will be masked, default is 'in'
+     * The type of the mask, 'in' means the area inside the polygon will be masked, 'out' means the area outside the polygon will be masked, default is 'in'
      */
     type?: 'in' | 'out';
     /**
-     * the GeoJSON data or URL of the GeoJSON data for the mask
+     * The GeoJSON data or URL of the GeoJSON data for the mask
      */
     data: GeoJSON.GeoJSON | string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naivemap/image-layer-core",
-  "version": "0.2.0-alpha.0",
+  "version": "0.2.0",
   "description": "Map engine agnostic image custom layer core.",
   "main": "./dist/index.umd.js",
   "module": "./dist/index.es.js",
@@ -35,7 +35,7 @@
     "earcut": "^3.0.1",
     "tinyqueue": "^3.0.0",
     "twgl.js": "^5.5.4",
-    "@naivemap/map-gl-layer-adaptor": "0.2.0-alpha.0"
+    "@naivemap/map-gl-layer-adaptor": "0.2.0"
   },
   "peerDependencies": {
     "proj4": "^2.8.0"