@artstesh/maps 6.0.7 → 6.0.9

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

@@ -4,7 +4,6 @@ import Cluster from 'ol/source/Cluster';
 import { PostboyGenericMessage } from '@artstesh/postboy';
 export declare class AddLayerCommand extends PostboyGenericMessage {
     layer: Layer<VectorSource<any> | Cluster>;
-    static readonly ID: string;
+    static readonly ID = "7fe68d71-350f-47e2-b1ae-62cc333e1572";
     constructor(layer: Layer<VectorSource<any> | Cluster>);
-    get id(): string;
 }

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

@@ -3,7 +3,6 @@ import { XYZ } from 'ol/source';
 import { PostboyGenericMessage } from '@artstesh/postboy';
 export declare class AddTileCommand extends PostboyGenericMessage {
     layer: TileLayer<XYZ>;
-    static readonly ID: string;
+    static readonly ID = "ae29b7af-21aa-4b0a-8586-92c23779e6cb";
     constructor(layer: TileLayer<XYZ>);
-    get id(): string;
 }

package/dist/src/map/messages/commands/cancel-drawing.command.d.ts

@@ -1,5 +1,7 @@
 import { PostboyGenericMessage } from '@artstesh/postboy';
+/**
+ * Represents a command to cancel a drawing action.
+ */
 export declare class CancelDrawingCommand extends PostboyGenericMessage {
-    static readonly ID: string;
-    get id(): string;
+    static readonly ID = "192d70f8-9d12-4cb3-a8ad-0fc2dc5af1de";
 }

package/dist/src/map/messages/commands/cancel-feature-modification.command.d.ts

@@ -1,5 +1,7 @@
 import { PostboyGenericMessage } from '@artstesh/postboy';
+/**
+ * Represents a command to cancel a feature modification.
+ */
 export declare class CancelFeatureModificationCommand extends PostboyGenericMessage {
-    static readonly ID: string;
-    get id(): string;
+    static readonly ID = "e7886353-53b3-4bbe-93b5-6490e5f1305e";
 }

package/dist/src/map/messages/commands/close-tooltip.command.d.ts

@@ -1,7 +1,14 @@
 import { PostboyGenericMessage } from '@artstesh/postboy';
+/**
+ * A command class that represents the action to close a tooltip.
+ */
 export declare class CloseTooltipCommand extends PostboyGenericMessage {
     tooltipId: string;
-    static readonly ID: string;
+    static readonly ID = "df687e26-7298-46d7-8911-d014801dafac";
+    /**
+     * Creates an instance of the class with the specified tooltip ID.
+     *
+     * @param {string} tooltipId - The unique identifier for the tooltip.
+     */
     constructor(tooltipId: string);
-    get id(): string;
 }

package/dist/src/map/messages/commands/draw-selection-area.command.d.ts

@@ -3,11 +3,22 @@ import Style from 'ol/style/Style';
 import { IIdentified } from '../../models/i-identified';
 import { Dictionary } from '@artstesh/collections';
 import { DrawingType } from '../../models';
+/**
+ * Class representing a command to draw a selection area with a specific type and style.
+ *
+ * @return {Dictionary<IIdentified[]>} - a collection of features inside the selected area, grouped by a layer's name
+ */
 export declare class DrawSelectionAreaCommand extends PostboyCallbackMessage<Dictionary<IIdentified[]>> {
     type: DrawingType;
     style: Style;
     ignore: Set<string>;
-    static readonly ID: string;
+    static readonly ID = "06e43f59-c6ba-41bb-9c5b-f6534d914905";
+    /**
+     * Constructs a new instance with the specified type, style, and optional set of ignored items.
+     *
+     * @param {DrawingType} type - The type of drawing to be created.
+     * @param {Style} style - The style information for the drawing.
+     * @param {Set<string>} [ignore=new Set<string>()] - Optional set of items to be ignored.
+     */
     constructor(type: DrawingType, style: Style, ignore?: Set<string>);
-    get id(): string;
 }

package/dist/src/map/messages/commands/fit-to-features.command.d.ts

@@ -4,7 +4,6 @@ import { PostboyGenericMessage } from '@artstesh/postboy';
 export declare class FitToFeaturesCommand extends PostboyGenericMessage {
     features: Feature<Geometry>[];
     zoomAfter: number;
-    static readonly ID: string;
+    static readonly ID = "04d67609-0b4c-4f52-aa53-ad0a3db967dc";
     constructor(features: Feature<Geometry>[], zoomAfter?: number);
-    get id(): string;
 }

