forked from NICEXAI/leaflet_zh
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreference.html
25388 lines (21629 loc) · 858 KB
/
reference.html
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
---
layout: v2
title: Documentation
bodyclass: api-page
---
<h2>Leaflet API 文档</h2>
<p>当前所使用的 <strong>Leaflet 版本为 1.9.3</strong>. 如果你使用的是版本不一致，请下载使用<a href='reference-versions.html'>对应版本</a>.</p>
<div id="toc" class="clearfix">
<div class="toc-col map-col">
<h4>地图</h4>
<ul>
<li><a href="#map-example">使用示例</a></li>
<li><a href="#map-factory">创建对象</a></li>
<li><a href="#map-option">Options 选项</a></li>
<li><a href="#map-event">事件</a></li>
</ul>
<h4>地图方法</h4>
<ul>
<li><a href="#map-methods-for-layers-and-controls">图层和控件</a></li>
<li><a href="#map-methods-for-modifying-map-state">修改地图状态</a></li>
<li><a href="#map-methods-for-getting-map-state">获取地图状态</a></li>
<li><a href="#map-conversion-methods">转换</a></li>
<li><a href="#map-other-methods">其它</a></li>
</ul>
<h4>地图杂项</h4>
<ul>
<li><a href="#map-property">Properties 属性</a></li>
<li><a href="#map-pane">Panes 窗格</a></li>
</ul>
</div>
<div class="toc-col">
<h4>UI 图层</h4>
<ul>
<li><a href="#marker">Marker 标记</a></li>
<li><a href="#divoverlay">DivOverlay</a></li>
<li><a href="#popup">Popup 弹出窗口</a></li>
<li><a href="#tooltip">Tooltip 工具提示</a></li>
</ul>
<h4>栅格图层</h4>
<ul>
<li><a href="#tilelayer">TileLayer</a></li>
<li><a href="#tilelayer-wms">TileLayer.WMS</a></li>
<li><a href="#imageoverlay">ImageOverlay</a></li>
<li><a href="#videooverlay">VideoOverlay</a></li>
</ul>
<h4>矢量图层</h4>
<ul>
<li><a href="#path">Path 路径</a></li>
<li><a href="#polyline">Polyline 折线</a></li>
<li><a href="#polygon">Polygon 多边形</a></li>
<li><a href="#rectangle">Rectangle 矩形</a></li>
<li><a href="#circle">Circle 圆形</a></li>
<li><a href="#circlemarker">CircleMarker 圆形标记</a></li>
<li><a href="#svgoverlay">SVGOverlay</a></li>
<li><a href="#svg">SVG 矢量渲染器</a></li>
<li><a href="#canvas">Canvas 矢量渲染器</a></li>
</ul>
</div>
<div class="toc-col">
<h4>其它图层</h4>
<ul>
<li><a href="#layergroup">LayerGroup 图层组</a></li>
<li><a href="#featuregroup">FeatureGroup 要素组</a></li>
<li><a href="#geojson">GeoJSON 图层</a></li>
<li><a href="#gridlayer">GridLayer 网格图层</a></li>
</ul>
<h4>基本类型</h4>
<ul>
<li><a href="#latlng">LatLng 经纬度</a></li>
<li><a href="#latlngbounds">LatLngBounds 经纬度边界</a></li>
<li><a href="#point">Point 点</a></li>
<li><a href="#bounds">Bounds 边界</a></li>
<li><a href="#icon">Icon 图标</a></li>
<li><a href="#divicon">DivIcon</a></li>
</ul>
<h4>控件</h4>
<ul>
<li><a href="#control-zoom">Zoom 缩放</a></li>
<li><a href="#control-attribution">Attribution 版权</a></li>
<li><a href="#control-layers">Layers 图层</a></li>
<li><a href="#control-scale">Scale 比例尺</a></li>
</ul>
</div>
<div class="toc-col">
<h4>Util 常用方法类</h4>
<ul>
<li><a href="#browser">Browser 浏览器</a></li>
<li><a href="#util">Util 工具</a></li>
<li><a href="#transformation">Transformation 转换</a></li>
<li><a href="#lineutil">LineUtil 折线工具</a></li>
<li><a href="#polyutil">PolyUtil 多边形工具</a></li>
</ul>
<h4>DOM 常用方法类</h4>
<ul>
<li><a href="#domevent">DomEvent</a></li>
<li><a href="#domutil">DomUtil</a></li>
<li><a href="#posanimation">PosAnimation 平移动画</a></li>
<li><a href="#draggable">Draggable 拖动</a></li>
</ul>
</div>
<div class="toc-col last-col">
<h4>基础类</h4>
<ul>
<li><a href="#class">Class 类</a></li>
<li><a href="#evented">Evented 事件</a></li>
<li><a href="#layer">Layer 图层</a></li>
<li><a href="#interactive-layer">Interactive layer 交互图层</a></li>
<li><a href="#control">Control 控件</a></li>
<li><a href="#handler">Handler 处理程序</a></li>
<!--<li><a class="nodocs" href="#">IFeature</a></li>-->
<li><a href="#projection">Projection 地图投影</a></li>
<li><a href="#crs">CRS 坐标系</a></li>
<li><a href="#renderer">Renderer 矢量渲染器</a></li>
</ul>
<h4>其它</h4>
<ul>
<li><a href="#event-objects">Event objects 事件对象</a></li>
<li><a href="#global-switches">Global switches 全局开关</a></li>
<li><a href="#noconflict">noConflict 原始值</a></li>
<li><a href="#version">version 版本号</a></li>
</ul>
</div>
</div>
<h2 id='map'>地图</h2><p>API 的核心类 — 它用来在页面中创建并操作地图。</p>
<section>
<h3 id='map-example'>使用示例</h3>
<section >
<pre><code class="language-js">// 使用 id 为 map 的 div 容器初始化地图，同时指定地图的中心点和缩放级别
var map = L.map('map', {
center: [51.505, -0.09],
zoom: 13
});
</code></pre>
</section>
</section><section>
<h3 id='map-factory'>创建对象</h3>
<section >
<table><thead>
<tr>
<th>工厂函数</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-l-map'>
<td><code><b>L.map</b>(<nobr><String></nobr> <i>id</i>, <nobr><Map options></nobr> <i>options?</i>)</code></td>
<td>在一个指定 id 的 div 元素中初始化地图并设置相关参数。</td>
</tr>
<tr id='map-l-map'>
<td><code><b>L.map</b>(<nobr><HTMLElement></nobr> <i>el</i>, <nobr><Map options></nobr> <i>options?</i>)</code></td>
<td>在一个 div 实例中初始化地图并设置相关参数。</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='map-option'>Options 选项</h3>
<section >
<table><thead>
<tr>
<th>选项</th>
<th>类型</th>
<th>默认值</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-prefercanvas'>
<td><code><b>preferCanvas</b></code></td>
<td><code>Boolean</code></td>
<td><code>false</code></td>
<td>是否使用 <a href="#canvas"><code>Canvas</code></a> 来渲染 <a
href="#path"><code>Path</code></a>（路径）.默认情况下，所有 Path 都是使用 <a href="#svg"><code>SVG</code></a> 进行渲染。</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-control-options'>控件选项</h4>
<table><thead>
<tr>
<th>选项</th>
<th>类型</th>
<th>默认值</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-attributioncontrol'>
<td><code><b>attributionControl</b></code></td>
<td><code>Boolean</code></td>
<td><code>true</code></td>
<td>默认情况下，是否将 <a href="#control-attribution">attribution</a> 版权控件添加到地图中。</td>
</tr>
<tr id='map-zoomcontrol'>
<td><code><b>zoomControl</b></code></td>
<td><code>Boolean</code></td>
<td><code>true</code></td>
<td>默认情况下，是否将 <a href="#control-zoom">zoom</a> 缩放控件添加到地图中。</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-interaction-options'>交互选项</h4>
<table><thead>
<tr>
<th>选项</th>
<th>类型</th>
<th>默认值</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-closepopuponclick'>
<td><code><b>closePopupOnClick</b></code></td>
<td><code>Boolean</code></td>
<td><code>true</code></td>
<td>如果你不希望用户点击地图时 popups（弹出窗口）自动关闭，则可以将其设置为 false。</td>
</tr>
<tr id='map-zoomsnap'>
<td><code><b>zoomSnap</b></code></td>
<td><code>Number</code></td>
<td><code>1</code></td>
<td>强制让地图的缩放级别始终为这个值的倍数，特别是在 <a href="#map-fitbounds"><code>fitBounds()</code></a> 或 pinch-zoom 后。默认情况下，缩放级别将是其最接近的整数；
较低的值（例如 0.5 or 0.1）允许更大的颗粒度。数值 0 意味着缩放级别将不会被 fitBounds 或 pinch-zoom。</td>
</tr>
<tr id='map-zoomdelta'>
<td><code><b>zoomDelta</b></code></td>
<td><code>Number</code></td>
<td><code>1</code></td>
<td>控件在进行 <a href="#map-zoomin"><code>zoomIn()</code></a>、 <a href="#map-zoomout"><code>zoomOut()</code></a>
以及按 + - 键或者使用 <a href="#control-zoom">zoom</a> 进行缩放之后，地图缩放级别改变的值。小于 1 的值（例如 0.5）允许更大的颗粒度。</td>
</tr>
<tr id='map-trackresize'>
<td><code><b>trackResize</b></code></td>
<td><code>Boolean</code></td>
<td><code>true</code></td>
<td>地图是否会自动根据浏览器窗口的大小来更新自己。</td>
</tr>
<tr id='map-boxzoom'>
<td><code><b>boxZoom</b></code></td>
<td><code>Boolean</code></td>
<td><code>true</code></td>
<td>是否可以在按住 shift 键的同时拖动鼠标将地图缩放到指定的矩形区域。</td>
</tr>
<tr id='map-doubleclickzoom'>
<td><code><b>doubleClickZoom</b></code></td>
<td><code>Boolean|String</code></td>
<td><code>true</code></td>
<td>地图是否可以通过双击来放大，以及在按住 shift 的同时双击来缩小。如果设置为 'center'，不管鼠标在哪里，双击缩放都将缩放到视图的中心。</td>
</tr>
<tr id='map-dragging'>
<td><code><b>dragging</b></code></td>
<td><code>Boolean</code></td>
<td><code>true</code></td>
<td>地图是否可以通过 mouse/touch 进行拖动。</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-map-state-options'>地图状态选项</h4>
<table><thead>
<tr>
<th>选项</th>
<th>类型</th>
<th>默认值</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-crs'>
<td><code><b>crs</b></code></td>
<td><code><a href='#crs'>CRS</a></code></td>
<td><code>L.CRS.EPSG3857</code></td>
<td>该地图使用的<a href="#crs">坐标系</a>。如果你不确定坐标系这是什么意思，请不要更改它。</td>
</tr>
<tr id='map-center'>
<td><code><b>center</b></code></td>
<td><code><a href='#latlng'>LatLng</a></code></td>
<td><code>undefined</code></td>
<td>地图初始化时的中心点位置</td>
</tr>
<tr id='map-zoom'>
<td><code><b>zoom</b></code></td>
<td><code>Number</code></td>
<td><code>undefined</code></td>
<td>地图初始化时的缩放等级</td>
</tr>
<tr id='map-minzoom'>
<td><code><b>minZoom</b></code></td>
<td><code>Number</code></td>
<td><code>*</code></td>
<td>地图的最小缩放级别。 如果未指定，并且地图中至少有一个 <a href="#gridlayer"><code>GridLayer</code></a> 或 <a
href="#tilelayer"><code>TileLayer</code></a>，则将使用其最低的 minZoom 选项。</td>
</tr>
<tr id='map-maxzoom'>
<td><code><b>maxZoom</b></code></td>
<td><code>Number</code></td>
<td><code>*</code></td>
<td>地图的最大缩放级别。 如果未指定，并且地图中至少有一个 <a href="#gridlayer"><code>GridLayer</code></a> 或 <a
href="#tilelayer"><code>TileLayer</code></a>，则将使用其最大的 maxZoom 选项。</td>
</tr>
<tr id='map-layers'>
<td><code><b>layers</b></code></td>
<td><code>Layer[]</code></td>
<td><code>[]</code></td>
<td>默认添加到地图上的图层组</td>
</tr>
<tr id='map-maxbounds'>
<td><code><b>maxBounds</b></code></td>
<td><code><a href='#latlngbounds'>LatLngBounds</a></code></td>
<td><code>null</code></td>
<td>当这个选项被设置后，地图将被限制在指定的地理边界内， 当用户平移将地图拖动到视图以外的范围时会出现弹回的效果， 并且也不允许缩小视图到指定范围以外的区域（这取决于地图的尺寸）. 要动态设置此限制，请使用 <a
href="#map-setmaxbounds"><code>setMaxBounds</code></a> 方法。</td>
</tr>
<tr id='map-renderer'>
<td><code><b>renderer</b></code></td>
<td><code><a href='#renderer'>Renderer</a></code></td>
<td><code>*</code></td>
<td>在地图上绘制矢量图层的默认方法，默认为 <a href="#svg"><code>L.SVG</code></a> 或 <a href="#canvas"><code>L.Canvas</code></a>，
这取决于浏览器是否支持。</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-animation-options'>动画选项</h4>
<table><thead>
<tr>
<th>选项</th>
<th>类型</th>
<th>默认值</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-zoomanimation'>
<td><code><b>zoomAnimation</b></code></td>
<td><code>Boolean</code></td>
<td><code>true</code></td>
<td>是否启用地图缩放动画。默认情况下，它在所有支持 CSS3 Transitions 的浏览器中都是启用的，Android 除外。</td>
</tr>
<tr id='map-zoomanimationthreshold'>
<td><code><b>zoomAnimationThreshold</b></code></td>
<td><code>Number</code></td>
<td><code>4</code></td>
<td>如果缩放差异超过此值，则不会为缩放设置动画。</td>
</tr>
<tr id='map-fadeanimation'>
<td><code><b>fadeAnimation</b></code></td>
<td><code>Boolean</code></td>
<td><code>true</code></td>
<td>是否启用淡出淡出动画。默认情况下，它在所有支持 CSS3 Transitions 的浏览器中都是启用的，Android 除外。</td>
</tr>
<tr id='map-markerzoomanimation'>
<td><code><b>markerZoomAnimation</b></code></td>
<td><code>Boolean</code></td>
<td><code>true</code></td>
<td>Marker 标记是否使用缩放动画进行缩放。默认情况下，它在所有支持 CSS3 Transitions 的浏览器中都是启用的，Android 除外。</td>
</tr>
<tr id='map-transform3dlimit'>
<td><code><b>transform3DLimit</b></code></td>
<td><code>Number</code></td>
<td><code>2^23</code></td>
<td>定义了 CSS 转换的最大尺寸。默认值不应该被改变，除非网页浏览器在做了一个大的 panBy 后将层定位在错误的地方。</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-panning-inertia-options'>Panning Inertia 选项</h4>
<table><thead>
<tr>
<th>选项</th>
<th>类型</th>
<th>默认值</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-inertia'>
<td><code><b>inertia</b></code></td>
<td><code>Boolean</code></td>
<td><code>*</code></td>
<td>如果启用，地图的平移会有一种惯性效应，即地图在拖动时形成动力，并在一段时间内继续向同一方向移动。在触摸设备上感觉特别好。除非在旧的 Android 设备上运行，否则默认情况下是启用的。</td>
</tr>
<tr id='map-inertiadeceleration'>
<td><code><b>inertiaDeceleration</b></code></td>
<td><code>Number</code></td>
<td><code>3000</code></td>
<td>惯性运动减速的速度, 以像素/秒²单位。</td>
</tr>
<tr id='map-inertiamaxspeed'>
<td><code><b>inertiaMaxSpeed</b></code></td>
<td><code>Number</code></td>
<td><code>Infinity</code></td>
<td>惯性运动的最大速度，以像素/秒为单位。</td>
</tr>
<tr id='map-easelinearity'>
<td><code><b>easeLinearity</b></code></td>
<td><code>Number</code></td>
<td><code>0.2</code></td>
<td></td>
</tr>
<tr id='map-worldcopyjump'>
<td><code><b>worldCopyJump</b></code></td>
<td><code>Boolean</code></td>
<td><code>false</code></td>
<td>启用该选项后，当你平移到世界的另一个 "copy" 时，地图会跟踪并无缝跳转到原来的副本，这样所有的覆盖物如 markers（标记）和 vector layers（矢量图层）都仍然可见。</td>
</tr>
<tr id='map-maxboundsviscosity'>
<td><code><b>maxBoundsViscosity</b></code></td>
<td><code>Number</code></td>
<td><code>0.0</code></td>
<td>如果设置了 maxBounds，这个选项将控制拖动地图时边界的稳固程度。默认值为 0.0，允许用户以正常速度在界外拖动，更高的值会减慢地图在界外的拖动速度，而 1.0 使界外完全稳固，防止用户在界外拖动。</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-keyboard-navigation-options'>按键导航选项</h4>
<table><thead>
<tr>
<th>选项</th>
<th>类型</th>
<th>默认值</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-keyboard'>
<td><code><b>keyboard</b></code></td>
<td><code>Boolean</code></td>
<td><code>true</code></td>
<td>地图是否获得焦点，并且允许用户通过键盘和 +/- 来进行浏览地图。</td>
</tr>
<tr id='map-keyboardpandelta'>
<td><code><b>keyboardPanDelta</b></code></td>
<td><code>Number</code></td>
<td><code>80</code></td>
<td>按下方向键时，平移的像素数量。</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-mouse-wheel-options'>鼠标选项</h4>
<table><thead>
<tr>
<th>选项</th>
<th>类型</th>
<th>默认值</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-scrollwheelzoom'>
<td><code><b>scrollWheelZoom</b></code></td>
<td><code>Boolean|String</code></td>
<td><code>true</code></td>
<td>地图是否允许通过使用鼠标滚轮进行缩放。如果通过'center'，不管鼠标在哪里，都将会放大到视图的中心。</td>
</tr>
<tr id='map-wheeldebouncetime'>
<td><code><b>wheelDebounceTime</b></code></td>
<td><code>Number</code></td>
<td><code>40</code></td>
<td>限制滚轮的触发速度（以毫秒为单位）。默认情况下，用户通过滚轮缩放的次数不能超过每 40 毫秒一次。</td>
</tr>
<tr id='map-wheelpxperzoomlevel'>
<td><code><b>wheelPxPerZoomLevel</b></code></td>
<td><code>Number</code></td>
<td><code>60</code></td>
<td>多少滚动像素（由 <a href="#domevent-getwheeldelta">L.DomEvent.getWheelDelta</a> 报告）意味着一个完整缩放级别的更改。
较小的值将使滚轮变焦更快（反之亦然）</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-touch-interaction-options'>触摸交互选项</h4>
<table><thead>
<tr>
<th>选项</th>
<th>类型</th>
<th>默认值</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-taphold'>
<td><code><b>tapHold</b></code></td>
<td><code>Boolean</code></td>
<td><code></code></td>
<td>是否启用 mobile hacks 以支持 taps（在 iOS / Android上 修复 200ms 点击延迟）和 touch（触发 contextmenu 事件）。</td>
</tr>
<tr id='map-taptolerance'>
<td><code><b>tapTolerance</b></code></td>
<td><code>Number</code></td>
<td><code>15</code></td>
<td>用户在触摸时，移动手指的像素数超过此值时被认为是有效的 tap。</td>
</tr>
<tr id='map-touchzoom'>
<td><code><b>touchZoom</b></code></td>
<td><code>Boolean|String</code></td>
<td><code>*</code></td>
<td>地图是否允许通过两根手指的触摸拖动进行缩放。如果通过 'center'，就会放大到视图的中心，而不管 touch 事件（手指）在哪里。除了老式的 Android 系统外，对具有 touch-capable 功能的网络浏览器来说是启用的。</td>
</tr>
<tr id='map-bounceatzoomlimits'>
<td><code><b>bounceAtZoomLimits</b></code></td>
<td><code>Boolean</code></td>
<td><code>true</code></td>
<td>如果您不希望在地图缩放超过最小/最大缩放范围时反弹，请将其设置为 false。</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='map-event'>事件</h3>
<section class='collapsable'>
<h4 id='map-layer-events'>图层事件</h4>
<table><thead>
<tr>
<th>事件名</th>
<th>数据</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-baselayerchange'>
<td><code><b>baselayerchange</b></code></td>
<td><code><a href='#layerscontrolevent'>LayersControlEvent</a></code></td>
<td>通过<a href="#control-layers">图层控件</a>更改基本图层时触发。</td>
</tr>
<tr id='map-overlayadd'>
<td><code><b>overlayadd</b></code></td>
<td><code><a href='#layerscontrolevent'>LayersControlEvent</a></code></td>
<td>通过<a href="#control-layers">图层控件</a>选择叠加图层时触发。</td>
</tr>
<tr id='map-overlayremove'>
<td><code><b>overlayremove</b></code></td>
<td><code><a href='#layerscontrolevent'>LayersControlEvent</a></code></td>
<td>通过<a href="#control-layers">图层控件</a>取消选择叠加图层时触发。</td>
</tr>
<tr id='map-layeradd'>
<td><code><b>layeradd</b></code></td>
<td><code><a href='#layerevent'>LayerEvent</a></code></td>
<td>将新图层添加到地图时触发。</td>
</tr>
<tr id='map-layerremove'>
<td><code><b>layerremove</b></code></td>
<td><code><a href='#layerevent'>LayerEvent</a></code></td>
<td>从地图上删除某些图层时触发</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-map-state-change-events'>地图状态变更事件</h4>
<div class='section-comments'></div>
<table><thead>
<tr>
<th>事件名</th>
<th>数据</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-zoomlevelschange'>
<td><code><b>zoomlevelschange</b></code></td>
<td><code><a href='#event'>Event</a></code></td>
<td>当地图上的缩放级别数因添加或移除图层而更改时触发。</td>
</tr>
<tr id='map-resize'>
<td><code><b>resize</b></code></td>
<td><code><a href='#resizeevent'>ResizeEvent</a></code></td>
<td>调整地图大小时触发。</td>
</tr>
<tr id='map-unload'>
<td><code><b>unload</b></code></td>
<td><code><a href='#event'>Event</a></code></td>
<td>当使用 <a href="#map-remove">remove</a> 方法销毁地图时触发。</td>
</tr>
<tr id='map-viewreset'>
<td><code><b>viewreset</b></code></td>
<td><code><a href='#event'>Event</a></code></td>
<td>当地图需要重绘其内容时触发（通常发生在地图缩放或加载时）。 对于创建 custom overlays 非常有用。</td>
</tr>
<tr id='map-load'>
<td><code><b>load</b></code></td>
<td><code><a href='#event'>Event</a></code></td>
<td>地图初始化时触发（首次设置其中心和缩放比例时）。</td>
</tr>
<tr id='map-zoomstart'>
<td><code><b>zoomstart</b></code></td>
<td><code><a href='#event'>Event</a></code></td>
<td>地图缩放即将更改时（例如在缩放动画之前）触发。</td>
</tr>
<tr id='map-movestart'>
<td><code><b>movestart</b></code></td>
<td><code><a href='#event'>Event</a></code></td>
<td>当地图视图开始更改时触发（例如，用户开始拖动地图）。</td>
</tr>
<tr id='map-zoom'>
<td><code><b>zoom</b></code></td>
<td><code><a href='#event'>Event</a></code></td>
<td>在缩放级别的任何更改（包括缩放和飞行动画）期间反复触发。</td>
</tr>
<tr id='map-move'>
<td><code><b>move</b></code></td>
<td><code><a href='#event'>Event</a></code></td>
<td>在地图的任何移动过程中反复触发，包括平移和飞行动画。</td>
</tr>
<tr id='map-zoomend'>
<td><code><b>zoomend</b></code></td>
<td><code><a href='#event'>Event</a></code></td>
<td>在任何动画执行完毕地图更新后都会触发。</td>
</tr>
<tr id='map-moveend'>
<td><code><b>moveend</b></code></td>
<td><code><a href='#event'>Event</a></code></td>
<td>地图中心停止更改时触发（例如，用户停止拖动地图）。</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-popup-events'>Popup 弹窗事件</h4>
<table><thead>
<tr>
<th>事件名</th>
<th>数据</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-popupopen'>
<td><code><b>popupopen</b></code></td>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>在地图上打开 popup（弹出窗口）时触发。</td>
</tr>
<tr id='map-popupclose'>
<td><code><b>popupclose</b></code></td>
<td><code><a href='#popupevent'>PopupEvent</a></code></td>
<td>当地图中的 popup（弹出窗口）关闭时触发。</td>
</tr>
<tr id='map-autopanstart'>
<td><code><b>autopanstart</b></code></td>
<td><code><a href='#event'>Event</a></code></td>
<td>打开 popup（弹出窗口）时地图开始自动平移时触发。</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-tooltip-events'>Tooltip 工具提示事件</h4>
<table><thead>
<tr>
<th>事件名</th>
<th>数据</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-tooltipopen'>
<td><code><b>tooltipopen</b></code></td>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>在地图上打开 tooltip（工具提示）时触发。</td>
</tr>
<tr id='map-tooltipclose'>
<td><code><b>tooltipclose</b></code></td>
<td><code><a href='#tooltipevent'>TooltipEvent</a></code></td>
<td>地图中的 tooltip（工具提示）关闭时触发。</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-location-events'>Location 定位相关事件</h4>
<table><thead>
<tr>
<th>事件名</th>
<th>数据</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-locationerror'>
<td><code><b>locationerror</b></code></td>
<td><code><a href='#errorevent'>ErrorEvent</a></code></td>
<td>当获取地理位置（使用 <a href="#map-locate"><code>locate</code></a> 方法）失败时触发。</td>
</tr>
<tr id='map-locationfound'>
<td><code><b>locationfound</b></code></td>
<td><code><a href='#locationevent'>LocationEvent</a></code></td>
<td>当获取地理位置（使用 <a href="#map-locate"><code>locate</code></a> 方法）成功时触发。</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-interaction-events'>交互事件</h4>
<table><thead>
<tr>
<th>事件名</th>
<th>数据</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-click'>
<td><code><b>click</b></code></td>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>当用户点击地图时触发。</td>
</tr>
<tr id='map-dblclick'>
<td><code><b>dblclick</b></code></td>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>当用户双击地图时触发。</td>
</tr>
<tr id='map-mousedown'>
<td><code><b>mousedown</b></code></td>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>当用户在地图上按下鼠标按钮时触发。</td>
</tr>
<tr id='map-mouseup'>
<td><code><b>mouseup</b></code></td>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>当用户释放地图上的鼠标按钮时触发。</td>
</tr>
<tr id='map-mouseover'>
<td><code><b>mouseover</b></code></td>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>当鼠标进入地图时触发。</td>
</tr>
<tr id='map-mouseout'>
<td><code><b>mouseout</b></code></td>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>当鼠标离开地图时触发。</td>
</tr>
<tr id='map-mousemove'>
<td><code><b>mousemove</b></code></td>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>当鼠标在地图上移动时触发。</td>
</tr>
<tr id='map-contextmenu'>
<td><code><b>contextmenu</b></code></td>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>当用户在地图上按下鼠标右键时触发，从而阻止默认浏览器上下文菜单显示，如果此事件上有侦听器。 当用户长按时，也会在移动设备上触发。</td>
</tr>
<tr id='map-keypress'>
<td><code><b>keypress</b></code></td>
<td><code><a href='#keyboardevent'>KeyboardEvent</a></code></td>
<td>当用户在聚焦地图时按下键盘上输入字符时触发。</td>
</tr>
<tr id='map-keydown'>
<td><code><b>keydown</b></code></td>
<td><code><a href='#keyboardevent'>KeyboardEvent</a></code></td>
<td>当地图聚焦时用户按下键盘上的键时触发。 与keypress事件不同，对于产生字符值的键和不产生字符值的键都会触发keydown事件。</td>
</tr>
<tr id='map-keyup'>
<td><code><b>keyup</b></code></td>
<td><code><a href='#keyboardevent'>KeyboardEvent</a></code></td>
<td>当用户在地图被聚焦时从键盘上释放一个按键时触发。</td>
</tr>
<tr id='map-preclick'>
<td><code><b>preclick</b></code></td>
<td><code><a href='#mouseevent'>MouseEvent</a></code></td>
<td>在鼠标点击地图之前触发（当你希望在点击事件触发之前执行某些操作时可以使用）。</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-other-events'>其它事件</h4>
<table><thead>
<tr>
<th>事件名</th>
<th>数据</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-zoomanim'>
<td><code><b>zoomanim</b></code></td>
<td><code><a href='#zoomanimevent'>ZoomAnimEvent</a></code></td>
<td>每个缩放动画至少触发一次。 对于连续缩放（如捏合缩放），在缩放过程中每帧触发一次。</td>
</tr>
</tbody></table>
</section>
</section><section>
<h3 id='map-method'>方法</h3>
<section >
<table><thead>
<tr>
<th>方法名</th>
<th>返回值</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-getrenderer'>
<td><code><b>getRenderer</b>(<nobr><<a href='#path'>Path</a>></nobr> <i>layer</i>)</code></td>
<td><code><a href='#renderer'>Renderer</a></code></td>
<td><p>返回 <a href="#renderer"><code>Renderer</code></a> 的实例，该实例应该用于渲染给定的 <a href="#path"><code>Path</code></a>。它将确保地图和路径的 Renderer 选项得到尊重，并且 Renderer 确实存在于地图上。</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-methods-for-layers-and-controls'>图层和控件</h4>
<table><thead>
<tr>
<th>方法名</th>
<th>返回值</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-addcontrol'>
<td><code><b>addControl</b>(<nobr><<a href='#control'>Control</a>></nobr> <i>control</i>)</code></td>
<td><code>this</code></td>
<td><p>添加控件到地图上</p>
</td>
</tr>
<tr id='map-removecontrol'>
<td><code><b>removeControl</b>(<nobr><<a href='#control'>Control</a>></nobr> <i>control</i>)</code></td>
<td><code>this</code></td>
<td><p>从地图上移除一个指定的控件</p>
</td>
</tr>
<tr id='map-addlayer'>
<td><code><b>addLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</code></td>
<td><code>this</code></td>
<td><p>添加图层到地图上</p>
</td>
</tr>
<tr id='map-removelayer'>
<td><code><b>removeLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</code></td>
<td><code>this</code></td>
<td><p>从地图上移除一个指定的图层</p>
</td>
</tr>
<tr id='map-haslayer'>
<td><code><b>hasLayer</b>(<nobr><<a href='#layer'>Layer</a>></nobr> <i>layer</i>)</code></td>
<td><code>Boolean</code></td>
<td><p>地图上是否存在指定的图层，如果给定的图层当前已被加到地图上，则返回 true</p>
</td>
</tr>
<tr id='map-eachlayer'>
<td><code><b>eachLayer</b>(<nobr><Function></nobr> <i>fn</i>, <nobr><Object></nobr> <i>context?</i>)</code></td>
<td><code>this</code></td>
<td><p>遍历地图的图层，选择指定上下文的迭代器函数。</p>
<pre><code>map.eachLayer(function(layer){
layer.bindPopup('Hello');
});
</code></pre>
</td>
</tr>
<tr id='map-openpopup'>
<td><code><b>openPopup</b>(<nobr><<a href='#popup'>Popup</a>></nobr> <i>popup</i>)</code></td>
<td><code>this</code></td>
<td><p>打开指定的 Popup（弹窗）。（如果之前有打开其他的，会自动关闭，确保只有一个）</p>
</td>
</tr>
<tr id='map-openpopup'>
<td><code><b>openPopup</b>(<nobr><String|HTMLElement></nobr> <i>content</i>, <nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><<a href='#popup-option'>Popup options</a>></nobr> <i>options?</i>)</code></td>
<td><code>this</code></td>
<td><p>创建指定的内容和选项的 Popup（弹窗），并在地图上的指定点打开它。</p>
</td>
</tr>
<tr id='map-closepopup'>
<td><code><b>closePopup</b>(<nobr><<a href='#popup'>Popup</a>></nobr> <i>popup?</i>)</code></td>
<td><code>this</code></td>
<td><p>关闭之前打开的（或给定某个）<a href="#map-openpopup">Popup</a> （弹窗）。</p>
</td>
</tr>
<tr id='map-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><<a href='#tooltip'>Tooltip</a>></nobr> <i>tooltip</i>)</code></td>
<td><code>this</code></td>
<td><p>打开指定的 Tooltip（提示框）。</p>
</td>
</tr>
<tr id='map-opentooltip'>
<td><code><b>openTooltip</b>(<nobr><String|HTMLElement></nobr> <i>content</i>, <nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><<a href='#tooltip-option'>Tooltip options</a>></nobr> <i>options?</i>)</code></td>
<td><code>this</code></td>
<td><p>创建并打开具有指定内容和选项的 Tooltip（提示框）。</p>
</td>
</tr>
<tr id='map-closetooltip'>
<td><code><b>closeTooltip</b>(<nobr><<a href='#tooltip'>Tooltip</a>></nobr> <i>tooltip</i>)</code></td>
<td><code>this</code></td>
<td><p>关闭之前打开的（或给定某个）Tooltip（提示框）。</p>
</td>
</tr>
</tbody></table>
</section><section class='collapsable'>
<h4 id='map-methods-for-modifying-map-state'>修改地图状态</h4>
<table><thead>
<tr>
<th>方法名</th>
<th>返回值</th>
<th>说明</th>
</tr>
</thead><tbody>
<tr id='map-setview'>
<td><code><b>setView</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>center</i>, <nobr><Number></nobr> <i>zoom</i>, <nobr><<a href='#zoom/pan-options'>Zoom/pan options</a>></nobr> <i>options?</i>)</code></td>
<td><code>this</code></td>
<td><p>用指定的动画选项设置地图的视图（地理中心和缩放）。</p>
</td>
</tr>
<tr id='map-setzoom'>
<td><code><b>setZoom</b>(<nobr><Number></nobr> <i>zoom</i>, <nobr><<a href='#zoom/pan-options'>Zoom/pan options</a>></nobr> <i>options?</i>)</code></td>
<td><code>this</code></td>
<td><p>设置地图的缩放级别。</p>
</td>
</tr>
<tr id='map-zoomin'>
<td><code><b>zoomIn</b>(<nobr><Number></nobr> <i>delta?</i>, <nobr><<a href='#zoom-options'>Zoom options</a>></nobr> <i>options?</i>)</code></td>
<td><code>this</code></td>
<td><p>放大地图级别 ( delta 为空时，默认值取自 <a href="#map-zoomdelta"><code>zoomDelta</code></a> )。</p>
</td>
</tr>
<tr id='map-zoomout'>
<td><code><b>zoomOut</b>(<nobr><Number></nobr> <i>delta?</i>, <nobr><<a href='#zoom-options'>Zoom options</a>></nobr> <i>options?</i>)</code></td>
<td><code>this</code></td>
<td><p>缩小地图级别 ( delta 为空时，默认值取自 <a href="#map-zoomdelta"><code>zoomDelta</code></a> )。</p>
</td>
</tr>
<tr id='map-setzoomaround'>
<td><code><b>setZoomAround</b>(<nobr><<a href='#latlng'>LatLng</a>></nobr> <i>latlng</i>, <nobr><Number></nobr> <i>zoom</i>, <nobr><<a href='#zoom-options'>Zoom options</a>></nobr> <i>options</i>)</code></td>
<td><code>this</code></td>
<td><p>缩放地图，同时保持地图上的指定地理位置不变（例如内部用于滚动缩放和双击缩放）。</p>
</td>
</tr>
<tr id='map-setzoomaround'>
<td><code><b>setZoomAround</b>(<nobr><<a href='#point'>Point</a>></nobr> <i>offset</i>, <nobr><Number></nobr> <i>zoom</i>, <nobr><<a href='#zoom-options'>Zoom options</a>></nobr> <i>options</i>)</code></td>
<td><code>this</code></td>
<td><p>缩放地图，同时保持地图上相对于左上角的指定像素位置不变。</p>
</td>