@syncfusion/ej2-maps 20.4.49 → 21.1.35

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 (55) hide show
  1. package/CHANGELOG.md +4 -20
  2. package/dist/ej2-maps.min.js +2 -2
  3. package/dist/ej2-maps.umd.min.js +2 -2
  4. package/dist/ej2-maps.umd.min.js.map +1 -1
  5. package/dist/es6/ej2-maps.es2015.js +993 -236
  6. package/dist/es6/ej2-maps.es2015.js.map +1 -1
  7. package/dist/es6/ej2-maps.es5.js +1008 -236
  8. package/dist/es6/ej2-maps.es5.js.map +1 -1
  9. package/dist/global/ej2-maps.min.js +2 -2
  10. package/dist/global/ej2-maps.min.js.map +1 -1
  11. package/dist/global/index.d.ts +1 -1
  12. package/package.json +13 -13
  13. package/src/maps/layers/bubble.d.ts +2 -0
  14. package/src/maps/layers/bubble.js +2 -1
  15. package/src/maps/layers/color-mapping.d.ts +1 -0
  16. package/src/maps/layers/color-mapping.js +1 -0
  17. package/src/maps/layers/data-label.d.ts +1 -0
  18. package/src/maps/layers/data-label.js +9 -4
  19. package/src/maps/layers/layer-panel.js +1 -0
  20. package/src/maps/layers/legend.d.ts +2 -0
  21. package/src/maps/layers/legend.js +2 -0
  22. package/src/maps/layers/marker.d.ts +5 -0
  23. package/src/maps/layers/marker.js +42 -3
  24. package/src/maps/layers/navigation-selected-line.d.ts +1 -0
  25. package/src/maps/layers/navigation-selected-line.js +1 -0
  26. package/src/maps/maps-model.d.ts +47 -33
  27. package/src/maps/maps.d.ts +144 -88
  28. package/src/maps/maps.js +217 -61
  29. package/src/maps/model/base-model.d.ts +535 -230
  30. package/src/maps/model/base.d.ts +540 -263
  31. package/src/maps/model/base.js +168 -28
  32. package/src/maps/model/constants.d.ts +12 -0
  33. package/src/maps/model/constants.js +12 -0
  34. package/src/maps/model/export-image.d.ts +1 -1
  35. package/src/maps/model/export-image.js +1 -1
  36. package/src/maps/model/export-pdf.d.ts +2 -2
  37. package/src/maps/model/export-pdf.js +2 -2
  38. package/src/maps/model/interface.d.ts +137 -108
  39. package/src/maps/model/theme.d.ts +1 -0
  40. package/src/maps/model/theme.js +1 -0
  41. package/src/maps/user-interaction/annotation.d.ts +2 -0
  42. package/src/maps/user-interaction/annotation.js +2 -0
  43. package/src/maps/user-interaction/highlight.d.ts +1 -0
  44. package/src/maps/user-interaction/highlight.js +1 -0
  45. package/src/maps/user-interaction/selection.d.ts +1 -0
  46. package/src/maps/user-interaction/selection.js +1 -0
  47. package/src/maps/user-interaction/tooltip.d.ts +16 -0
  48. package/src/maps/user-interaction/tooltip.js +23 -6
  49. package/src/maps/user-interaction/zoom.d.ts +99 -3
  50. package/src/maps/user-interaction/zoom.js +405 -100
  51. package/src/maps/utils/enum.d.ts +105 -91
  52. package/src/maps/utils/helper.d.ts +76 -16
  53. package/src/maps/utils/helper.js +122 -37
  54. package/.eslintrc.json +0 -259
  55. package/tslint.json +0 -111