package/dist/src/map/messages/commands/fit-to-polygons.command.d.ts

@@ -1,9 +1,18 @@
 import { PostboyGenericMessage } from '@artstesh/postboy';
 import { PolygonModel } from '../../models';
+/**
+ * FitToPolygonsCommand is a command used to fit a given set of polygon features
+ * to the viewable area, optionally applying a zoom transformation afterwards.
+ */
 export declare class FitToPolygonsCommand extends PostboyGenericMessage {
     features: PolygonModel[];
     zoomAfter: number;
-    static readonly ID: string;
+    static readonly ID = "308394ce-48d3-45f5-8671-52207fba4be3";
+    /**
+     * Creates an instance of the class with specified polygon features and an optional zoom level.
+     *
+     * @param {PolygonModel[]} features - An array of polygon models to fit to.
+     * @param {number} [zoomAfter=0] - Optional zoom level change to apply after initialization. Defaults to 0.
+     */
     constructor(features: PolygonModel[], zoomAfter?: number);
-    get id(): string;
 }

package/dist/src/map/messages/commands/modify-feature.command.d.ts

@@ -1,11 +1,23 @@
 import { PostboyCallbackMessage } from '@artstesh/postboy';
 import { FeatureOutputFormat, PolygonModel } from '../../models';
 import Style from 'ol/style/Style';
+/**
+ * Represents a command to modify a feature with a specific style and output format
+ * for a polygonal model.
+ *
+ * @return {string | null} a string representation of the modified feature in the appropriate format
+ */
 export declare class ModifyFeatureCommand extends PostboyCallbackMessage<string | null> {
     model: PolygonModel;
     style: Style;
     format: FeatureOutputFormat;
-    static readonly ID: string;
+    static readonly ID = "8f76507e-f18d-4232-bab7-f3d4e3d707bb";
+    /**
+     * Constructs an instance of the class.
+     *
+     * @param {PolygonModel} model - The polygon model to be used.
+     * @param {Style} style - The style configuration for the polygon.
+     * @param {FeatureOutputFormat} [format=FeatureOutputFormat.GeoJson] - The output format of the features. Default is GeoJson.
+     */
     constructor(model: PolygonModel, style: Style, format?: FeatureOutputFormat);
-    get id(): string;
 }

package/dist/src/map/messages/commands/place-layer-features.command.d.ts

@@ -4,7 +4,6 @@ import { PostboyGenericMessage } from '@artstesh/postboy';
 export declare class PlaceLayerFeaturesCommand extends PostboyGenericMessage {
     layer: string;
     features: Feature<Geometry>[];
-    static readonly ID: string;
+    static readonly ID = "5f27a2cd-8d8a-4929-b703-8aee6dcdc21c";
     constructor(layer: string, features: Feature<Geometry>[]);
-    get id(): string;
 }

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

@@ -1,8 +1,20 @@
 import { PostboyGenericMessage } from '@artstesh/postboy';
 import { MapControl } from '../../models/map-control';
+/**
+ * Represents a command to remove a map control from the map.
+ *
+ * The command is identified by a unique static ID, and it requires a MapControl item
+ * to specify the control to be removed.
+ *
+ * @extends PostboyGenericMessage
+ */
 export declare class RemoveControlCommand extends PostboyGenericMessage {
     item: MapControl;
-    static readonly ID: string;
+    static readonly ID = "73bcb4f5-ce7d-4c71-b70d-e772100136a1";
+    /**
+     * Constructs an instance of the class.
+     *
+     * @param {MapControl} item - The map control instance to be removed.
+     */
     constructor(item: MapControl);
-    get id(): string;
 }

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

@@ -2,7 +2,6 @@ import BaseLayer from 'ol/layer/Base';
 import { PostboyGenericMessage } from '@artstesh/postboy';
 export declare class RemoveLayerCommand extends PostboyGenericMessage {
     layer: BaseLayer;
-    static readonly ID: string;
+    static readonly ID = "1b60599c-599a-4fdb-bad2-23b12e435e1a";
     constructor(layer: BaseLayer);
-    get id(): string;
 }

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

