@artstesh/maps 5.1.1 → 5.1.3

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

@@ -1,15 +1,61 @@
 import Style, { StyleFunction } from 'ol/style/Style';
+/**
+ * A layer that is responsible for showing and styling main features on the map, such as markers and polygons
+ */
 export declare class FeatureLayerSettings {
+    /**
+     * The identifier of the field, it is autogenerated by default, but can be set manually
+     */
     name: string;
+    /**
+     * The priority of showing - layers with higher zIndex cover others in case of collisions
+     */
     zIndex: number;
+    /**
+     * The maximum zoom at which the layer is visible. 19 by default
+     */
     maxZoom: number;
+    /**
+     * The minimum zoom at which the layer is visible. 0 by default
+     */
     minZoom: number;
+    /**
+     * The styling definition of layer's features. The easiest way is to use {@link PolygonStyleHelper},{@link MarkerStyleHelper}
+     */
     style?: Style | StyleFunction;
+    /**
+     * Creates a clone of the existing settings
+     * @param model
+     */
     static copy(model: FeatureLayerSettings): FeatureLayerSettings;
+    /**
+     Setter for {@link FeatureLayerSettings.zIndex}
+     * @param zIndex
+     */
     setZIndex(zIndex: number): FeatureLayerSettings;
+    /**
+     * Setter for {@link FeatureLayerSettings.name}
+     * @param name
+     */
     setName(name: string): FeatureLayerSettings;
+    /**
+     * Setter for {@link FeatureLayerSettings.maxZoom}
+     * @param maxZoom
+     */
     setMaxZoom(maxZoom: number): FeatureLayerSettings;
+    /**
+     * Setter for {@link FeatureLayerSettings.minZoom}
+     * @param minZoom
+     */
     setMinZoom(minZoom: number): FeatureLayerSettings;
+    /**
+     * Setter for {@link FeatureLayerSettings.style}
+     * @param style
+     */
     setStyle(style: Style | StyleFunction): FeatureLayerSettings;
+    /**
+     * Checks if the model has the same content
+     * @param model - the object to compare
+     */
     isSame(model: FeatureLayerSettings): boolean;
 }

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

@@ -0,0 +1,8 @@
+import { PostboyGenericMessage } from '@artstesh/postboy';
+import { MapControl } from '../../models/map-control';
+export declare class AddControlCommand extends PostboyGenericMessage {
+    item: MapControl;
+    static readonly ID: string;
+    constructor(item: MapControl);
+    get id(): string;
+}

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

@@ -0,0 +1,8 @@
+import { PostboyGenericMessage } from '@artstesh/postboy';
+import { MapControl } from '../../models/map-control';
+export declare class RemoveControlCommand extends PostboyGenericMessage {
+    item: MapControl;
+    static readonly ID: string;
+    constructor(item: MapControl);
+    get id(): string;
+}

package/dist/map/messages/commands/set-map-center.command.d.ts

@@ -0,0 +1,18 @@
+import { PostboyGenericMessage } from '@artstesh/postboy';
+/**
+ * Forces map to move to a specific point
+ */
+export declare class SetMapCenterCommand extends PostboyGenericMessage {
+    lat: number;
+    lng: number;
+    zoom?: number | undefined;
+    static readonly ID: string;
+    /**
+     *
+     * @param lat - the desired latitude
+     * @param lng - the desired longitude
+     * @param zoom - the desired zoom; doesn't change zoom if undefined
+     */
+    constructor(lat: number, lng: number, zoom?: number | undefined);
+    get id(): string;
+}

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

@@ -7,3 +7,6 @@ export * from './commands/cancel-drawing.command';
 export * from './commands/draw-selection-area.command';
 export * from './commands/modify-feature.command';
 export * from './commands/cancel-feature-modification.command';
+export * from './commands/add-control.command';
+export * from './commands/remove-control.command';
+export * from './commands/set-map-center.command';

package/dist/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 './dictionary';
+export * from './map-control';

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

@@ -0,0 +1,13 @@
+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.
+ * 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.
+ * You can also extend this base for your own control class. See examples/custom-controls for an example of how to do this.
+ */
+export declare class MapControl extends Control {
+    constructor(options: Options);
+}

package/dist/map/services/controls/controls.service.d.ts

@@ -0,0 +1,14 @@
+import { MapPostboyService } from '../map-postboy.service';
+import { IPostboyDependingService } from '@artstesh/postboy';
+import * as i0 from "@angular/core";
+export declare class ControlsService implements IPostboyDependingService {
+    private postboy;
+    private map?;
+    constructor(postboy: MapPostboyService);
+    up(): void;
+    private observeMapRender;
+    private observeAdding;
+    private observeRemoving;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ControlsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ControlsService>;
+}

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

@@ -6,6 +6,8 @@ export declare class MapStateService implements IPostboyDependingService {
     private map?;
     constructor(postboy: MapPostboyService);
     up(): void;
+    private observeMapRendering;
+    private observeCenter;
     static ɵfac: i0.ɵɵFactoryDeclaration<MapStateService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<MapStateService>;
 }

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

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

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

