@artstesh/maps 6.0.1 → 6.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/dist/esm2022/map/helpers/marker-style.helper.mjs +27 -1
  2. package/dist/esm2022/map/helpers/polygon-style.helper.mjs +22 -1
  3. package/dist/esm2022/map/helpers/stringify-feature.helper.mjs +24 -21
  4. package/dist/esm2022/map/helpers/text-style.helper.mjs +12 -1
  5. package/dist/esm2022/map/map-plate/controls/map-control-zoom/map-control-zoom.component.mjs +26 -9
  6. package/dist/esm2022/map/map-plate/controls/map-control-zoom/zoom-control.settings.mjs +72 -1
  7. package/dist/esm2022/map/map-plate/features/markers/markers.component.mjs +11 -1
  8. package/dist/esm2022/map/map-plate/features/polygons/polygons.component.mjs +11 -1
  9. package/dist/esm2022/map/map-plate/layers/cluster-layer/cluster-layer.component.mjs +16 -8
  10. package/dist/esm2022/map/map-plate/layers/cluster-layer/cluster-layer.settings.mjs +79 -1
  11. package/dist/esm2022/map/map-plate/layers/feature-layer/feature-layer.component.mjs +8 -8
  12. package/dist/esm2022/map/map-plate/layers/feature-layer/feature-layer.settings.mjs +37 -17
  13. package/dist/esm2022/map/map-plate/layers/tile-layer/tile-layer.component.mjs +7 -7
  14. package/dist/esm2022/map/map-plate/layers/tile-layer/tile-layer.settings.mjs +76 -1
  15. package/dist/esm2022/map/map-plate/map-plate.component.mjs +5 -5
  16. package/dist/esm2022/map/map-plate/tooltips/tooltip/tooltip.component.mjs +23 -23
  17. package/dist/esm2022/map/map-plate/tooltips/tooltip/tooltip.settings.mjs +2 -2
  18. package/dist/esm2022/map/messages/commands/fit-to-polygons.command.mjs +1 -1
  19. package/dist/esm2022/map/messages/events/map-move-end.event.mjs +4 -6
  20. package/dist/esm2022/map/messages/executors/get-map-position.executor.mjs +16 -0
  21. package/dist/esm2022/map/messages/index.mjs +2 -1
  22. package/dist/esm2022/map/models/index.mjs +2 -1
  23. package/dist/esm2022/map/models/map-control.mjs +2 -2
  24. package/dist/esm2022/map/models/map-position.model.mjs +2 -0
  25. package/dist/esm2022/map/models/marker-model.mjs +1 -1
  26. package/dist/esm2022/map/models/polygon.model.mjs +12 -12
  27. package/dist/esm2022/map/services/feature.service.mjs +6 -6
  28. package/dist/esm2022/map/services/map-click.service.mjs +9 -9
  29. package/dist/esm2022/map/services/map-feature.service.mjs +1 -1
  30. package/dist/esm2022/map/services/map-state.service.mjs +11 -6
  31. package/dist/esm2022/map/services/message-registrator.service.mjs +5 -1
  32. package/dist/esm2022/src/map/helpers/marker-style.helper.mjs +27 -1
  33. package/dist/esm2022/src/map/helpers/polygon-style.helper.mjs +22 -1
  34. package/dist/esm2022/src/map/helpers/stringify-feature.helper.mjs +24 -21
  35. package/dist/esm2022/src/map/helpers/text-style.helper.mjs +12 -1
  36. package/dist/esm2022/src/map/map-plate/controls/map-control-zoom/map-control-zoom.component.mjs +26 -9
  37. package/dist/esm2022/src/map/map-plate/controls/map-control-zoom/zoom-control.settings.mjs +72 -1
  38. package/dist/esm2022/src/map/map-plate/features/markers/markers.component.mjs +11 -1
  39. package/dist/esm2022/src/map/map-plate/features/polygons/polygons.component.mjs +11 -1
  40. package/dist/esm2022/src/map/map-plate/layers/cluster-layer/cluster-layer.component.mjs +16 -8
  41. package/dist/esm2022/src/map/map-plate/layers/cluster-layer/cluster-layer.settings.mjs +79 -1
  42. package/dist/esm2022/src/map/map-plate/layers/feature-layer/feature-layer.component.mjs +8 -8
  43. package/dist/esm2022/src/map/map-plate/layers/feature-layer/feature-layer.settings.mjs +37 -17
  44. package/dist/esm2022/src/map/map-plate/layers/tile-layer/tile-layer.component.mjs +7 -7
  45. package/dist/esm2022/src/map/map-plate/layers/tile-layer/tile-layer.settings.mjs +76 -1
  46. package/dist/esm2022/src/map/map-plate/map-plate.component.mjs +5 -5
  47. package/dist/esm2022/src/map/map-plate/tooltips/tooltip/tooltip.component.mjs +23 -23
  48. package/dist/esm2022/src/map/map-plate/tooltips/tooltip/tooltip.settings.mjs +2 -2
  49. package/dist/esm2022/src/map/messages/commands/fit-to-polygons.command.mjs +1 -1
  50. package/dist/esm2022/src/map/messages/events/map-move-end.event.mjs +4 -6
  51. package/dist/esm2022/src/map/messages/executors/get-map-position.executor.mjs +16 -0
  52. package/dist/esm2022/src/map/messages/index.mjs +2 -1
  53. package/dist/esm2022/src/map/models/index.mjs +2 -1
  54. package/dist/esm2022/src/map/models/map-control.mjs +2 -2
  55. package/dist/esm2022/src/map/models/map-position.model.mjs +2 -0
  56. package/dist/esm2022/src/map/models/marker-model.mjs +1 -1
  57. package/dist/esm2022/src/map/models/polygon.model.mjs +12 -12
  58. package/dist/esm2022/src/map/services/feature.service.mjs +6 -6
  59. package/dist/esm2022/src/map/services/map-click.service.mjs +9 -9
  60. package/dist/esm2022/src/map/services/map-feature.service.mjs +1 -1
  61. package/dist/esm2022/src/map/services/map-state.service.mjs +11 -6
  62. package/dist/esm2022/src/map/services/message-registrator.service.mjs +5 -1
  63. package/dist/fesm2022/maps-components-src-map.mjs +498 -125
  64. package/dist/fesm2022/maps-components-src-map.mjs.map +1 -1
  65. package/dist/fesm2022/maps-components.mjs +498 -125
  66. package/dist/fesm2022/maps-components.mjs.map +1 -1
  67. package/dist/map/helpers/marker-style.helper.d.ts +26 -0
  68. package/dist/map/helpers/polygon-style.helper.d.ts +21 -0
  69. package/dist/map/helpers/stringify-feature.helper.d.ts +18 -0
  70. package/dist/map/helpers/text-style.helper.d.ts +11 -0
  71. package/dist/map/map-plate/controls/map-control-zoom/map-control-zoom.component.d.ts +20 -3
  72. package/dist/map/map-plate/controls/map-control-zoom/zoom-control.settings.d.ts +71 -0
  73. package/dist/map/map-plate/features/markers/markers.component.d.ts +10 -0
  74. package/dist/map/map-plate/features/polygons/polygons.component.d.ts +10 -0
  75. package/dist/map/map-plate/layers/cluster-layer/cluster-layer.component.d.ts +10 -2
  76. package/dist/map/map-plate/layers/cluster-layer/cluster-layer.settings.d.ts +78 -0
  77. package/dist/map/map-plate/layers/feature-layer/feature-layer.component.d.ts +2 -2
  78. package/dist/map/map-plate/layers/feature-layer/feature-layer.settings.d.ts +36 -16
  79. package/dist/map/map-plate/layers/tile-layer/tile-layer.component.d.ts +1 -1
  80. package/dist/map/map-plate/layers/tile-layer/tile-layer.settings.d.ts +75 -0
  81. package/dist/map/map-plate/map-plate.component.d.ts +2 -2
  82. package/dist/map/map-plate/tooltips/tooltip/tooltip.component.d.ts +5 -5
  83. package/dist/map/map-plate/tooltips/tooltip/tooltip.settings.d.ts +1 -1
  84. package/dist/map/messages/events/map-move-end.event.d.ts +3 -3
  85. package/dist/map/messages/executors/get-map-position.executor.d.ts +12 -0
  86. package/dist/map/messages/index.d.ts +1 -0
  87. package/dist/map/models/index.d.ts +1 -0
  88. package/dist/map/models/map-control.d.ts +1 -1
  89. package/dist/map/models/map-position.model.d.ts +6 -0
  90. package/dist/map/models/polygon.model.d.ts +2 -2
  91. package/dist/map/services/feature.service.d.ts +1 -1
  92. package/dist/map/services/map-click.service.d.ts +1 -1
  93. package/dist/map/services/map-state.service.d.ts +2 -0
  94. package/dist/map/services/message-registrator.service.d.ts +1 -0
  95. package/dist/src/map/helpers/marker-style.helper.d.ts +26 -0
  96. package/dist/src/map/helpers/polygon-style.helper.d.ts +21 -0
  97. package/dist/src/map/helpers/stringify-feature.helper.d.ts +18 -0
  98. package/dist/src/map/helpers/text-style.helper.d.ts +11 -0
  99. package/dist/src/map/map-plate/controls/map-control-zoom/map-control-zoom.component.d.ts +20 -3
  100. package/dist/src/map/map-plate/controls/map-control-zoom/zoom-control.settings.d.ts +71 -0
  101. package/dist/src/map/map-plate/features/markers/markers.component.d.ts +10 -0
  102. package/dist/src/map/map-plate/features/polygons/polygons.component.d.ts +10 -0
  103. package/dist/src/map/map-plate/layers/cluster-layer/cluster-layer.component.d.ts +10 -2
  104. package/dist/src/map/map-plate/layers/cluster-layer/cluster-layer.settings.d.ts +78 -0
  105. package/dist/src/map/map-plate/layers/feature-layer/feature-layer.component.d.ts +2 -2
  106. package/dist/src/map/map-plate/layers/feature-layer/feature-layer.settings.d.ts +36 -16
  107. package/dist/src/map/map-plate/layers/tile-layer/tile-layer.component.d.ts +1 -1
  108. package/dist/src/map/map-plate/layers/tile-layer/tile-layer.settings.d.ts +75 -0
  109. package/dist/src/map/map-plate/map-plate.component.d.ts +2 -2
  110. package/dist/src/map/map-plate/tooltips/tooltip/tooltip.component.d.ts +5 -5
  111. package/dist/src/map/map-plate/tooltips/tooltip/tooltip.settings.d.ts +1 -1
  112. package/dist/src/map/messages/events/map-move-end.event.d.ts +3 -3
  113. package/dist/src/map/messages/executors/get-map-position.executor.d.ts +12 -0
  114. package/dist/src/map/messages/index.d.ts +1 -0
  115. package/dist/src/map/models/index.d.ts +1 -0
  116. package/dist/src/map/models/map-control.d.ts +1 -1
  117. package/dist/src/map/models/map-position.model.d.ts +6 -0
  118. package/dist/src/map/models/polygon.model.d.ts +2 -2
  119. package/dist/src/map/services/feature.service.d.ts +1 -1
  120. package/dist/src/map/services/map-click.service.d.ts +1 -1
  121. package/dist/src/map/services/map-state.service.d.ts +2 -0
  122. package/dist/src/map/services/message-registrator.service.d.ts +1 -0
  123. package/package.json +1 -1
