@artstesh/maps 5.2.4 → 5.2.5

package/dist/map/map-plate/layers/image-layer/image-layer-factory.d.ts

@@ -0,0 +1,9 @@
+import Static from 'ol/source/ImageStatic';
+import { ImageLayerSettings } from './image-layer.settings';
+import ImageLayer from 'ol/layer/Image';
+import * as i0 from "@angular/core";
+export declare class ImageLayerFactory {
+    build(settings: ImageLayerSettings): ImageLayer<Static>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ImageLayerFactory, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ImageLayerFactory>;
+}

package/dist/map/map-plate/layers/image-layer/image-layer.component.d.ts

@@ -0,0 +1,22 @@
+import { OnInit } from '@angular/core';
+import { DestructibleComponent } from '../../../common/destructible.component';
+import { MapPostboyService } from '../../../services/map-postboy.service';
+import { ImageLayerFactory } from './image-layer-factory';
+import ImageLayer from 'ol/layer/Image';
+import Static from 'ol/source/ImageStatic';
+import { ImageLayerSettings } from './image-layer.settings';
+import * as i0 from "@angular/core";
+export declare class ImageLayerComponent extends DestructibleComponent implements OnInit {
+    private postboy;
+    private factory;
+    layer?: ImageLayer<Static>;
+    constructor(postboy: MapPostboyService, factory: ImageLayerFactory);
+    _settings: ImageLayerSettings;
+    set settings(value: ImageLayerSettings | undefined);
+    ngOnInit(): void;
+    onDestroy: () => void;
+    private initLayer;
+    private removeLayer;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ImageLayerComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ImageLayerComponent, "art-image-layer", never, { "settings": { "alias": "settings"; "required": false; }; }, {}, never, never, false, never>;
+}

package/dist/map/map-plate/layers/image-layer/image-layer.settings.d.ts

@@ -0,0 +1,97 @@
+export declare class ImageLayerSettings {
+    /**
+     * Represents the tiles URL.
+     * @typedef {string} url
+     *
+     * @example
+     * 'https://example.ex/{z}/{x}/{y}.png'
+     */
+    url: string;
+    /**
+     * Use interpolated values when resampling.
+     * By default, linear interpolation is used when resampling.
+     * Set to false to use the nearest neighbor instead.
+     */
+    interpolate?: boolean;
+    /**
+     * The projection of the coordinate system.
+     *
+     * @type {string}
+     * @default 'EPSG:3857'
+     */
+    projection: string;
+    extent: number[];
+    /**
+     * Additional headers that should be added to each tile request
+     *
+     * @type {Record<string, string>}
+     * @default An empty array
+     */
+    requestHeaders: Record<string, string> | null;
+    /**
+     * Creates a copy of the given tile layer settings.
+     *
+     * @param {ImageLayerSettings} model - The tile layer settings to be copied.
+     * @return {ImageLayerSettings} - A new instance of ImageLayerSettings with the same properties as the model.
+     */
+    static copy(model: ImageLayerSettings): ImageLayerSettings;
+    /**
+     * Sets the URL of the ImageLayerSettings object.
+     *
+     * @param {string} url - The URL to be set.
+     * @return {ImageLayerSettings} - The updated ImageLayerSettings object.
+     */
+    setUrl(url: string): ImageLayerSettings;
+    /**
+     * Sets the interpolation state for the image layer settings.
+     *
+     * @param {boolean} [interpolate] - Use interpolated values when resampling.
+     * By default, linear interpolation is used when resampling.
+     * Set to false to use the nearest neighbor instead.
+     * @return {ImageLayerSettings} A new instance of ImageLayerSettings with the updated interpolation setting.
+     */
+    setInterpolate(interpolate?: boolean): ImageLayerSettings;
+    setExtent(extent: number[]): ImageLayerSettings;
+    /**
+     * Sets the requestHeaders of the ImageLayerSettings object.
+     *
+     * @param {Record<string, string>} requestHeaders - The headers which should be provided.
+     * @return {ImageLayerSettings} - The updated ImageLayerSettings object.
+     */
+    setRequestHeaders(requestHeaders: Record<string, string>): ImageLayerSettings;
+    /**
+     * Sets the maximum zoom level for the tile layer.
+     *
+     * @param {number} maxZoom - The maximum zoom level.
+     * @returns {ImageLayerSettings} - The updated tile layer settings object.
+     */
+    setMaxZoom(maxZoom: number): ImageLayerSettings;
+    /**
+     * Sets the minimum zoom level for the Tile Layer.
+     *
+     * @param {number} minZoom - The minimum zoom level to be set.
+     * @return {ImageLayerSettings} The modified ImageLayerSettings object with the updated minimum zoom level.
+     */
+    setMinZoom(minZoom: number): ImageLayerSettings;
+    /**
+     * Sets the opacity of the ImageLayerSettings.
+     *
+     * @param {number} opacity - The opacity value to set. Must be a number between 0 and 1.
+     * @return {ImageLayerSettings} - A new instance of ImageLayerSettings with the opacity set.
+     */
+    setOpacity(opacity: number): ImageLayerSettings;
+    /**
+     * Sets the projection for the tile layer settings.
+     *
+     * @param {string} projection - The desired projection for the tile layer settings.
+     * @return {ImageLayerSettings} - The updated tile layer settings with the new projection.
+     */
+    setProjection(projection: string): ImageLayerSettings;
+    /**
+     * Checks if the current instance of ImageLayerSettings is equal to the given model.
+     * @param {ImageLayerSettings} model - The model to compare against.
+     * @return {boolean} - True if all properties of the current instance matches the properties of the model;
+     *                    otherwise, false.
+     */
+    isSame(model: ImageLayerSettings): boolean;
+}

