@artstesh/maps 6.0.1 → 6.0.3

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

@@ -1,14 +1,89 @@
+/**
+ * Class representing settings for a tile layer.
+ */
 export declare class TileLayerSettings {
+    /**
+     * The maximum zoom level for a map view.
+     *
+     * @type {number}
+     * @default 19
+     */
     maxZoom: number;
+    /**
+     * The minimum zoom level allowed.
+     *
+     * @type {number}
+     */
     minZoom: number;
+    /**
+     * The opacity of an element.
+     *
+     * @type {number}
+     * @default 0.6
+     */
     opacity: number;
+    /**
+     * Represents the tiles URL.
+     * @typedef {string} url
+     *
+     * @example
+     * 'https://example.ex/{z}/{x}/{y}.png'
+     */
     url: string;
+    /**
+     * The projection of the coordinate system.
+     *
+     * @type {string}
+     * @default 'EPSG:3857'
+     */
     projection: string;
+    /**
+     * Creates a copy of the given tile layer settings.
+     *
+     * @param {TileLayerSettings} model - The tile layer settings to be copied.
+     * @return {TileLayerSettings} - A new instance of TileLayerSettings with the same properties as the model.
+     */
     static copy(model: TileLayerSettings): TileLayerSettings;
+    /**
+     * Sets the URL of the TileLayerSettings object.
+     *
+     * @param {string} url - The URL to be set.
+     * @return {TileLayerSettings} - The updated TileLayerSettings object.
+     */
     setUrl(url: string): TileLayerSettings;
+    /**
+     * Sets the maximum zoom level for the tile layer.
+     *
+     * @param {number} maxZoom - The maximum zoom level.
+     * @returns {TileLayerSettings} - The updated tile layer settings object.
+     */
     setMaxZoom(maxZoom: number): TileLayerSettings;
+    /**
+     * Sets the minimum zoom level for the Tile Layer.
+     *
+     * @param {number} minZoom - The minimum zoom level to be set.
+     * @return {TileLayerSettings} The modified TileLayerSettings object with the updated minimum zoom level.
+     */
     setMinZoom(minZoom: number): TileLayerSettings;
+    /**
+     * Sets the opacity of the TileLayerSettings.
+     *
+     * @param {number} opacity - The opacity value to set. Must be a number between 0 and 1.
+     * @return {TileLayerSettings} - A new instance of TileLayerSettings with the opacity set.
+     */
     setOpacity(opacity: number): TileLayerSettings;
+    /**
+     * Sets the projection for the tile layer settings.
+     *
+     * @param {string} projection - The desired projection for the tile layer settings.
+     * @return {TileLayerSettings} - The updated tile layer settings with the new projection.
+     */
     setProjection(projection: string): TileLayerSettings;
+    /**
+     * Checks if the current instance of TileLayerSettings is equal to the given model.
+     * @param {TileLayerSettings} 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: TileLayerSettings): boolean;
 }

package/dist/src/map/map-plate/map-plate.component.d.ts

@@ -15,13 +15,13 @@ export declare class MapPlateComponent extends DestructibleComponent implements
     private detector;
     map: Map;
     osmUrl: string;
+    drawingLayerSettings: FeatureLayerSettings;
     constructor(elementRef: ElementRef, postboy: MapPostboyService, mapFactory: MapPlateFactory, registrator: MessageRegistratorService, detector: ChangeDetectorRef);
     _settings: MapSettings;
-    drawingLayerSettings: FeatureLayerSettings;
     set settings(value: MapSettings | undefined);
     ngOnInit(): void;
-    private setOsm;
     onDestroy: () => void;
+    private setOsm;
     static ɵfac: i0.ɵɵFactoryDeclaration<MapPlateComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<MapPlateComponent, "art-map-plate", never, { "settings": { "alias": "settings"; "required": false; }; }, {}, never, ["*"], false, never>;
 }

package/dist/src/map/map-plate/tooltips/tooltip/tooltip.component.d.ts

@@ -8,19 +8,19 @@ export declare class TooltipComponent extends DestructibleComponent implements O
     private postboy;
     private detector;
     container: ElementRef<HTMLElement>;
-    _settings: TooltipSettings;
-    private map?;
     overlay?: Overlay;
     show: boolean;
-    set settings(value: TooltipSettings | undefined);
+    private map?;
     constructor(postboy: MapPostboyService, detector: ChangeDetectorRef);
+    _settings: TooltipSettings;
+    set settings(value: TooltipSettings | undefined);
     ngOnInit(): void;
+    addOverlay(coordinates: number[]): void;
+    options: (coordinates: number[]) => OverlayOptions;
     private observeMapClick;
     private observeClose;
     private observeMapRender;
     private removeOverlay;
-    addOverlay(coordinates: number[]): void;
-    options: (coordinates: number[]) => OverlayOptions;
     static ɵfac: i0.ɵɵFactoryDeclaration<TooltipComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<TooltipComponent, "art-tooltip", never, { "settings": { "alias": "settings"; "required": false; }; }, {}, never, ["*"], false, never>;
 }

package/dist/src/map/map-plate/tooltips/tooltip/tooltip.settings.d.ts

@@ -2,9 +2,9 @@ import { MapClickEvent } from '../../../messages';
 export declare class TooltipSettings {
     readonly id: string;
     containerClass: string;
-    show: (ev: MapClickEvent) => boolean;
     constructor(id?: string);
     static copy(model: TooltipSettings): TooltipSettings;
+    show: (ev: MapClickEvent) => boolean;
     setShow(show: (ev: MapClickEvent) => boolean): TooltipSettings;
     setClass(containerClass: string): TooltipSettings;
     isSame(model: TooltipSettings): boolean;

package/dist/src/map/messages/events/map-move-end.event.d.ts

@@ -1,8 +1,8 @@
 import { PostboyGenericMessage } from '@artstesh/postboy';
+import { MapPosition } from '../../models';
 export declare class MapMoveEndEvent extends PostboyGenericMessage {
-    zoom: number;
-    extent: number[];
+    position: MapPosition | null;
     static readonly ID: string;
-    constructor(zoom: number, extent: number[]);
+    constructor(position: MapPosition | null);
     get id(): string;
 }

package/dist/src/map/messages/executors/get-map-position.executor.d.ts

@@ -0,0 +1,12 @@
+import { PostboyExecutor } from '@artstesh/postboy';
+import { MapPosition } from '../../models';
+/**
+ * A message that allows to get the current state of the map.
+ * If the map's state is not defined yet, the executor would return null
+ * @returns {MapPosition | null}
+ */
+export declare class GetMapPositionExecutor extends PostboyExecutor<MapPosition | null> {
+    static readonly ID = "52c95689-d09b-4082-ba58-9183ea96a213";
+    get id(): string;
+    constructor();
+}

package/dist/src/map/messages/index.d.ts

@@ -12,3 +12,4 @@ export * from './commands/remove-control.command';
 export * from './commands/set-map-center.command';
 export * from './executors/calculate-area.executor';
 export * from './commands/fit-to-polygons.command';
+export * from './executors/get-map-position.executor';

package/dist/src/map/models/index.d.ts

@@ -5,3 +5,4 @@ export * from './polygon.model';
 export * from './drawing-type.enum';
 export * from './feature-format.enum';
 export * from './map-control';
+export * from './map-position.model';

package/dist/src/map/models/map-control.d.ts

@@ -2,7 +2,7 @@ import { Control } from 'ol/control';
 import { Options } from 'ol/control/Control';
 /**
  *
- * A control is a visible widget with a DOM element in a fixed position on the screen. They can involve user input (buttons), or be informational only; the position is determined using CSS. By default these are placed in the container with CSS class name ol-overlaycontainer-stopevent, but can use any outside DOM element.
+ * A control is a visible widget with a DOM element in a fixed position on the screen. They can involve user input (buttons), or be informational only; the position is determined using CSS. By default, these are placed in the container with CSS class name ol-overlaycontainer-stopevent, but can use any outside DOM element.
  * This is the base class for controls. You can use it for simple custom controls by creating the element with listeners, creating an instance:
  * var myControl = new Control({element: myElement}); and then adding this to the map.
  * The main advantage of having this as a control rather than a simple separate DOM element is that preventing propagation is handled for you. Controls will also be objects in a module:ol/Collection~Collection, so you can use their methods.

package/dist/src/map/models/map-position.model.d.ts

@@ -0,0 +1,6 @@
+export interface MapPosition {
+    latitude: number;
+    longitude: number;
+    zoom: number;
+    extent: number[];
+}

package/dist/src/map/models/polygon.model.d.ts

@@ -7,13 +7,13 @@ export declare class PolygonModel {
     readonly id: string | number;
     readonly lat: number;
     readonly lng: number;
+    private constructor();
     private _feature;
+    get feature(): Feature<Geometry>;
     static fromGeoJson(id: string | number, json: string, info?: {
         [id: string]: any;
     }): PolygonModel;
     static fromWKT(id: string | number, wkt: string, info?: {
         [id: string]: any;
     }): PolygonModel;
-    private constructor();
-    get feature(): Feature<Geometry>;
 }

package/dist/src/map/services/feature.service.d.ts

@@ -4,6 +4,6 @@ import { FilterFeaturesInAreaExecutor } from '../messages/executors/filter-featu
 export declare class FeatureService {
     constructor();
     static filterFeaturesInArea(query: FilterFeaturesInAreaExecutor): Feature<Geometry>[];
-    private static booleanIntersects;
     static calculateArea(g: Geometry | undefined): number;
+    private static booleanIntersects;
 }

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

@@ -8,8 +8,8 @@ export declare class MapClickService implements IPostboyDependingService {
     private map?;
     constructor(postboy: MapPostboyService);
     up(): void;
-    private observeMapRender;
     onClick(ev: MapBrowserEvent<UIEvent>): MapClickEvent;
+    private observeMapRender;
     private getFeatureCollectionWithInner;
     static ɵfac: i0.ɵɵFactoryDeclaration<MapClickService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<MapClickService>;

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

@@ -1,11 +1,13 @@
 import { MapPostboyService } from './map-postboy.service';
 import { IPostboyDependingService } from '@artstesh/postboy';
+import { MapPosition } from '../models';
 import * as i0 from "@angular/core";
 export declare class MapStateService implements IPostboyDependingService {
     private postboy;
     private map?;
     constructor(postboy: MapPostboyService);
     up(): void;
+    getMapPosition(): MapPosition | null;
     private observeMapRendering;
     private observeCenter;
     static ɵfac: i0.ɵɵFactoryDeclaration<MapStateService, never>;

package/dist/src/map/services/message-registrator.service.d.ts

@@ -9,6 +9,7 @@ import { FeatureModificationService } from './drawing/feature-modification.servi
 import { ControlsService } from './controls/controls.service';
 import * as i0 from "@angular/core";
 export declare class MessageRegistratorService extends PostboyAbstractRegistrator {
+    private state;
     constructor(service: MapPostboyService, management: MapManagementService, state: MapStateService, mapFeature: MapFeatureService, interaction: MapClickService, drawing: DrawingService, featureModification: FeatureModificationService, controls: ControlsService);
     protected _up(): void;
     private setExecutors;

package/package.json

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