@@ -1,7 +1,33 @@
1
1
  import Style from 'ol/style/Style';
2
2
  import { Text } from 'ol/style';
3
+ /**
4
+ * Helper class to create and modify marker styles.
5
+ */
3
6
  export declare class MarkerStyleHelper {
7
+ /**
8
+ * Creates a new Style object from an SVG.
9
+ * @param {string} svg - The SVG string.
10
+ * @param {Array<number>} [size=[30, 30]] - The size of the icon image.
11
+ * @param {number} [zIndex=400] - The zIndex of the style.
12
+ * @returns {Style} A new Style object.
13
+ */
4
14
  static fromSvg(svg: string, size?: [number, number], zIndex?: number): Style;
15
+ /**
16
+ * Returns a Style object with a circle style.
17
+ *
18
+ * @param {number} radius - The radius of the circle.
19
+ * @param {string} fill - The fill color of the circle. Format: '#RRGGBB' or 'rgba(R, G, B, A)'.
20
+ * @param {string} strokeColor - The stroke color of the circle. Format: '#RRGGBB' or 'rgba(R, G, B, A)'.
21
+ * @param {number} [strokeWidth=1] - The width of the stroke. Default is 1.
22
+ * @returns {Style} - A Style object with a Circle image.
23
+ */
5
24
  static circle(radius: number, fill: string, strokeColor: string, strokeWidth?: number): Style;
25
+ /**
26
+ * Applies the given Text to the provided Style.
27
+ *
28
+ * @param {Style} style - The Style to modify.
29
+ * @param {Text} text - The Text to apply to the Style.
30
+ * @return {Style} - The modified Style with the applied Text.
31
+ */
6
32
  static withText(style: Style, text: Text): Style;
7
33
  }
