@artstesh/maps 5.1.1 → 5.1.2

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/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/package.json

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