@naivemap/mapbox-gl-image-layer 0.6.0-beta.0 → 0.6.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Naive Map
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,97 +1,11 @@
-## ImageLayer class
-
-```bash
-npm i @naivemap/mapbox-gl-image-layer proj4
-```
-
-<b>Signature:</b>
-
-```typescript
-export default class ImageLayer implements mapboxgl.CustomLayerInterface
-```
-
-<b>Implements:</b> mapboxgl.CustomLayerInterface
-
-## Constructors
-
-| Constructor | Description |
-| --- | --- |
-| (constructor)(`id`: `string`, `option`: `ImageOption`) | Constructs a new instance of the <code>ImageLayer</code> class |
-
-### Parameters
-
-**id** `(string)` The ID of the layer.
-
-**option** `(ImageOption)` The option of the image.
-
-| Name | Description |
-| --- | --- |
-| **option.url** <br />(`string`) | URL that points to an image. |
-| **option.projection** <br />(`string`) | Projection with EPSG code that points to the image. |
-| **option.coordinates** <br />(`Array<Array<number>>`) | Corners of image specified in longitude, latitude pairs: top left, top right, bottom right, bottom left. ref: [coordinates](https://docs.mapbox.com/mapbox-gl-js/style-spec/sources/#image-coordinates) |
-| **option.resampling** <br />(Optional `enum`. One of `"linear"`, `"nearest"`. Defaults to `"linear"`) | The resampling/interpolation method to use for overscaling, also known as texture magnification filter. ref: [raster-resampling](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#paint-raster-raster-resampling) |
-| **option.opacity** <br />(Optional `number` between 0 and 1 inclusive. Defaults to 1. | The opacity at which the image will be drawn. |
-| **option.crossOrigin** <br />(`string`) | The crossOrigin attribute is a string which specifies the Cross-Origin Resource Sharing ([CORS](https://developer.mozilla.org/en-US/docs/Glossary/CORS)) setting to use when retrieving the image. |
-| **option.mask** <br />(`MaskProperty`) | The polygonal mask or multipolygonal mask for the image. |
-
-```ts
-export type ImageOption = {
-  url: string
-  projection: string
-  coordinates: Coordinates
-  resampling?: 'linear' | 'nearest'
-  opacity?: number
-  crossOrigin?: string
-  mask?: MaskProperty
-}
-
-// top left, top right, bottom right, bottom left.
-export type Coordinates = [[number, number], [number, number], [number, number], [number, number]]
-
-export type MaskProperty = {
-  type?: 'in' | 'out' // default: in
-  data: GeoJSON.Polygon | GeoJSON.MultiPolygon
-}
-```
-
-### Methods
-
-#### updateImage
-
-Updates the URL, the projection, the coordinates, the opacity or the resampling of the image.
-
-```ts
-updateImage(option: {
-  url?: string
-  projection?: string
-  coordinates?: Coordinates
-  opacity?: number
-  resampling?: 'linear' | 'nearest'
-}): this
-```
-
-#### updateMask
-
-Updates the mask property.
-
-```ts
-updateMask(mask: Partial<MaskProperty>): this
-```
-
-## Example
-
-```ts
-const layer = new ImageLayer('layer-id', {
-  url: '/4326.png',
-  projection: 'EPSG:4326',
-  resampling: 'nearest',
-  coordinates: [
-    [105.289838, 32.204171], // top-left
-    [110.195632, 32.204171], // top-right
-    [110.195632, 28.164713], // bottom-right
-    [105.289838, 28.164713], // bottom-left
-  ],
-})
-
-map.addLayer(layer)
-```
+# @naivemap/mapbox-gl-image-layer
+
+ImageLayer ([@naivemap/mapbox-gl-image-layer](https://www.npmjs.com/package/@naivemap/mapbox-gl-image-layer)): A versatile layer for displaying georeferenced images with **various projections** on the map. It supports loading and correctly positioning images from different coordinate systems, making it ideal for integrating non-standard raster data, historical maps, or aerial imagery.
+
+[API References](https://www.naivemap.com/map-gl-layers/api/image-layer/)
+
+## Install
+
+```bash
+pnpm add @naivemap/mapbox-gl-image-layer proj4
+```

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './mapbox-gl-image-layer/src/index'
+export {}
+import ImageLayer from './mapbox-gl-image-layer/src/index'
+export default ImageLayer
+export * from './mapbox-gl-image-layer/src/index'
+export {}