@@ -1,5 +1,26 @@
1
1
  import Style from 'ol/style/Style';
2
+ /**
3
+ * A helper class for creating polygon styles.
4
+ * @class
5
+ */
2
6
  export declare class PolygonStyleHelper {
7
+ /**
8
+ * Creates a Style object with the given fill color, stroke color, and stroke width.
9
+ *
10
+ * @param {string} fill - The fill color in hexadecimal or RGB format.
11
+ * @param {string} stroke - The stroke color in hexadecimal or RGB format.
12
+ * @param {number} [strokeWidth=1] - The width of the stroke. Defaults to 1.
13
+ * @return {Style} The created Style object.
14
+ */
3
15
  static simple(fill: string, stroke: string, strokeWidth?: number): Style;
16
+ /**
17
+ * Creates a new Style object with the given fill, stroke, stroke width, and pin radius.
18
+ *
19
+ * @param {string} fill - The color to use for the fill of the style.
20
+ * @param {string} stroke - The color to use for the stroke of the style.
21
+ * @param {number} [strokeWidth=1] - The width of the stroke. Defaults to 1.
22
+ * @param {number} [pinRadius=5] - The radius of the circle used as the image for the style. Defaults to 5.
23
+ * @returns {Style} - The newly created Style object.
24
+ */
4
25
  static edit(fill: string, stroke: string, strokeWidth?: number, pinRadius?: number): Style;
5
26
  }
@@ -1,8 +1,26 @@
1
1
  import { Feature } from 'ol';
2
2
  import { Geometry } from 'ol/geom';
3
3
  import { FeatureOutputFormat } from '../models';
4
+ /**
5
+ * A helper class for converting and stringify features.
6
+ */
4
7
  export declare class StringifyFeatureHelper {
5
8
  static polygon(feature: Feature<Geometry>, format?: FeatureOutputFormat): string;
9
+ /**
10
+ * Creates a polygon feature representing a circle based on a given feature with a circle geometry.
11
+ *
12
+ * @param {Feature<Geometry>} feature - The input feature with a circle geometry.
13
+ * @param {FeatureOutputFormat} format - The format for outputting the polygon feature. (default: FeatureOutputFormat.GeoJson)
14
+ *
15
+ * @return {string} - The string representation of the polygon feature.
16
+ */
6
17
  static circle(feature: Feature<Geometry>, format?: FeatureOutputFormat): string;
18
+ /**
19
+ * Draw a circle based on a center point and radius.
20
+ *
21
+ * @param {number[]} point - The center point coordinates in EPSG:4326 format.
22
+ * @param {number} radius - The radius of the circle in meters.
23
+ * @return {Coordinate[][]} - The coordinates of the circle boundary in EPSG:4326 format.
24
+ */
7
25
  private static drawCircle;
8
26
  }