@@ -1,15 +1,61 @@
 import Style, { StyleFunction } from 'ol/style/Style';
+/**
+ * A layer that is responsible for showing and styling main features on the map, such as markers and polygons
+ */
 export declare class FeatureLayerSettings {
+    /**
+     * The identifier of the field, it is autogenerated by default, but can be set manually
+     */
     name: string;
+    /**
+     * The priority of showing - layers with higher zIndex cover others in case of collisions
+     */
     zIndex: number;
+    /**
+     * The maximum zoom at which the layer is visible. 19 by default
+     */
     maxZoom: number;
+    /**
+     * The minimum zoom at which the layer is visible. 0 by default
+     */
     minZoom: number;
+    /**
+     * The styling definition of layer's features. The easiest way is to use {@link PolygonStyleHelper},{@link MarkerStyleHelper}
+     */
     style?: Style | StyleFunction;
+    /**
+     * Creates a clone of the existing settings
+     * @param model
+     */
     static copy(model: FeatureLayerSettings): FeatureLayerSettings;
+    /**
+     Setter for {@link FeatureLayerSettings.zIndex}
+     * @param zIndex
+     */
     setZIndex(zIndex: number): FeatureLayerSettings;
+    /**
+     * Setter for {@link FeatureLayerSettings.name}
+     * @param name
+     */
     setName(name: string): FeatureLayerSettings;
+    /**
+     * Setter for {@link FeatureLayerSettings.maxZoom}
+     * @param maxZoom
+     */
     setMaxZoom(maxZoom: number): FeatureLayerSettings;
+    /**
+     * Setter for {@link FeatureLayerSettings.minZoom}
+     * @param minZoom
+     */
     setMinZoom(minZoom: number): FeatureLayerSettings;
+    /**
+     * Setter for {@link FeatureLayerSettings.style}
+     * @param style
+     */
     setStyle(style: Style | StyleFunction): FeatureLayerSettings;
+    /**
+     * Checks if the model has the same content
+     * @param model - the object to compare
+     */
     isSame(model: FeatureLayerSettings): boolean;
 }

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

@@ -0,0 +1,8 @@
+import { PostboyGenericMessage } from '@artstesh/postboy';
+import { MapControl } from '../../models/map-control';
+export declare class AddControlCommand extends PostboyGenericMessage {
+    item: MapControl;
+    static readonly ID: string;
+    constructor(item: MapControl);
+    get id(): string;
+}

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

@@ -0,0 +1,8 @@
+import { PostboyGenericMessage } from '@artstesh/postboy';
+import { MapControl } from '../../models/map-control';
+export declare class RemoveControlCommand extends PostboyGenericMessage {
+    item: MapControl;
+    static readonly ID: string;
+    constructor(item: MapControl);
+    get id(): string;
+}

package/dist/src/map/messages/commands/set-map-center.command.d.ts

@@ -0,0 +1,18 @@
+import { PostboyGenericMessage } from '@artstesh/postboy';
+/**
+ * Forces map to move to a specific point
+ */
+export declare class SetMapCenterCommand extends PostboyGenericMessage {
+    lat: number;
+    lng: number;
+    zoom?: number | undefined;
+    static readonly ID: string;
+    /**
+     *
+     * @param lat - the desired latitude
+     * @param lng - the desired longitude
+     * @param zoom - the desired zoom; doesn't change zoom if undefined
+     */
+    constructor(lat: number, lng: number, zoom?: number | undefined);
+    get id(): string;
+}

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

@@ -7,3 +7,6 @@ export * from './commands/cancel-drawing.command';
 export * from './commands/draw-selection-area.command';
 export * from './commands/modify-feature.command';
 export * from './commands/cancel-feature-modification.command';
+export * from './commands/add-control.command';
+export * from './commands/remove-control.command';
+export * from './commands/set-map-center.command';

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 './dictionary';
+export * from './map-control';

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

@@ -0,0 +1,13 @@
+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.
+ * 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.
+ * You can also extend this base for your own control class. See examples/custom-controls for an example of how to do this.
+ */
+export declare class MapControl extends Control {
+    constructor(options: Options);
+}

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

@@ -0,0 +1,14 @@
+import { MapPostboyService } from '../map-postboy.service';
+import { IPostboyDependingService } from '@artstesh/postboy';
+import * as i0 from "@angular/core";
+export declare class ControlsService implements IPostboyDependingService {
+    private postboy;
+    private map?;
+    constructor(postboy: MapPostboyService);
+    up(): void;
+    private observeMapRender;
+    private observeAdding;
+    private observeRemoving;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ControlsService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ControlsService>;
+}

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

@@ -6,6 +6,8 @@ export declare class MapStateService implements IPostboyDependingService {
     private map?;
     constructor(postboy: MapPostboyService);
     up(): void;
+    private observeMapRendering;
+    private observeCenter;
     static ɵfac: i0.ɵɵFactoryDeclaration<MapStateService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<MapStateService>;
 }

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

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

package/package.json

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