@naivemap/maplibre-gl-image-layer 0.0.1-alpha.2 → 0.0.1-alpha.4

package/README.md

@@ -7,5 +7,5 @@ ImageLayer ([@naivemap/maplibre-gl-image-layer](https://www.npmjs.com/package/@n
 ## Install
 
 ```bash
-pnpm add @naivemap/maplibre-gl-image-layer
+pnpm add @naivemap/maplibre-gl-image-layer proj4
 ```

package/dist/ImageLayer.d.ts

@@ -1,25 +1,9 @@
 import { default as maplibregl } from 'maplibre-gl';
-import { Coordinates } from './arrugator';
-/**
- * The properties for masking the image layer.
- */
-export type MaskProperty = {
-    /**
-     * The type of mask to apply.
-     * - 'in': The mask is applied inside the polygon (default).
-     * - 'out': The mask is applied outside the polygon.
-     */
-    type?: 'in' | 'out';
-    /**
-     * The data for the mask, which can be a GeoJSON Polygon or MultiPolygon.
-     * If not provided, no mask will be applied.
-     */
-    data: GeoJSON.Polygon | GeoJSON.MultiPolygon;
-};
+import { MaskProperty } from './mask';
 /**
  * The options for the ImageLayer.
  */
-export type ImageOption = {
+export type ImageLayerOption = {
     /**
      * URL that points to an image.
      */
@@ -31,7 +15,7 @@ export type ImageOption = {
     /**
      * Corners of image specified in longitude, latitude pairs.
      */
-    coordinates: Coordinates;
+    coordinates: maplibregl.Coordinates;
     /**
      * The resampling/interpolation method to use for overscaling.
      * - 'linear': Linear interpolation (default).
@@ -117,7 +101,7 @@ export default class ImageLayer implements maplibregl.CustomLayerInterface {
      * @param id - A unique layer id
      * @param option - ImageLayer options
      */
-    constructor(id: string, option: ImageOption);
+    constructor(id: string, option: ImageLayerOption);
     /**
      * @ignore
      */
@@ -133,22 +117,12 @@ export default class ImageLayer implements maplibregl.CustomLayerInterface {
     /**
      * Updates the URL, the projection, the coordinates, the opacity or the resampling of the image.
      * @param {Object} option Options object.
-     * @param {string} [option.url] Image URL.
-     * @param {string} [option.projection] Projection with EPSG code that points to the image..
-     * @param {Array<Array<number>>} [option.coordinates] Four geographical coordinates,
-     * @param {number} [option.opacity] opacity of the image.
-     * @param {string} [option.resampling] The resampling/interpolation method to use for overscaling.
-     */
-    updateImage(option: {
-        url?: string;
-        projection?: string;
-        coordinates?: Coordinates;
-        opacity?: number;
-        resampling?: 'linear' | 'nearest';
-    }): this;
-    /**
-     * Updates the mask property
-     * @param {MaskProperty} mask The mask property.
+     */
+    updateImage(option: Partial<Omit<ImageLayerOption, 'mask'>>): this;
+    /**
+     * Updates the mask property of the image layer.
+     * @param mask
+     * @returns
      */
     updateMask(mask: Partial<MaskProperty>): this;
     private loadTexture;

package/dist/arrugator/index.d.ts

@@ -1,7 +1,6 @@
-export type Coordinates = [[number, number], [number, number], [number, number], [number, number]];
 export type ArrugadoFlat = {
     pos: number[];
     uv: number[];
     trigs: number[];
 };
-export declare function initArrugator(fromProj: string, coordinates: Coordinates, step?: number): ArrugadoFlat;
+export declare function initArrugator(fromProj: string, coordinates: maplibregl.Coordinates, step?: number): ArrugadoFlat;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 import { default as ImageLayer } from './ImageLayer';
-export type { ImageOption, MaskProperty } from './ImageLayer';
+export type { ImageLayerOption } from './ImageLayer';
 export default ImageLayer;
-export type { Coordinates } from './arrugator';
+export type { MaskProperty } from './mask';