-
Notifications
You must be signed in to change notification settings - Fork 21
/
Copy pathpx-map-api.json
4711 lines (4711 loc) · 153 KB
/
px-map-api.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"schema_version": "1.0.0",
"elements": [
{
"description": "`px-map` is a lightweight framework for building interactive maps with web\ncomponents and Polymer. The framework includes a base mapping component\n(`<px-map>`) that can be used with many different subcomponents to solve\ncommon mapping UI problems, like plotting geographic data.\n\n### Usage\n\n#### Example: Basic map\n\nBelow is a simple example with little configuration that will display a map\ncentered on Tokyo, Japan:\n\n <px-map lat=\"35.6895\" lng=\"139.6917\" zoom=\"12\" style=\"width: 500px; height: 300px;\">\n <px-map-tile-layer url=\"https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png\"></px-map-tile-layer>\n <px-map-control-zoom position=\"bottomright\"></px-map-control-zoom>\n </px-map>\n\nThis example uses the `<px-map>` base component to draw a map and center it on\na specific location when it first loads.\n\nIf we stopped there and didn't add any subcomponents, the map would load, draw itself,\nand center on Tokyo, but we would only see a gray background. The map needs a\nbase layer — some underlying imagery that shows road networks or satellite imagery\nor terrain information. In this example, we use the `<px-map-tile-layer>` subcomponent\nto load imagery from an OpenStreetMap tile layer service showing the road network\nand other points of interest.\n\nFinally, we use the `<px-map-control-zoom>` subcomponent to add a zoom control\nthat lets the user click or tap buttons to zoom in and out of the map.\n\n#### Example: Visualizing geospatial data\n\nPlotting geospatial data on the map is easy — just choose the right subcomponent\nto show the information you have. For example, we can plot two points-of-interest\nin Tokyo using static markers:\n\n <px-map fit-to-markers style=\"width: 500px; height: 300px;\">\n <px-map-tile-layer url=\"https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png\"></px-map-tile-layer>\n <px-map-control-zoom position=\"bottomright\"></px-map-control-zoom>\n\n <px-map-layer-group name=\"Landmarks\">\n <px-map-marker-static lat=\"35.6763976\" lng=\"35.6763976\">\n <px-map-popup-info title=\"Meiji Jingu\" description=\"Shinto shrine dedicated to the Emperor Meiji and Empress Shoken.\"></px-map-popup-info>\n </px-map-marker-static>\n <px-map-marker-static lat=\"35.6654861\" lng=\"139.7706668\">\n <px-map-popup-info title=\"Tsukiji Market\" description=\"Sprawling wholesale fish market with an array of seafood & viewing areas for a popular tuna auction.\"></px-map-popup-info>\n </px-map-marker-static>\n </px-map-layer-group>\n </px-map>\n\nThis example sets up a `<px-map>` base component that will automatically set its\nlocation and zoom level to fit the markers we added. It adds a basic tile layer\n(`<px-map-tile-layer>`) and zoom control (`<px-map-zoom-control>`).\n\nTo plot related points of interest, we use the `<px-map-layer-group>` and give\nit a descriptive name. We add markers with geographic data that describes their\nlocation using `<px-map-marker-static>`. To give users more information about\neach point, we add popups to both markers with the name and description of the\nplace they represent using `<px-map-popup-info>`.\n\n### Styling\nThe following custom properties are available for styling:\n\nCustom property | Description\n:----------------|:-------------\n`--px-map-z-index` | Configurable z-index to position `px-map` within your app\n\n### What you can do with px-map\n\nOut of the box, `px-map` includes the basic things needed to draw and plot data\non an interactive map. It is also extensible — development teams are encouraged\nto build their own subcomponents that add features needed for their application.\n\nThe following components are available:\n\nBase map\n\n- `<px-map>`: Draws the underlying map, sets location/zoom and notifies updates when the user interacts with the map, enables and disables interactions, orchestrates subcomponents\n\nTile layers\n\n- `<px-map-tile-layer>`: Calls a tile service API to fetch underlying tile images for the map\n\nOverlay/visualization layers\n\n- `<px-map-layer-group>`: Groups related overlays together to allow for bulk interactions (e.g. hide all in the group)\n- `<px-map-marker-static>`: Creates a marker that shows the state of a point/asset (e.g. with color)\n- `<px-map-marker-symbol>`: Creates a marker with an icon that shows the state of a point/asset\n- `<px-map-marker-locate>`: Creates a marker that represents the user's location\n- `<px-map-marker-group>`: Draws many markers in clusters, useful for visualizing thousands of points that can be dynamically updated\n\nUI components\n\n- `<px-map-popup-info>`: Binds a popup that can include text or an image to markers\n- `<px-map-popup-data>`: Binds a popup that can include text and key/value data to markers\n\nControls\n\n- `<px-map-control-zoom>`: Adds zoom buttons the user can tap to zoom in or out\n- `<px-map-control-scale>`: Adds a scale that shows the distance of an area on the map in miles/kilometers\n- `<px-map-control-locate>`: Adds a button the user can tap to locate themselves on the map and center the map on their location\n\nThe current major release (v1.X) is focused on providing essential controls,\ntile layer API support, and on plotting point-based data (e.g. markers) and\nupdating the point data in real time. Support for drawing lines, polygons, and\nother geospatial data representations hasn't been added to the framework and will\nrequire some extensions if needed. New subcomponents will be added over time.\n\n### What's under the hood\n\nThe current major release of `px-map` uses the open source Leaflet library to\nsupport displaying a map with base tiles and geospatial overlays. Future iterations of\nthe component may offer the ability to use a different library in place of\nLeaflet, while keeping the same basic API.\n\n### Choosing a tile server\n\nMost px-map demos use the OpenStreetMap public tile service to serve map tiles\n(e.g. `https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png`) with the px-map-tile-layer\nsubcomponent. This tile service is used for demo purposes only. You should not use\nthis tile service for production applications; you will need to implement or\npurchase your own tile service.\n\nThe [OpenStreetMap Tile Usage Policy](https://operations.osmfoundation.org/policies/tiles/)\ndetails specific restrictions for developers using their public tile service.\nThese restrictions include the following provision: \"Heavy use (e.g. distributing\nan app that uses tiles from openstreetmap.org) is forbidden without prior\npermission\". If you choose to use the OpenStreetMap service for demos or development,\nyou should likely replace the service URLs when your app is shipped to production.\n\nThe following list of companies provide tile service APIs that may be free or\npaid and should be compatible with the px-map-tile-layer (note that these are\nnot endorsed, but just offered as options):\n\n - [Mapbox](https://www.mapbox.com/help/how-mapbox-data-works/)\n - [Carto](https://carto.com/location-data-services/basemaps/)\n - [Mapzen](https://mapzen.com/products/maps/)\n\nYou can also use the px-map-tile-layer-bing component to load map tiles from the Bing API.",
"summary": "",
"path": "px-map.html",
"properties": [
{
"name": "crs",
"type": "L.CRS",
"description": "The coordinate reference system to use when projecting geographic points\ninto pixel coordinates. Can only be set once before the map is first\ninitialized. If you don't know what this is, do not set it and the map\nwill default to the most common web mapping projection (EPSG3857).",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 291,
"column": 6
},
"end": {
"line": 293,
"column": 7
}
},
"metadata": {
"polymer": {
"attributeType": "Object"
}
},
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "lat",
"type": "Number",
"description": "The latitude of the active map center. Can be used to set or update\nthe center of the map, or read from after the user moves the map to\nget updated coordinates.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 302,
"column": 6
},
"end": {
"line": 307,
"column": 7
}
},
"metadata": {
"polymer": {
"notify": true,
"observer": "\"shouldUpdateInst\"",
"attributeType": "Number"
}
},
"defaultValue": "37.7672375",
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "lng",
"type": "Number",
"description": "The longitude of the active map center. Can be used to set or update\nthe center of the map, or read from after the user moves the map to\nget updated coordinates.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 316,
"column": 6
},
"end": {
"line": 321,
"column": 7
}
},
"metadata": {
"polymer": {
"notify": true,
"observer": "\"shouldUpdateInst\"",
"attributeType": "Number"
}
},
"defaultValue": "-121.9584131",
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "zoom",
"type": "Number",
"description": "The zoom level of the active map. Can be used to set or update\nthe zoom level of the map, or read from after the user changes the\nmap zoom level to an updated value.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 330,
"column": 6
},
"end": {
"line": 335,
"column": 7
}
},
"metadata": {
"polymer": {
"notify": true,
"observer": "\"shouldUpdateInst\"",
"attributeType": "Number"
}
},
"defaultValue": "10",
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "maxZoom",
"type": "Number",
"description": "The maximum zoom level for the active map (the furthest the user can\nzoom in). Setting it at the map level will take precedence over the\nmax zoom of all other layers, including tile layers. If you need to\nset different zoom bounds based on the visible tile layer, set the\nmax zoom directly on your tile layer.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 346,
"column": 6
},
"end": {
"line": 349,
"column": 7
}
},
"metadata": {
"polymer": {
"observer": "\"shouldUpdateInst\"",
"attributeType": "Number"
}
},
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "minZoom",
"type": "Number",
"description": "The minimum zoom level for the active map (the furthest the user can\nzoom out). Setting it at the map level will take precedence over the\nmin zoom of all other layers, including tile layers. If you need to\nset different zoom bounds based on the visible tile layer, set the\nmin zoom directly on your tile layer.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 360,
"column": 6
},
"end": {
"line": 363,
"column": 7
}
},
"metadata": {
"polymer": {
"observer": "\"shouldUpdateInst\"",
"attributeType": "Number"
}
},
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "unclampZoomToLayers",
"type": "Boolean",
"description": "If set, respects the configured minimum and maximum zoom levels even if they fall outside\nthe supported bounds of any children layers.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 371,
"column": 6
},
"end": {
"line": 375,
"column": 7
}
},
"metadata": {
"polymer": {
"observer": "\"shouldUpdateInst\"",
"attributeType": "Boolean"
}
},
"defaultValue": "false",
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "_clampedMinZoom",
"type": "Number",
"description": "Tracks the highest minimum zoom level supported by all children layers.",
"privacy": "protected",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 382,
"column": 6
},
"end": {
"line": 385,
"column": 7
}
},
"metadata": {
"polymer": {
"attributeType": "Number"
}
},
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "_clampedMaxZoom",
"type": "Number",
"description": "Tracks the lowest maximum zoom level supported by all children layers.",
"privacy": "protected",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 392,
"column": 6
},
"end": {
"line": 395,
"column": 7
}
},
"metadata": {
"polymer": {
"attributeType": "Number"
}
},
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "maxBounds",
"type": "Array",
"description": "Restricts the user from moving the map outside of a specific geographic\nboundary. The user will be bounced back if they attempt to pan outside the view.\nDisabled by default, letting the user pan to any point on the map.\n\nPass an array of [lat,lng] values like the following:\n\n [[40.712, -74.227], [40.774, -74.125]]\n\nThe first pair should represent the southwest extend of the boundary,\nand the second pair should represent the northeast extend of the\nboundary.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 412,
"column": 6
},
"end": {
"line": 415,
"column": 7
}
},
"metadata": {
"polymer": {
"observer": "\"shouldUpdateInst\"",
"attributeType": "Array"
}
},
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "disableDragging",
"type": "Boolean",
"description": "Set to disable dragging of the map with the mouse or by touch. Use to\nrestrict changing the map's visible area (e.g. for a static map) or\nto set up a map for being updated programmatically (e.g. through regular\nresponses from an API).",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 425,
"column": 6
},
"end": {
"line": 429,
"column": 7
}
},
"metadata": {
"polymer": {
"observer": "\"shouldUpdateInst\"",
"attributeType": "Boolean"
}
},
"defaultValue": "false",
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "disableScrollZoom",
"type": "Boolean",
"description": "Set to disable zooming with the scroll wheel. Useful if you have a map\nthat takes up the full width of a page and want to allow the user to\nscroll/swipe past without getting stuck in a zoom-in-zoom-out loop.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 438,
"column": 6
},
"end": {
"line": 442,
"column": 7
}
},
"metadata": {
"polymer": {
"observer": "\"shouldUpdateInst\"",
"attributeType": "Boolean"
}
},
"defaultValue": "false",
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "disableTouchZoom",
"type": "Boolean",
"description": "Set to disable the two-finger zoom gesture on touch devices.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 449,
"column": 6
},
"end": {
"line": 453,
"column": 7
}
},
"metadata": {
"polymer": {
"observer": "\"shouldUpdateInst\"",
"attributeType": "Boolean"
}
},
"defaultValue": "false",
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "disableDoubleClickZoom",
"type": "Boolean",
"description": "Set to disable zooming on double-click.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 460,
"column": 6
},
"end": {
"line": 464,
"column": 7
}
},
"metadata": {
"polymer": {
"observer": "\"shouldUpdateInst\"",
"attributeType": "Boolean"
}
},
"defaultValue": "false",
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "disableAttribution",
"type": "Boolean",
"description": "Set to disable the attribution control, which can be used to show the\nsource of tile layers or other data overlays.\n\nThis property is not dynamic and can only be set once when the map is\nfirst initialized.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 475,
"column": 6
},
"end": {
"line": 478,
"column": 7
}
},
"metadata": {
"polymer": {
"attributeType": "Boolean"
}
},
"defaultValue": "false",
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "attributionPrefix",
"type": "String",
"description": "Stringified HTML that will be used as the first item in your attribution\nlist. Pass an <a> tag with a link to more information about your\nattribution source. Example: '<a href=\"https://example.com\">Example</a>'\n\nDefaults to a link to the Leaflet.js library. If an empty string is\npassed (\"\") the prefix will be hidden.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 490,
"column": 6
},
"end": {
"line": 494,
"column": 7
}
},
"metadata": {
"polymer": {
"observer": "\"shouldUpdateInst\"",
"attributeType": "String"
}
},
"defaultValue": "\"<a href=\\\"http://leafletjs.com\\\" title=\\\"A JS library for interactive maps\\\">Leaflet</a>\"",
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "flexToSize",
"type": "Boolean",
"description": "Uses flexbox to set the size of the map. Set the parent container\nto use `display: flex;` in your CSS and the map will automatically\nfill the container's available height and width.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 503,
"column": 6
},
"end": {
"line": 507,
"column": 7
}
},
"metadata": {
"polymer": {
"attributeType": "Boolean"
}
},
"defaultValue": "false",
"inheritedFrom": "PxMapBehavior.LeafletRoot"
}
],
"methods": [
{
"name": "beforeRegister",
"description": "",
"privacy": "protected",
"sourceRange": {
"file": "px-map-behavior-element.es6.js",
"start": {
"line": 32,
"column": 4
},
"end": {
"line": 43,
"column": 5
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.Element"
},
{
"name": "attached",
"description": "",
"privacy": "protected",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 510,
"column": 4
},
"end": {
"line": 529,
"column": 5
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "detached",
"description": "",
"privacy": "protected",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 531,
"column": 4
},
"end": {
"line": 535,
"column": 5
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "notifyInstReady",
"description": "If this element's instance is ready to create and add to its parent,\nfires an event the parent will catch.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-element.es6.js",
"start": {
"line": 60,
"column": 4
},
"end": {
"line": 64,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "isReady",
"type": "Boolean",
"defaultValue": "true",
"description": "If `true` instance parent will be notified"
}
],
"return": {
"type": "Boolean",
"desc": "If `true` the parent was notified"
},
"inheritedFrom": "PxMapBehavior.Element"
},
{
"name": "shouldAddInst",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 537,
"column": 4
},
"end": {
"line": 542,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "evt"
}
],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "shouldRemoveInst",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-element.es6.js",
"start": {
"line": 78,
"column": 4
},
"end": {
"line": 82,
"column": 5
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.Element"
},
{
"name": "shouldUpdateInst",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-element.es6.js",
"start": {
"line": 87,
"column": 4
},
"end": {
"line": 101,
"column": 5
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.Element"
},
{
"name": "createInst",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 550,
"column": 4
},
"end": {
"line": 560,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "options"
}
],
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "updateInst",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 620,
"column": 4
},
"end": {
"line": 686,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "lastOptions"
},
{
"name": "nextOptions"
}
],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "getInstOptions",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 595,
"column": 4
},
"end": {
"line": 618,
"column": 5
}
},
"metadata": {},
"params": [],
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "addInst",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 562,
"column": 4
},
"end": {
"line": 586,
"column": 5
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "removeInst",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-root.es6.js",
"start": {
"line": 588,
"column": 4
},
"end": {
"line": 593,
"column": 5
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.LeafletRoot"
},
{
"name": "extendObj",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-element.es6.js",
"start": {
"line": 127,
"column": 4
},
"end": {
"line": 133,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "obj"
},
{
"name": "properties",
"rest": true
}
],
"inheritedFrom": "PxMapBehavior.Element"
},
{
"name": "addProperties",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-element.es6.js",
"start": {
"line": 135,
"column": 4
},
"end": {
"line": 141,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "properties",
"rest": true
}
],
"inheritedFrom": "PxMapBehavior.Element"
},
{
"name": "bindEvents",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-element.es6.js",
"start": {
"line": 143,
"column": 4
},
"end": {
"line": 159,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "evts"
},
{
"name": "target"
}
],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.Element"
},
{
"name": "unbindAllEvents",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-element.es6.js",
"start": {
"line": 161,
"column": 4
},
"end": {
"line": 173,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "boundEvts"
},
{
"name": "boundEvtEls"
}
],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.Element"
},
{
"name": "isShadyScoped",
"description": "If this component is being drawn in Shady DOM, returns true. Used to\nensure the shady DOM scope classes are applied when we make DOM\ntransactions that can't be reviewed by the scopeSubtree observer\nin the root `px-map` component that is the parent of all elements.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-element.es6.js",
"start": {
"line": 183,
"column": 4
},
"end": {
"line": 185,
"column": 5
}
},
"metadata": {},
"params": [],
"return": {
"type": "Boolean"
},
"inheritedFrom": "PxMapBehavior.Element"
},
{
"name": "getShadyScope",
"description": "Returns the stringified shady DOM scope classes. Useful for ensuring they're\napplied during DOM transactions that can't be reviewed by the scopeSubtree\nobserver in the root `px-map` component that is the parent of all elements.",
"privacy": "public",
"sourceRange": {
"file": "px-map-behavior-element.es6.js",
"start": {
"line": 194,
"column": 4
},
"end": {
"line": 196,
"column": 5
}
},
"metadata": {},
"params": [],
"return": {
"type": "String",
"desc": "A list of CSS classes separated by spaces"
},
"inheritedFrom": "PxMapBehavior.Element"
},
{
"name": "created",
"description": "",
"privacy": "protected",
"sourceRange": {
"file": "px-map-behavior-layer.es6.js",
"start": {
"line": 119,
"column": 4
},
"end": {
"line": 122,
"column": 5
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.ParentLayer"
},
{
"name": "_tryToAddAllChildren",
"description": "",
"privacy": "protected",
"sourceRange": {
"file": "px-map-behavior-layer.es6.js",
"start": {
"line": 130,
"column": 4
},
"end": {
"line": 138,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "evt"
}
],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.ParentLayer"
},
{
"name": "_tryToAddOneChild",
"description": "",
"privacy": "protected",
"sourceRange": {
"file": "px-map-behavior-layer.es6.js",
"start": {
"line": 140,
"column": 4
},
"end": {
"line": 152,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "evt"
}
],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.ParentLayer"
},
{
"name": "_attachLayerChildren",
"description": "",
"privacy": "protected",
"sourceRange": {
"file": "px-map-behavior-layer.es6.js",
"start": {
"line": 154,
"column": 4
},
"end": {
"line": 161,
"column": 5
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.ParentLayer"
},
{
"name": "_attachLayerChild",
"description": "",
"privacy": "protected",
"sourceRange": {
"file": "px-map-behavior-layer.es6.js",
"start": {
"line": 163,
"column": 4
},
"end": {
"line": 168,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "childEl"
}
],
"return": {
"type": "void"
},
"inheritedFrom": "PxMapBehavior.ParentLayer"
},
{
"name": "_detachLayerChildren",
"description": "",
"privacy": "protected",
"sourceRange": {
"file": "px-map-behavior-layer.es6.js",
"start": {
"line": 172,
"column": 4
},
"end": {
"line": 179,
"column": 5
}
},
"metadata": {},