@inlog/inlog-maps 6.4.3 → 6.5.0

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 (61) hide show
  1. package/DOCUMENTATION.md +2033 -1870
  2. package/README.md +3 -2
  3. package/_bundles/inlog-maps.js +1 -1
  4. package/_bundles/inlog-maps.js.map +1 -1
  5. package/_bundles/inlog-maps.min.js +1 -1
  6. package/_bundles/inlog-maps.min.js.map +1 -1
  7. package/lib/index.d.ts +2 -0
  8. package/lib/index.js +2 -0
  9. package/lib/index.js.map +1 -1
  10. package/lib/map.d.ts +49 -2
  11. package/lib/map.js +131 -1
  12. package/lib/map.js.map +1 -1
  13. package/lib/models/apis/google/google-heatmap.d.ts +13 -0
  14. package/lib/models/apis/google/google-heatmap.js +128 -0
  15. package/lib/models/apis/google/google-heatmap.js.map +1 -0
  16. package/lib/models/apis/googleMaps.d.ts +7 -0
  17. package/lib/models/apis/googleMaps.js +24 -0
  18. package/lib/models/apis/googleMaps.js.map +1 -1
  19. package/lib/models/apis/leaflet/leaflet-heatmap.d.ts +12 -0
  20. package/lib/models/apis/leaflet/leaflet-heatmap.js +110 -0
  21. package/lib/models/apis/leaflet/leaflet-heatmap.js.map +1 -0
  22. package/lib/models/apis/leaflet/leaflet-polylines.js +3 -4
  23. package/lib/models/apis/leaflet/leaflet-polylines.js.map +1 -1
  24. package/lib/models/apis/leaflet.d.ts +7 -0
  25. package/lib/models/apis/leaflet.js +24 -0
  26. package/lib/models/apis/leaflet.js.map +1 -1
  27. package/lib/models/apis/mapFunctions.d.ts +6 -0
  28. package/lib/models/features/heatmap/heatmap-options.d.ts +21 -0
  29. package/lib/models/features/heatmap/heatmap-options.js +21 -0
  30. package/lib/models/features/heatmap/heatmap-options.js.map +1 -0
  31. package/lib/models/features/polygons/polygon-alter-options.d.ts +1 -1
  32. package/lib/models/features/polygons/polygon-alter-options.js +1 -1
  33. package/lib/models/features/polygons/polygon-alter-options.js.map +1 -1
  34. package/lib-esm/index.d.ts +2 -0
  35. package/lib-esm/index.js +2 -0
  36. package/lib-esm/index.js.map +1 -1
  37. package/lib-esm/map.d.ts +49 -2
  38. package/lib-esm/map.js +131 -1
  39. package/lib-esm/map.js.map +1 -1
  40. package/lib-esm/models/apis/google/google-heatmap.d.ts +13 -0
  41. package/lib-esm/models/apis/google/google-heatmap.js +128 -0
  42. package/lib-esm/models/apis/google/google-heatmap.js.map +1 -0
  43. package/lib-esm/models/apis/googleMaps.d.ts +7 -0
  44. package/lib-esm/models/apis/googleMaps.js +24 -0
  45. package/lib-esm/models/apis/googleMaps.js.map +1 -1
  46. package/lib-esm/models/apis/leaflet/leaflet-heatmap.d.ts +12 -0
  47. package/lib-esm/models/apis/leaflet/leaflet-heatmap.js +110 -0
  48. package/lib-esm/models/apis/leaflet/leaflet-heatmap.js.map +1 -0
  49. package/lib-esm/models/apis/leaflet/leaflet-polylines.js +3 -4
  50. package/lib-esm/models/apis/leaflet/leaflet-polylines.js.map +1 -1
  51. package/lib-esm/models/apis/leaflet.d.ts +7 -0
  52. package/lib-esm/models/apis/leaflet.js +24 -0
  53. package/lib-esm/models/apis/leaflet.js.map +1 -1
  54. package/lib-esm/models/apis/mapFunctions.d.ts +6 -0
  55. package/lib-esm/models/features/heatmap/heatmap-options.d.ts +21 -0
  56. package/lib-esm/models/features/heatmap/heatmap-options.js +21 -0
  57. package/lib-esm/models/features/heatmap/heatmap-options.js.map +1 -0
  58. package/lib-esm/models/features/polygons/polygon-alter-options.d.ts +1 -1
  59. package/lib-esm/models/features/polygons/polygon-alter-options.js +1 -1
  60. package/lib-esm/models/features/polygons/polygon-alter-options.js.map +1 -1
  61. package/package.json +2 -1