package/dist/map/map-plate/layers/index.d.ts

@@ -5,3 +5,5 @@ export * from './feature-layer/feature-layer.settings';
 export * from './feature-layer/feature-layer.component';
 export * from './cluster-layer/cluster-layer.component';
 export * from './cluster-layer/cluster-layer.settings';
+export * from './image-layer/image-layer.component';
+export * from './image-layer/image-layer.settings';

package/dist/map/map.module.d.ts

@@ -9,9 +9,10 @@ import * as i7 from "./map-plate/tooltips/tooltip/tooltip.component";
 import * as i8 from "./map-plate/features/polygons/polygons.component";
 import * as i9 from "./map-plate/layers/cluster-layer/cluster-layer.component";
 import * as i10 from "./map-plate/controls/map-control-zoom/map-control-zoom.component";
-import * as i11 from "@angular/common";
+import * as i11 from "./map-plate/layers/image-layer/image-layer.component";
+import * as i12 from "@angular/common";
 export declare class MapModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<MapModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<MapModule, [typeof i1.DestructibleComponent, typeof i2.MapPlateComponent, typeof i3.TileLayerComponent, typeof i4.OsmTileLayerComponent, typeof i5.FeatureLayerComponent, typeof i6.MarkersComponent, typeof i7.TooltipComponent, typeof i8.PolygonsComponent, typeof i9.ClusterLayerComponent, typeof i10.MapControlZoomComponent], [typeof i11.CommonModule], [typeof i2.MapPlateComponent, typeof i5.FeatureLayerComponent, typeof i6.MarkersComponent, typeof i3.TileLayerComponent, typeof i7.TooltipComponent, typeof i8.PolygonsComponent, typeof i9.ClusterLayerComponent, typeof i10.MapControlZoomComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<MapModule, [typeof i1.DestructibleComponent, typeof i2.MapPlateComponent, typeof i3.TileLayerComponent, typeof i4.OsmTileLayerComponent, typeof i5.FeatureLayerComponent, typeof i6.MarkersComponent, typeof i7.TooltipComponent, typeof i8.PolygonsComponent, typeof i9.ClusterLayerComponent, typeof i10.MapControlZoomComponent, typeof i11.ImageLayerComponent], [typeof i12.CommonModule], [typeof i2.MapPlateComponent, typeof i5.FeatureLayerComponent, typeof i6.MarkersComponent, typeof i3.TileLayerComponent, typeof i7.TooltipComponent, typeof i8.PolygonsComponent, typeof i9.ClusterLayerComponent, typeof i10.MapControlZoomComponent, typeof i11.ImageLayerComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<MapModule>;
 }

package/dist/map/messages/commands/add-image-layer.command.d.ts

@@ -0,0 +1,8 @@
+import { PostboyGenericMessage } from '@artstesh/postboy';
+import Static from 'ol/source/ImageStatic';
+import ImageLayer from 'ol/layer/Image';
+export declare class AddImageLayerCommand extends PostboyGenericMessage {
+    layer: ImageLayer<Static>;
+    static readonly ID = "70f9b86f-8bc2-4f28-ae79-a13fc0b1ee5d";
+    constructor(layer: ImageLayer<Static>);
+}

package/dist/map/messages/commands/remove-image-layer.command.d.ts

@@ -0,0 +1,8 @@
+import { PostboyGenericMessage } from '@artstesh/postboy';
+import ImageLayer from 'ol/layer/Image';
+import Static from 'ol/source/ImageStatic';
+export declare class RemoveImageLayerCommand extends PostboyGenericMessage {
+    layer: ImageLayer<Static>;
+    static readonly ID = "c8e7efdb-17ff-4cf9-89be-e688b8de3b95";
+    constructor(layer: ImageLayer<Static>);
+}

package/dist/map/services/map-management.service.d.ts

@@ -10,6 +10,7 @@ export declare class MapManagementService implements IPostboyDependingService {
     private observeRemoveTile;
     private observeLayerQuery;
     private observeAddTile;
+    private observeImageLayer;
     private observeMapRender;
     private observeAddLayer;
     private observePlaceFeatures;

package/dist/src/map/map-plate/layers/image-layer/image-layer-factory.d.ts

@@ -0,0 +1,9 @@
+import Static from 'ol/source/ImageStatic';
+import { ImageLayerSettings } from './image-layer.settings';
+import ImageLayer from 'ol/layer/Image';
+import * as i0 from "@angular/core";
+export declare class ImageLayerFactory {
+    build(settings: ImageLayerSettings): ImageLayer<Static>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ImageLayerFactory, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ImageLayerFactory>;
+}

package/dist/src/map/map-plate/layers/image-layer/image-layer.component.d.ts

@@ -0,0 +1,22 @@
+import { OnInit } from '@angular/core';
+import { DestructibleComponent } from '../../../common/destructible.component';
+import { MapPostboyService } from '../../../services/map-postboy.service';
+import { ImageLayerFactory } from './image-layer-factory';
+import ImageLayer from 'ol/layer/Image';
+import Static from 'ol/source/ImageStatic';
+import { ImageLayerSettings } from './image-layer.settings';
+import * as i0 from "@angular/core";
+export declare class ImageLayerComponent extends DestructibleComponent implements OnInit {
+    private postboy;
+    private factory;
+    layer?: ImageLayer<Static>;
+    constructor(postboy: MapPostboyService, factory: ImageLayerFactory);
+    _settings: ImageLayerSettings;
+    set settings(value: ImageLayerSettings | undefined);
+    ngOnInit(): void;
+    onDestroy: () => void;
+    private initLayer;
+    private removeLayer;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ImageLayerComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ImageLayerComponent, "art-image-layer", never, { "settings": { "alias": "settings"; "required": false; }; }, {}, never, never, false, never>;
+}

package/dist/src/map/map-plate/layers/image-layer/image-layer.settings.d.ts

@@ -0,0 +1,97 @@
+export declare class ImageLayerSettings {
+    /**
+     * Represents the tiles URL.
+     * @typedef {string} url
+     *
+     * @example
+     * 'https://example.ex/{z}/{x}/{y}.png'
+     */
+    url: string;
+    /**
+     * Use interpolated values when resampling.
+     * By default, linear interpolation is used when resampling.
+     * Set to false to use the nearest neighbor instead.
+     */
+    interpolate?: boolean;
+    /**
+     * The projection of the coordinate system.
+     *
+     * @type {string}
+     * @default 'EPSG:3857'
+     */
+    projection: string;
+    extent: number[];
+    /**
+     * Additional headers that should be added to each tile request
+     *
+     * @type {Record<string, string>}
+     * @default An empty array
+     */
+    requestHeaders: Record<string, string> | null;
+    /**
+     * Creates a copy of the given tile layer settings.
+     *
+     * @param {ImageLayerSettings} model - The tile layer settings to be copied.
+     * @return {ImageLayerSettings} - A new instance of ImageLayerSettings with the same properties as the model.
+     */
+    static copy(model: ImageLayerSettings): ImageLayerSettings;
+    /**
+     * Sets the URL of the ImageLayerSettings object.
+     *
+     * @param {string} url - The URL to be set.
+     * @return {ImageLayerSettings} - The updated ImageLayerSettings object.
+     */
+    setUrl(url: string): ImageLayerSettings;
+    /**
+     * Sets the interpolation state for the image layer settings.
+     *
+     * @param {boolean} [interpolate] - Use interpolated values when resampling.
+     * By default, linear interpolation is used when resampling.
+     * Set to false to use the nearest neighbor instead.
+     * @return {ImageLayerSettings} A new instance of ImageLayerSettings with the updated interpolation setting.
+     */
+    setInterpolate(interpolate?: boolean): ImageLayerSettings;
+    setExtent(extent: number[]): ImageLayerSettings;
+    /**
+     * Sets the requestHeaders of the ImageLayerSettings object.
+     *
+     * @param {Record<string, string>} requestHeaders - The headers which should be provided.
+     * @return {ImageLayerSettings} - The updated ImageLayerSettings object.
+     */
+    setRequestHeaders(requestHeaders: Record<string, string>): ImageLayerSettings;
+    /**
+     * Sets the maximum zoom level for the tile layer.
+     *
+     * @param {number} maxZoom - The maximum zoom level.
+     * @returns {ImageLayerSettings} - The updated tile layer settings object.
+     */
+    setMaxZoom(maxZoom: number): ImageLayerSettings;
+    /**
+     * Sets the minimum zoom level for the Tile Layer.
+     *
+     * @param {number} minZoom - The minimum zoom level to be set.
+     * @return {ImageLayerSettings} The modified ImageLayerSettings object with the updated minimum zoom level.
+     */
+    setMinZoom(minZoom: number): ImageLayerSettings;
+    /**
+     * Sets the opacity of the ImageLayerSettings.
+     *
+     * @param {number} opacity - The opacity value to set. Must be a number between 0 and 1.
+     * @return {ImageLayerSettings} - A new instance of ImageLayerSettings with the opacity set.
+     */
+    setOpacity(opacity: number): ImageLayerSettings;
+    /**
+     * Sets the projection for the tile layer settings.
+     *
+     * @param {string} projection - The desired projection for the tile layer settings.
+     * @return {ImageLayerSettings} - The updated tile layer settings with the new projection.
+     */
+    setProjection(projection: string): ImageLayerSettings;
+    /**
+     * Checks if the current instance of ImageLayerSettings is equal to the given model.
+     * @param {ImageLayerSettings} model - The model to compare against.
+     * @return {boolean} - True if all properties of the current instance matches the properties of the model;
+     *                    otherwise, false.
+     */
+    isSame(model: ImageLayerSettings): boolean;
+}

package/dist/src/map/map-plate/layers/index.d.ts

@@ -5,3 +5,5 @@ export * from './feature-layer/feature-layer.settings';
 export * from './feature-layer/feature-layer.component';
 export * from './cluster-layer/cluster-layer.component';
 export * from './cluster-layer/cluster-layer.settings';
+export * from './image-layer/image-layer.component';
+export * from './image-layer/image-layer.settings';

package/dist/src/map/map.module.d.ts

@@ -9,9 +9,10 @@ import * as i7 from "./map-plate/tooltips/tooltip/tooltip.component";
 import * as i8 from "./map-plate/features/polygons/polygons.component";
 import * as i9 from "./map-plate/layers/cluster-layer/cluster-layer.component";
 import * as i10 from "./map-plate/controls/map-control-zoom/map-control-zoom.component";
-import * as i11 from "@angular/common";
+import * as i11 from "./map-plate/layers/image-layer/image-layer.component";
+import * as i12 from "@angular/common";
 export declare class MapModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<MapModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<MapModule, [typeof i1.DestructibleComponent, typeof i2.MapPlateComponent, typeof i3.TileLayerComponent, typeof i4.OsmTileLayerComponent, typeof i5.FeatureLayerComponent, typeof i6.MarkersComponent, typeof i7.TooltipComponent, typeof i8.PolygonsComponent, typeof i9.ClusterLayerComponent, typeof i10.MapControlZoomComponent], [typeof i11.CommonModule], [typeof i2.MapPlateComponent, typeof i5.FeatureLayerComponent, typeof i6.MarkersComponent, typeof i3.TileLayerComponent, typeof i7.TooltipComponent, typeof i8.PolygonsComponent, typeof i9.ClusterLayerComponent, typeof i10.MapControlZoomComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<MapModule, [typeof i1.DestructibleComponent, typeof i2.MapPlateComponent, typeof i3.TileLayerComponent, typeof i4.OsmTileLayerComponent, typeof i5.FeatureLayerComponent, typeof i6.MarkersComponent, typeof i7.TooltipComponent, typeof i8.PolygonsComponent, typeof i9.ClusterLayerComponent, typeof i10.MapControlZoomComponent, typeof i11.ImageLayerComponent], [typeof i12.CommonModule], [typeof i2.MapPlateComponent, typeof i5.FeatureLayerComponent, typeof i6.MarkersComponent, typeof i3.TileLayerComponent, typeof i7.TooltipComponent, typeof i8.PolygonsComponent, typeof i9.ClusterLayerComponent, typeof i10.MapControlZoomComponent, typeof i11.ImageLayerComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<MapModule>;
 }

package/dist/src/map/messages/commands/add-image-layer.command.d.ts

@@ -0,0 +1,8 @@
+import { PostboyGenericMessage } from '@artstesh/postboy';
+import Static from 'ol/source/ImageStatic';
+import ImageLayer from 'ol/layer/Image';
+export declare class AddImageLayerCommand extends PostboyGenericMessage {
+    layer: ImageLayer<Static>;
+    static readonly ID = "70f9b86f-8bc2-4f28-ae79-a13fc0b1ee5d";
+    constructor(layer: ImageLayer<Static>);
+}

package/dist/src/map/messages/commands/remove-image-layer.command.d.ts

@@ -0,0 +1,8 @@
+import { PostboyGenericMessage } from '@artstesh/postboy';
+import ImageLayer from 'ol/layer/Image';
+import Static from 'ol/source/ImageStatic';
+export declare class RemoveImageLayerCommand extends PostboyGenericMessage {
+    layer: ImageLayer<Static>;
+    static readonly ID = "c8e7efdb-17ff-4cf9-89be-e688b8de3b95";
+    constructor(layer: ImageLayer<Static>);
+}

package/dist/src/map/services/map-management.service.d.ts

@@ -10,6 +10,7 @@ export declare class MapManagementService implements IPostboyDependingService {
     private observeRemoveTile;
     private observeLayerQuery;
     private observeAddTile;
+    private observeImageLayer;
     private observeMapRender;
     private observeAddLayer;
     private observePlaceFeatures;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artstesh/maps",
-  "version": "5.2.4",
+  "version": "5.2.5",
   "author": "artstesh",
   "license": "MIT",
   "description": "Let's draw a map ;)",