@@ -31,7 +31,7 @@ import { IBubbleRenderingEventArgs, IAnimationCompleteEventArgs, IPrintEventArgs
31
31
  import { LayerPanel } from './layers/layer-panel';
32
32
  import { GeoLocation, Rect } from '../maps/utils/helper';
33
33
  import { Annotations } from '../maps/user-interaction/annotation';
34
- import { DataLabel, IAnnotationRenderingEventArgs } from './index';
34
+ import { DataLabel, IAnnotationRenderingEventArgs, IMarkerDragEventArgs } from './index';
35
35
  import { NavigationLine } from './layers/navigation-selected-line';
36
36
  import { ExportType } from '../maps/utils/enum';
37
37
  import { PdfPageOrientation } from '@syncfusion/ej2-pdf-export';
@@ -39,7 +39,8 @@ import { Print } from './model/print';
39
39
  import { PdfExport } from './model/export-pdf';
40
40
  import { ImageExport } from './model/export-image';
41
41
  /**
42
- * Represents the Maps control.
42
+ * Represents the maps control. It is ideal for rendering maps from GeoJSON data or other map providers like OpenStreetMap, Google Maps, Bing Maps, etc that
43
+ * has rich feature set that includes markers, labels, bubbles and much more.
43
44
  * ```html
44
45
  * <div id="maps"/>
45
46
  * <script>
@@ -50,65 +51,85 @@ import { ImageExport } from './model/export-image';
50
51
  */
51
52
  export declare class Maps extends Component<HTMLElement> implements INotifyPropertyChanged {
52
53
  /**
53
- * Sets and gets the module to add bubbles in the maps component.
54
+ * Gets or sets the module to add bubbles in the maps.
55
+ *
56
+ * @private
54
57
  */
55
58
  bubbleModule: Bubble;
56
59
  /**
57
- * Sets and get the module to add the marker in the maps component.
60
+ * Sets and get the module to add the marker in the maps.
61
+ *
62
+ * @private
58
63
  */
59
64
  markerModule: Marker;
60
65
  /**
61
- * Sets and gets the module to add the data-label in the maps component.
66
+ * Gets or sets the module to add the data-label in the maps.
67
+ *
68
+ * @private
62
69
  */
63
70
  dataLabelModule: DataLabel;
64
71
  /**
65
- * Sets and gets the module to highlight the element when mouse has hovered on it in maps.
72
+ * Gets or sets the module to highlight the element when mouse has hovered on it in maps.
73
+ *
74
+ * @private
66
75
  */
67
76
  highlightModule: Highlight;
68
77
  /**
69
- * Sets and gets the module to add the navigation lines in the maps component.
78
+ * Gets or sets the module to add the navigation lines in the maps.
79
+ *
80
+ * @private
70
81
  */
71
82
  navigationLineModule: NavigationLine;
72
83
  /**
73
- * Sets and gets the module to add the legend in maps.
84
+ * Gets or sets the module to add the legend in maps.
85
+ *
86
+ * @private
74
87
  */
75
88
  legendModule: Legend;
76
89
  /**
77
- * Sets and gets the module to select the geometric shapes when clicking in maps.
90
+ * Gets or sets the module to select the geometric shapes when clicking in maps.
91
+ *
92
+ * @private
78
93
  */
79
94
  selectionModule: Selection;
80
95
  /**
81
- * Sets and gets the module to add the tooltip when mouse has hovered on an element in maps.
96
+ * Gets or sets the module to add the tooltip when mouse has hovered on an element in maps.
97
+ *
98
+ * @private
82
99
  */
83
100
  mapsTooltipModule: MapsTooltip;
84
101
  /**
85
- * Sets and gets the module to add the zooming operations in maps.
102
+ * Gets or sets the module to add the zooming operations in maps.
103
+ *
104
+ * @private
86
105
  */
87
106
  zoomModule: Zoom;
88
107
  /**
89
- * Sets and gets the module to add annotation elements in maps.
108
+ * Gets or sets the module to add annotation elements in maps.
109
+ *
110
+ * @private
90
111
  */
91
112
  annotationsModule: Annotations;
92
113
  /**
93
- * This module enables the print functionality in Maps control.
114
+ * This module enables the print functionality in maps.
94
115
  *
95
116
  * @private
96
117
  */
97
118
  printModule: Print;
98
119
  /**
99
- * This module enables the export to PDF functionality in Maps control.
120
+ * This module enables the export to PDF functionality in maps.
100
121
  *
101
122
  * @private
102
123
  */
103
124
  pdfExportModule: PdfExport;
104
125
  /**
105
- * This module enables the export to image functionality in Maps control.
126
+ * This module enables the export to image functionality in maps.
106
127
  *
107
128
  * @private
108
129
  */
109
130
  imageExportModule: ImageExport;
110
131
  /**
111
- * Sets and gets the background color of the maps container.
132
+ * Gets or sets the background color of the maps container.
112
133
  *
113
134
  * @default null
114
135
  */
@@ -120,25 +141,25 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
120
141
  */
121
142
  useGroupingSeparator: boolean;
122
143
  /**
123
- * Sets and gets the format in which the text in the maps are to be rendered.
144
+ * Gets or sets the format to apply internationalization for the text in the maps.
124
145
  *
125
146
  * @default null
126
147
  */
127
148
  format: string;
128
149
  /**
129
- * Sets and gets the width in which the maps is to be rendered.
150
+ * Gets or sets the width in which the maps is to be rendered.
130
151
  *
131
152
  * @default null
132
153
  */
133
154
  width: string;
134
155
  /**
135
- * Sets and gets the height in which the maps is to be rendered.
156
+ * Gets or sets the height in which the maps is to be rendered.
136
157
  *
137
158
  * @default null
138
159
  */
139
160
  height: string;
140
161
  /**
141
- * Sets and gets the mode in which the tooltip is to be displayed.
162
+ * Gets or sets the mode in which the tooltip is to be displayed.
142
163
  * The tooltip can be rendered on mouse move, click or double clicking on the
143
164
  * element on the map.
144
165
  *
@@ -146,91 +167,91 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
146
167
  */
147
168
  tooltipDisplayMode: TooltipGesture;
148
169
  /**
149
- * Enables or disables the print functionality in map.
170
+ * Enables or disables the print functionality in maps.
150
171
  *
151
172
  * @default false
152
173
  */
153
174
  allowPrint: boolean;
154
175
  /**
155
- * Enables or disables the export to image functionality in map.
176
+ * Enables or disables the export to image functionality in maps.
156
177
  *
157
178
  * @default false
158
179
  */
159
180
  allowImageExport: boolean;
160
181
  /**
161
- * Enables or disables the export to PDF functionality in map.
182
+ * Enables or disables the export to PDF functionality in maps.
162
183
  *
163
184
  * @default false
164
185
  */
165
186
  allowPdfExport: boolean;
166
187
  /**
167
- * Sets and gets the title to be displayed for maps.
188
+ * Gets or sets the options to customize the title of the maps.
168
189
  */
169
190
  titleSettings: TitleSettingsModel;
170
191
  /**
171
- * Sets and gets the options to customize the zooming operations in maps.
192
+ * Gets or sets the options to customize the zooming operations in maps.
172
193
  */
173
194
  zoomSettings: ZoomSettingsModel;
174
195
  /**
175
- * Sets and gets the options to customize the legend of the maps.
196
+ * Gets or sets the options to customize the legend of the maps.
176
197
  */
177
198
  legendSettings: LegendSettingsModel;
178
199
  /**
179
- * Sets and gets the options to customize the layers of the maps.
200
+ * Gets or sets the options to customize the layers of the maps.
180
201
  */
181
202
  layers: LayerSettingsModel[];
182
203
  /**
183
- * Sets and gets the options for customizing the annotation of maps.
204
+ * Gets or sets the options for customizing the annotations in the maps.
184
205
  */
185
206
  annotations: AnnotationModel[];
186
207
  /**
187
- * Sets and gets the options to customize the margins of the maps.
208
+ * Gets or sets the options to customize the margin of the maps.
188
209
  */
189
210
  margin: MarginModel;
190
211
  /**
191
- * Sets and gets the options for customizing the color and width of the maps border.
212
+ * Gets or sets the options for customizing the style properties of the maps border.
192
213
  */
193
214
  border: BorderModel;
194
215
  /**
195
- * Set and gets the theme supported for the maps.
216
+ * Gets or sets the theme styles supported for maps. When the theme is set, the styles associated with the theme will be set in the maps.
196
217
  *
197
218
  * @default Material
198
219
  */
199
220
  theme: MapsTheme;
200
221
  /**
201
- * Sets and gets the projection type for the maps.
222
+ * Gets or sets the projection with which the maps will be rendered to show the two-dimensional curved surface of a globe on a plane.
202
223
  *
203
224
  * @default Mercator
204
225
  */
205
226
  projectionType: ProjectionType;
206
227
  /**
207
- * Sets and gets the base map index of maps. It provides the option to select which layer to be visible in the maps.
228
+ * Gets or sets the index of the layer of maps which will be the base layer. It provides the option to select which layer to be visible in the maps.
208
229
  *
209
230
  * @default 0
210
231
  */
211
232
  baseLayerIndex: number;
212
233
  /**
213
- * Sets and gets the description for maps.
234
+ * Gets or sets the description of the maps for assistive technology.
214
235
  *
215
236
  * @default null
216
237
  */
217
238
  description: string;
218
239
  /**
219
- * Sets and gets the tab index value for the maps.
240
+ * Gets or sets the tab index value for the maps.
220
241
  *
221
242
  * @default 1
222
243
  */
223
244
  tabIndex: number;
224
245
  /**
225
- * Sets and gets the center position of the maps.
246
+ * Gets or sets the center position of the maps.
226
247
  */
227
248
  centerPosition: CenterPositionModel;
228
249
  /**
229
- * Sets and gets the options to customize the area around the map.
250
+ * Gets or sets the options to customize the area around the map.
230
251
  */
231
252
  mapsArea: MapsAreaSettingsModel;
232
253
  /**
233
- * Triggers when the map is on load.
254
+ * Triggers before the maps gets rendered.
234
255
  *
235
256
  * @event load
236
257
  */
@@ -273,7 +294,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
273
294
  */
274
295
  rightClick: EmitType<IMouseEventArgs>;
275
296
  /**
276
- * Triggers when resizing the maps.
297
+ * Triggers to notify the resize of the maps when the window is resized.
277
298
  *
278
299
  * @event resize
279
300
  */
@@ -299,25 +320,25 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
299
320
  */
300
321
  tooltipRenderComplete: EmitType<ITooltipRenderCompleteEventArgs>;
301
322
  /**
302
- * Triggers when clicking a shape in maps.
323
+ * Triggers when a shape is selected in the maps.
303
324
  *
304
325
  * @event shapeSelected
305
326
  */
306
327
  shapeSelected: EmitType<IShapeSelectedEventArgs>;
307
328
  /**
308
- * Triggers when clicking the shape on maps and before the selection is applied.
329
+ * Triggers before the shape, bubble or marker gets selected.
309
330
  *
310
331
  * @event itemSelection
311
332
  */
312
333
  itemSelection: EmitType<ISelectionEventArgs>;
313
334
  /**
314
- * Trigger when mouse move on the shape in maps and before the shape gets highlighted.
335
+ * Trigger before the shape, bubble or marker gets highlighted.
315
336
  *
316
337
  * @event itemHighlight
317
338
  */
318
339
  itemHighlight: EmitType<ISelectionEventArgs>;
319
340
  /**
320
- * Triggers when mouse move on the shape in maps and before the shape gets highlighted.
341
+ * Triggers before the shape gets highlighted.
321
342
  *
322
343
  * @event shapeHighlight
323
344
  */
@@ -347,11 +368,23 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
347
368
  */
348
369
  markerClusterRendering: EmitType<IMarkerClusterRenderingEventArgs>;
349
370
  /**
350
- * Triggers when clicking on the maps marker element.
371
+ * Triggers when clicking on a marker element.
351
372
  *
352
373
  * @event markerClick
353
374
  */
354
375
  markerClick: EmitType<IMarkerClickEventArgs>;
376
+ /**
377
+ * When the marker begins to drag on the map, this event is triggered.
378
+ *
379
+ * @event markerDragStart
380
+ */
381
+ markerDragStart: EmitType<IMarkerDragEventArgs>;
382
+ /**
383
+ * When the marker has stopped dragging on the map, this event is triggered.
384
+ *
385
+ * @event markerDragEnd
386
+ */
387
+ markerDragEnd: EmitType<IMarkerDragEventArgs>;
355
388
  /**
356
389
  * Triggers when clicking the marker cluster in maps.
357
390
  *
@@ -395,19 +428,19 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
395
428
  */
396
429
  bubbleMouseMove: EmitType<IBubbleMoveEventArgs>;
397
430
  /**
398
- * Triggers after the animation completed in the maps component.
431
+ * Triggers after the animation is completed in the maps.
399
432
  *
400
433
  * @event animationComplete
401
434
  */
402
435
  animationComplete: EmitType<IAnimationCompleteEventArgs>;
403
436
  /**
404
- * Triggers before rendering the annotation in maps.
437
+ * Triggers before rendering an annotation in the maps.
405
438
  *
406
439
  * @event annotationRendering
407
440
  */
408
441
  annotationRendering: EmitType<IAnnotationRenderingEventArgs>;
409
442
  /**
410
- * Triggers before the zoom operations in the maps such as zoom in and zoom out.
443
+ * Triggers before the zoom operations such as zoom in and zoom out in the maps.
411
444
  *
412
445
  * @event zoom
413
446
  */
@@ -513,7 +546,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
513
546
  *
514
547
  * Specifies whether the shape is selected in the maps or not.
515
548
  *
516
- * @returns {boolean} - Returns the boolean value.
549
+ * @returns {boolean} - Returns a boolean value to specify whether the shape is selected in the maps or not.
517
550
  */
518
551
  readonly isShapeSelected: boolean;
519
552
  dataLabel: DataLabel;
@@ -593,6 +626,8 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
593
626
  /** @private */
594
627
  serverProcess: any;
595
628
  /** @private */
629
+ toolbarProperties: any;
630
+ /** @private */
596
631
  previousScale: number;
597
632
  /** @private */
598
633
  previousPoint: Point;
@@ -661,6 +696,8 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
661
696
  /** @private */
662
697
  previousTileWidth: number;
663
698
  /** @private */
699
+ markerDragId: string;
700
+ /** @private */
664
701
  previousTileHeight: number;
665
702
  /** @private */
666
703
  initialZoomLevel: number;
@@ -673,7 +710,11 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
673
710
  /** @private */
674
711
  markerClusterExpand: boolean;
675
712
  /** @private */
713
+ mouseMoveId: string;
714
+ /** @private */
676
715
  shapeSelectionItem: any[];
716
+ /** @private */
717
+ markerDragArgument: any;
677
718
  /**
678
719
  * Constructor for creating the widget
679
720
  *
@@ -692,6 +733,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
692
733
  *
693
734
  * @param {string} key - Specifies the key
694
735
  * @returns {string} - Returns the string value
736
+ * @private
695
737
  */
696
738
  getLocalizedLabel(key: string): string;
697
739
  /**
@@ -717,6 +759,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
717
759
  * @param {LayerSettings} layer - Specifies the layer for the maps.
718
760
  * @param {string} dataType - Specifies the data type for maps.
719
761
  * @returns {void}
762
+ * @private
720
763
  */
721
764
  processResponseJsonData(processType: string, data?: any | string, layer?: LayerSettings, dataType?: string): void;
722
765
  private renderMap;
@@ -817,6 +860,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
817
860
  *
818
861
  * @param {PointerEvent} e - Specifies the pointer event on maps.
819
862
  * @returns {void}
863
+ * @private
820
864
  */
821
865
  mouseLeaveOnMap(e: PointerEvent): void;
822
866
  private keyUpHandler;
@@ -835,10 +879,12 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
835
879
  *
836
880
  * @param {PointerEvent} e - Specifies the pointer event on maps.
837
881
  * @returns {void}
882
+ * @private
838
883
  */
839
884
  mapsOnClick(e: PointerEvent): void;
840
885
  private clickHandler;
841
886
  private triggerShapeSelection;
887
+ private getMarkerClickLocation;
842
888
  private getClickLocation;
843
889
  private removeTileMap;
844
890
  /**
@@ -846,6 +892,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
846
892
  *
847
893
  * @param {PointerEvent} e - Specifies the pointer event on maps.
848
894
  * @returns {boolean} - Returns the boolean value
895
+ * @private
849
896
  */
850
897
  mouseEndOnMap(e: PointerEvent): boolean;
851
898
  /**
@@ -853,6 +900,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
853
900
  *
854
901
  * @param {PointerEvent} e - Specifies the pointer event on maps
855
902
  * @returns {void}
903
+ * @private
856
904
  */
857
905
  mouseDownOnMap(e: PointerEvent): void;
858
906
  /**
@@ -862,11 +910,18 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
862
910
  * @private
863
911
  */
864
912
  mergeCluster(): void;
913
+ /**
914
+ * @param {PointerEvent} e - Specifies the pointer event.
915
+ * @returns {void}
916
+ * @private
917
+ */
918
+ mapsOnRightClick(e: PointerEvent): void;
865
919
  /**
866
920
  * This method is used to perform operations when performing the double click operation on maps.
867
921
  *
868
922
  * @param {PointerEvent} e - Specifies the pointer event.
869
923
  * @returns {void}
924
+ * @private
870
925
  */
871
926
  mapsOnDoubleClick(e: PointerEvent): void;
872
927
  /**
@@ -874,6 +929,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
874
929
  *
875
930
  * @param {PointerEvent} e - Specifies the pointer event on maps.
876
931
  * @returns {void}
932
+ * @private
877
933
  */
878
934
  mouseMoveOnMap(e: PointerEvent): void;
879
935
  /**
@@ -881,6 +937,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
881
937
  *
882
938
  * @param {PointerEvent} e - Specifies the pointer event on maps.
883
939
  * @returns {void}
940
+ * @private
884
941
  */
885
942
  onMouseMove(e: PointerEvent): boolean;
886
943
  private legendTooltip;
@@ -889,10 +946,8 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
889
946
  /**
890
947
  * This method is used to zoom the map by specifying the center position.
891
948
  *
892
- * @param {number} centerPosition - Specifies the center position
893
- * @param {number} centerPosition.latitude - Specifies the latitude value for the center position
894
- * @param {number} centerPosition.longitude - Specifies the longitude value for the center position
895
- * @param {number} zoomFactor - Specifies the zoom factor for maps.
949
+ * @param {number} centerPosition - Specifies the location of the maps to be zoomed as geographical coordinates.
950
+ * @param {number} zoomFactor - Specifies the zoom factor for the maps.
896
951
  * @returns {void}
897
952
  */
898
953
  zoomByPosition(centerPosition: {
@@ -902,20 +957,20 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
902
957
  /**
903
958
  * This method is used to perform panning by specifying the direction.
904
959
  *
905
- * @param {PanDirection} direction - Specifies the direction in which the panning is performed.
906
- * @param {PointerEvent | TouchEvent} mouseLocation - Specifies the location of the mouse pointer in maps.
960
+ * @param {PanDirection} direction - Specifies the direction in which the panning must be performed.
961
+ * @param {PointerEvent | TouchEvent} mouseLocation - Specifies the location of the mouse pointer in maps in pixels.
907
962
  * @returns {void}
908
963
  */
909
964
  panByDirection(direction: PanDirection, mouseLocation?: PointerEvent | TouchEvent): void;
910
965
  /**
911
966
  * This method is used to add the layers dynamically to the maps.
912
967
  *
913
- * @param {Object} layer - Specifies the layer for the maps.
968
+ * @param {Object} layer - Specifies the layer to be added in the maps.
914
969
  * @returns {void}
915
970
  */
916
971
  addLayer(layer: Object): void;
917
972
  /**
918
- * This method is used to remove a layer from map.
973
+ * This method is used to remove a layer from the maps.
919
974
  *
920
975
  * @param {number} index - Specifies the index number of the layer to be removed.
921
976
  * @returns {void}
@@ -923,7 +978,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
923
978
  removeLayer(index: number): void;
924
979
  /**
925
980
  * This method is used to add markers dynamically in the maps.
926
- * If we provide the index value of the layer in which the marker to be added and the coordinates
981
+ * If we provide the index value of the layer in which the marker to be added and the settings
927
982
  * of the marker as parameters, the marker will be added in the location.
928
983
  *
929
984
  * @param {number} layerIndex - Specifies the index number of the layer.
@@ -932,22 +987,22 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
932
987
  */
933
988
  addMarker(layerIndex: number, markerCollection: MarkerSettingsModel[]): void;
934
989
  /**
935
- * This method is used to select the geometric shape element in the maps component.
990
+ * This method is used to select the geometric shape element in the maps.
936
991
  *
937
992
  * @param {number} layerIndex - Specifies the index of the layer in maps.
938
993
  * @param {string | string[]} propertyName - Specifies the property name from the data source.
939
- * @param {string} name - Specifies the name of the shape that is selected.
940
- * @param {boolean} enable - Specifies the shape selection to be enabled.
994
+ * @param {string} name - Specifies the name of the shape, which is mapped from the data source, that is selected.
995
+ * @param {boolean} enable - Specifies whether the shape should be selected or the selection should be removed.
941
996
  * @returns {void}
942
997
  */
943
998
  shapeSelection(layerIndex: number, propertyName: string | string[], name: string, enable?: boolean): void;
944
999
  /**
945
- * This method is used to zoom the maps component based on the provided coordinates.
1000
+ * This method is used to zoom the maps based on the provided coordinates.
946
1001
  *
947
- * @param {number} minLatitude - Specifies the minimum latitude to be zoomed.
948
- * @param {number} minLongitude - Specifies the minimum latitude to be zoomed.
949
- * @param {number} maxLatitude - Specifies the maximum latitude to be zoomed.
950
- * @param {number} maxLongitude - Specifies the maximum longitude to be zoomed.
1002
+ * @param {number} minLatitude - Specifies the minimum latitude of the location to be zoomed.
1003
+ * @param {number} minLongitude - Specifies the minimum latitude of the location to be zoomed.
1004
+ * @param {number} maxLatitude - Specifies the maximum latitude of the location to be zoomed.
1005
+ * @param {number} maxLongitude - Specifies the maximum longitude of the location to be zoomed.
951
1006
  * @returns {void}
952
1007
  */
953
1008
  zoomToCoordinates(minLatitude: number, minLongitude: number, maxLatitude: number, maxLongitude: number): void;
@@ -958,19 +1013,19 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
958
1013
  */
959
1014
  private removeShapeSelection;
960
1015
  /**
961
- * This method is used to set culture for maps component.
1016
+ * This method is used to set culture for maps.
962
1017
  *
963
1018
  * @returns {void}
964
1019
  */
965
1020
  private setCulture;
966
1021
  /**
967
- * This method to set locale constants to the maps component.
1022
+ * This method to set locale constants to the maps.
968
1023
  *
969
1024
  * @returns {void}
970
1025
  */
971
1026
  private setLocaleConstants;
972
1027
  /**
973
- * This method disposes the maps component.
1028
+ * This method destroys the maps. This method removes the events associated with the maps and disposes the objects created for rendering and updating the maps.
974
1029
  *
975
1030
  * @returns {void}
976
1031
  */
@@ -979,6 +1034,7 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
979
1034
  * Gets component name
980
1035
  *
981
1036
  * @returns {string} - Returns the string value
1037
+ * @private
982
1038
  */
983
1039
  getModuleName(): string;
984
1040
  /**
@@ -1042,27 +1098,27 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
1042
1098
  */
1043
1099
  getBubbleVisible(layer: LayerSettingsModel): boolean;
1044
1100
  /**
1045
- * This method handles the printing functionality for the maps component.
1101
+ * This method handles the printing functionality for the maps.
1046
1102
  *
1047
1103
  * @param {string[] | string | Element} id - Specifies the element to be printed.
1048
1104
  * @returns {void}
1049
1105
  */
1050
1106
  print(id?: string[] | string | Element): void;
1051
1107
  /**
1052
- * This method handles the export functionality for the maps component.
1108
+ * This method handles the export functionality for the maps.
1053
1109
  *
1054
1110
  * @param {ExportType} type - Specifies the type of the exported file.
1055
1111
  * @param {string} fileName - Specifies the name of the file with which the rendered maps need to be exported.
1056
- * @param {PdfPageOrientation} orientation - Specifies the orientation of the pdf document in exporting.
1057
- * @param {boolean} allowDownload - Specifies whether to download as a file or get as base64 string for the file
1058
- * @returns {Promise<string>} - Returns the string value.
1112
+ * @param {PdfPageOrientation} orientation - Specifies the orientation of the PDF document while exporting.
1113
+ * @param {boolean} allowDownload - Specifies whether to download as a file or get as base64 string for the file.
1114
+ * @returns {Promise<string>} - Specifies the base64 string of the exported image which is returned when the `allowDownload` is set to false.
1059
1115
  */
1060
1116
  export(type: ExportType, fileName: string, orientation?: PdfPageOrientation, allowDownload?: boolean): Promise<string>;
1061
1117
  /**
1062
1118
  * This method is used to get the Bing maps URL.
1063
1119
  *
1064
- * @param {string} url - Specifies the URL of the maps.
1065
- * @returns {Promise<string>} - Returns the processed Bing URL as Promise.
1120
+ * @param {string} url - Specifies the URL of the Bing maps along with the API key.
1121
+ * @returns {Promise<string>} - Returns the processed Bing URL as `Promise`.
1066
1122
  */
1067
1123
  getBingUrlTemplate(url: string): Promise<string>;
1068
1124
  /**
@@ -1078,29 +1134,29 @@ export declare class Maps extends Component<HTMLElement> implements INotifyPrope
1078
1134
  */
1079
1135
  private findVisibleLayers;
1080
1136
  /**
1081
- * This method is used to get the geo location points.
1137
+ * This method is used to get the geographical coordinates for location points in pixels when shape maps are rendered in the maps.
1082
1138
  *
1083
- * @param {number} layerIndex - Specifies the index number of the layer of the map.
1084
- * @param {number} x - Specifies the x value.
1085
- * @param {number} y - Specifies the y value.
1086
- * @returns {GeoPosition}- Returns the geo position
1139
+ * @param {number} layerIndex - Specifies the index number of the layer of the maps.
1140
+ * @param {number} x - Specifies the x value in pixel.
1141
+ * @param {number} y - Specifies the y value in pixel.
1142
+ * @returns {GeoPosition}- Returns the geographical coordinates.
1087
1143
  */
1088
1144
  getGeoLocation(layerIndex: number, x: number, y: number): GeoPosition;
1089
1145
  private clip;
1090
1146
  /**
1091
- * This method is used to get the geo location points when tile maps is rendered in the maps component.
1147
+ * This method is used to get the geographical coordinates for location points in pixels when an online map provider is rendered in the maps.
1092
1148
  *
1093
- * @param {number} x - Specifies the x value
1094
- * @param {number} y - Specifies the y value
1095
- * @returns {GeoPosition} - Returns the position
1149
+ * @param {number} x - Specifies the x value in pixel.
1150
+ * @param {number} y - Specifies the y value in pixel.
1151
+ * @returns {GeoPosition} - Returns the geographical coordinates.
1096
1152
  */
1097
1153
  getTileGeoLocation(x: number, y: number): GeoPosition;
1098
1154
  /**
1099
- * This method is used to convert the point to latitude and longitude in maps.
1155
+ * This method is used to convert the point in pixels to latitude and longitude in maps.
1100
1156
  *
1101
- * @param {number} pageX - Specifies the x value for the page.
1102
- * @param {number} pageY - Specifies the y value for the page.
1103
- * @returns {Object} - Returns the object.
1157
+ * @param {number} pageX - Specifies the x position value in pixels.
1158
+ * @param {number} pageY - Specifies the y position value in pixels.
1159
+ * @returns {Object} - Returns the latitude and longitude values.
1104
1160
  */
1105
1161
  pointToLatLong(pageX: number, pageY: number): Object;
1106
1162
  }