@@ -1,4 +1,15 @@
1
1
  import { Text } from 'ol/style';
2
+ /**
3
+ * Helper class for creating text styles.
4
+ */
2
5
  export declare class TextStyleHelper {
6
+ /**
7
+ * Creates a new instance of the Text class with the specified properties.
8
+ *
9
+ * @param {string} text - The text content of the Text object.
10
+ * @param {string} font - The font style of the Text object.
11
+ * @param {string} color - The color of the Text object.
12
+ * @return {Text} A new instance of the Text class.
13
+ */
3
14
  static get(text: string, font: string, color: string): Text;
4
15
  }
@@ -3,16 +3,33 @@ import { MapPostboyService } from '../../../services/map-postboy.service';
3
3
  import { DestructibleComponent } from '../../../common/destructible.component';
4
4
  import { ZoomControlSettings } from './zoom-control.settings';
5
5
  import * as i0 from "@angular/core";
6
+ /**
7
+ * @class
8
+ * @classdesc Represents a component for the Zoom control on a map.
9
+ * @extends DestructibleComponent
10
+ * @implements OnInit
11
+ */
6
12
  export declare class MapControlZoomComponent extends DestructibleComponent implements OnInit {
7
13
  private postboy;
8
- private _settings;
9
14
  private map?;
10
15
  private control?;
11
- set settings(value: ZoomControlSettings | undefined);
12
16
  constructor(postboy: MapPostboyService);
17
+ private _settings;
18
+ /**
19
+ * Sets the settings for the Zoom Control.
20
+ *
21
+ * @param {ZoomControlSettings | undefined} value - The new settings for the Zoom Control.
22
+ *
23
+ * @description
24
+ * This method sets the settings for the Zoom Control. It takes a parameter `value` which should be an object of type `ZoomControlSettings` or `undefined`.
25
+ *
26
+ * If the `value` is `undefined` or the same as the current settings, the method will return without making any changes.
27
+ *
28
+ */
29
+ set settings(value: ZoomControlSettings | undefined);
13
30
  ngOnInit(): void;
14
- private setControl;
15
31
  onDestroy: () => void;
32
+ private setControl;
16
33
  private eliminate;
17
34
  static ɵfac: i0.ɵɵFactoryDeclaration<MapControlZoomComponent, never>;
18
35
  static ɵcmp: i0.ɵɵComponentDeclaration<MapControlZoomComponent, "art-map-control-zoom", never, { "settings": { "alias": "settings"; "required": false; }; }, {}, never, never, false, never>;
@@ -1,14 +1,85 @@
1
+ /**
2
+ * Represents the settings for a zoom control.
3
+ */
1
4
  export declare class ZoomControlSettings {
5
+ /**
6
+ * The CSS class name of the control element.
7
+ *
8
+ * @type {string}
9
+ */
2
10
  controlClass: string;
11
+ /**
12
+ * The CSS class name for zoom in button.
13
+ * @type {string}
14
+ */
3
15
  zoomInClass: string;
16
+ /**
17
+ * The CSS class name for the zoom out button element.
18
+ *
19
+ * @type {string}
20
+ */
4
21
  zoomOutClass: string;
22
+ /**
23
+ * The label for the zoom in action.
24
+ *
25
+ * @type {string}
26
+ */
5
27
  zoomInLabel: string;
28
+ /**
29
+ * The label for the zoom out control.
30
+ *
31
+ * @type {string}
32
+ */
6
33
  zoomOutLabel: string;
34
+ /**
35
+ * Copies the provided ZoomControlSettings object.
36
+ *
37
+ * @param {ZoomControlSettings} model - The ZoomControlSettings object to be copied.
38
+ * @return {ZoomControlSettings} - The copied ZoomControlSettings object.
39
+ */
7
40
  static copy(model: ZoomControlSettings): ZoomControlSettings;
41
+ /**
42
+ * Checks if the current ZoomControlSettings object is equal to the given model.
43
+ *
44
+ * @param {ZoomControlSettings} model - The ZoomControlSettings object to compare with.
45
+ *
46
+ * @return {boolean} - true if the current object is equal to the given model, false otherwise.
47
+ */
8
48
  isSame(model: ZoomControlSettings): boolean;
49
+ /**
50
+ * Sets the zoom in label of the Zoom Control Settings.
51
+ *
52
+ * @param {string} zoomInLabel - The label for the zoom in button.
53
+ * @return {ZoomControlSettings} - The new Zoom Control Settings object with the updated zoom in label.
54
+ */
9
55
  setZoomInLabel(zoomInLabel: string): ZoomControlSettings;
56
+ /**
57
+ * Sets the zoomOutClass property of the ZoomControlSettings object.
58
+ *
59
+ * @param {string} zoomOutClass - The CSS class to be assigned to the zoom out button.
60
+ * @return {ZoomControlSettings} - The updated ZoomControlSettings object with the new zoomOutClass value.
61
+ */
10
62
  setZoomOutClass(zoomOutClass: string): ZoomControlSettings;
63
+ /**
64
+ * Sets the zoom in class for the zoom control settings.
65
+ *
66
+ * @param {string} zoomInClass - The new zoom in class to be set.
67
+ * @return {ZoomControlSettings} - The updated zoom control settings.
68
+ */
11
69
  setZoomInClass(zoomInClass: string): ZoomControlSettings;
70
+ /**
71
+ * Set the label for the zoom out control.
72
+ *
73
+ * @param {string} zoomOutLabel - The label for the zoom out control.
74
+ * @returns {ZoomControlSettings} - The updated zoom control settings.
75
+ */
12
76
  setZoomOutLabel(zoomOutLabel: string): ZoomControlSettings;
77
+ /**
78
+ * Sets the control class for the ZoomControlSettings.
79
+ *
80
+ * @param {string} controlClass - The class name of the control to be set.
81
+ *
82
+ * @return {ZoomControlSettings} - The modified ZoomControlSettings object.
83
+ */
13
84
  setControlClass(controlClass: string): ZoomControlSettings;
14
85
  }
@@ -3,11 +3,21 @@ import { DestructibleComponent } from '../../../common/destructible.component';
3
3
  import { MapPostboyService } from '../../../services/map-postboy.service';
4
4
  import { MarkerModel } from '../../../models/marker-model';
5
5
  import * as i0 from "@angular/core";
6
+ /**
7
+ * MarkersComponent is a component that displays markers on a map.
8
+ * It listens for changes in the `markers` input property and
9
+ * automatically puts the markers on the map using the MapPostboyService.
10
+ */
6
11
  export declare class MarkersComponent extends DestructibleComponent implements OnInit {
7
12
  private postboy;
8
13
  layerName: string;
9
14
  constructor(postboy: MapPostboyService);
10
15
  _markers: MarkerModel[];
16
+ /**
17
+ * Sets the markers property.
18
+ *
19
+ * @param {MarkerModel[]} value - The array of MarkerModel objects to set as markers.
20
+ */
11
21
  set markers(value: MarkerModel[]);
12
22
  ngOnInit(): void;
13
23
  private putMarkers;
@@ -3,11 +3,21 @@ import { DestructibleComponent } from '../../../common/destructible.component';
3
3
  import { MapPostboyService } from '../../../services/map-postboy.service';
4
4
  import { PolygonModel } from '../../../models/polygon.model';
5
5
  import * as i0 from "@angular/core";
6
+ /**
7
+ * Component for rendering polygons on a map.
8
+ * It listens for changes in the `polygons` input property and
9
+ * automatically puts the polygons on the map using the MapPostboyService.
10
+ */
6
11
  export declare class PolygonsComponent extends DestructibleComponent implements OnInit {
7
12
  private postboy;
8
13
  layerName: string;
9
14
  constructor(postboy: MapPostboyService);
10
15
  _polygons: PolygonModel[];
16
+ /**
17
+ * Sets the value of polygons.
18
+ *
19
+ * @param {PolygonModel[]} value - The new value for polygons.
20
+ */
11
21
  set polygons(value: PolygonModel[]);
12
22
  ngOnInit(): void;
13
23
  private putPolygons;
@@ -5,14 +5,22 @@ import { ClusterLayerManager } from './cluster-layer.manager';
5
5
  import { ClusterLayerSettings } from './cluster-layer.settings';
6
6
  import { ClusterLayerFactory } from './cluster-layer-factory.service';
7
7
  import * as i0 from "@angular/core";
8
+ /**
9
+ * Represents a cluster layer component.
10
+ */
8
11
  export declare class ClusterLayerComponent extends DestructibleComponent implements OnInit {
9
12
  private postboy;
10
13
  private factory;
11
14
  manager: ClusterLayerManager | null;
12
- _settings: ClusterLayerSettings;
13
15
  constructor(postboy: MapPostboyService, factory: ClusterLayerFactory);
14
- ngOnInit(): void;
16
+ _settings: ClusterLayerSettings;
17
+ /**
18
+ * Sets the settings for the cluster layer.
19
+ *
20
+ * @param {ClusterLayerSettings | undefined} value - The settings for the cluster layer.
21
+ */
15
22
  set settings(value: ClusterLayerSettings | undefined);
23
+ ngOnInit(): void;
16
24
  onDestroy: () => void;
17
25
  private initLayer;
18
26
  private removeLayer;
@@ -3,20 +3,98 @@ import { IIdentified } from '../../../models/i-identified';
3
3
  export declare class ClusterLayerSettings {
4
4
  name: string;
5
5
  zIndex: number;
6
+ /**
7
+ * The maximum view zoom level (inclusive) at which this layer will be visible.
8
+ *
9
+ * @type {number}
10
+ * @default 19
11
+ */
6
12
  maxZoom: number;
13
+ /**
14
+ * The minimum view zoom level (exclusive) at which this layer will be visible.
15
+ *
16
+ * @type {number}
17
+ */
7
18
  minZoom: number;
19
+ /**
20
+ * Distance in pixels within which features will be clustered together.
21
+ *
22
+ * @type {number}
23
+ */
8
24
  distance: number;
9
25
  bbox: boolean;
10
26
  clusterCancel: number;
11
27
  style?: (features: IIdentified[]) => Style;
28
+ /**
29
+ * Creates a copy of the given ClusterLayerSettings object.
30
+ *
31
+ * @param {ClusterLayerSettings} model - The ClusterLayerSettings object to be copied.
32
+ * @returns {ClusterLayerSettings} - A new ClusterLayerSettings object that is a copy of the original object.
33
+ */
12
34
  static copy(model: ClusterLayerSettings): ClusterLayerSettings;
35
+ /**
36
+ * Set the z-index for the ClusterLayer.
37
+ *
38
+ * @param {number} zIndex - The new z-index for the ClusterLayer.
39
+ * @return {ClusterLayerSettings} - The updated ClusterLayerSettings object.
40
+ */
13
41
  setZIndex(zIndex: number): ClusterLayerSettings;
42
+ /**
43
+ * Sets the distance value for ClusterLayerSettings.
44
+ *
45
+ * @param {number} distance - The distance value to be set.
46
+ * @return {ClusterLayerSettings} - The modified ClusterLayerSettings object.
47
+ */
14
48
  setDistance(distance: number): ClusterLayerSettings;
49
+ /**
50
+ * Sets the name of the ClusterLayerSettings object.
51
+ *
52
+ * @param {string} name - The name to set for the ClusterLayerSettings.
53
+ * @return {ClusterLayerSettings} - A new ClusterLayerSettings object with the updated name.
54
+ */
15
55
  setName(name: string): ClusterLayerSettings;
56
+ /**
57
+ * Sets the maximum zoom level for the Cluster Layer.
58
+ *
59
+ * @param {number} maxZoom - The maximum zoom level to be set.
60
+ * @return {ClusterLayerSettings} - The updated ClusterLayerSettings object.
61
+ */
16
62
  setMaxZoom(maxZoom: number): ClusterLayerSettings;
63
+ /**
64
+ * Sets the minimum zoom level for the ClusterLayerSettings.
65
+ *
66
+ * @param {number} minZoom - The minimum zoom level to set.
67
+ * @return {ClusterLayerSettings} - The updated ClusterLayerSettings object.
68
+ */
17
69
  setMinZoom(minZoom: number): ClusterLayerSettings;
70
+ /**
71
+ * Sets the cluster cancel number for the ClusterLayerSettings.
72
+ *
73
+ * @param {number} clusterCancel - The new cluster cancel number.
74
+ * @returns {ClusterLayerSettings} - The updated ClusterLayerSettings object.
75
+ */
18
76
  setClusterCancel(clusterCancel: number): ClusterLayerSettings;
77
+ /**
78
+ * Sets the value of 'bbox' property in the ClusterLayerSettings object.
79
+ *
80
+ * @param {boolean} bbox - A boolean value indicating whether to include bounding box calculation in the cluster layer settings.
81
+ * @returns {ClusterLayerSettings} - The updated ClusterLayerSettings object with the newly set 'bbox' value.
82
+ */
19
83
  setBbox(bbox: boolean): ClusterLayerSettings;
84
+ /**
85
+ * Sets the style for the ClusterLayerSettings.
86
+ *
87
+ * @param {function} style - A function that takes an array of identified features as input and returns a Style or StyleFunction.
88
+ *
89
+ * @return {ClusterLayerSettings} - The updated ClusterLayerSettings object with the new style applied.
90
+ */
20
91
  setStyle(style: (features: IIdentified[]) => Style | StyleFunction): ClusterLayerSettings;
92
+ /**
93
+ * Checks if the current ClusterLayerSettings object is the same as the specified model.
94
+ *
95
+ * @param {ClusterLayerSettings} model - The model to compare with the current object.
96
+ *
97
+ * @return {boolean} - Returns true if the current ClusterLayerSettings object is the same as the specified model, otherwise false.
98
+ */
21
99
  isSame(model: ClusterLayerSettings): boolean;
22
100
  }
@@ -10,10 +10,10 @@ export declare class FeatureLayerComponent extends DestructibleComponent impleme
10
10
  private postboy;
11
11
  private factory;
12
12
  layer: Layer<VectorSource<any>> | null;
13
- _settings: FeatureLayerSettings;
14
13
  constructor(postboy: MapPostboyService, factory: FeatureLayerFactory);
15
- ngOnInit(): void;
14
+ _settings: FeatureLayerSettings;
16
15
  set settings(value: FeatureLayerSettings | undefined);
16
+ ngOnInit(): void;
17
17
  onDestroy: () => void;
18
18
  private initLayer;
19
19
  private removeLayer;
@@ -12,11 +12,16 @@ export declare class FeatureLayerSettings {
12
12
  */
13
13
  zIndex: number;
14
14
  /**
15
- * The maximum zoom at which the layer is visible. 19 by default
15
+ The maximum view zoom level (inclusive) at which this layer will be visible.
16
+
17
+ @type {number}
18
+ @default 19
16
19
  */
17
20
  maxZoom: number;
18
21
  /**
19
- * The minimum zoom at which the layer is visible. 0 by default
22
+ The minimum view zoom level (exclusive) at which this layer will be visible.
23
+
24
+ @type {number}
20
25
  */
21
26
  minZoom: number;
22
27
  /**
@@ -24,38 +29,53 @@ export declare class FeatureLayerSettings {
24
29
  */
25
30
  style?: Style | StyleFunction;
26
31
  /**
27
- * Creates a clone of the existing settings
28
- * @param model
32
+ * Copies the given FeatureLayerSettings object
33
+ *
34
+ * @param {FeatureLayerSettings} model - The FeatureLayerSettings object to be copied
35
+ * @returns {FeatureLayerSettings} - A copy of the FeatureLayerSettings object
29
36
  */
30
37
  static copy(model: FeatureLayerSettings): FeatureLayerSettings;
31
38
  /**
32
- Setter for {@link FeatureLayerSettings.zIndex}
33
- * @param zIndex
39
+ * Sets the z-index value for the FeatureLayerSettings object.
40
+ *
41
+ * @param {number} zIndex - The new z-index value.
42
+ * @return {FeatureLayerSettings} - The updated FeatureLayerSettings object.
34
43
  */
35
44
  setZIndex(zIndex: number): FeatureLayerSettings;
36
45
  /**
37
- * Setter for {@link FeatureLayerSettings.name}
38
- * @param name
46
+ * Sets the name of the FeatureLayerSettings.
47
+ *
48
+ * @param {string} name - The name to set for the FeatureLayerSettings.
49
+ *
50
+ * @return {FeatureLayerSettings} - The updated FeatureLayerSettings object with the new name.
39
51
  */
40
52
  setName(name: string): FeatureLayerSettings;
41
53
  /**
42
- * Setter for {@link FeatureLayerSettings.maxZoom}
43
- * @param maxZoom
54
+ * Sets the maximum zoom level for the FeatureLayerSettings.
55
+ *
56
+ * @param {number} maxZoom - The maximum zoom level.
57
+ * @return {FeatureLayerSettings} - The updated FeatureLayerSettings object.
44
58
  */
45
59
  setMaxZoom(maxZoom: number): FeatureLayerSettings;
46
60
  /**
47
- * Setter for {@link FeatureLayerSettings.minZoom}
48
- * @param minZoom
61
+ * Sets the minimum zoom level for the feature layer.
62
+ *
63
+ * @param {number} minZoom The minimum zoom level to be set.
64
+ * @returns {FeatureLayerSettings} The updated feature layer settings object.
49
65
  */
50
66
  setMinZoom(minZoom: number): FeatureLayerSettings;
51
67
  /**
52
- * Setter for {@link FeatureLayerSettings.style}
53
- * @param style
68
+ * Sets the style for the FeatureLayerSettings object.
69
+ *
70
+ * @param {Style | StyleFunction} style - The new style to set. It can be either a Style object or a StyleFunction.
71
+ * @return {FeatureLayerSettings} - The updated FeatureLayerSettings object with the new style.
54
72
  */
55
73
  setStyle(style: Style | StyleFunction): FeatureLayerSettings;
56
74
  /**
57
- * Checks if the model has the same content
58
- * @param model - the object to compare
75
+ * Checks if the given FeatureLayerSettings object is identical to the current object.
76
+ *
77
+ * @param {FeatureLayerSettings} model - The FeatureLayerSettings object to compare with.
78
+ * @return {boolean} - Returns true if the given object is identical to the current object, otherwise false.
59
79
  */
60
80
  isSame(model: FeatureLayerSettings): boolean;
61
81
  }
@@ -10,9 +10,9 @@ export declare class TileLayerComponent extends DestructibleComponent {
10
10
  private factory;
11
11
  layer?: TileLayer<XYZ>;
12
12
  constructor(postboy: MapPostboyService, factory: TileLayerFactory);
13
- ngOnInit(): void;
14
13
  _settings: TileLayerSettings;
15
14
  set settings(value: TileLayerSettings | undefined);
15
+ ngOnInit(): void;
16
16
  onDestroy: () => void;
17
17
  private initLayer;
18
18
  private removeLayer;
@@ -1,14 +1,89 @@
1
+ /**
2
+ * Class representing settings for a tile layer.
3
+ */
1
4
  export declare class TileLayerSettings {
5
+ /**
6
+ * The maximum zoom level for a map view.
7
+ *
8
+ * @type {number}
9
+ * @default 19
10
+ */
2
11
  maxZoom: number;
12
+ /**
13
+ * The minimum zoom level allowed.
14
+ *
15
+ * @type {number}
16
+ */
3
17
  minZoom: number;
18
+ /**
19
+ * The opacity of an element.
20
+ *
21
+ * @type {number}
22
+ * @default 0.6
23
+ */
4
24
  opacity: number;
25
+ /**
26
+ * Represents the tiles URL.
27
+ * @typedef {string} url
28
+ *
29
+ * @example
30
+ * 'https://example.ex/{z}/{x}/{y}.png'
31
+ */
5
32
  url: string;
33
+ /**
34
+ * The projection of the coordinate system.
35
+ *
36
+ * @type {string}
37
+ * @default 'EPSG:3857'
38
+ */
6
39
  projection: string;
40
+ /**
41
+ * Creates a copy of the given tile layer settings.
42
+ *
43
+ * @param {TileLayerSettings} model - The tile layer settings to be copied.
44
+ * @return {TileLayerSettings} - A new instance of TileLayerSettings with the same properties as the model.
45
+ */
7
46
  static copy(model: TileLayerSettings): TileLayerSettings;
47
+ /**
48
+ * Sets the URL of the TileLayerSettings object.
49
+ *
50
+ * @param {string} url - The URL to be set.
51
+ * @return {TileLayerSettings} - The updated TileLayerSettings object.
52
+ */
8
53
  setUrl(url: string): TileLayerSettings;
54
+ /**
55
+ * Sets the maximum zoom level for the tile layer.
56
+ *
57
+ * @param {number} maxZoom - The maximum zoom level.
58
+ * @returns {TileLayerSettings} - The updated tile layer settings object.
59
+ */
9
60
  setMaxZoom(maxZoom: number): TileLayerSettings;
61
+ /**
62
+ * Sets the minimum zoom level for the Tile Layer.
63
+ *
64
+ * @param {number} minZoom - The minimum zoom level to be set.
65
+ * @return {TileLayerSettings} The modified TileLayerSettings object with the updated minimum zoom level.
66
+ */
10
67
  setMinZoom(minZoom: number): TileLayerSettings;
68
+ /**
69
+ * Sets the opacity of the TileLayerSettings.
70
+ *
71
+ * @param {number} opacity - The opacity value to set. Must be a number between 0 and 1.
72
+ * @return {TileLayerSettings} - A new instance of TileLayerSettings with the opacity set.
73
+ */
11
74
  setOpacity(opacity: number): TileLayerSettings;
75
+ /**
76
+ * Sets the projection for the tile layer settings.
77
+ *
78
+ * @param {string} projection - The desired projection for the tile layer settings.
79
+ * @return {TileLayerSettings} - The updated tile layer settings with the new projection.
80
+ */
12
81
  setProjection(projection: string): TileLayerSettings;
82
+ /**
83
+ * Checks if the current instance of TileLayerSettings is equal to the given model.
84
+ * @param {TileLayerSettings} model - The model to compare against.
85
+ * @return {boolean} - True if all properties of the current instance matches the properties of the model;
86
+ * otherwise, false.
87
+ */
13
88
  isSame(model: TileLayerSettings): boolean;
14
89
  }
@@ -15,13 +15,13 @@ export declare class MapPlateComponent extends DestructibleComponent implements
15
15
  private detector;
16
16
  map: Map;
17
17
  osmUrl: string;
18
+ drawingLayerSettings: FeatureLayerSettings;
18
19
  constructor(elementRef: ElementRef, postboy: MapPostboyService, mapFactory: MapPlateFactory, registrator: MessageRegistratorService, detector: ChangeDetectorRef);
19
20
  _settings: MapSettings;
20
- drawingLayerSettings: FeatureLayerSettings;
21
21
  set settings(value: MapSettings | undefined);
22
22
  ngOnInit(): void;
23
- private setOsm;
24
23
  onDestroy: () => void;
24
+ private setOsm;
25
25
  static ɵfac: i0.ɵɵFactoryDeclaration<MapPlateComponent, never>;
26
26
  static ɵcmp: i0.ɵɵComponentDeclaration<MapPlateComponent, "art-map-plate", never, { "settings": { "alias": "settings"; "required": false; }; }, {}, never, ["*"], false, never>;
27
27
  }
@@ -8,19 +8,19 @@ export declare class TooltipComponent extends DestructibleComponent implements O
8
8
  private postboy;
9
9
  private detector;
10
10
  container: ElementRef<HTMLElement>;
11
- _settings: TooltipSettings;
12
- private map?;
13
11
  overlay?: Overlay;
14
12
  show: boolean;
15
- set settings(value: TooltipSettings | undefined);
13
+ private map?;
16
14
  constructor(postboy: MapPostboyService, detector: ChangeDetectorRef);
15
+ _settings: TooltipSettings;
16
+ set settings(value: TooltipSettings | undefined);
17
17
  ngOnInit(): void;
18
+ addOverlay(coordinates: number[]): void;
19
+ options: (coordinates: number[]) => OverlayOptions;
18
20
  private observeMapClick;
19
21
  private observeClose;
20
22
  private observeMapRender;
21
23
  private removeOverlay;
22
- addOverlay(coordinates: number[]): void;
23
- options: (coordinates: number[]) => OverlayOptions;
24
24
  static ɵfac: i0.ɵɵFactoryDeclaration<TooltipComponent, never>;
25
25
  static ɵcmp: i0.ɵɵComponentDeclaration<TooltipComponent, "art-tooltip", never, { "settings": { "alias": "settings"; "required": false; }; }, {}, never, ["*"], false, never>;
26
26
  }
@@ -2,9 +2,9 @@ import { MapClickEvent } from '../../../messages';
2
2
  export declare class TooltipSettings {
3
3
  readonly id: string;
4
4
  containerClass: string;
5
- show: (ev: MapClickEvent) => boolean;
6
5
  constructor(id?: string);
7
6
  static copy(model: TooltipSettings): TooltipSettings;
7
+ show: (ev: MapClickEvent) => boolean;
8
8
  setShow(show: (ev: MapClickEvent) => boolean): TooltipSettings;
9
9
  setClass(containerClass: string): TooltipSettings;
10
10
  isSame(model: TooltipSettings): boolean;
@@ -1,8 +1,8 @@
1
1
  import { PostboyGenericMessage } from '@artstesh/postboy';
2
+ import { MapPosition } from '../../models';
2
3
  export declare class MapMoveEndEvent extends PostboyGenericMessage {
3
- zoom: number;
4
- extent: number[];
4
+ position: MapPosition | null;
5
5
  static readonly ID: string;
6
- constructor(zoom: number, extent: number[]);
6
+ constructor(position: MapPosition | null);
7
7
  get id(): string;
8
8
  }