package/DOCUMENTATION.md CHANGED
@@ -1,1870 +1,2033 @@
1
- # [@inlog/inlog-maps](https://github.com/weareinlog/inlog-maps#readme) *6.4.3*
2
-
3
- > A library for using generic layer maps
4
-
5
-
6
- ### lib-esm/map.js
7
-
8
-
9
- #### Map.initialize(mapType, options, elementId)
10
-
11
- Use this to initialize map
12
-
13
-
14
-
15
-
16
- ##### Parameters
17
-
18
- | Name | Type | Description | |
19
- | ---- | ---- | ----------- | -------- |
20
- | mapType | `InlogMaps.MapType` | |   |
21
- | options | `any` | |   |
22
- | elementId | `string` | default: 'inlog-map' [nullable] |   |
23
-
24
-
25
-
26
-
27
- ##### Returns
28
-
29
-
30
- - `Promisse.<any>`
31
-
32
-
33
-
34
- #### Map.loadGEOJson(data, options, eventClick)
35
-
36
- Use this function to add GEOJSON to the currentMap
37
-
38
-
39
-
40
-
41
- ##### Parameters
42
-
43
- | Name | Type | Description | |
44
- | ---- | ---- | ----------- | -------- |
45
- | data | `object` | Geojson |   |
46
- | options | `InlogMaps.GeoJsonOptions` | |   |
47
- | eventClick | `any` | is a function callback on click [nullable] |   |
48
-
49
-
50
-
51
-
52
- ##### Returns
53
-
54
-
55
- - `Void`
56
-
57
-
58
-
59
- #### Map.drawMarker(type, options, eventClick)
60
-
61
- Use this function to draw markers in the currentMap
62
-
63
-
64
-
65
-
66
- ##### Parameters
67
-
68
- | Name | Type | Description | |
69
- | ---- | ---- | ----------- | -------- |
70
- | type | `string` | |   |
71
- | options | `InlogMaps.MarkerOptions` | |   |
72
- | eventClick | `any` | is a function callback on click [nullable] |   |
73
-
74
-
75
-
76
-
77
- ##### Returns
78
-
79
-
80
- - `Void`
81
-
82
-
83
-
84
- #### Map.drawCircleMarker(type, options, eventClick)
85
-
86
- Use this function to draw circle markers in the currentMap
87
-
88
-
89
-
90
-
91
- ##### Parameters
92
-
93
- | Name | Type | Description | |
94
- | ---- | ---- | ----------- | -------- |
95
- | type | `string` | |   |
96
- | options | `InlogMaps.CircleMarkerOptions` | |   |
97
- | eventClick | `any` | is a function callback on click [nullable] |   |
98
-
99
-
100
-
101
-
102
- ##### Returns
103
-
104
-
105
- - `Void`
106
-
107
-
108
-
109
- #### Map.toggleMarkers(show, type, condition)
110
-
111
- Use this function to show/hide markers from a specific type
112
-
113
-
114
-
115
-
116
- ##### Parameters
117
-
118
- | Name | Type | Description | |
119
- | ---- | ---- | ----------- | -------- |
120
- | show | `boolean` | |   |
121
- | type | `string` | |   |
122
- | condition | `any` | toogle markers with the condition [nullable] |   |
123
-
124
-
125
-
126
-
127
- ##### Returns
128
-
129
-
130
- - `Void`
131
-
132
-
133
-
134
- #### Map.removeMarkers(type, condition)
135
-
136
- Remove markers from the map and from internal list
137
-
138
-
139
-
140
-
141
- ##### Parameters
142
-
143
- | Name | Type | Description | |
144
- | ---- | ---- | ----------- | -------- |
145
- | type | `string` | |   |
146
- | condition | `any` | remove markers with the condition [nullable] |   |
147
-
148
-
149
-
150
-
151
- ##### Returns
152
-
153
-
154
- - `Void`
155
-
156
-
157
-
158
- #### Map.removeAllMarkers()
159
-
160
- Remove all markers from the map and from the internal list
161
-
162
-
163
-
164
-
165
-
166
-
167
- ##### Returns
168
-
169
-
170
- - `Void`
171
-
172
-
173
-
174
- #### Map.alterMarkerOptions(type, options, condition)
175
-
176
- Use this function to alter marker style
177
-
178
-
179
-
180
-
181
- ##### Parameters
182
-
183
- | Name | Type | Description | |
184
- | ---- | ---- | ----------- | -------- |
185
- | type | `string` | |   |
186
- | options | `InlogMaps.MarkerAlterOptions` | |   |
187
- | condition | `any` | alter markers with the condition [nullable] |   |
188
-
189
-
190
-
191
-
192
- ##### Returns
193
-
194
-
195
- - `Void`
196
-
197
-
198
-
199
- #### Map.alterMarkerPosition(type, position, addTransition, condition)
200
-
201
- Use this functions to alterar marker position
202
-
203
-
204
-
205
-
206
- ##### Parameters
207
-
208
- | Name | Type | Description | |
209
- | ---- | ---- | ----------- | -------- |
210
- | type | `string` | |   |
211
- | position | `Array.<number>` | | &nbsp; |
212
- | addTransition | `boolean` | [nullable] | &nbsp; |
213
- | condition | `any` | [nullable] | &nbsp; |
214
-
215
-
216
-
217
-
218
- ##### Returns
219
-
220
-
221
- - `Void`
222
-
223
-
224
-
225
- #### Map.fitBoundsMarkers(type, condition, onlyMarkersOnMap)
226
-
227
- Use this function to fit bounds in the markers with the especified type
228
-
229
-
230
-
231
-
232
- ##### Parameters
233
-
234
- | Name | Type | Description | |
235
- | ---- | ---- | ----------- | -------- |
236
- | type | `string` | | &nbsp; |
237
- | condition | `any` | [nullable] | &nbsp; |
238
- | onlyMarkersOnMap | `boolean` | default true | &nbsp; |
239
-
240
-
241
-
242
-
243
- ##### Returns
244
-
245
-
246
- - `Void`
247
-
248
-
249
-
250
- #### Map.setCenterMarker(type, condition)
251
-
252
- Use this functions to set the center of the map on marker
253
-
254
-
255
-
256
-
257
- ##### Parameters
258
-
259
- | Name | Type | Description | |
260
- | ---- | ---- | ----------- | -------- |
261
- | type | `string` | | &nbsp; |
262
- | condition | `any` | center on marker with the condition [nullable] | &nbsp; |
263
-
264
-
265
-
266
-
267
- ##### Returns
268
-
269
-
270
- - `Void`
271
-
272
-
273
-
274
- #### Map.markerExists(type, condition)
275
-
276
- This functions returns if marker exists
277
-
278
-
279
-
280
-
281
- ##### Parameters
282
-
283
- | Name | Type | Description | |
284
- | ---- | ---- | ----------- | -------- |
285
- | type | | | &nbsp; |
286
- | condition | | [nullable] | &nbsp; |
287
-
288
-
289
-
290
-
291
- ##### Returns
292
-
293
-
294
- - `boolean`
295
-
296
-
297
-
298
- #### Map.countMarkers(type, onlyOnMap, condition)
299
-
300
- Use this function to count markers by type
301
-
302
-
303
-
304
-
305
- ##### Parameters
306
-
307
- | Name | Type | Description | |
308
- | ---- | ---- | ----------- | -------- |
309
- | type | `string` | | &nbsp; |
310
- | onlyOnMap | `boolean` | exclude hidden markers, default true | &nbsp; |
311
- | condition | `any` | | &nbsp; |
312
-
313
-
314
-
315
-
316
- ##### Returns
317
-
318
-
319
- - `number`
320
-
321
-
322
-
323
- #### Map.addMarkerEvent(type, event, eventFunction, condition)
324
-
325
- This function add new events on marker
326
-
327
-
328
-
329
-
330
- ##### Parameters
331
-
332
- | Name | Type | Description | |
333
- | ---- | ---- | ----------- | -------- |
334
- | type | `string` | | &nbsp; |
335
- | event | `InlogMaps.MarkerEventType` | | &nbsp; |
336
- | eventFunction | `any` | | &nbsp; |
337
- | condition | `any` | [nullable] | &nbsp; |
338
-
339
-
340
-
341
-
342
- ##### Returns
343
-
344
-
345
- - `Void`
346
-
347
-
348
-
349
- #### Map.removeMarkerEvent(type, event, condition)
350
-
351
- This function remove events of marker
352
-
353
-
354
-
355
-
356
- ##### Parameters
357
-
358
- | Name | Type | Description | |
359
- | ---- | ---- | ----------- | -------- |
360
- | type | `string` | | &nbsp; |
361
- | event | `InlogMaps.MarkerEventType` | | &nbsp; |
362
- | condition | `any` | [nullable] | &nbsp; |
363
-
364
-
365
-
366
-
367
- ##### Returns
368
-
369
-
370
- - `Void`
371
-
372
-
373
-
374
- #### Map.addMarkerClusterer(type, config)
375
-
376
- Use this function to add MarkerClusterer on the map
377
-
378
-
379
-
380
-
381
- ##### Parameters
382
-
383
- | Name | Type | Description | |
384
- | ---- | ---- | ----------- | -------- |
385
- | type | `string` | same type of markers | &nbsp; |
386
- | config | `InlogMaps.MarkerClusterConfig` | | &nbsp; |
387
-
388
-
389
-
390
-
391
- ##### Returns
392
-
393
-
394
- - `Void`
395
-
396
-
397
-
398
- #### Map.alterMarkerClustererConfig(type, config)
399
-
400
- Use this function to alter clusterer options
401
-
402
-
403
-
404
-
405
- ##### Parameters
406
-
407
- | Name | Type | Description | |
408
- | ---- | ---- | ----------- | -------- |
409
- | type | | same type of markers | &nbsp; |
410
- | config | `InlogMaps.MarkerClusterConfig` | | &nbsp; |
411
-
412
-
413
-
414
-
415
- ##### Returns
416
-
417
-
418
- - `Void`
419
-
420
-
421
-
422
- #### Map.refreshClusterer(type)
423
-
424
- Use this function to redraw marker clusterer
425
-
426
-
427
-
428
-
429
- ##### Parameters
430
-
431
- | Name | Type | Description | |
432
- | ---- | ---- | ----------- | -------- |
433
- | type | | same type of markers | &nbsp; |
434
-
435
-
436
-
437
-
438
- ##### Returns
439
-
440
-
441
- - `Void`
442
-
443
-
444
-
445
- #### Map.clearMarkersClusterer(type)
446
-
447
- Use this to clear markers on clusterer
448
-
449
-
450
-
451
-
452
- ##### Parameters
453
-
454
- | Name | Type | Description | |
455
- | ---- | ---- | ----------- | -------- |
456
- | type | | same type of markers | &nbsp; |
457
-
458
-
459
-
460
-
461
- ##### Returns
462
-
463
-
464
- - `Void`
465
-
466
-
467
-
468
- #### Map.drawPolygon(type, options, eventClick)
469
-
470
- Use this function to draw polygons
471
-
472
-
473
-
474
-
475
- ##### Parameters
476
-
477
- | Name | Type | Description | |
478
- | ---- | ---- | ----------- | -------- |
479
- | type | `string` | | &nbsp; |
480
- | options | `InlogMaps.PolygonOptions` | | &nbsp; |
481
- | eventClick | `any` | [nullable] | &nbsp; |
482
-
483
-
484
-
485
-
486
- ##### Returns
487
-
488
-
489
- - `Void`
490
-
491
-
492
-
493
- #### Map.togglePolygons(show, type, condition)
494
-
495
- Use this function to show/hide polygon from a especific type
496
-
497
-
498
-
499
-
500
- ##### Parameters
501
-
502
- | Name | Type | Description | |
503
- | ---- | ---- | ----------- | -------- |
504
- | show | `boolean` | | &nbsp; |
505
- | type | `string` | | &nbsp; |
506
- | condition | `any` | toggle polygon with the condition [nullable] | &nbsp; |
507
-
508
-
509
-
510
-
511
- ##### Returns
512
-
513
-
514
- - `Void`
515
-
516
-
517
-
518
- #### Map.removePolygons(type, condition)
519
-
520
- Remove polygons from the map and from internal list
521
-
522
-
523
-
524
-
525
- ##### Parameters
526
-
527
- | Name | Type | Description | |
528
- | ---- | ---- | ----------- | -------- |
529
- | type | `string` | | &nbsp; |
530
- | condition | `any` | remove polygons with the condition [nullable] | &nbsp; |
531
-
532
-
533
-
534
-
535
- ##### Returns
536
-
537
-
538
- - `Void`
539
-
540
-
541
-
542
- #### Map.removeAllPolygons()
543
-
544
- Remove all polygons from the map and from the internal list
545
-
546
-
547
-
548
-
549
-
550
-
551
- ##### Returns
552
-
553
-
554
- - `Void`
555
-
556
-
557
-
558
- #### Map.alterPolygonOptions(type, options, condition)
559
-
560
- Use this function to alter polygons options/style
561
-
562
-
563
-
564
-
565
- ##### Parameters
566
-
567
- | Name | Type | Description | |
568
- | ---- | ---- | ----------- | -------- |
569
- | type | `string` | | &nbsp; |
570
- | options | `InlogMaps.PolygonAlterOptions` | | &nbsp; |
571
- | condition | `any` | alter polygon with the condition [nullable] | &nbsp; |
572
-
573
-
574
-
575
-
576
- ##### Returns
577
-
578
-
579
- - `Void`
580
-
581
-
582
-
583
- #### Map.fitBoundsPolygons(type, condition)
584
-
585
- Use this function to fit bounds of a polygon
586
-
587
-
588
-
589
-
590
- ##### Parameters
591
-
592
- | Name | Type | Description | |
593
- | ---- | ---- | ----------- | -------- |
594
- | type | `string` | | &nbsp; |
595
- | condition | `any` | fit polygon bounds with the condition [nullable] | &nbsp; |
596
-
597
-
598
-
599
-
600
- ##### Returns
601
-
602
-
603
- - `Void`
604
-
605
-
606
-
607
- #### Map.setCenterPolygons(type, condition)
608
-
609
- Set center on polygon bounds
610
-
611
-
612
-
613
-
614
- ##### Parameters
615
-
616
- | Name | Type | Description | |
617
- | ---- | ---- | ----------- | -------- |
618
- | type | `string` | | &nbsp; |
619
- | condition | `any` | fit polygon bounds with the condition [nullable] | &nbsp; |
620
-
621
-
622
-
623
-
624
- ##### Returns
625
-
626
-
627
- - `Void`
628
-
629
-
630
-
631
- #### Map.polygonExists(type, condition)
632
-
633
- This functions returns if polygon exists
634
-
635
-
636
-
637
-
638
- ##### Parameters
639
-
640
- | Name | Type | Description | |
641
- | ---- | ---- | ----------- | -------- |
642
- | type | | | &nbsp; |
643
- | condition | | [nullable] | &nbsp; |
644
-
645
-
646
-
647
-
648
- ##### Returns
649
-
650
-
651
- - `boolean`
652
-
653
-
654
-
655
- #### Map.getPolygonPath(type, condition)
656
-
657
- Use this function to get the path of some polygon
658
-
659
-
660
-
661
-
662
- ##### Parameters
663
-
664
- | Name | Type | Description | |
665
- | ---- | ---- | ----------- | -------- |
666
- | type | `string` | | &nbsp; |
667
- | condition | `any` | | &nbsp; |
668
-
669
-
670
-
671
-
672
- ##### Returns
673
-
674
-
675
- - `Array.&lt;number&gt;`
676
-
677
-
678
-
679
- #### Map.addPolygonEvent(type, event, eventFunction, condition)
680
-
681
- This function add new events on polygon
682
-
683
-
684
-
685
-
686
- ##### Parameters
687
-
688
- | Name | Type | Description | |
689
- | ---- | ---- | ----------- | -------- |
690
- | type | `string` | | &nbsp; |
691
- | event | `InlogMaps.PolygonEventType` | | &nbsp; |
692
- | eventFunction | `any` | | &nbsp; |
693
- | condition | `any` | [nullable] | &nbsp; |
694
-
695
-
696
-
697
-
698
- ##### Returns
699
-
700
-
701
- - `Void`
702
-
703
-
704
-
705
- #### Map.removePolygonEvent(type, event, condition)
706
-
707
- This function remove events of polygon
708
-
709
-
710
-
711
-
712
- ##### Parameters
713
-
714
- | Name | Type | Description | |
715
- | ---- | ---- | ----------- | -------- |
716
- | type | `string` | | &nbsp; |
717
- | event | `InlogMaps.PolygonEventType` | | &nbsp; |
718
- | condition | `any` | [nullable] | &nbsp; |
719
-
720
-
721
-
722
-
723
- ##### Returns
724
-
725
-
726
- - `Void`
727
-
728
-
729
-
730
- #### Map.drawCircle(type, options, eventClick)
731
-
732
- Use this function to draw circles on the currentMap
733
-
734
-
735
-
736
-
737
- ##### Parameters
738
-
739
- | Name | Type | Description | |
740
- | ---- | ---- | ----------- | -------- |
741
- | type | `string` | | &nbsp; |
742
- | options | `InlogMaps.CircleOptions` | | &nbsp; |
743
- | eventClick | `any` | [nullable] | &nbsp; |
744
-
745
-
746
-
747
-
748
- ##### Returns
749
-
750
-
751
- - `Void`
752
-
753
-
754
-
755
- #### Map.toggleCircles(show, type, condition)
756
-
757
- Use this function to show/hide circles from a especific type
758
-
759
-
760
-
761
-
762
- ##### Parameters
763
-
764
- | Name | Type | Description | |
765
- | ---- | ---- | ----------- | -------- |
766
- | show | `boolean` | | &nbsp; |
767
- | type | `string` | | &nbsp; |
768
- | condition | `any` | toggle circles with the condition [nullable] | &nbsp; |
769
-
770
-
771
-
772
-
773
- ##### Returns
774
-
775
-
776
- - `Void`
777
-
778
-
779
-
780
- #### Map.removeCircles(type, condition)
781
-
782
- Remove circles from the map and from internal list
783
-
784
-
785
-
786
-
787
- ##### Parameters
788
-
789
- | Name | Type | Description | |
790
- | ---- | ---- | ----------- | -------- |
791
- | type | `string` | | &nbsp; |
792
- | condition | `any` | remove circles with the condition [nullable] | &nbsp; |
793
-
794
-
795
-
796
-
797
- ##### Returns
798
-
799
-
800
- - `Void`
801
-
802
-
803
-
804
- #### Map.removeAllCircles()
805
-
806
- Remove all circles from the map and from the internal list
807
-
808
-
809
-
810
-
811
-
812
-
813
- ##### Returns
814
-
815
-
816
- - `Void`
817
-
818
-
819
-
820
- #### Map.alterCircleOptions(type, options, condition)
821
-
822
- Use this function to alter circle options
823
-
824
-
825
-
826
-
827
- ##### Parameters
828
-
829
- | Name | Type | Description | |
830
- | ---- | ---- | ----------- | -------- |
831
- | type | `string` | | &nbsp; |
832
- | options | `InlogMaps.CircleAlterOptions` | | &nbsp; |
833
- | condition | `any` | alter circle with the condition [nullable] | &nbsp; |
834
-
835
-
836
-
837
-
838
- ##### Returns
839
-
840
-
841
- - `Void`
842
-
843
-
844
-
845
- #### Map.fitBoundsCircles(type, condition)
846
-
847
- Use this function to fit bounds of a polygon
848
-
849
-
850
-
851
-
852
- ##### Parameters
853
-
854
- | Name | Type | Description | |
855
- | ---- | ---- | ----------- | -------- |
856
- | type | `string` | | &nbsp; |
857
- | condition | `any` | fit polygon bounds with the condition [nullable] | &nbsp; |
858
-
859
-
860
-
861
-
862
- ##### Returns
863
-
864
-
865
- - `Void`
866
-
867
-
868
-
869
- #### Map.circleExists(type, condition)
870
-
871
- This functions returns if circle exists
872
-
873
-
874
-
875
-
876
- ##### Parameters
877
-
878
- | Name | Type | Description | |
879
- | ---- | ---- | ----------- | -------- |
880
- | type | `string` | | &nbsp; |
881
- | condition | `any` | [nullable] | &nbsp; |
882
-
883
-
884
-
885
-
886
- ##### Returns
887
-
888
-
889
- - `boolean`
890
-
891
-
892
-
893
- #### Map.getCircleCenter(type, condition)
894
-
895
- This function return circle center
896
-
897
-
898
-
899
-
900
- ##### Parameters
901
-
902
- | Name | Type | Description | |
903
- | ---- | ---- | ----------- | -------- |
904
- | type | `string` | | &nbsp; |
905
- | condition | `any` | [nullable] | &nbsp; |
906
-
907
-
908
-
909
-
910
- ##### Returns
911
-
912
-
913
- - `Array.&lt;number&gt;`
914
-
915
-
916
-
917
- #### Map.getCircleRadius(type, condition)
918
-
919
- This function return circle center
920
-
921
-
922
-
923
-
924
- ##### Parameters
925
-
926
- | Name | Type | Description | |
927
- | ---- | ---- | ----------- | -------- |
928
- | type | `string` | | &nbsp; |
929
- | condition | `any` | [nullable] | &nbsp; |
930
-
931
-
932
-
933
-
934
- ##### Returns
935
-
936
-
937
- - `number`
938
-
939
-
940
-
941
- #### Map.addCircleEvent(type, event, eventFunction, condition)
942
-
943
- This function add new events on circle
944
-
945
-
946
-
947
-
948
- ##### Parameters
949
-
950
- | Name | Type | Description | |
951
- | ---- | ---- | ----------- | -------- |
952
- | type | `string` | | &nbsp; |
953
- | event | `InlogMaps.CircleEventType` | | &nbsp; |
954
- | eventFunction | `any` | | &nbsp; |
955
- | condition | `any` | [nullable] | &nbsp; |
956
-
957
-
958
-
959
-
960
- ##### Returns
961
-
962
-
963
- - `Void`
964
-
965
-
966
-
967
- #### Map.removeCircleEvent(type, event, condition)
968
-
969
- This function remove events of circle
970
-
971
-
972
-
973
-
974
- ##### Parameters
975
-
976
- | Name | Type | Description | |
977
- | ---- | ---- | ----------- | -------- |
978
- | type | `string` | | &nbsp; |
979
- | event | `InlogMaps.CircleEventType` | | &nbsp; |
980
- | condition | `any` | [nullable] | &nbsp; |
981
-
982
-
983
-
984
-
985
- ##### Returns
986
-
987
-
988
- - `Void`
989
-
990
-
991
-
992
- #### Map.drawPolyline(type, options, eventClick)
993
-
994
- Use this function to draw polylines on the currentMap
995
-
996
-
997
-
998
-
999
- ##### Parameters
1000
-
1001
- | Name | Type | Description | |
1002
- | ---- | ---- | ----------- | -------- |
1003
- | type | `string` | | &nbsp; |
1004
- | options | `InlogMaps.PolylineOptions` | | &nbsp; |
1005
- | eventClick | `any` | [nullable] | &nbsp; |
1006
-
1007
-
1008
-
1009
-
1010
- ##### Returns
1011
-
1012
-
1013
- - `Void`
1014
-
1015
-
1016
-
1017
- #### Map.drawPolylineWithNavigation(type, options)
1018
-
1019
- Use this function to draw polylines with navigation on the currentMap
1020
-
1021
-
1022
-
1023
-
1024
- ##### Parameters
1025
-
1026
- | Name | Type | Description | |
1027
- | ---- | ---- | ----------- | -------- |
1028
- | type | `string` | | &nbsp; |
1029
- | options | `InlogMaps.PolylineOptions` | | &nbsp; |
1030
-
1031
-
1032
-
1033
-
1034
- ##### Returns
1035
-
1036
-
1037
- - `Void`
1038
-
1039
-
1040
-
1041
- #### Map.togglePolylines(show, type, condition)
1042
-
1043
- Use this function to toggle polylines
1044
-
1045
-
1046
-
1047
-
1048
- ##### Parameters
1049
-
1050
- | Name | Type | Description | |
1051
- | ---- | ---- | ----------- | -------- |
1052
- | show | `boolean` | | &nbsp; |
1053
- | type | `string` | | &nbsp; |
1054
- | condition | `any` | toggle polyline with the condition [nullable] | &nbsp; |
1055
-
1056
-
1057
-
1058
-
1059
- ##### Returns
1060
-
1061
-
1062
- - `Void`
1063
-
1064
-
1065
-
1066
- #### Map.removePolylines(type, condition)
1067
-
1068
- Use this function to remove polylines
1069
-
1070
-
1071
-
1072
-
1073
- ##### Parameters
1074
-
1075
- | Name | Type | Description | |
1076
- | ---- | ---- | ----------- | -------- |
1077
- | type | `string` | | &nbsp; |
1078
- | condition | `any` | remove polyline with the condition [nullable] | &nbsp; |
1079
-
1080
-
1081
-
1082
-
1083
- ##### Returns
1084
-
1085
-
1086
- - `Void`
1087
-
1088
-
1089
-
1090
- #### Map.removeAllPolylines()
1091
-
1092
- Remove all polylines from the map and from the internal list
1093
-
1094
-
1095
-
1096
-
1097
-
1098
-
1099
- ##### Returns
1100
-
1101
-
1102
- - `Void`
1103
-
1104
-
1105
-
1106
- #### Map.alterPolylineOptions(type, options, condition)
1107
-
1108
- Use this function to alter polyline options
1109
-
1110
-
1111
-
1112
-
1113
- ##### Parameters
1114
-
1115
- | Name | Type | Description | |
1116
- | ---- | ---- | ----------- | -------- |
1117
- | type | `string` | | &nbsp; |
1118
- | options | `InlogMaps.PolylineOptions` | | &nbsp; |
1119
- | condition | `any` | alter polyline with the condition [nullable] | &nbsp; |
1120
-
1121
-
1122
-
1123
-
1124
- ##### Returns
1125
-
1126
-
1127
- - `Void`
1128
-
1129
-
1130
-
1131
- #### Map.fitBoundsPolylines(type, condition)
1132
-
1133
- Use this functions to fit polylines bounds
1134
-
1135
-
1136
-
1137
-
1138
- ##### Parameters
1139
-
1140
- | Name | Type | Description | |
1141
- | ---- | ---- | ----------- | -------- |
1142
- | type | `string` | | &nbsp; |
1143
- | condition | `any` | [nullable] | &nbsp; |
1144
-
1145
-
1146
-
1147
-
1148
- ##### Returns
1149
-
1150
-
1151
- - `Void`
1152
-
1153
-
1154
-
1155
- #### Map.polylineExists(type, condition)
1156
-
1157
- This functions returns if polyline exists
1158
-
1159
-
1160
-
1161
-
1162
- ##### Parameters
1163
-
1164
- | Name | Type | Description | |
1165
- | ---- | ---- | ----------- | -------- |
1166
- | type | `string` | | &nbsp; |
1167
- | condition | `any` | [nullable] | &nbsp; |
1168
-
1169
-
1170
-
1171
-
1172
- ##### Returns
1173
-
1174
-
1175
- - `boolean`
1176
-
1177
-
1178
-
1179
- #### Map.addPolylinePath(type, position, condition)
1180
-
1181
- Use this function to add more paths to a polyline
1182
-
1183
-
1184
-
1185
-
1186
- ##### Parameters
1187
-
1188
- | Name | Type | Description | |
1189
- | ---- | ---- | ----------- | -------- |
1190
- | type | `string` | | &nbsp; |
1191
- | position | `Array.<number>` | | &nbsp; |
1192
- | condition | `any` | [nullable] | &nbsp; |
1193
-
1194
-
1195
-
1196
-
1197
- ##### Returns
1198
-
1199
-
1200
- - `Void`
1201
-
1202
-
1203
-
1204
- #### Map.getPolylinePath(type, condition)
1205
-
1206
- Use this function to get the path of some polyline
1207
-
1208
-
1209
-
1210
-
1211
- ##### Parameters
1212
-
1213
- | Name | Type | Description | |
1214
- | ---- | ---- | ----------- | -------- |
1215
- | type | `string` | | &nbsp; |
1216
- | condition | `any` | | &nbsp; |
1217
-
1218
-
1219
-
1220
-
1221
- ##### Returns
1222
-
1223
-
1224
- - `Array.&lt;number&gt;`
1225
-
1226
-
1227
-
1228
- #### Map.removePolylineHighlight()
1229
-
1230
- Use this function to clear polyline selected from the currentMap
1231
-
1232
-
1233
-
1234
-
1235
-
1236
-
1237
- ##### Returns
1238
-
1239
-
1240
- - `Void`
1241
-
1242
-
1243
-
1244
- #### Map.addPolylineEvent(type, event, eventFunction, condition)
1245
-
1246
- Use this function to add listeners on polyline
1247
-
1248
-
1249
-
1250
-
1251
- ##### Parameters
1252
-
1253
- | Name | Type | Description | |
1254
- | ---- | ---- | ----------- | -------- |
1255
- | type | `string` | | &nbsp; |
1256
- | event | `InlogMaps.PolylineEventType` | | &nbsp; |
1257
- | eventFunction | `any` | | &nbsp; |
1258
- | condition | `any` | [nullable] | &nbsp; |
1259
-
1260
-
1261
-
1262
-
1263
- ##### Returns
1264
-
1265
-
1266
- - `Void`
1267
-
1268
-
1269
-
1270
- #### Map.removePolylineEvent(type, event, condition)
1271
-
1272
- Use this function to remove listeners of polyline
1273
-
1274
-
1275
-
1276
-
1277
- ##### Parameters
1278
-
1279
- | Name | Type | Description | |
1280
- | ---- | ---- | ----------- | -------- |
1281
- | type | `string` | | &nbsp; |
1282
- | event | `InlogMaps.PolylineEventType` | | &nbsp; |
1283
- | condition | `any` | [nullable] | &nbsp; |
1284
-
1285
-
1286
-
1287
-
1288
- ##### Returns
1289
-
1290
-
1291
- - `Void`
1292
-
1293
-
1294
-
1295
- #### Map.setIndexPolylineHighlight(type, initialIndex, condition)
1296
-
1297
- Use this function to set position of polyline highlight
1298
-
1299
-
1300
-
1301
-
1302
- ##### Parameters
1303
-
1304
- | Name | Type | Description | |
1305
- | ---- | ---- | ----------- | -------- |
1306
- | type | `string` | | &nbsp; |
1307
- | initialIndex | `number` | | &nbsp; |
1308
- | condition | `any` | [nullable] | &nbsp; |
1309
-
1310
-
1311
-
1312
-
1313
- ##### Returns
1314
-
1315
-
1316
- - `Void`
1317
-
1318
-
1319
-
1320
- #### Map.getObjectPolyline(type, condition)
1321
-
1322
- Use this function to get the object of a polyline
1323
-
1324
-
1325
-
1326
-
1327
- ##### Parameters
1328
-
1329
- | Name | Type | Description | |
1330
- | ---- | ---- | ----------- | -------- |
1331
- | type | `string` | | &nbsp; |
1332
- | condition | `any` | | &nbsp; |
1333
-
1334
-
1335
-
1336
-
1337
- ##### Returns
1338
-
1339
-
1340
- - `object`
1341
-
1342
-
1343
-
1344
- #### Map.getObjectPolylineHighlight()
1345
-
1346
- Use this function to get the object of the polyline highligth
1347
-
1348
-
1349
-
1350
-
1351
-
1352
-
1353
- ##### Returns
1354
-
1355
-
1356
- - `object`
1357
-
1358
-
1359
-
1360
- #### Map.addPolylineHighlightEvent(event, eventFunction)
1361
-
1362
- Use this function to add events on polyline highligtht / selected polyline
1363
-
1364
-
1365
-
1366
-
1367
- ##### Parameters
1368
-
1369
- | Name | Type | Description | |
1370
- | ---- | ---- | ----------- | -------- |
1371
- | event | `InlogMaps.PolylineEventType` | | &nbsp; |
1372
- | eventFunction | `any` | | &nbsp; |
1373
-
1374
-
1375
-
1376
-
1377
- ##### Returns
1378
-
1379
-
1380
- - `Void`
1381
-
1382
-
1383
-
1384
- #### Map.getPolylineHighlightIndex()
1385
-
1386
- Use this function to get initial and final index of the polyline highlight
1387
-
1388
-
1389
-
1390
-
1391
-
1392
-
1393
- ##### Returns
1394
-
1395
-
1396
- - `Array.&lt;number&gt;` returns an array with initial index and final index
1397
-
1398
-
1399
-
1400
- #### Map.drawPopup(type, options)
1401
-
1402
- Use this function to draw popups on the currentMap
1403
-
1404
-
1405
-
1406
-
1407
- ##### Parameters
1408
-
1409
- | Name | Type | Description | |
1410
- | ---- | ---- | ----------- | -------- |
1411
- | type | `string` | | &nbsp; |
1412
- | options | `InlogMaps.PopupOptions` | | &nbsp; |
1413
-
1414
-
1415
-
1416
-
1417
- ##### Returns
1418
-
1419
-
1420
- - `Void`
1421
-
1422
-
1423
-
1424
- #### Map.alterPopup(type, options)
1425
-
1426
- Use this function to alter popups
1427
-
1428
-
1429
-
1430
-
1431
- ##### Parameters
1432
-
1433
- | Name | Type | Description | |
1434
- | ---- | ---- | ----------- | -------- |
1435
- | type | `string` | | &nbsp; |
1436
- | options | `InlogMaps.PopupOptions` | | &nbsp; |
1437
-
1438
-
1439
-
1440
-
1441
- ##### Returns
1442
-
1443
-
1444
- - `Void`
1445
-
1446
-
1447
-
1448
- #### Map.getObjectOpenPopup(type)
1449
-
1450
-
1451
-
1452
-
1453
-
1454
-
1455
- ##### Parameters
1456
-
1457
- | Name | Type | Description | |
1458
- | ---- | ---- | ----------- | -------- |
1459
- | type | `string` | | &nbsp; |
1460
-
1461
-
1462
-
1463
-
1464
- ##### Returns
1465
-
1466
-
1467
- - `object`
1468
-
1469
-
1470
-
1471
- #### Map.closePopup(type)
1472
-
1473
- Use this function to close popup by type
1474
-
1475
-
1476
-
1477
-
1478
- ##### Parameters
1479
-
1480
- | Name | Type | Description | |
1481
- | ---- | ---- | ----------- | -------- |
1482
- | type | `string` | | &nbsp; |
1483
-
1484
-
1485
-
1486
-
1487
- ##### Returns
1488
-
1489
-
1490
- - `Void`
1491
-
1492
-
1493
-
1494
- #### Map.closeAllPopups(type)
1495
-
1496
- Use this function to close all popups
1497
-
1498
-
1499
-
1500
-
1501
- ##### Parameters
1502
-
1503
- | Name | Type | Description | |
1504
- | ---- | ---- | ----------- | -------- |
1505
- | type | `string` | | &nbsp; |
1506
-
1507
-
1508
-
1509
-
1510
- ##### Returns
1511
-
1512
-
1513
- - `Void`
1514
-
1515
-
1516
-
1517
- #### Map.resizeMap()
1518
-
1519
- Resize de map based on html size
1520
-
1521
-
1522
-
1523
-
1524
-
1525
-
1526
- ##### Returns
1527
-
1528
-
1529
- - `Void`
1530
-
1531
-
1532
-
1533
- #### Map.addEventMap(eventType, eventFunction)
1534
-
1535
- Use this function to add event clicks on the currentMap
1536
-
1537
-
1538
-
1539
-
1540
- ##### Parameters
1541
-
1542
- | Name | Type | Description | |
1543
- | ---- | ---- | ----------- | -------- |
1544
- | eventType | `InlogMaps.MapEventType` | | &nbsp; |
1545
- | eventFunction | | function callback | &nbsp; |
1546
-
1547
-
1548
-
1549
-
1550
- ##### Returns
1551
-
1552
-
1553
- - `Void`
1554
-
1555
-
1556
-
1557
- #### Map.removeEventMap(eventType)
1558
-
1559
- Use this function to remove event clicks from the currentMap
1560
-
1561
-
1562
-
1563
-
1564
- ##### Parameters
1565
-
1566
- | Name | Type | Description | |
1567
- | ---- | ---- | ----------- | -------- |
1568
- | eventType | `InlogMaps.MapEventType` | | &nbsp; |
1569
-
1570
-
1571
-
1572
-
1573
- ##### Returns
1574
-
1575
-
1576
- - `Void`
1577
-
1578
-
1579
-
1580
- #### Map.getZoom()
1581
-
1582
- Returns the current zoom level of the map view
1583
-
1584
-
1585
-
1586
-
1587
-
1588
-
1589
- ##### Returns
1590
-
1591
-
1592
- - `number`
1593
-
1594
-
1595
-
1596
- #### Map.setZoom(zoom)
1597
-
1598
- Set the current zoom level of the map view
1599
-
1600
-
1601
-
1602
-
1603
- ##### Parameters
1604
-
1605
- | Name | Type | Description | |
1606
- | ---- | ---- | ----------- | -------- |
1607
- | zoom | `number` | | &nbsp; |
1608
-
1609
-
1610
-
1611
-
1612
- ##### Returns
1613
-
1614
-
1615
- - `Void`
1616
-
1617
-
1618
-
1619
- #### Map.takeMapScreenshot()
1620
-
1621
- Takes a screenshot with all the context included in it (visible area)
1622
- Returns the image as a base64 string or null
1623
-
1624
-
1625
-
1626
-
1627
-
1628
-
1629
- ##### Returns
1630
-
1631
-
1632
- - `Promise.&lt;string|null&gt;`
1633
-
1634
-
1635
-
1636
- #### Map.removeRuler()
1637
-
1638
- Remove ruler in the map
1639
-
1640
-
1641
-
1642
-
1643
-
1644
-
1645
- ##### Returns
1646
-
1647
-
1648
- -
1649
-
1650
-
1651
-
1652
- #### Map.createRuler()
1653
-
1654
- Create ruler in the map
1655
-
1656
-
1657
-
1658
-
1659
-
1660
-
1661
- ##### Returns
1662
-
1663
-
1664
- -
1665
-
1666
-
1667
-
1668
- #### Map.getCenter()
1669
-
1670
- Returns the center position of the map
1671
-
1672
-
1673
-
1674
-
1675
-
1676
-
1677
- ##### Returns
1678
-
1679
-
1680
- - `Array.&lt;number&gt;`
1681
-
1682
-
1683
-
1684
- #### Map.setCenter(position)
1685
-
1686
- Set the position center of the map
1687
-
1688
-
1689
-
1690
-
1691
- ##### Parameters
1692
-
1693
- | Name | Type | Description | |
1694
- | ---- | ---- | ----------- | -------- |
1695
- | position | `Array.<number>` | | &nbsp; |
1696
-
1697
-
1698
-
1699
-
1700
- ##### Returns
1701
-
1702
-
1703
- - `Void`
1704
-
1705
-
1706
-
1707
- #### Map.pixelsToLatLng(offsetx, offsety)
1708
-
1709
- Returns the coordinates from pixels
1710
-
1711
-
1712
-
1713
-
1714
- ##### Parameters
1715
-
1716
- | Name | Type | Description | |
1717
- | ---- | ---- | ----------- | -------- |
1718
- | offsetx | `number` | | &nbsp; |
1719
- | offsety | `number` | | &nbsp; |
1720
-
1721
-
1722
-
1723
-
1724
- ##### Returns
1725
-
1726
-
1727
- - `Array.&lt;number&gt;`
1728
-
1729
-
1730
-
1731
- #### Map.fitBoundsElements(type, condition)
1732
-
1733
- Use this functions to fit bounds on elements with same type and condition
1734
-
1735
-
1736
-
1737
-
1738
- ##### Parameters
1739
-
1740
- | Name | Type | Description | |
1741
- | ---- | ---- | ----------- | -------- |
1742
- | type | `string` | | &nbsp; |
1743
- | condition | `any` | [nullable] | &nbsp; |
1744
-
1745
-
1746
-
1747
-
1748
- ##### Returns
1749
-
1750
-
1751
- - `Void`
1752
-
1753
-
1754
-
1755
- #### Map.drawOverlay(type, options)
1756
-
1757
- Use this function to dray overlays on the current map
1758
-
1759
-
1760
-
1761
-
1762
- ##### Parameters
1763
-
1764
- | Name | Type | Description | |
1765
- | ---- | ---- | ----------- | -------- |
1766
- | type | `string` | | &nbsp; |
1767
- | options | `InlogMaps.OverlayOptions` | | &nbsp; |
1768
-
1769
-
1770
-
1771
-
1772
- ##### Returns
1773
-
1774
-
1775
- - `Void`
1776
-
1777
-
1778
-
1779
- #### Map.toggleOverlay(show, type, condition)
1780
-
1781
- Use this function to show or hide overlay
1782
-
1783
-
1784
-
1785
-
1786
- ##### Parameters
1787
-
1788
- | Name | Type | Description | |
1789
- | ---- | ---- | ----------- | -------- |
1790
- | show | `boolean` | | &nbsp; |
1791
- | type | `string` | | &nbsp; |
1792
- | condition | `any` | [nullable] | &nbsp; |
1793
-
1794
-
1795
-
1796
-
1797
- ##### Returns
1798
-
1799
-
1800
- - `Void`
1801
-
1802
-
1803
-
1804
- #### Map.removeOverlays(type, condition)
1805
-
1806
- Remove overlays from the map and from internal list
1807
-
1808
-
1809
-
1810
-
1811
- ##### Parameters
1812
-
1813
- | Name | Type | Description | |
1814
- | ---- | ---- | ----------- | -------- |
1815
- | type | `string` | | &nbsp; |
1816
- | condition | `any` | remove overlays with the condition [nullable] | &nbsp; |
1817
-
1818
-
1819
-
1820
-
1821
- ##### Returns
1822
-
1823
-
1824
- - `Void`
1825
-
1826
-
1827
-
1828
- #### Map.removeAllOverlays()
1829
-
1830
- Remove all overlays from the map and from the internal list
1831
-
1832
-
1833
-
1834
-
1835
-
1836
-
1837
- ##### Returns
1838
-
1839
-
1840
- - `Void`
1841
-
1842
-
1843
-
1844
- #### Map.checkIdx(type, point, condition)
1845
-
1846
- Use this function get idx polyline
1847
-
1848
-
1849
-
1850
-
1851
- ##### Parameters
1852
-
1853
- | Name | Type | Description | |
1854
- | ---- | ---- | ----------- | -------- |
1855
- | type | `string` | | &nbsp; |
1856
- | point | `[number, number]` | | &nbsp; |
1857
- | condition | `any` | | &nbsp; |
1858
-
1859
-
1860
-
1861
-
1862
- ##### Returns
1863
-
1864
-
1865
- - `Void`
1866
-
1867
-
1868
-
1869
-
1870
- *Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*
1
+ # [@inlog/inlog-maps](https://github.com/weareinlog/inlog-maps#readme) *6.5.0*
2
+
3
+ > A library for using generic layer maps
4
+
5
+
6
+ ### lib-esm/map.js
7
+
8
+
9
+ #### Map.initialize(mapType, options, elementId)
10
+
11
+ Use this to initialize map
12
+
13
+
14
+
15
+
16
+ ##### Parameters
17
+
18
+ | Name | Type | Description | |
19
+ | ---- | ---- | ----------- | -------- |
20
+ | mapType | `InlogMaps.MapType` | | &nbsp; |
21
+ | options | `any` | | &nbsp; |
22
+ | elementId | `string` | default: 'inlog-map' [nullable] | &nbsp; |
23
+
24
+
25
+
26
+
27
+ ##### Returns
28
+
29
+
30
+ - `Promisse.&lt;any&gt;`
31
+
32
+
33
+
34
+ #### Map.loadGEOJson(data, options, eventClick)
35
+
36
+ Use this function to add GEOJSON to the currentMap
37
+
38
+
39
+
40
+
41
+ ##### Parameters
42
+
43
+ | Name | Type | Description | |
44
+ | ---- | ---- | ----------- | -------- |
45
+ | data | `object` | Geojson | &nbsp; |
46
+ | options | `InlogMaps.GeoJsonOptions` | | &nbsp; |
47
+ | eventClick | `any` | is a function callback on click [nullable] | &nbsp; |
48
+
49
+
50
+
51
+
52
+ ##### Returns
53
+
54
+
55
+ - `Void`
56
+
57
+
58
+
59
+ #### Map.drawMarker(type, options, eventClick)
60
+
61
+ Use this function to draw markers in the currentMap
62
+
63
+
64
+
65
+
66
+ ##### Parameters
67
+
68
+ | Name | Type | Description | |
69
+ | ---- | ---- | ----------- | -------- |
70
+ | type | `string` | | &nbsp; |
71
+ | options | `InlogMaps.MarkerOptions` | | &nbsp; |
72
+ | eventClick | `any` | is a function callback on click [nullable] | &nbsp; |
73
+
74
+
75
+
76
+
77
+ ##### Returns
78
+
79
+
80
+ - `Void`
81
+
82
+
83
+
84
+ #### Map.drawCircleMarker(type, options, eventClick)
85
+
86
+ Use this function to draw circle markers in the currentMap
87
+
88
+
89
+
90
+
91
+ ##### Parameters
92
+
93
+ | Name | Type | Description | |
94
+ | ---- | ---- | ----------- | -------- |
95
+ | type | `string` | | &nbsp; |
96
+ | options | `InlogMaps.CircleMarkerOptions` | | &nbsp; |
97
+ | eventClick | `any` | is a function callback on click [nullable] | &nbsp; |
98
+
99
+
100
+
101
+
102
+ ##### Returns
103
+
104
+
105
+ - `Void`
106
+
107
+
108
+
109
+ #### Map.toggleMarkers(show, type, condition)
110
+
111
+ Use this function to show/hide markers from a specific type
112
+
113
+
114
+
115
+
116
+ ##### Parameters
117
+
118
+ | Name | Type | Description | |
119
+ | ---- | ---- | ----------- | -------- |
120
+ | show | `boolean` | | &nbsp; |
121
+ | type | `string` | | &nbsp; |
122
+ | condition | `any` | toogle markers with the condition [nullable] | &nbsp; |
123
+
124
+
125
+
126
+
127
+ ##### Returns
128
+
129
+
130
+ - `Void`
131
+
132
+
133
+
134
+ #### Map.removeMarkers(type, condition)
135
+
136
+ Remove markers from the map and from internal list
137
+
138
+
139
+
140
+
141
+ ##### Parameters
142
+
143
+ | Name | Type | Description | |
144
+ | ---- | ---- | ----------- | -------- |
145
+ | type | `string` | | &nbsp; |
146
+ | condition | `any` | remove markers with the condition [nullable] | &nbsp; |
147
+
148
+
149
+
150
+
151
+ ##### Returns
152
+
153
+
154
+ - `Void`
155
+
156
+
157
+
158
+ #### Map.removeAllMarkers()
159
+
160
+ Remove all markers from the map and from the internal list
161
+
162
+
163
+
164
+
165
+
166
+
167
+ ##### Returns
168
+
169
+
170
+ - `Void`
171
+
172
+
173
+
174
+ #### Map.alterMarkerOptions(type, options, condition)
175
+
176
+ Use this function to alter marker style
177
+
178
+
179
+
180
+
181
+ ##### Parameters
182
+
183
+ | Name | Type | Description | |
184
+ | ---- | ---- | ----------- | -------- |
185
+ | type | `string` | | &nbsp; |
186
+ | options | `InlogMaps.MarkerAlterOptions` | | &nbsp; |
187
+ | condition | `any` | alter markers with the condition [nullable] | &nbsp; |
188
+
189
+
190
+
191
+
192
+ ##### Returns
193
+
194
+
195
+ - `Void`
196
+
197
+
198
+
199
+ #### Map.alterMarkerPosition(type, position, addTransition, condition)
200
+
201
+ Use this functions to alterar marker position
202
+
203
+
204
+
205
+
206
+ ##### Parameters
207
+
208
+ | Name | Type | Description | |
209
+ | ---- | ---- | ----------- | -------- |
210
+ | type | `string` | | &nbsp; |
211
+ | position | `Array.<number>` | | &nbsp; |
212
+ | addTransition | `boolean` | [nullable] | &nbsp; |
213
+ | condition | `any` | [nullable] | &nbsp; |
214
+
215
+
216
+
217
+
218
+ ##### Returns
219
+
220
+
221
+ - `Void`
222
+
223
+
224
+
225
+ #### Map.fitBoundsMarkers(type, condition, onlyMarkersOnMap)
226
+
227
+ Use this function to fit bounds in the markers with the especified type
228
+
229
+
230
+
231
+
232
+ ##### Parameters
233
+
234
+ | Name | Type | Description | |
235
+ | ---- | ---- | ----------- | -------- |
236
+ | type | `string` | | &nbsp; |
237
+ | condition | `any` | [nullable] | &nbsp; |
238
+ | onlyMarkersOnMap | `boolean` | default true | &nbsp; |
239
+
240
+
241
+
242
+
243
+ ##### Returns
244
+
245
+
246
+ - `Void`
247
+
248
+
249
+
250
+ #### Map.setCenterMarker(type, condition)
251
+
252
+ Use this functions to set the center of the map on marker
253
+
254
+
255
+
256
+
257
+ ##### Parameters
258
+
259
+ | Name | Type | Description | |
260
+ | ---- | ---- | ----------- | -------- |
261
+ | type | `string` | | &nbsp; |
262
+ | condition | `any` | center on marker with the condition [nullable] | &nbsp; |
263
+
264
+
265
+
266
+
267
+ ##### Returns
268
+
269
+
270
+ - `Void`
271
+
272
+
273
+
274
+ #### Map.markerExists(type, condition)
275
+
276
+ This functions returns if marker exists
277
+
278
+
279
+
280
+
281
+ ##### Parameters
282
+
283
+ | Name | Type | Description | |
284
+ | ---- | ---- | ----------- | -------- |
285
+ | type | | | &nbsp; |
286
+ | condition | | [nullable] | &nbsp; |
287
+
288
+
289
+
290
+
291
+ ##### Returns
292
+
293
+
294
+ - `boolean`
295
+
296
+
297
+
298
+ #### Map.countMarkers(type, onlyOnMap, condition)
299
+
300
+ Use this function to count markers by type
301
+
302
+
303
+
304
+
305
+ ##### Parameters
306
+
307
+ | Name | Type | Description | |
308
+ | ---- | ---- | ----------- | -------- |
309
+ | type | `string` | | &nbsp; |
310
+ | onlyOnMap | `boolean` | exclude hidden markers, default true | &nbsp; |
311
+ | condition | `any` | | &nbsp; |
312
+
313
+
314
+
315
+
316
+ ##### Returns
317
+
318
+
319
+ - `number`
320
+
321
+
322
+
323
+ #### Map.addMarkerEvent(type, event, eventFunction, condition)
324
+
325
+ This function add new events on marker
326
+
327
+
328
+
329
+
330
+ ##### Parameters
331
+
332
+ | Name | Type | Description | |
333
+ | ---- | ---- | ----------- | -------- |
334
+ | type | `string` | | &nbsp; |
335
+ | event | `InlogMaps.MarkerEventType` | | &nbsp; |
336
+ | eventFunction | `any` | | &nbsp; |
337
+ | condition | `any` | [nullable] | &nbsp; |
338
+
339
+
340
+
341
+
342
+ ##### Returns
343
+
344
+
345
+ - `Void`
346
+
347
+
348
+
349
+ #### Map.removeMarkerEvent(type, event, condition)
350
+
351
+ This function remove events of marker
352
+
353
+
354
+
355
+
356
+ ##### Parameters
357
+
358
+ | Name | Type | Description | |
359
+ | ---- | ---- | ----------- | -------- |
360
+ | type | `string` | | &nbsp; |
361
+ | event | `InlogMaps.MarkerEventType` | | &nbsp; |
362
+ | condition | `any` | [nullable] | &nbsp; |
363
+
364
+
365
+
366
+
367
+ ##### Returns
368
+
369
+
370
+ - `Void`
371
+
372
+
373
+
374
+ #### Map.addMarkerClusterer(type, config)
375
+
376
+ Use this function to add MarkerClusterer on the map
377
+
378
+
379
+
380
+
381
+ ##### Parameters
382
+
383
+ | Name | Type | Description | |
384
+ | ---- | ---- | ----------- | -------- |
385
+ | type | `string` | same type of markers | &nbsp; |
386
+ | config | `InlogMaps.MarkerClusterConfig` | | &nbsp; |
387
+
388
+
389
+
390
+
391
+ ##### Returns
392
+
393
+
394
+ - `Void`
395
+
396
+
397
+
398
+ #### Map.alterMarkerClustererConfig(type, config)
399
+
400
+ Use this function to alter clusterer options
401
+
402
+
403
+
404
+
405
+ ##### Parameters
406
+
407
+ | Name | Type | Description | |
408
+ | ---- | ---- | ----------- | -------- |
409
+ | type | | same type of markers | &nbsp; |
410
+ | config | `InlogMaps.MarkerClusterConfig` | | &nbsp; |
411
+
412
+
413
+
414
+
415
+ ##### Returns
416
+
417
+
418
+ - `Void`
419
+
420
+
421
+
422
+ #### Map.refreshClusterer(type)
423
+
424
+ Use this function to redraw marker clusterer
425
+
426
+
427
+
428
+
429
+ ##### Parameters
430
+
431
+ | Name | Type | Description | |
432
+ | ---- | ---- | ----------- | -------- |
433
+ | type | | same type of markers | &nbsp; |
434
+
435
+
436
+
437
+
438
+ ##### Returns
439
+
440
+
441
+ - `Void`
442
+
443
+
444
+
445
+ #### Map.clearMarkersClusterer(type)
446
+
447
+ Use this to clear markers on clusterer
448
+
449
+
450
+
451
+
452
+ ##### Parameters
453
+
454
+ | Name | Type | Description | |
455
+ | ---- | ---- | ----------- | -------- |
456
+ | type | | same type of markers | &nbsp; |
457
+
458
+
459
+
460
+
461
+ ##### Returns
462
+
463
+
464
+ - `Void`
465
+
466
+
467
+
468
+ #### Map.drawPolygon(type, options, eventClick)
469
+
470
+ Use this function to draw polygons
471
+
472
+
473
+
474
+
475
+ ##### Parameters
476
+
477
+ | Name | Type | Description | |
478
+ | ---- | ---- | ----------- | -------- |
479
+ | type | `string` | | &nbsp; |
480
+ | options | `InlogMaps.PolygonOptions` | | &nbsp; |
481
+ | eventClick | `any` | [nullable] | &nbsp; |
482
+
483
+
484
+
485
+
486
+ ##### Returns
487
+
488
+
489
+ - `Void`
490
+
491
+
492
+
493
+ #### Map.togglePolygons(show, type, condition)
494
+
495
+ Use this function to show/hide polygon from a especific type
496
+
497
+
498
+
499
+
500
+ ##### Parameters
501
+
502
+ | Name | Type | Description | |
503
+ | ---- | ---- | ----------- | -------- |
504
+ | show | `boolean` | | &nbsp; |
505
+ | type | `string` | | &nbsp; |
506
+ | condition | `any` | toggle polygon with the condition [nullable] | &nbsp; |
507
+
508
+
509
+
510
+
511
+ ##### Returns
512
+
513
+
514
+ - `Void`
515
+
516
+
517
+
518
+ #### Map.removePolygons(type, condition)
519
+
520
+ Remove polygons from the map and from internal list
521
+
522
+
523
+
524
+
525
+ ##### Parameters
526
+
527
+ | Name | Type | Description | |
528
+ | ---- | ---- | ----------- | -------- |
529
+ | type | `string` | | &nbsp; |
530
+ | condition | `any` | remove polygons with the condition [nullable] | &nbsp; |
531
+
532
+
533
+
534
+
535
+ ##### Returns
536
+
537
+
538
+ - `Void`
539
+
540
+
541
+
542
+ #### Map.removeAllPolygons()
543
+
544
+ Remove all polygons from the map and from the internal list
545
+
546
+
547
+
548
+
549
+
550
+
551
+ ##### Returns
552
+
553
+
554
+ - `Void`
555
+
556
+
557
+
558
+ #### Map.alterPolygonOptions(type, options, condition)
559
+
560
+ Use this function to alter polygons options/style
561
+
562
+
563
+
564
+
565
+ ##### Parameters
566
+
567
+ | Name | Type | Description | |
568
+ | ---- | ---- | ----------- | -------- |
569
+ | type | `string` | | &nbsp; |
570
+ | options | `InlogMaps.PolygonAlterOptions` | | &nbsp; |
571
+ | condition | `any` | alter polygon with the condition [nullable] | &nbsp; |
572
+
573
+
574
+
575
+
576
+ ##### Returns
577
+
578
+
579
+ - `Void`
580
+
581
+
582
+
583
+ #### Map.fitBoundsPolygons(type, condition)
584
+
585
+ Use this function to fit bounds of a polygon
586
+
587
+
588
+
589
+
590
+ ##### Parameters
591
+
592
+ | Name | Type | Description | |
593
+ | ---- | ---- | ----------- | -------- |
594
+ | type | `string` | | &nbsp; |
595
+ | condition | `any` | fit polygon bounds with the condition [nullable] | &nbsp; |
596
+
597
+
598
+
599
+
600
+ ##### Returns
601
+
602
+
603
+ - `Void`
604
+
605
+
606
+
607
+ #### Map.setCenterPolygons(type, condition)
608
+
609
+ Set center on polygon bounds
610
+
611
+
612
+
613
+
614
+ ##### Parameters
615
+
616
+ | Name | Type | Description | |
617
+ | ---- | ---- | ----------- | -------- |
618
+ | type | `string` | | &nbsp; |
619
+ | condition | `any` | fit polygon bounds with the condition [nullable] | &nbsp; |
620
+
621
+
622
+
623
+
624
+ ##### Returns
625
+
626
+
627
+ - `Void`
628
+
629
+
630
+
631
+ #### Map.polygonExists(type, condition)
632
+
633
+ This functions returns if polygon exists
634
+
635
+
636
+
637
+
638
+ ##### Parameters
639
+
640
+ | Name | Type | Description | |
641
+ | ---- | ---- | ----------- | -------- |
642
+ | type | | | &nbsp; |
643
+ | condition | | [nullable] | &nbsp; |
644
+
645
+
646
+
647
+
648
+ ##### Returns
649
+
650
+
651
+ - `boolean`
652
+
653
+
654
+
655
+ #### Map.getPolygonPath(type, condition)
656
+
657
+ Use this function to get the path of some polygon
658
+
659
+
660
+
661
+
662
+ ##### Parameters
663
+
664
+ | Name | Type | Description | |
665
+ | ---- | ---- | ----------- | -------- |
666
+ | type | `string` | | &nbsp; |
667
+ | condition | `any` | | &nbsp; |
668
+
669
+
670
+
671
+
672
+ ##### Returns
673
+
674
+
675
+ - `Array.&lt;number&gt;`
676
+
677
+
678
+
679
+ #### Map.addPolygonEvent(type, event, eventFunction, condition)
680
+
681
+ This function add new events on polygon
682
+
683
+
684
+
685
+
686
+ ##### Parameters
687
+
688
+ | Name | Type | Description | |
689
+ | ---- | ---- | ----------- | -------- |
690
+ | type | `string` | | &nbsp; |
691
+ | event | `InlogMaps.PolygonEventType` | | &nbsp; |
692
+ | eventFunction | `any` | | &nbsp; |
693
+ | condition | `any` | [nullable] | &nbsp; |
694
+
695
+
696
+
697
+
698
+ ##### Returns
699
+
700
+
701
+ - `Void`
702
+
703
+
704
+
705
+ #### Map.removePolygonEvent(type, event, condition)
706
+
707
+ This function remove events of polygon
708
+
709
+
710
+
711
+
712
+ ##### Parameters
713
+
714
+ | Name | Type | Description | |
715
+ | ---- | ---- | ----------- | -------- |
716
+ | type | `string` | | &nbsp; |
717
+ | event | `InlogMaps.PolygonEventType` | | &nbsp; |
718
+ | condition | `any` | [nullable] | &nbsp; |
719
+
720
+
721
+
722
+
723
+ ##### Returns
724
+
725
+
726
+ - `Void`
727
+
728
+
729
+
730
+ #### Map.drawCircle(type, options, eventClick)
731
+
732
+ Use this function to draw circles on the currentMap
733
+
734
+
735
+
736
+
737
+ ##### Parameters
738
+
739
+ | Name | Type | Description | |
740
+ | ---- | ---- | ----------- | -------- |
741
+ | type | `string` | | &nbsp; |
742
+ | options | `InlogMaps.CircleOptions` | | &nbsp; |
743
+ | eventClick | `any` | [nullable] | &nbsp; |
744
+
745
+
746
+
747
+
748
+ ##### Returns
749
+
750
+
751
+ - `Void`
752
+
753
+
754
+
755
+ #### Map.toggleCircles(show, type, condition)
756
+
757
+ Use this function to show/hide circles from a especific type
758
+
759
+
760
+
761
+
762
+ ##### Parameters
763
+
764
+ | Name | Type | Description | |
765
+ | ---- | ---- | ----------- | -------- |
766
+ | show | `boolean` | | &nbsp; |
767
+ | type | `string` | | &nbsp; |
768
+ | condition | `any` | toggle circles with the condition [nullable] | &nbsp; |
769
+
770
+
771
+
772
+
773
+ ##### Returns
774
+
775
+
776
+ - `Void`
777
+
778
+
779
+
780
+ #### Map.removeCircles(type, condition)
781
+
782
+ Remove circles from the map and from internal list
783
+
784
+
785
+
786
+
787
+ ##### Parameters
788
+
789
+ | Name | Type | Description | |
790
+ | ---- | ---- | ----------- | -------- |
791
+ | type | `string` | | &nbsp; |
792
+ | condition | `any` | remove circles with the condition [nullable] | &nbsp; |
793
+
794
+
795
+
796
+
797
+ ##### Returns
798
+
799
+
800
+ - `Void`
801
+
802
+
803
+
804
+ #### Map.removeAllCircles()
805
+
806
+ Remove all circles from the map and from the internal list
807
+
808
+
809
+
810
+
811
+
812
+
813
+ ##### Returns
814
+
815
+
816
+ - `Void`
817
+
818
+
819
+
820
+ #### Map.alterCircleOptions(type, options, condition)
821
+
822
+ Use this function to alter circle options
823
+
824
+
825
+
826
+
827
+ ##### Parameters
828
+
829
+ | Name | Type | Description | |
830
+ | ---- | ---- | ----------- | -------- |
831
+ | type | `string` | | &nbsp; |
832
+ | options | `InlogMaps.CircleAlterOptions` | | &nbsp; |
833
+ | condition | `any` | alter circle with the condition [nullable] | &nbsp; |
834
+
835
+
836
+
837
+
838
+ ##### Returns
839
+
840
+
841
+ - `Void`
842
+
843
+
844
+
845
+ #### Map.fitBoundsCircles(type, condition)
846
+
847
+ Use this function to fit bounds of a polygon
848
+
849
+
850
+
851
+
852
+ ##### Parameters
853
+
854
+ | Name | Type | Description | |
855
+ | ---- | ---- | ----------- | -------- |
856
+ | type | `string` | | &nbsp; |
857
+ | condition | `any` | fit polygon bounds with the condition [nullable] | &nbsp; |
858
+
859
+
860
+
861
+
862
+ ##### Returns
863
+
864
+
865
+ - `Void`
866
+
867
+
868
+
869
+ #### Map.circleExists(type, condition)
870
+
871
+ This functions returns if circle exists
872
+
873
+
874
+
875
+
876
+ ##### Parameters
877
+
878
+ | Name | Type | Description | |
879
+ | ---- | ---- | ----------- | -------- |
880
+ | type | `string` | | &nbsp; |
881
+ | condition | `any` | [nullable] | &nbsp; |
882
+
883
+
884
+
885
+
886
+ ##### Returns
887
+
888
+
889
+ - `boolean`
890
+
891
+
892
+
893
+ #### Map.getCircleCenter(type, condition)
894
+
895
+ This function return circle center
896
+
897
+
898
+
899
+
900
+ ##### Parameters
901
+
902
+ | Name | Type | Description | |
903
+ | ---- | ---- | ----------- | -------- |
904
+ | type | `string` | | &nbsp; |
905
+ | condition | `any` | [nullable] | &nbsp; |
906
+
907
+
908
+
909
+
910
+ ##### Returns
911
+
912
+
913
+ - `Array.&lt;number&gt;`
914
+
915
+
916
+
917
+ #### Map.getCircleRadius(type, condition)
918
+
919
+ This function return circle center
920
+
921
+
922
+
923
+
924
+ ##### Parameters
925
+
926
+ | Name | Type | Description | |
927
+ | ---- | ---- | ----------- | -------- |
928
+ | type | `string` | | &nbsp; |
929
+ | condition | `any` | [nullable] | &nbsp; |
930
+
931
+
932
+
933
+
934
+ ##### Returns
935
+
936
+
937
+ - `number`
938
+
939
+
940
+
941
+ #### Map.addCircleEvent(type, event, eventFunction, condition)
942
+
943
+ This function add new events on circle
944
+
945
+
946
+
947
+
948
+ ##### Parameters
949
+
950
+ | Name | Type | Description | |
951
+ | ---- | ---- | ----------- | -------- |
952
+ | type | `string` | | &nbsp; |
953
+ | event | `InlogMaps.CircleEventType` | | &nbsp; |
954
+ | eventFunction | `any` | | &nbsp; |
955
+ | condition | `any` | [nullable] | &nbsp; |
956
+
957
+
958
+
959
+
960
+ ##### Returns
961
+
962
+
963
+ - `Void`
964
+
965
+
966
+
967
+ #### Map.removeCircleEvent(type, event, condition)
968
+
969
+ This function remove events of circle
970
+
971
+
972
+
973
+
974
+ ##### Parameters
975
+
976
+ | Name | Type | Description | |
977
+ | ---- | ---- | ----------- | -------- |
978
+ | type | `string` | | &nbsp; |
979
+ | event | `InlogMaps.CircleEventType` | | &nbsp; |
980
+ | condition | `any` | [nullable] | &nbsp; |
981
+
982
+
983
+
984
+
985
+ ##### Returns
986
+
987
+
988
+ - `Void`
989
+
990
+
991
+
992
+ #### Map.drawPolyline(type, options, eventClick)
993
+
994
+ Use this function to draw polylines on the currentMap
995
+
996
+
997
+
998
+
999
+ ##### Parameters
1000
+
1001
+ | Name | Type | Description | |
1002
+ | ---- | ---- | ----------- | -------- |
1003
+ | type | `string` | | &nbsp; |
1004
+ | options | `InlogMaps.PolylineOptions` | | &nbsp; |
1005
+ | eventClick | `any` | [nullable] | &nbsp; |
1006
+
1007
+
1008
+
1009
+
1010
+ ##### Returns
1011
+
1012
+
1013
+ - `Void`
1014
+
1015
+
1016
+
1017
+ #### Map.drawPolylineWithNavigation(type, options)
1018
+
1019
+ Use this function to draw polylines with navigation on the currentMap
1020
+
1021
+
1022
+
1023
+
1024
+ ##### Parameters
1025
+
1026
+ | Name | Type | Description | |
1027
+ | ---- | ---- | ----------- | -------- |
1028
+ | type | `string` | | &nbsp; |
1029
+ | options | `InlogMaps.PolylineOptions` | | &nbsp; |
1030
+
1031
+
1032
+
1033
+
1034
+ ##### Returns
1035
+
1036
+
1037
+ - `Void`
1038
+
1039
+
1040
+
1041
+ #### Map.togglePolylines(show, type, condition)
1042
+
1043
+ Use this function to toggle polylines
1044
+
1045
+
1046
+
1047
+
1048
+ ##### Parameters
1049
+
1050
+ | Name | Type | Description | |
1051
+ | ---- | ---- | ----------- | -------- |
1052
+ | show | `boolean` | | &nbsp; |
1053
+ | type | `string` | | &nbsp; |
1054
+ | condition | `any` | toggle polyline with the condition [nullable] | &nbsp; |
1055
+
1056
+
1057
+
1058
+
1059
+ ##### Returns
1060
+
1061
+
1062
+ - `Void`
1063
+
1064
+
1065
+
1066
+ #### Map.removePolylines(type, condition)
1067
+
1068
+ Use this function to remove polylines
1069
+
1070
+
1071
+
1072
+
1073
+ ##### Parameters
1074
+
1075
+ | Name | Type | Description | |
1076
+ | ---- | ---- | ----------- | -------- |
1077
+ | type | `string` | | &nbsp; |
1078
+ | condition | `any` | remove polyline with the condition [nullable] | &nbsp; |
1079
+
1080
+
1081
+
1082
+
1083
+ ##### Returns
1084
+
1085
+
1086
+ - `Void`
1087
+
1088
+
1089
+
1090
+ #### Map.removeAllPolylines()
1091
+
1092
+ Remove all polylines from the map and from the internal list
1093
+
1094
+
1095
+
1096
+
1097
+
1098
+
1099
+ ##### Returns
1100
+
1101
+
1102
+ - `Void`
1103
+
1104
+
1105
+
1106
+ #### Map.alterPolylineOptions(type, options, condition)
1107
+
1108
+ Use this function to alter polyline options
1109
+
1110
+
1111
+
1112
+
1113
+ ##### Parameters
1114
+
1115
+ | Name | Type | Description | |
1116
+ | ---- | ---- | ----------- | -------- |
1117
+ | type | `string` | | &nbsp; |
1118
+ | options | `InlogMaps.PolylineOptions` | | &nbsp; |
1119
+ | condition | `any` | alter polyline with the condition [nullable] | &nbsp; |
1120
+
1121
+
1122
+
1123
+
1124
+ ##### Returns
1125
+
1126
+
1127
+ - `Void`
1128
+
1129
+
1130
+
1131
+ #### Map.fitBoundsPolylines(type, condition)
1132
+
1133
+ Use this functions to fit polylines bounds
1134
+
1135
+
1136
+
1137
+
1138
+ ##### Parameters
1139
+
1140
+ | Name | Type | Description | |
1141
+ | ---- | ---- | ----------- | -------- |
1142
+ | type | `string` | | &nbsp; |
1143
+ | condition | `any` | [nullable] | &nbsp; |
1144
+
1145
+
1146
+
1147
+
1148
+ ##### Returns
1149
+
1150
+
1151
+ - `Void`
1152
+
1153
+
1154
+
1155
+ #### Map.polylineExists(type, condition)
1156
+
1157
+ This functions returns if polyline exists
1158
+
1159
+
1160
+
1161
+
1162
+ ##### Parameters
1163
+
1164
+ | Name | Type | Description | |
1165
+ | ---- | ---- | ----------- | -------- |
1166
+ | type | `string` | | &nbsp; |
1167
+ | condition | `any` | [nullable] | &nbsp; |
1168
+
1169
+
1170
+
1171
+
1172
+ ##### Returns
1173
+
1174
+
1175
+ - `boolean`
1176
+
1177
+
1178
+
1179
+ #### Map.addPolylinePath(type, position, condition)
1180
+
1181
+ Use this function to add more paths to a polyline
1182
+
1183
+
1184
+
1185
+
1186
+ ##### Parameters
1187
+
1188
+ | Name | Type | Description | |
1189
+ | ---- | ---- | ----------- | -------- |
1190
+ | type | `string` | | &nbsp; |
1191
+ | position | `Array.<number>` | | &nbsp; |
1192
+ | condition | `any` | [nullable] | &nbsp; |
1193
+
1194
+
1195
+
1196
+
1197
+ ##### Returns
1198
+
1199
+
1200
+ - `Void`
1201
+
1202
+
1203
+
1204
+ #### Map.getPolylinePath(type, condition)
1205
+
1206
+ Use this function to get the path of some polyline
1207
+
1208
+
1209
+
1210
+
1211
+ ##### Parameters
1212
+
1213
+ | Name | Type | Description | |
1214
+ | ---- | ---- | ----------- | -------- |
1215
+ | type | `string` | | &nbsp; |
1216
+ | condition | `any` | | &nbsp; |
1217
+
1218
+
1219
+
1220
+
1221
+ ##### Returns
1222
+
1223
+
1224
+ - `Array.&lt;number&gt;`
1225
+
1226
+
1227
+
1228
+ #### Map.removePolylineHighlight()
1229
+
1230
+ Use this function to clear polyline selected from the currentMap
1231
+
1232
+
1233
+
1234
+
1235
+
1236
+
1237
+ ##### Returns
1238
+
1239
+
1240
+ - `Void`
1241
+
1242
+
1243
+
1244
+ #### Map.addPolylineEvent(type, event, eventFunction, condition)
1245
+
1246
+ Use this function to add listeners on polyline
1247
+
1248
+
1249
+
1250
+
1251
+ ##### Parameters
1252
+
1253
+ | Name | Type | Description | |
1254
+ | ---- | ---- | ----------- | -------- |
1255
+ | type | `string` | | &nbsp; |
1256
+ | event | `InlogMaps.PolylineEventType` | | &nbsp; |
1257
+ | eventFunction | `any` | | &nbsp; |
1258
+ | condition | `any` | [nullable] | &nbsp; |
1259
+
1260
+
1261
+
1262
+
1263
+ ##### Returns
1264
+
1265
+
1266
+ - `Void`
1267
+
1268
+
1269
+
1270
+ #### Map.removePolylineEvent(type, event, condition)
1271
+
1272
+ Use this function to remove listeners of polyline
1273
+
1274
+
1275
+
1276
+
1277
+ ##### Parameters
1278
+
1279
+ | Name | Type | Description | |
1280
+ | ---- | ---- | ----------- | -------- |
1281
+ | type | `string` | | &nbsp; |
1282
+ | event | `InlogMaps.PolylineEventType` | | &nbsp; |
1283
+ | condition | `any` | [nullable] | &nbsp; |
1284
+
1285
+
1286
+
1287
+
1288
+ ##### Returns
1289
+
1290
+
1291
+ - `Void`
1292
+
1293
+
1294
+
1295
+ #### Map.setIndexPolylineHighlight(type, initialIndex, condition)
1296
+
1297
+ Use this function to set position of polyline highlight
1298
+
1299
+
1300
+
1301
+
1302
+ ##### Parameters
1303
+
1304
+ | Name | Type | Description | |
1305
+ | ---- | ---- | ----------- | -------- |
1306
+ | type | `string` | | &nbsp; |
1307
+ | initialIndex | `number` | | &nbsp; |
1308
+ | condition | `any` | [nullable] | &nbsp; |
1309
+
1310
+
1311
+
1312
+
1313
+ ##### Returns
1314
+
1315
+
1316
+ - `Void`
1317
+
1318
+
1319
+
1320
+ #### Map.getObjectPolyline(type, condition)
1321
+
1322
+ Use this function to get the object of a polyline
1323
+
1324
+
1325
+
1326
+
1327
+ ##### Parameters
1328
+
1329
+ | Name | Type | Description | |
1330
+ | ---- | ---- | ----------- | -------- |
1331
+ | type | `string` | | &nbsp; |
1332
+ | condition | `any` | | &nbsp; |
1333
+
1334
+
1335
+
1336
+
1337
+ ##### Returns
1338
+
1339
+
1340
+ - `object`
1341
+
1342
+
1343
+
1344
+ #### Map.getObjectPolylineHighlight()
1345
+
1346
+ Use this function to get the object of the polyline highligth
1347
+
1348
+
1349
+
1350
+
1351
+
1352
+
1353
+ ##### Returns
1354
+
1355
+
1356
+ - `object`
1357
+
1358
+
1359
+
1360
+ #### Map.addPolylineHighlightEvent(event, eventFunction)
1361
+
1362
+ Use this function to add events on polyline highligtht / selected polyline
1363
+
1364
+
1365
+
1366
+
1367
+ ##### Parameters
1368
+
1369
+ | Name | Type | Description | |
1370
+ | ---- | ---- | ----------- | -------- |
1371
+ | event | `InlogMaps.PolylineEventType` | | &nbsp; |
1372
+ | eventFunction | `any` | | &nbsp; |
1373
+
1374
+
1375
+
1376
+
1377
+ ##### Returns
1378
+
1379
+
1380
+ - `Void`
1381
+
1382
+
1383
+
1384
+ #### Map.getPolylineHighlightIndex()
1385
+
1386
+ Use this function to get initial and final index of the polyline highlight
1387
+
1388
+
1389
+
1390
+
1391
+
1392
+
1393
+ ##### Returns
1394
+
1395
+
1396
+ - `Array.&lt;number&gt;` returns an array with initial index and final index
1397
+
1398
+
1399
+
1400
+ #### Map.drawPopup(type, options)
1401
+
1402
+ Use this function to draw popups on the currentMap
1403
+
1404
+
1405
+
1406
+
1407
+ ##### Parameters
1408
+
1409
+ | Name | Type | Description | |
1410
+ | ---- | ---- | ----------- | -------- |
1411
+ | type | `string` | | &nbsp; |
1412
+ | options | `InlogMaps.PopupOptions` | | &nbsp; |
1413
+
1414
+
1415
+
1416
+
1417
+ ##### Returns
1418
+
1419
+
1420
+ - `Void`
1421
+
1422
+
1423
+
1424
+ #### Map.alterPopup(type, options)
1425
+
1426
+ Use this function to alter popups
1427
+
1428
+
1429
+
1430
+
1431
+ ##### Parameters
1432
+
1433
+ | Name | Type | Description | |
1434
+ | ---- | ---- | ----------- | -------- |
1435
+ | type | `string` | | &nbsp; |
1436
+ | options | `InlogMaps.PopupOptions` | | &nbsp; |
1437
+
1438
+
1439
+
1440
+
1441
+ ##### Returns
1442
+
1443
+
1444
+ - `Void`
1445
+
1446
+
1447
+
1448
+ #### Map.getObjectOpenPopup(type)
1449
+
1450
+
1451
+
1452
+
1453
+
1454
+
1455
+ ##### Parameters
1456
+
1457
+ | Name | Type | Description | |
1458
+ | ---- | ---- | ----------- | -------- |
1459
+ | type | `string` | | &nbsp; |
1460
+
1461
+
1462
+
1463
+
1464
+ ##### Returns
1465
+
1466
+
1467
+ - `object`
1468
+
1469
+
1470
+
1471
+ #### Map.closePopup(type)
1472
+
1473
+ Use this function to close popup by type
1474
+
1475
+
1476
+
1477
+
1478
+ ##### Parameters
1479
+
1480
+ | Name | Type | Description | |
1481
+ | ---- | ---- | ----------- | -------- |
1482
+ | type | `string` | | &nbsp; |
1483
+
1484
+
1485
+
1486
+
1487
+ ##### Returns
1488
+
1489
+
1490
+ - `Void`
1491
+
1492
+
1493
+
1494
+ #### Map.closeAllPopups(type)
1495
+
1496
+ Use this function to close all popups
1497
+
1498
+
1499
+
1500
+
1501
+ ##### Parameters
1502
+
1503
+ | Name | Type | Description | |
1504
+ | ---- | ---- | ----------- | -------- |
1505
+ | type | `string` | | &nbsp; |
1506
+
1507
+
1508
+
1509
+
1510
+ ##### Returns
1511
+
1512
+
1513
+ - `Void`
1514
+
1515
+
1516
+
1517
+ #### Map.resizeMap()
1518
+
1519
+ Resize de map based on html size
1520
+
1521
+
1522
+
1523
+
1524
+
1525
+
1526
+ ##### Returns
1527
+
1528
+
1529
+ - `Void`
1530
+
1531
+
1532
+
1533
+ #### Map.addEventMap(eventType, eventFunction)
1534
+
1535
+ Use this function to add event clicks on the currentMap
1536
+
1537
+
1538
+
1539
+
1540
+ ##### Parameters
1541
+
1542
+ | Name | Type | Description | |
1543
+ | ---- | ---- | ----------- | -------- |
1544
+ | eventType | `InlogMaps.MapEventType` | | &nbsp; |
1545
+ | eventFunction | | function callback | &nbsp; |
1546
+
1547
+
1548
+
1549
+
1550
+ ##### Returns
1551
+
1552
+
1553
+ - `Void`
1554
+
1555
+
1556
+
1557
+ #### Map.removeEventMap(eventType)
1558
+
1559
+ Use this function to remove event clicks from the currentMap
1560
+
1561
+
1562
+
1563
+
1564
+ ##### Parameters
1565
+
1566
+ | Name | Type | Description | |
1567
+ | ---- | ---- | ----------- | -------- |
1568
+ | eventType | `InlogMaps.MapEventType` | | &nbsp; |
1569
+
1570
+
1571
+
1572
+
1573
+ ##### Returns
1574
+
1575
+
1576
+ - `Void`
1577
+
1578
+
1579
+
1580
+ #### Map.getZoom()
1581
+
1582
+ Returns the current zoom level of the map view
1583
+
1584
+
1585
+
1586
+
1587
+
1588
+
1589
+ ##### Returns
1590
+
1591
+
1592
+ - `number`
1593
+
1594
+
1595
+
1596
+ #### Map.setZoom(zoom)
1597
+
1598
+ Set the current zoom level of the map view
1599
+
1600
+
1601
+
1602
+
1603
+ ##### Parameters
1604
+
1605
+ | Name | Type | Description | |
1606
+ | ---- | ---- | ----------- | -------- |
1607
+ | zoom | `number` | | &nbsp; |
1608
+
1609
+
1610
+
1611
+
1612
+ ##### Returns
1613
+
1614
+
1615
+ - `Void`
1616
+
1617
+
1618
+
1619
+ #### Map.takeMapScreenshot()
1620
+
1621
+ Takes a screenshot with all the context included in it (visible area)
1622
+ Returns the image as a base64 string or null
1623
+
1624
+
1625
+
1626
+
1627
+
1628
+
1629
+ ##### Returns
1630
+
1631
+
1632
+ - `Promise.&lt;string|null&gt;`
1633
+
1634
+
1635
+
1636
+ #### Map.drawHeatMap(type, options)
1637
+
1638
+ Use this function to draw heatmaps in the currentMap
1639
+
1640
+
1641
+
1642
+
1643
+ ##### Parameters
1644
+
1645
+ | Name | Type | Description | |
1646
+ | ---- | ---- | ----------- | -------- |
1647
+ | type | `string` | | &nbsp; |
1648
+ | options | `HeatMapOptions` | | &nbsp; |
1649
+
1650
+
1651
+
1652
+
1653
+ ##### Returns
1654
+
1655
+
1656
+ - `Void`
1657
+
1658
+
1659
+
1660
+ #### Map.toggleHeatMaps(show, type, condition)
1661
+
1662
+ Use this function to show/hide heatmaps from a specific type
1663
+
1664
+
1665
+
1666
+
1667
+ ##### Parameters
1668
+
1669
+ | Name | Type | Description | |
1670
+ | ---- | ---- | ----------- | -------- |
1671
+ | show | `boolean` | | &nbsp; |
1672
+ | type | `string` | | &nbsp; |
1673
+ | condition | `any` | toggle heatmaps with the condition [nullable] | &nbsp; |
1674
+
1675
+
1676
+
1677
+
1678
+ ##### Returns
1679
+
1680
+
1681
+ - `Void`
1682
+
1683
+
1684
+
1685
+ #### Map.updateHeatMapData(type, data, condition)
1686
+
1687
+ Update heatmap data for a specific type
1688
+
1689
+
1690
+
1691
+
1692
+ ##### Parameters
1693
+
1694
+ | Name | Type | Description | |
1695
+ | ---- | ---- | ----------- | -------- |
1696
+ | type | `string` | | &nbsp; |
1697
+ | data | `Array.<Array.<number>>` | | &nbsp; |
1698
+ | condition | `any` | update heatmaps with the condition [nullable] | &nbsp; |
1699
+
1700
+
1701
+
1702
+
1703
+ ##### Returns
1704
+
1705
+
1706
+ - `Void`
1707
+
1708
+
1709
+
1710
+ #### Map.setHeatMapOptions(type, options, condition)
1711
+
1712
+ Set heatmap options for a specific type
1713
+
1714
+
1715
+
1716
+
1717
+ ##### Parameters
1718
+
1719
+ | Name | Type | Description | |
1720
+ | ---- | ---- | ----------- | -------- |
1721
+ | type | `string` | | &nbsp; |
1722
+ | options | `Partial.<HeatMapOptions>` | | &nbsp; |
1723
+ | condition | `any` | update heatmaps with the condition [nullable] | &nbsp; |
1724
+
1725
+
1726
+
1727
+
1728
+ ##### Returns
1729
+
1730
+
1731
+ - `Void`
1732
+
1733
+
1734
+
1735
+ #### Map.removeHeatMaps(type, condition)
1736
+
1737
+ Remove heatmaps from the map and from internal list
1738
+
1739
+
1740
+
1741
+
1742
+ ##### Parameters
1743
+
1744
+ | Name | Type | Description | |
1745
+ | ---- | ---- | ----------- | -------- |
1746
+ | type | `string` | | &nbsp; |
1747
+ | condition | `any` | remove heatmaps with the condition [nullable] | &nbsp; |
1748
+
1749
+
1750
+
1751
+
1752
+ ##### Returns
1753
+
1754
+
1755
+ - `Void`
1756
+
1757
+
1758
+
1759
+ #### Map.removeAllHeatMaps()
1760
+
1761
+ Remove all heatmaps from the map and from the internal list
1762
+
1763
+
1764
+
1765
+
1766
+
1767
+
1768
+ ##### Returns
1769
+
1770
+
1771
+ - `Void`
1772
+
1773
+
1774
+
1775
+ #### Map.isHeatMapOnMap(type, condition)
1776
+
1777
+ Check if heatmap is visible on map
1778
+
1779
+
1780
+
1781
+
1782
+ ##### Parameters
1783
+
1784
+ | Name | Type | Description | |
1785
+ | ---- | ---- | ----------- | -------- |
1786
+ | type | `string` | | &nbsp; |
1787
+ | condition | `any` | check heatmaps with the condition [nullable] | &nbsp; |
1788
+
1789
+
1790
+
1791
+
1792
+ ##### Returns
1793
+
1794
+
1795
+ - `boolean`
1796
+
1797
+
1798
+
1799
+ #### Map.removeRuler()
1800
+
1801
+ Remove ruler in the map
1802
+
1803
+
1804
+
1805
+
1806
+
1807
+
1808
+ ##### Returns
1809
+
1810
+
1811
+ -
1812
+
1813
+
1814
+
1815
+ #### Map.createRuler()
1816
+
1817
+ Create ruler in the map
1818
+
1819
+
1820
+
1821
+
1822
+
1823
+
1824
+ ##### Returns
1825
+
1826
+
1827
+ -
1828
+
1829
+
1830
+
1831
+ #### Map.getCenter()
1832
+
1833
+ Returns the center position of the map
1834
+
1835
+
1836
+
1837
+
1838
+
1839
+
1840
+ ##### Returns
1841
+
1842
+
1843
+ - `Array.&lt;number&gt;`
1844
+
1845
+
1846
+
1847
+ #### Map.setCenter(position)
1848
+
1849
+ Set the position center of the map
1850
+
1851
+
1852
+
1853
+
1854
+ ##### Parameters
1855
+
1856
+ | Name | Type | Description | |
1857
+ | ---- | ---- | ----------- | -------- |
1858
+ | position | `Array.<number>` | | &nbsp; |
1859
+
1860
+
1861
+
1862
+
1863
+ ##### Returns
1864
+
1865
+
1866
+ - `Void`
1867
+
1868
+
1869
+
1870
+ #### Map.pixelsToLatLng(offsetx, offsety)
1871
+
1872
+ Returns the coordinates from pixels
1873
+
1874
+
1875
+
1876
+
1877
+ ##### Parameters
1878
+
1879
+ | Name | Type | Description | |
1880
+ | ---- | ---- | ----------- | -------- |
1881
+ | offsetx | `number` | | &nbsp; |
1882
+ | offsety | `number` | | &nbsp; |
1883
+
1884
+
1885
+
1886
+
1887
+ ##### Returns
1888
+
1889
+
1890
+ - `Array.&lt;number&gt;`
1891
+
1892
+
1893
+
1894
+ #### Map.fitBoundsElements(type, condition)
1895
+
1896
+ Use this functions to fit bounds on elements with same type and condition
1897
+
1898
+
1899
+
1900
+
1901
+ ##### Parameters
1902
+
1903
+ | Name | Type | Description | |
1904
+ | ---- | ---- | ----------- | -------- |
1905
+ | type | `string` | | &nbsp; |
1906
+ | condition | `any` | [nullable] | &nbsp; |
1907
+
1908
+
1909
+
1910
+
1911
+ ##### Returns
1912
+
1913
+
1914
+ - `Void`
1915
+
1916
+
1917
+
1918
+ #### Map.drawOverlay(type, options)
1919
+
1920
+ Use this function to dray overlays on the current map
1921
+
1922
+
1923
+
1924
+
1925
+ ##### Parameters
1926
+
1927
+ | Name | Type | Description | |
1928
+ | ---- | ---- | ----------- | -------- |
1929
+ | type | `string` | | &nbsp; |
1930
+ | options | `InlogMaps.OverlayOptions` | | &nbsp; |
1931
+
1932
+
1933
+
1934
+
1935
+ ##### Returns
1936
+
1937
+
1938
+ - `Void`
1939
+
1940
+
1941
+
1942
+ #### Map.toggleOverlay(show, type, condition)
1943
+
1944
+ Use this function to show or hide overlay
1945
+
1946
+
1947
+
1948
+
1949
+ ##### Parameters
1950
+
1951
+ | Name | Type | Description | |
1952
+ | ---- | ---- | ----------- | -------- |
1953
+ | show | `boolean` | | &nbsp; |
1954
+ | type | `string` | | &nbsp; |
1955
+ | condition | `any` | [nullable] | &nbsp; |
1956
+
1957
+
1958
+
1959
+
1960
+ ##### Returns
1961
+
1962
+
1963
+ - `Void`
1964
+
1965
+
1966
+
1967
+ #### Map.removeOverlays(type, condition)
1968
+
1969
+ Remove overlays from the map and from internal list
1970
+
1971
+
1972
+
1973
+
1974
+ ##### Parameters
1975
+
1976
+ | Name | Type | Description | |
1977
+ | ---- | ---- | ----------- | -------- |
1978
+ | type | `string` | | &nbsp; |
1979
+ | condition | `any` | remove overlays with the condition [nullable] | &nbsp; |
1980
+
1981
+
1982
+
1983
+
1984
+ ##### Returns
1985
+
1986
+
1987
+ - `Void`
1988
+
1989
+
1990
+
1991
+ #### Map.removeAllOverlays()
1992
+
1993
+ Remove all overlays from the map and from the internal list
1994
+
1995
+
1996
+
1997
+
1998
+
1999
+
2000
+ ##### Returns
2001
+
2002
+
2003
+ - `Void`
2004
+
2005
+
2006
+
2007
+ #### Map.checkIdx(type, point, condition)
2008
+
2009
+ Use this function get idx polyline
2010
+
2011
+
2012
+
2013
+
2014
+ ##### Parameters
2015
+
2016
+ | Name | Type | Description | |
2017
+ | ---- | ---- | ----------- | -------- |
2018
+ | type | `string` | | &nbsp; |
2019
+ | point | `Array.<number>` | | &nbsp; |
2020
+ | condition | `any` | | &nbsp; |
2021
+
2022
+
2023
+
2024
+
2025
+ ##### Returns
2026
+
2027
+
2028
+ - `Void`
2029
+
2030
+
2031
+
2032
+
2033
+ *Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*