@@ -3,7 +3,6 @@ import { XYZ } from 'ol/source';
 import { PostboyGenericMessage } from '@artstesh/postboy';
 export declare class RemoveTileCommand extends PostboyGenericMessage {
     layer: TileLayer<XYZ>;
-    static readonly ID: string;
+    static readonly ID = "dab0f861-bb25-46da-9388-717bfaae798f";
     constructor(layer: TileLayer<XYZ>);
-    get id(): string;
 }

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

@@ -6,7 +6,7 @@ export declare class SetMapCenterCommand extends PostboyGenericMessage {
     lat: number;
     lng: number;
     zoom?: number | undefined;
-    static readonly ID: string;
+    static readonly ID = "d4e3cf4f-0be7-4c1a-8355-8607d02c3dea";
     /**
      *
      * @param lat - the desired latitude
@@ -14,5 +14,4 @@ export declare class SetMapCenterCommand extends PostboyGenericMessage {
      * @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/commands/start-drawing.command.d.ts

@@ -1,11 +1,20 @@
 import { PostboyCallbackMessage } from '@artstesh/postboy';
 import { DrawingType, FeatureOutputFormat } from '../../models';
 import Style from 'ol/style/Style';
+/**
+ * Represents a command to start a drawing operation.
+ */
 export declare class StartDrawingCommand extends PostboyCallbackMessage<string | null> {
     type: DrawingType;
     style: Style;
     format: FeatureOutputFormat;
-    static readonly ID: string;
+    static readonly ID = "4407e9ee-d6c3-4e77-8000-c1aae7433fb6";
+    /**
+     * Constructor for creating an instance of the class that represents a drawing feature with specific type, style, and output format.
+     *
+     * @param {DrawingType} type - The type of the drawing to be created.
+     * @param {Style} style - The style defining visual appearance of the drawing.
+     * @param {FeatureOutputFormat} [format=FeatureOutputFormat.GeoJson] - The format of the feature output. Defaults to GeoJson.
+     */
     constructor(type: DrawingType, style: Style, format?: FeatureOutputFormat);
-    get id(): string;
 }

package/dist/src/map/messages/events/drawing-finished.event.d.ts

@@ -1,6 +1,4 @@
 import { PostboyGenericMessage } from '@artstesh/postboy';
 export declare class DrawingFinishedEvent extends PostboyGenericMessage {
-    static readonly ID: string;
-    constructor();
-    get id(): string;
+    static readonly ID = "9094e160-8df7-4868-883a-3436724106dd";
 }

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

@@ -2,6 +2,12 @@ import { Feature } from 'ol';
 import { Geometry } from 'ol/geom';
 import { IIdentified } from '../../models/i-identified';
 import { PostboyGenericMessage } from '@artstesh/postboy';
+/**
+ * Represents an event triggered by a click on a map, containing information about the
+ * click's location, relevant entities, and features present at the clicked position.
+ *
+ * @extends {PostboyGenericMessage}
+ */
 export declare class MapClickEvent extends PostboyGenericMessage {
     coordinates: number[];
     entities: {
@@ -10,11 +16,17 @@ export declare class MapClickEvent extends PostboyGenericMessage {
     features: {
         [layer: string]: Feature<Geometry>[];
     };
-    static readonly ID: string;
+    static readonly ID = "ee31a86c-e838-4531-8399-983753a354df";
+    /**
+     * Creates an instance of this class with the provided coordinates, entities, and features.
+     *
+     * @param {number[]} coordinates - An array representing the coordinates.
+     * @param {{ [layer: string]: IIdentified[] }} entities - A mapping of layer names to arrays of IIdentified entities.
+     * @param {{ [layer: string]: Feature<Geometry>[] }} features - A mapping of layer names to arrays of features with geometry.
+     */
     constructor(coordinates: number[], entities: {
         [layer: string]: IIdentified[];
     }, features: {
         [layer: string]: Feature<Geometry>[];
     });
-    get id(): string;
 }

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

@@ -1,8 +1,13 @@
 import { PostboyGenericMessage } from '@artstesh/postboy';
 import { MapPosition } from '../../models';
+/**
+ * Represents an event that is triggered when the movement of a map ends.
+ * This class is used to capture the final position of a map after a movement operation.
+ *
+ * @property {MapPosition | null} position - The final position of the map after movement ends. Can be null.
+ */
 export declare class MapMoveEndEvent extends PostboyGenericMessage {
     position: MapPosition | null;
-    static readonly ID: string;
+    static readonly ID = "d210ec7e-032f-4ce8-8a39-7b816519eaae";
     constructor(position: MapPosition | null);
-    get id(): string;
 }

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

@@ -1,8 +1,15 @@
 import Map from 'ol/Map';
 import { PostboyGenericMessage } from '@artstesh/postboy';
+/**
+ * Represents an event triggered when a map rendering process is completed.
+ */
 export declare class MapRenderedEvent extends PostboyGenericMessage {
     map: Map;
-    static readonly ID: string;
+    static readonly ID = "4515dde8-1519-4e3f-a0e3-10d3c52deabe";
+    /**
+     * Constructor for creating an instance of the class.
+     *
+     * @param {Map} map - The map instance to be used by the class.
+     */
     constructor(map: Map);
-    get id(): string;
 }

package/dist/src/map/messages/executors/calculate-area.executor.d.ts

@@ -2,9 +2,15 @@ import { PostboyExecutor } from '@artstesh/postboy';
 import { Feature } from 'ol';
 import { Geometry } from 'ol/geom';
 import { PolygonModel } from '../../models';
+/**
+ * An executor responsible for calculating the area of a given polygon.
+ *
+ * Use this class to manage and execute area-calculation logic for a polygon.
+ *
+ * @return {number} - the spherical area (in square meters)
+ */
 export declare class CalculateAreaExecutor extends PostboyExecutor<Feature<Geometry>[]> {
     polygon: PolygonModel;
-    static readonly ID: string;
+    static readonly ID = "82347b8c-7635-45ec-85ef-75aaf43bc34c";
     constructor(polygon: PolygonModel);
-    get id(): string;
 }

package/dist/src/map/messages/executors/filter-features-in-area.executor.d.ts

@@ -1,10 +1,17 @@
 import { PostboyExecutor } from '@artstesh/postboy';
 import { Feature } from 'ol';
 import { Geometry } from 'ol/geom';
+/**
+ * A class that extends the PostboyExecutor to filter geographical features within a specified area.
+ * This class is designed to process a list of input features and determine which of them are located inside the provided area geometry.
+ *
+ * Parameters:
+ * - `area`: A Geometry object defining the area to filter geographical features.
+ * - `features`: An array of geographical features, represented as `Feature<Geometry>` objects, to be filtered by their presence within the specified area.
+ */
 export declare class FilterFeaturesInAreaExecutor extends PostboyExecutor<Feature<Geometry>[]> {
     area: Geometry;
     features: Feature<Geometry>[];
-    static readonly ID: string;
+    static readonly ID = "4d26e1e3-e60f-4e49-804b-5b3eadc2adce";
     constructor(area: Geometry, features: Feature<Geometry>[]);
-    get id(): string;
 }

package/dist/src/map/messages/executors/filter-features-in-point.executor.d.ts

@@ -2,13 +2,23 @@ import { PostboyExecutor } from '@artstesh/postboy';
 import { Feature } from 'ol';
 import { Geometry } from 'ol/geom';
 /**
- * The FilterFeaturesInPointExecutor class is responsible for filtering features within a given point.
+ * A class responsible for executing filtering of geographical features
+ * based on a specific geographical point (latitude and longitude).
+ *
+ * @template Feature - A geographical feature that is processed by the executor.
+ * @template Geometry - The type of geometry associated with the feature.
  */
 export declare class FilterFeaturesInPointExecutor extends PostboyExecutor<Feature<Geometry>[]> {
     lat: number;
     lng: number;
     features: Feature<Geometry>[];
-    static readonly ID = "5b859282-5d5a-47ca-a6ad-863a66c8b82b";
-    get id(): string;
+    static readonly ID = "dcbb156d-def3-45b4-91af-84d1483d8941";
+    /**
+     * Constructs a new instance with the specified latitude, longitude, and features.
+     *
+     * @param {number} lat - The latitude coordinate.
+     * @param {number} lng - The longitude coordinate.
+     * @param {Feature<Geometry>[]} features - The array of features associated with the location.
+     */
     constructor(lat: number, lng: number, features: Feature<Geometry>[]);
 }

package/dist/src/map/messages/executors/generate-draw.executor.d.ts

@@ -8,7 +8,6 @@ export declare class GenerateDrawExecutor extends PostboyExecutor<Draw> {
     layer: Layer<VectorSource<any>>;
     style: Style;
     type: DrawingType;
-    static readonly ID: string;
+    static readonly ID = "5d5f0737-ff70-461e-9a2e-bf6166c914cb";
     constructor(layer: Layer<VectorSource<any>>, style: Style, type: DrawingType);
-    get id(): string;
 }

package/dist/src/map/messages/executors/generate-zoom-control.executor.d.ts

@@ -3,7 +3,6 @@ import { Draw } from 'ol/interaction';
 import { ZoomControlSettings } from '../../map-plate/controls/map-control-zoom/zoom-control.settings';
 export declare class GenerateZoomControlExecutor extends PostboyExecutor<Draw> {
     settings: ZoomControlSettings;
-    static readonly ID: string;
+    static readonly ID = "c59f4fc3-ccf6-4cb3-a38b-3a8c249114a2";
     constructor(settings: ZoomControlSettings);
-    get id(): string;
 }

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

@@ -7,6 +7,5 @@ import { MapPosition } from '../../models';
  */
 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

@@ -1,19 +1,19 @@
-export * from './events/map-rendered.event';
-export * from './events/map-click.event';
-export * from './events/map-move-end.event';
+export * from './commands/add-control.command';
 export * from './commands/close-tooltip.command';
 export * from './commands/start-drawing.command';
 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';
-export * from './executors/calculate-area.executor';
 export * from './commands/fit-to-polygons.command';
+export * from './events/map-rendered.event';
+export * from './events/map-click.event';
+export * from './events/map-move-end.event';
+export * from './executors/filter-features-in-point.executor';
+export * from './executors/filter-features-in-area.executor';
+export * from './executors/calculate-area.executor';
 export * from './executors/get-map-position.executor';
 export * from './queries/get-features-in-area.query';
-export * from './executors/filter-features-in-area.executor';
 export * from './queries/get-features-in-point.query';
-export * from './executors/filter-features-in-point.executor';

package/dist/src/map/messages/queries/get-features-in-area.query.d.ts

@@ -2,10 +2,19 @@ import { PostboyCallbackMessage } from '@artstesh/postboy';
 import { Geometry } from 'ol/geom';
 import { IIdentified } from '../../models/i-identified';
 import { Dictionary } from '@artstesh/collections';
+/**
+ * Class representing a query to get features within a specified geographical area.
+ * The query optionally takes a set of layer names to ignore during the operation.
+ */
 export declare class GetFeaturesInAreaQuery extends PostboyCallbackMessage<Dictionary<IIdentified[]>> {
     area: Geometry;
     ignore: Set<string>;
-    static readonly ID: string;
+    static readonly ID = "317cf427-a029-4a43-97c4-cb6b8148ff65";
+    /**
+     * Constructor to initialize the object with a Geometry instance and an optional set of strings to ignore.
+     *
+     * @param {Geometry} area - The Geometry object used to define the area.
+     * @param {Set<string>} [ignore] - An optional set of layer names that will be ignored. Defaults to an empty set.
+     */
     constructor(area: Geometry, ignore?: Set<string>);
-    get id(): string;
 }

package/dist/src/map/messages/queries/get-features-in-point.query.d.ts

@@ -9,7 +9,13 @@ export declare class GetFeaturesInPointQuery extends PostboyCallbackMessage<Dict
     lat: number;
     lng: number;
     ignore: Set<string>;
-    static readonly ID: string;
+    static readonly ID = "99bbc56f-34a2-4064-8300-13bb3d0662c1";
+    /**
+     * Constructor for initializing a geographic coordinate object.
+     *
+     * @param {number} lat - The latitude of the location.
+     * @param {number} lng - The longitude of the location.
+     * @param {Set<string>} [ignore=new Set<string>()] - An optional set of strings to ignore during processing.
+     */
     constructor(lat: number, lng: number, ignore?: Set<string>);
-    get id(): string;
 }

package/dist/src/map/messages/queries/get-layer.query.d.ts

@@ -4,7 +4,6 @@ import VectorSource from 'ol/source/Vector';
 import Cluster from 'ol/source/Cluster';
 export declare class GetLayerQuery extends PostboyCallbackMessage<Layer<VectorSource<any> | Cluster> | null> {
     name: string;
-    static readonly ID: string;
+    static readonly ID = "d2683490-2aa2-4dee-855d-f752ce4d3be5";
     constructor(name: string);
-    get id(): string;
 }

package/dist/src/map/models/drawing-type.enum.d.ts

@@ -1,3 +1,16 @@
+/**
+ * Enum representing various drawing types.
+ *
+ * This enumeration is used to define the types of drawable shapes
+ * within a specific drawing context. Each member corresponds to
+ * a specific type of drawing.
+ *
+ * Members:
+ * - `Polygon`: Represents a polygonal shape (e.g., triangle, pentagon, etc.).
+ * - `Circle`: Represents a circular shape.
+ * - `Square`: Represents a square shape.
+ * - `Box`: Represents a rectangular box shape.
+ */
 export declare enum DrawingType {
     Polygon = 1,
     Circle = 2,

package/dist/src/map/models/feature-format.enum.d.ts

@@ -1,3 +1,11 @@
+/**
+ * An enumeration representing different formats for feature outputs.
+ * This can be used to specify the desired output format when dealing with geospatial data.
+ *
+ * Enumerators:
+ * - GeoJson: Represents the GeoJSON format for geospatial data.
+ * - WKT: Represents the Well-Known Text (WKT) format for geospatial data.
+ */
 export declare enum FeatureOutputFormat {
     GeoJson = 1,
     WKT = 2

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

@@ -1,3 +1,15 @@
+/**
+ * Represents a position and view configuration on a map.
+ *
+ * This interface is utilized to store and retrieve geographic and viewport details,
+ * including location coordinates, zoom level, and map extent.
+ *
+ * Properties:
+ * - `latitude`: The latitude coordinate of the map's center point.
+ * - `longitude`: The longitude coordinate of the map's center point.
+ * - `zoom`: The zoom level of the map's view.
+ * - `extent`: The geographical rectangular bounds defining the visible area of the map, represented as an array of coordinates [minX, minY, maxX, maxY].
+ */
 export interface MapPosition {
     latitude: number;
     longitude: number;

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

@@ -1,4 +1,8 @@
 import { MapLyrs } from './map-lyrs.enum';
+/**
+ * Represents the configurable settings for a map instance, providing
+ * options for center coordinates, zoom levels, map layers, and language.
+ */
 export declare class MapSettings {
     center: number[];
     maxZoom: number;
@@ -7,11 +11,53 @@ export declare class MapSettings {
     lyrs: MapLyrs;
     language: string;
     static copy(model: MapSettings): MapSettings;
+    /**
+     * Sets the center for the map settings.
+     *
+     * @param {number[]} center - A two-element array representing the latitude and longitude of the map's center.
+     * @return {MapSettings} A new MapSettings object with the updated center.
+     */
     setCenter(center: number[]): MapSettings;
+    /**
+     * Sets the maximum zoom level for the map.
+     *
+     * @param {number} maxZoom - The maximum zoom level to be set.
+     * @return {MapSettings} A new instance of MapSettings with the updated maximum zoom level.
+     */
     setMaxZoom(maxZoom: number): MapSettings;
+    /**
+     * Sets the minimum zoom level for the map settings.
+     *
+     * @param {number} minZoom The minimum zoom level to be set. Must be a valid numeric value.
+     * @return {MapSettings} A new MapSettings object with the updated minimum zoom level.
+     */
     setMinZoom(minZoom: number): MapSettings;
+    /**
+     * Adjusts the zoom level of the map by setting the specified value.
+     *
+     * @param {number} zoom - The desired zoom level to be set.
+     * @return {MapSettings} A new MapSettings instance with the updated zoom level.
+     */
     setZoom(zoom: number): MapSettings;
+    /**
+     * Sets the layers in the map settings with the provided layers.
+     *
+     * @param {MapLyrs} lyrs - The layers to be set in the map settings.
+     * @return {MapSettings} A new instance of MapSettings with the updated layers.
+     */
     setLyrs(lyrs: MapLyrs): MapSettings;
+    /**
+     * Updates the language setting for the map configuration and returns a new instance with the updated language.
+     *
+     * @param {string} language - The language to be set for the map configuration.
+     * @return {MapSettings} A new instance of MapSettings with the updated language.
+     */
     setLanguage(language: string): MapSettings;
+    /**
+     * Compares the current MapSettings instance with another to determine if they are identical.
+     *
+     * @param {MapSettings} model - The MapSettings instance to compare with the current instance.
+     * @return {boolean} Returns true if both MapSettings instances have the same properties and values; otherwise, false.
+     */
     isSame(model: MapSettings): boolean;
 }